Doxygen para PRG

Doxygen para PRG

Postby quim » Mon Jan 02, 2017 11:56 am

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
quim
 
Posts: 42
Joined: Mon Apr 11, 2011 6:22 pm

Re: Doxygen para PRG

Postby Antonio Linares » Mon Jan 02, 2017 12:16 pm

regards, saludos

Antonio Linares
www.fivetechsoft.com
User avatar
Antonio Linares
Site Admin
 
Posts: 42203
Joined: Thu Oct 06, 2005 5:47 pm
Location: Spain

Re: Doxygen para PRG

Postby quim » Mon Jan 02, 2017 12:26 pm

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
quim
 
Posts: 42
Joined: Mon Apr 11, 2011 6:22 pm

Re: Doxygen para PRG

Postby Antonio Linares » Mon Jan 02, 2017 12:33 pm

regards, saludos

Antonio Linares
www.fivetechsoft.com
User avatar
Antonio Linares
Site Admin
 
Posts: 42203
Joined: Thu Oct 06, 2005 5:47 pm
Location: Spain

Re: Doxygen para PRG

Postby quim » Mon Jan 02, 2017 3:24 pm

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  Expand view  RUN

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 !
quim
 
Posts: 42
Joined: Mon Apr 11, 2011 6:22 pm

Re: Doxygen para PRG

Postby Antonio Linares » Mon Jan 02, 2017 11:55 pm

Te ha llegado a mostrar el gráfico ?

Puedes copiar la imagen aquí ? gracias
regards, saludos

Antonio Linares
www.fivetechsoft.com
User avatar
Antonio Linares
Site Admin
 
Posts: 42203
Joined: Thu Oct 06, 2005 5:47 pm
Location: Spain

Re: Doxygen para PRG

Postby quim » Wed Jan 04, 2017 12:44 pm

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  Expand view  RUN

/**
  @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
quim
 
Posts: 42
Joined: Mon Apr 11, 2011 6:22 pm

Re: Doxygen para PRG

Postby cnavarro » Wed Jan 04, 2017 2:49 pm

Puedes explicar, brevemente, como usar Doxygen y Graphviz?
Es por linea de comandos?
Cristobal Navarro
Hay dos tipos de personas: las que te hacen perder el tiempo y las que te hacen perder la noción del tiempo
El secreto de la felicidad no está en hacer lo que te gusta, sino en que te guste lo que haces
User avatar
cnavarro
 
Posts: 6552
Joined: Wed Feb 15, 2012 8:25 pm
Location: España

Re: Doxygen para PRG

Postby quim » Wed Jan 04, 2017 4:10 pm

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
quim
 
Posts: 42
Joined: Mon Apr 11, 2011 6:22 pm

Re: Doxygen para PRG

Postby cnavarro » Wed Jan 04, 2017 5:00 pm

Gracias
Yo me habia descargado en .ZIP y no lo encontraba
Cristobal Navarro
Hay dos tipos de personas: las que te hacen perder el tiempo y las que te hacen perder la noción del tiempo
El secreto de la felicidad no está en hacer lo que te gusta, sino en que te guste lo que haces
User avatar
cnavarro
 
Posts: 6552
Joined: Wed Feb 15, 2012 8:25 pm
Location: España


Return to FiveWin para Harbour/xHarbour

Who is online

Users browsing this forum: No registered users and 102 guests