如何使用doxygen记录应用程序源文件

How to document application source file using Doxygen

本文关键字:应用程序 源文件 记录 doxygen 何使用      更新时间:2023-10-16

我正在编写C/C 程序。程序的树结构如下如下:

Program
   |---- lib1
     |----src
     |----include
   |---- lib2
     |----src
     |----include
   |---- app1
     |----main.cpp
   |---- app2
     |----main.cpp

app1和app2是使用lib1和lib2的两个应用。

我已经记录了lib1和lib2中的标头文件。但是,我还想记录App1和App2,因为这两个应用程序是命令行工具,它们采用了一堆参数并做一些事情。这样做的正确方法是什么?

谢谢

感谢戴尔·威尔逊(Dale Wilson)的帮助,我找到了正确的标签。

extract_all =是

将其设置为"是",源文件将显示。

确保doxygen通过在doxygen配置文件中或使用doxygen向导中指定CPP文件来检查CPP文件。单击此处以获取有关此的更多详细信息。

然后将doxygen注释添加到CPP文件中。在线doxygen文档中的此页面提供了信息,请告诉您有关C-Style语言的信息。