LaTeX中使用doxygen的各个功能文档 [英] Individual function docs in LaTeX using doxygen

问题描述

我正在LaTeX中为某些软件编写各种手册.我必须使用 article 类.我必须在手册中包含各个c ++类的文档.我正在为此寻找氧气，但是我从未使用过氧气(如果有更好的方法，请告诉我).

I'm writing a manual of sorts in LaTeX for some software. I'm constrained to use the article class. I must include docs of individual c++ classes in the manual. I'm looking at doxygen for this, but I've never used doxygen (if there's a better way, let me know).

我可以用doxygen生成整个项目的一个很好的LaTeX(-> pdf)文件.但是我想做的是以某种方式提取每个类的LaTeX源，并将其放入我的LaTeX手册源中的适当位置.

I can get doxygen to produce a nice LaTeX (--> pdf) file of my entire project. But what I'd like to do is somehow extract the LaTeX source for each class and drop it into my LaTeX manual source at the appropriate place.

我尝试将refman.tex(由doxygen生成)中的所有序言内容放入 my 序言中，然后在文档中稍后使用\input包括个人的tex文件班级.在清除了一些冲突之后，我遇到了一个我不知道该如何克服的冲突. doxygen生成的doxygen.sty文件引用了\chaptermark，但是我相信这是 book 类中定义的宏.

I've tried putting all the preamble stuff from refman.tex (generated by doxygen) in my preamble, and then later in the document using \input to include the tex file of an individual class. After cleaning up a few conflicts, I get to one that I don't know how to get past. The doxygen-generated doxygen.sty file makes reference to \chaptermark, but I believe that this is a macro defined in the book class.

所以1.)我是否会以所有错误的方式进行操作? 2.)是否可以强制Doxygen在 article 类中生成代码? 3.)还有什么?

So 1.) Am I going about this all the wrong way? 2.)Is it possible to force Doxygen to produce code in the article class? 3.) Anything else?

-garyp

推荐答案

通过在doxygen配置中将COMPACT_LATEX设置为YES，可以使doxygen生成使用 article 文档类的文档.文件.

You can make doxygen produce a document that uses the article document class by setting COMPACT_LATEX to YES in your doxygen config file.

这篇关于LaTeX中使用doxygen的各个功能文档的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！