¿Cómo incluir fragmentos de LaTeX directamente en los comentarios de Doxygen?

Me gustaría poder editar partes de LaTeX de algunos comentarios de Doxygen externamente con algún editor adecuado. Lo usaría solo para entornos complejos. Para hacer eso, pensé que podía tener archivos LaTeX-only e incluirlos de Doxygen. Creé alias de Doxygen para \begin y \end para hacer la sintaxis compatible.¿Cómo incluir fragmentos de LaTeX directamente en los comentarios de Doxygen?

(Por ejemplo, sé cómo set-up Emacs/auctex para trabajar con fragmentos LaTeX que no tienen una estructura de preámbulo y en el documento.)

¿Hay una manera de incluir el contenido de un archivo .tex interior un comentario de Doxygen? Busco algo análogo al \htmlinclude, pero para archivos TeX. ¿Hay alguna forma de emular la funcionalidad, teniendo en cuenta mis requisitos para tener una fuente externa exclusiva de TeX?

Fuente

2011-02-03 simeonz

Ahora tenemos un sitio dedicado de preguntas y respuestas para preguntas sobre TeX. Por favor haga su pregunta nuevamente en tex.stackexchange.com –

¿Alguna vez resolvió esto? Intento hacer lo mismo. Probé varias variaciones en \ include y \ verbinclude, pero parece que no puedo hacerlo funcionar ... –

Lo siento, pero no pude encontrar la manera de hacerlo en el tiempo, aunque leí la documentación de Doxygen. La consulta era para fines educativos, así que finalmente me rendí. – simeonz

¿Has probado el comando \verbinclude? Este comando incluye cualquier archivo textualmente en la documentación (en contraste con \include, que se usa para incluir archivos fuente).

Desde el manual doxygen:

\verbinclude <file-name>

Este comando incluye el archivo <file-name> textualmente en la documentación. El comando es equivalente a pegar el archivo en la documentación y colocar los comandos \verbatim y \endverbatim alrededor.

Los archivos o directorios que doxygen debería buscar se pueden especificar utilizando la etiqueta EXAMPLE_PATH del archivo de configuración de doxygen.

Editar: acabo de tener una idea de que es posible que desee quitar el preámbulo de su archivo .tex antes de incluir el resto del archivo de la documentación. puede hacerlo utilizando el comando \dontinclude que, junto con los comandos \line, \skip, \skipline y \until, le permite incluir líneas/bloques específicos de un archivo en particular. Vea el ejemplo en el \dontincludedocumentation.

Fuente

2012-03-14 12:39:08 Chris

Gracias, pero lo que quería era tener macros LaTeX trabajando en el documento externo. Por ejemplo, un diagrama sería voluminoso, sin mencionar feo, simplemente sentado en los comentarios. Pensé que tal documentación "compleja" se puede poner en algún archivo externo. Pero he abandonado la idea ahora. – simeonz

Me temo que no entiendo muy bien tu comentario. El comando '\ verbinclude' incluye los contenidos de los archivos externos en su documentación durante la compilación de su documentación, esto no afecta sus archivos fuente. – Chris

Gracias, pero verbinclude no es la solución. Suprime las macros de LaTeX. Todo el código dentro de los entornos LaTeX se emite en forma de fuente. Entonces, por ejemplo, si quisiera dibujar un diagrama UML con LaTeX, obtendría el marcado fuente en la página, no la imagen que quiero. – simeonz

Usted puede usar algo como

\latexonly 
\input <file> 
\endlatexonly

donde <file> es la ruta de acceso al archivo para incluir, ya sea absoluta o relativa al directorio en el que se genera la documentación de látex.

Fuente

2013-09-12 08:20:12 Abrixas2

¿Cómo incluir fragmentos de LaTeX directamente en los comentarios de Doxygen?

Respuesta

Cuestiones relacionadas