18

我有一本使用 LaTeX 的“项目书” \documentclass{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.sty了这个特殊的 doxygen 调用:

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

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

在这一点上,我有一些可以接受的东西,但我想更进一步:“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 中,而你错过了它!”

4

1 回答 1

1

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

于 2013-07-16T20:38:35.830 回答