我可以使用doxygen来记录命令行程序吗？

Question

我贡献了一个使用Doxygen来记录一系列C库的大型代码项目。我们也开始使用doxygen和doxypy作为关联的python模块。

有没有简单的方法来记录命令行程序（在python或C中）和他们的命令行选项，（自动）使用doxygen？

Answer 1

为了生成man页面，您需要将GENERATE_MAN标记设置为是（.doxyfile）。

默认情况下，在使用OUTPUT_DIRECTORY提供的目录中创建一个名为man的子文件夹以包含生成的页面。

通过这样做，doxygen将呈现您添加到源代码中的所有标记作为手册页（每个翻译单元一页）。

此时，您可能想要使用exclude* directives排除您想要忽略的某些部分（我假定您有兴趣只显示如何调用主部分）。

我建议你编译两个不同的doxyfiles：一个用于内部使用（完整的类似javadoc的文档），另一个用于生成程序人等。

当然，您在第一次尝试时不会获得预期的结果，您可能需要使用doxygen标记进行一些操作。