Doxygen para PRG

Post Reply
quim
Posts: 27
Joined: Mon Apr 11, 2011 6:22 pm

Doxygen para PRG

Post by quim »

Saludos foro y Feliz 2017 !!!

Alguien ha utilizado Doxygen http://www.stack.nl/~dimitri/doxygen/index.html para documentar fuentes en PRG ?

He realizado algunas pruebas, con archivos C o PHP funciona la generación de documentación, pero con los PRG no....

Puede ser con sólo funcione con los lenguajes que dice soportar ? (C, Objective-C, C#, PHP, Java, Python, IDL)

Saludos
User avatar
Antonio Linares
Site Admin
Posts: 37481
Joined: Thu Oct 06, 2005 5:47 pm
Location: Spain
Contact:

Re: Doxygen para PRG

Post by Antonio Linares »

regards, saludos

Antonio Linares
www.fivetechsoft.com
quim
Posts: 27
Joined: Mon Apr 11, 2011 6:22 pm

Re: Doxygen para PRG

Post by quim »

Antonio:

La documentación generada en los enlaces que muestras creo que sólo son para fuentes C o CPP

No veo que se pueda generar desde fuentes PRG

Saludos y gracias por la respuesta
User avatar
Antonio Linares
Site Admin
Posts: 37481
Joined: Thu Oct 06, 2005 5:47 pm
Location: Spain
Contact:

Re: Doxygen para PRG

Post by Antonio Linares »

regards, saludos

Antonio Linares
www.fivetechsoft.com
quim
Posts: 27
Joined: Mon Apr 11, 2011 6:22 pm

Re: Doxygen para PRG

Post by quim »

OK reviso Scintilla, parece que es un editor de código no ?

Estoy utilizando Doxygen GUI frontend, tanto en Ubuntu 16 como en windows 10 con idéntico resultado

Ahora ya he podido generar documentación 'engañando' un poco la configuración.

Editando a mano el fichero de configuración del proyecto, en mi caso Doxyfile (una especie de fichero INI), he cambiado las secciones :

Code: Select all

EXTENSION_MAPPING = prg=c
FILE_PATTERNS  = *.c \
                         *.cc \
                         *.cpp \
                         *.c++ \
                         *.java \
                         *.h \
                         *.php \
                         *.prg
 
Ahora ya genera documentación (funciona el parser) ;
El siguiente paso será averiguar el léxico a tratar, ya que de momento sólo reconoce las palabras reservadas comunes a ambos lenguajes (function, for, while ... )
Seguiremos investigando, gracias !
User avatar
Antonio Linares
Site Admin
Posts: 37481
Joined: Thu Oct 06, 2005 5:47 pm
Location: Spain
Contact:

Re: Doxygen para PRG

Post by Antonio Linares »

Te ha llegado a mostrar el gráfico ?

Puedes copiar la imagen aquí ? gracias
regards, saludos

Antonio Linares
www.fivetechsoft.com
quim
Posts: 27
Joined: Mon Apr 11, 2011 6:22 pm

Re: Doxygen para PRG

Post by quim »

Antonio,

Doxygen no muestra directamente ningún gráfico... Es necesario instalar graphviz http://www.graphviz.org

Los tests de Doxygen realizados con Windows han sido decepcionantes ... muestra a duras penas el árbol de PRG de la aplicación y la documentación generada no supera el reconocer un par de defines

En cambio con Ubuntu, aparece documentación, de forma algo caótica, pero puede ser un punto de partida.
Graphviz ha generado las dependencias de forma gráfica, integrando imagen en el HTML final.
No he conseguido que haga caso a los 'comandos' de Doxygen, como son brief, file, author,... ni que documente una función

Code: Select all

/** 
  @brief  Aplicacion Clase TProgram    
  @file   PROGRAM.PRG   
  @author (C)2.016 JFG 
  @date   30/12/2016 
 */
/**
  @brief  funcion para traducir textos

  El diccionario se cargará desde una tabla de mensajes -> struct : Message, spanish, english, ...
  Id corresponde al idioma por defecto que está en el codigo de Getex...
 */
 
Dejo algunas imágenes ...
Image
Image
Image
User avatar
cnavarro
Posts: 5792
Joined: Wed Feb 15, 2012 8:25 pm
Location: España

Re: Doxygen para PRG

Post by cnavarro »

Puedes explicar, brevemente, como usar Doxygen y Graphviz?
Es por linea de comandos?
C. Navarro
Hay dos tipos de personas: las que te hacen perder el tiempo y las que te hacen perder la noción del tiempo
Si alguien te dice que algo no se puede hacer, recuerda que esta hablando de sus limitaciones, no de las tuyas.
quim
Posts: 27
Joined: Mon Apr 11, 2011 6:22 pm

Re: Doxygen para PRG

Post by quim »

Cristobal,
Doxygen funciona desde la linea de comandos pero tienes una GUI que te facilita el trabajo llamada Doxywizard
Todo es multiplataforma, tienes instaladores para Windows tipo setup.exe o paquetes deb (debian, en mi caso Ubuntu)
La herramienta graphviz es llamada desde esta GUI, te dejo unas imágenes
Saludos

Image
Image
User avatar
cnavarro
Posts: 5792
Joined: Wed Feb 15, 2012 8:25 pm
Location: España

Re: Doxygen para PRG

Post by cnavarro »

Gracias
Yo me habia descargado en .ZIP y no lo encontraba
C. Navarro
Hay dos tipos de personas: las que te hacen perder el tiempo y las que te hacen perder la noción del tiempo
Si alguien te dice que algo no se puede hacer, recuerda que esta hablando de sus limitaciones, no de las tuyas.
Post Reply