我已经用C++创建了一个simple library，并且在Doxygen中很好地记录了API。包中有一些使用库的示例程序。在同一个Doxygen进程中记录这些程序（作为命令行程序）有什么技巧吗？
yqkkidmi1#
我决定用更多的细节来回答我的评论。正如我在评论中提到的，我通常使用Doxygen的“MainPage”功能。对于我的公共存储库，我使用README.md页面并按如下方式配置Doxygen：
OUTPUT_DIRECTORY = docs/ EXTRACT_ALL = YES EXTRACT_PRIVATE = YES EXTRACT_PRIV_VIRTUAL = YES EXTRACT_PACKAGE = YES EXTRACT_STATIC = YES EXTRACT_LOCAL_CLASSES = YES INPUT = README.md <any other files or directories> USE_MDFILE_AS_MAINPAGE = README.md
然后这会生成Doxygen HTML文件，可以看到here, for example（请原谅无耻的插件）它对于提供库、用例的总体概述非常有用，尤其是在您提到的情况下，应用参数、开关等。
1条答案
按热度按时间yqkkidmi1#
我决定用更多的细节来回答我的评论。
正如我在评论中提到的，我通常使用Doxygen的“MainPage”功能。
对于我的公共存储库，我使用README.md页面并按如下方式配置Doxygen：
然后这会生成Doxygen HTML文件，可以看到here, for example（请原谅无耻的插件）
它对于提供库、用例的总体概述非常有用，尤其是在您提到的情况下，应用参数、开关等。