Saltar a contenido

Doxygen


Doxygen es la herramienta estándar de facto para generar documentación a partir de fuentes de C ++, pero también admite otros lenguajes de programación populares como C, Objective-C, C #, PHP, Java, Python, IDL (Corba, Microsoft y UNO/ OpenOffice), Fortran, VHDL, Tcl, y hasta cierto punto D.

Doxygen

Doxygen puede ayudarlo de tres maneras:

  1. Puede generar documentación en línea (en HTML) para navegadores y/o un manual de referencia fuera de línea (en LaTeX) a partir de un conjunto de archivos fuente documentados. También se admite la generación de resultados en RTF (MS-Word), PostScript, PDF hipervinculado, HTML comprimido y páginas man de Unix. La documentación se extrae directamente de las fuentes, lo que hace que sea mucho más fácil mantener la documentación coherente con el código fuente.
  2. Puede configurar doxygen para extraer la estructura de código de archivos fuente no documentados. Esto es muy útil para encontrar rápidamente su camino en grandes distribuciones de fuentes. Doxygen también puede visualizar las relaciones entre los diversos elementos por medio de gráficos de dependencia, diagramas de herencia y diagramas de colaboración, que se generan automáticamente.
  3. También puede usar doxygen para crear documentación normal (como lo hice para el manual del usuario de doxygen y el sitio web).

Doxygen está desarrollado bajo Mac OS X y Linux, pero está configurado para ser altamente portátil. Como resultado, se ejecuta en la mayoría de las plataformas de Unix. Además, los ejecutables para Windows también están disponibles.

Instalación

Linux

La mayoría de las distribuciones Linux lo trae para su instalación.

  • Para OpenSuse 15.0, se corre los siguientes comandos como 'root':
$ zypper ar -f -p 80 http://download.opensuse.org/repositories/devel:/tools/openSUSE_Leap_15.0/ "Develop Tools"
$ zypper in tig doxygen doxywizard xmlgraphics-fop graphviz graphviz-guile
$ zypper in flex bison lynx
$ zypper in texlive-sectsty texlive-tocloft texlive-xtab texlive-multirow
$ zypper in texlive-tex4ht texlive-tex4ht-bin texlive-autopdf texlive-dot2texi
$ zypper in texlive-uml texlive-tabu
$ texhash

Otras plataformas

Para otras plataformas se recomienda seguir las instrucciones de la página oficial.

Uso

Para el correcto uso de Doxygen y dependiendo de cada tipo de proyecto de desarrollo se recomienda leer los siguientes artículos:

Una ves instalado Doxygen se puede validar si el programa está correctamente instalado ejecutando el comando doxygen -version:

$ doxygen -version
1.8.14

Una vez que tenemos un archivo de configuración de Doxygen para un proyecto, para generar la documentación basta con ejecutar el siguiente comando:

doxygen -g <config-file>

por default toma el archivo 'Doxyfile':

doxygen -g Doxyfile