我想知道是否有办法将doxygen注释的特定部分从一个文件或多个文件复制到markdown页面中。下面我描述了我正在努力做的事情。
我正在开发一个C++插件代码,它由几个模块组成。每个模块都遵循其版本编号方案。在每个插件版本中,我都会为每个模块选择一个特定的版本号。为了允许最终用户通过程序访问这些信息,我设置了一个namespace
,如下所示:
namespace VersionInfo {
string getModuleA_Version() { return "2.3"; }
string getModuleB_Version() { return "1.0"; }
string getPlugin_Version() { return "10.11"; }
}
我还希望此信息显示在README.md
降价文件中。这在doxygen中可能吗?如果可能,我应该如何评论上面的C++代码和README.md
文件?
如果我必须在C++注释中再次写下版本号,我也可以。例如:
// Sample pseudo-code
/**
* @brief version number for module A.
* @version_moduleA 2.3
*/
string getModuleA_Version() { return "2.3"; }
是否可以如上定义自定义变量,然后在markdown文件中引用它们?例如:
// Sample pseudo-markdown
Versions
- ModuleA : @version_moduleA
- ModuleB : @version_moduleB
- ModuleC : @version_moduleC
我试着浏览了doxygen主页上的文档,但我想不通。
即使你指出了doxygen命令,我也会尝试从那里解决它。
编辑@Zane下面的评论让我思考了更多。上面描述的解决方案是首选,但我认为这是可以接受的,即使我可以从markdown文件链接到相应的评论。
我需要解决在markdown文件中插入源代码注释的相同问题。我的计划是让doxygen输出xml,并在markdown文件中放入我自己的自定义标记(如@xml_brief_description)。然后编写一个后处理脚本,解析XML文件并在markdown文件中进行适当的替换。
如果有人有更简单的方法来实现这一点,那么我洗耳恭听。