包括doxygen的LaTeX输出作为更大文档的附录

时间:2012-04-20 02:30:48

标签: latex doxygen

我有一个“项目书”,它使用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. 什么是最小的LaTeX命令集放在一个doxygen.sty文件中,该文件可以很好地呈现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}
    
  3. 最后一种方法是我认为非常干净的方法。

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

1 个答案:

答案 0 :(得分:1)

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