Incluyendo la salida LaTeX de doxygen como un apéndice a un documento más grande
(1)
Tengo un "libro de proyectos" que usa /documentclass{report}
LaTeX ("report" es como una versión más compacta de /documentclass{book}
). Me gustaría incluir en este libro un apéndice con la documentación de la API generada por Doxygen para el software en el proyecto.
Lo he logrado configurando las opciones de configuración de Doxygen LATEX_HEADER
y LATEX_FOOTER
en un archivo vacío. Esto hace que el latex / refman.tex resultante tenga comandos de nivel superior como: /section{/-Namespace /-Index}
, en cuyo punto puedo envolver esto con un documento de nivel superior como:
/documentclass{report}
/usepackage{doxygen.sty}
% the "import" package helps to find Doxygen files in the latex/ subdirectory
/usepackage{import}
% [...] title page and the rest of the book
/appendix
/chapter{API reference (generated by Doxygen)
subimport{latex/}{refman.tex}
% [...] final stuff
/end{document}
Esto funciona razonablemente bien y obtengo doxygen.sty
con esta invocación especial de doxygen:
doxygen -w latex /dev/null /dev/null doxygen.sty
Un problema es que esto coloca un encabezado "autogenerado" en todo el documento (no solo en el apéndice de doxygen). Puedo deshacerme de esto editando doxygen.sty
(también renombro para mi inclusión, en realidad) y comentando el bloque que comienza con los % Setup fancy headings
.
En este punto, tengo algo con lo que puedo vivir, pero me gustaría ir un paso más allá: el estilo "doxygen" modifica muchos otros aspectos del estilo del documento LaTeX, y me gusta menos.
Entonces mi pregunta es (en dos niveles de excelencia):
¿Cuál sería un conjunto mínimo de comandos LaTeX para colocar en un archivo doxygen.sty que mostraría bien el apéndice de doxygen pero no interferiría con el resto del documento LaTeX?
Aún mejor, ¿alguien ha encontrado una manera de hacer
/usepackage{doxygen_standalone} % [... until you need doxygen] /begin{doxygen} % the stuff you need to insert your auto-generated doxygen API docs, % for example the /subimport{latex/}{refman.tex} that I showed above /end{doxygen}
Este último enfoque es uno que consideraría muy limpio.
Espero que haya una respuesta muy simple, como por ejemplo, "esto ya existe en doxygen.sty como una opción, ¡y te lo perdiste!"
cambie el nombre de doxygen.sty a mydoxygen.sty, luego modifíquelo insertando / newenvironment {doxygen} {... la mayoría de doxygen.sty va aquí ...} {}