Documentation 生成;“用户”;及;发展商;使用Doxygen从同一代码库中获取文档
我是Doxygen的新手,我正在尝试记录一个我计划开源的API。我真的很想构建两套文档,一套用于API的最终用户,另一套用于打算修改API的用户。是否有方法标记Doxygen注释块,以便生成“用户”和“开发人员”文档树?有更好的办法解决我的问题吗?谢谢 根据代码的结构,您可以使用两个Doxygen配置文件,每个文件都包含单独的源文件。“用户”配置文件将只列出包含API公共接口的源文件,而“开发”配置文件将列出整个项目的所有源文件 这确实意味着您的所有接口(例如,抽象基类)都需要记录在用户心中,但这通常不是问题,因为根据定义,抽象基类中不太可能有任何实现细节 然后,所有“dev”文档都位于实现接口的实际类中,“user”Doxygen配置文件可以安全地忽略这些接口,API从未见过这些接口Documentation 生成;“用户”;及;发展商;使用Doxygen从同一代码库中获取文档,documentation,doxygen,Documentation,Doxygen,我是Doxygen的新手,我正在尝试记录一个我计划开源的API。我真的很想构建两套文档,一套用于API的最终用户,另一套用于打算修改API的用户。是否有方法标记Doxygen注释块,以便生成“用户”和“开发人员”文档树?有更好的办法解决我的问题吗?谢谢 根据代码的结构,您可以使用两个Doxygen配置文件,每个文件都包含单独的源文件。“用户”配置文件将只列出包含API公共接口的源文件,而“开发”配置文件将列出整个项目的所有源文件 这确实意味着您的所有接口(例如,抽象基类)都需要记录在用户心中,但
当然,如果您的代码不是以这种方式构造的,那么它将不起作用,因此我能想到的唯一解决方案是用一堆注释填充您的注释。除了Malvineous已经说过的,还有
\internal
doxygen命令
\internal
允许您通过更改doxy文件中的内部文档来隐藏或显示部分文档
更多信息请点击此处: