latex - 将 doxygen 的 LaTeX 输出作为附录包含到更大的文档中

标签 latex doxygen

我有一本使用 LaTeX 的 \documentclass{report} 的“项目书”(“report”就像 \documentclass{book} 的更紧凑版本)。我想在本书中添加一个附录,其中包含项目中软件的 Doxygen 生成的 API 文档。

我通过将 Doxygen 的配置选项 LATEX_HEADERLATEX_FOOTER 设置为空文件来实现此目的。这使得生成的 Latex/refman.tex 具有顶级命令,例如: \section{\-Namespace\-Index},此时我可以使用顶级文档来包装它,例如:

\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}

这工作得相当好,我通过这个特殊的 doxygen 调用得到了 doxygen.sty:

doxygen -w latex /dev/null /dev/null doxygen.sty

一个问题是,这会在整个文档上放置一个“自动生成的” header (而不仅仅是在 doxygen 附录上)。我可以通过编辑doxygen.sty(实际上,我也将其重命名为包含在内)并注释掉以%Setup fancy headers开头的 block 来摆脱这个问题。

此时我已经有了可以忍受的东西,但我想更进一步:“doxygen”样式修改了 LaTeX 文档样式的许多其他方面,而我不太喜欢它。

所以我的问题是(在两个卓越水平上):

  1. 放入 doxygen.sty 文件中的最小 LaTeX 命令集是什么,可以很好地呈现 doxygen 附录,但不会干扰 LaTeX 文档的其余部分?

  2. 更好的是,有人想出了一种方法

    \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}
    

我认为最后一种方法非常干净。

我希望有一个非常简单的答案,例如“这已经作为一个选项存在于 doxygen.sty 中,而你错过了它!”

最佳答案

将 doxygen.sty 重命名为 mydoxygen.sty,然后通过插入来修改它 \newenvironment{doxygen}{... doxygen.sty 的大部分内容都放在这里 ...}{}

关于latex - 将 doxygen 的 LaTeX 输出作为附录包含到更大的文档中,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/10239453/

相关文章:

latex - 在使用 LaTeX Beamer 进行分项时,我可以转到另一个帧吗?

c++ - Doxygen 提示递归 C++ 类

c - .c 文件中的 Doxygen

latex - 如何让 Doxygen 识别自定义 Latex 命令

emacs - 如何在org-mode下方便的定义latex格式?

latex - 如何在 LaTex 中删除标题

doxygen - 如何在 doxygen 中添加脚注?

c++ - 使用 Doxygen 注释不同文件中的函数

pdf - 调整 pdf 输出的表格宽度以完美适合线宽

r - 使 Sweave 或 knitr 把图形后缀放在 `\includegraphics{}`