C++ 将各种文件中的自定义命令收集到单独的页面中
我的应用程序中有一些C++类,它有一些“配置”成员,终端用户可以在运行时修改以选择各种配置。(如何在封面下实现这一点并不相关,也没有跳过。)我想将所有此类配置成员的自定义文档收集到一个单独的doxygen页面中,用户可以参考该页面,以了解存在的所有配置成员 考虑这个简单的例子。(如图所示,相关代码不必位于类声明的顶部。) 这将产生如下输出: 配置:Foo12C++ 将各种文件中的自定义命令收集到单独的页面中,c++,doxygen,C++,Doxygen,我的应用程序中有一些C++类,它有一些“配置”成员,终端用户可以在运行时修改以选择各种配置。(如何在封面下实现这一点并不相关,也没有跳过。)我想将所有此类配置成员的自定义文档收集到一个单独的doxygen页面中,用户可以参考该页面,以了解存在的所有配置成员 考虑这个简单的例子。(如图所示,相关代码不必位于类声明的顶部。) 这将产生如下输出: 配置:Foo12 默认值true 范围真、假 Purpose如果您不想要Foo12,请将此设置为false 配置:Foo34 默认值false 范围真、假
默认值true
范围真、假
Purpose如果您不想要Foo12,请将此设置为false
配置:Foo34
默认值false
范围真、假
目的如果需要,请将此设置为false
配置:Bar12
默认值true
范围真、假
目的如果您不想要Bar12,请将此设置为false
我对、、相当熟悉,但我不知道如何将它们结合使用以实现上述目标
\xrefitem
为每个自定义命令创建单独的页面。分组将文档放置在源文件中显示的任何位置。这些对于一次性向用户显示所有可用的配置设置没有多大帮助
我可以试着用什么方法让它工作?解决方案不需要干净或优雅,可以使用变通方法 这有什么好处吗
在doxyfile中设置别名
ALIASES = "wibble=@xrefitem wibble \"Wibbles!\" \"Wibble List\""
和使用
@wibble
- \b Config fobbling
- \b Default 4245345346
- \b Range 500 yards
在代码中
输出并不完美,但在我看来是可行的(我刚刚尝试过)。是的,这当然很有用,尽管它创建了“内联”文档。让我想想如何将其移动(或至少复制)到一个单独的页面中。当我这样做时,它会将条目放在文档中的一个单独的“Wibbles!”页面上。你是指单独的页面还是单独的文件?
@wibble
- \b Config fobbling
- \b Default 4245345346
- \b Range 500 yards