que documentar codigo pdf pdf-generation doxygen documentation-generation pdflatex

pdf - que - documentar codigo



¿Cómo obtener un solo documento PDF de Doxygen? (5)

Cuando genero documentación de Doxygen en formato PDF, obtengo muchos archivos diferentes con un solo diagrama en cada uno.
¿Es posible obtener un solo documento PDF, organizado como un libro, más o menos como la versión HTML?
¿Es posible obtenerlo automáticamente, es decir, sin tener que lidiar manualmente con los archivos de látex?

¡Gracias!


Consulte Conversión de un documento LaTeX en un documento PDF .

Cuando Doxygen ha terminado de procesarse, en el directorio de látex hay un archivo llamado ''refman.tex''.

Hay tres maneras en que puede usar ese archivo para obtener ''un libro'' de Doxygen:

  • LaTeX -> dvips -> ps2pdf

    látex miarchivo

    dvips myfile

    ps2pdf myfile.ps

  • LaTeX -> dvipdfm

    látex miarchivo

    dvipdfm myfile

  • pdflatex (o pdftex para TeX simple)

    pdflatex myfile


Otras personas no mencionaron un detalle:

Para que la ruta de pdflatex funcione, su directorio de trabajo actual debe ser la carpeta de látex generada; de lo contrario, obtendrá errores como doxygen.sty cannot be found .


Patel tiene razón: necesita ejecutar Doxygen, luego látex de algún tipo para crear el documento único.

Para mí, usando Doxygen 1.7.3, el archivo raíz para la compilación de látex parece ser "refman.tex".

Doxygen también crea un Makefile, así que si tienes make (no lo hago en mi Win7 box), puedes escribir make en el directorio de látex.

Señalo mi aplicación TeXnicCenter en refman.tex y la compilo de esa manera.

Espero que esto ayude,

-Mate


Suponiendo que doxygen está configurado correctamente, en Linux:

doxygen cd latex make

El archivo generado será refman.pdf a menos que esté configurado de otra manera.


Usando Doxygen 1.8.4+ (en Windows), también hay un script make.bat para que no necesites abrir la línea de comando.

  1. Configure Doxygen para salida LaTeX.

    GENERATE_LATEX = YES LATEX_OUTPUT = latex OUTPUT_DIRECTORY =

  2. Configure todas sus imágenes para la salida LaTeX.

    /image html application.jpg /image latex application.eps "My application" width=10cm

  3. Ejecuta Doxygen.

  4. Ejecute {OUTPUT_DIRECTORY}/{LATEX_OUTPUT}/make.bat.
  5. Abra {OUTPUT_DIRECTORY}/{LATEX_OUTPUT}/refman.pdf .

Si no se crea refman.pdf, ejecute make.bat desde una ventana de comandos y lea los errores.

Errores como: ''pdflatex'' is not recognized as an internal or external command, ... Significa que no tiene los prerequisites para ejecutar latex. Otros errores pueden deberse a la falta de paquetes de látex o errores de doxígeno que causan archivos .tex no válidos.

Una vez que tenga todos los requisitos previos instalados y una buena versión de doxygen, el procedimiento más simple debería funcionar siempre.