Doxygen-1.4.2

Introducción a Doxygen

El paquete Doxygen contiene un sistema de documentación para C++, C, Java, Objective-C, Corba IDL y, en parte, PHP, C# y D. Es útil para generar documrentación HTML y/o un manual de referencia a partir de un grupo de ficheros fuente documentados. También soporta generación de salida en RTF, PostScript, PDF con hiperlinks, HTML comprimido y páginas de manual Unix. La documentación se extrae directamente de las fuentes, lo que hace mucho más fácil mantener consistente la documentación con el código fuente.

También puedes configurar Doxygen para extraer la extructura del códifgo de ficheros fuente indocumentados. Esto es muy útil para encontrar rápidamente el camino en grandes distribuciones de fuentes. Usado junto con GraphViz podrás visualizar también las relaciones entre los diversos elementos en forma de gráficos de dependencias, diagramas de herencias y diagramas de colaboración, todos ellos generados automáticamente.

Información sobre el paquete

  • Descarga (HTTP):

  • Descarga (FTP): ftp://ftp.stack.nl/pub/users/dimitri/doxygen-1.4.2.src.tar.gz

  • Suma MD5 del paquete: 5e0b6c8854c87e06aaca78c81c5236ec

  • Tamaño del paquete: 2.8 MB

  • Estimación del espacio necesario en disco: 39.7 MB (additional 10.5 MB to build and install docs and doxywizard)

  • Tiempo estimado de construcción: 1.26 SBU (additional 0.50 SBU to build docs and doxywizard)

Instalación deDoxygen

Instala Doxygen ejecutando los siguientes comandos:

rm src/unistd.h &&
./configure --prefix /usr --docdir /usr/share/doc &&
make

Ahora, como usuario root:

make install

Si deseas generar e instalar la documentación del paquete (incluidas las páginas de manual) asegurate de que los paquetes Python, TeX y GraphViz están instalados. Entonces sustituye el anterior comando make install por los siguientes comandos:

make docs &&
make pdf &&
install -v -d -m755 /usr/share/doc/doxygen/src &&
install -v -m644 src/translator{,_adapter,_en}.h \
    /usr/share/doc/doxygen/src &&
install -v -m644 VERSION /usr/share/doc/doxygen &&
make install_docs

Explicación de los comandos

rm src/unistd.h: Hay en error en Flex-2.5.31 que hace que make utlice este fichero en vez de la versión instalada en el sistema. Eliminando este fichero se permite que la intefaz GUI se construya correctamente.

--with-doxywizard: Utiliza este parámetro si tienes instalado Qt y desas construir la interfaz GUI.

make docs: Este comando construye las páginas de manual y la documentación HTML.

make pdf: Este comando construye una versión PDF del manual de Doxygen.

install ...: Estos comandos instalan varios ficheros requeridos por la instalación de la documentación.

Nota: Para la documentación en un idioma diferente al inglés, sustituye “_en” con el código de país correspondiente.

make install_docs: Este comando instala los binarios y la documentación.

Contenido

Programas instalados: doxygen, doxytag y doxywizard
Librerías instaladas: Ninguna
Directorio instalado: /usr/share/doc/doxygen

Descripciones cortas

doxygen

Utilidad basada en línea de comandos usada para generar ficheros de configuración de plantillas y entonces generar documentación a partir de estas plantillas. Utiliza doxygen --help para una explicación de los parámetros de línea de comandos.

doxytag

Genera un fichero de etiquetas y/o un índice de búsqueda para un conjunto de ficheros HTML.

doxywizard

Interfaz GUI para configurar y ejecutar doxygen.

Last updated on 2005-04-23 17:30:37 +0200