Question

我的应用程序中有一些C ++类，它们有一些“配置”成员，最终用户可以在运行时修改它们以选择各种配置。（如何在封面下实现它是不相关的并且被跳过。）我想将所有这些配置成员的自定义文档收集到用户可以参考的单独的doxygen页面中，以了解所有存在的配置成员。

考虑这个简单的例子。（相关代码不必位于类声明的顶部，如此处所示。）

class Foo {
public:
  /**
    * @config Foo12
    * @default true
    * @range true, false
    * @purpose set this false if you don't want Foo12
    */
  bool foo12;

  /**
    * @config Foo34
    * @default false
    * @range true, false
    * @purpose set this true if you want Foo34
    */
  bool foo34;
};

class Bar {
public:
  /**
    * @config Bar12
    * @default true
    * @range true, false
    * @purpose set this false if you don't want Bar12
    */
  bool bar12;    
};

这应该产生如下输出：

配置：Foo12
  默认是真的   范围 true，false
  用途如果您不想要Foo12，请将此设置为false
  配置：Foo34
  默认 false
  范围 true，false
  目的如果您想要Foo34，请将此设置为false
  配置：Bar12
  默认是真的   范围 true，false
  目的如果您不想要Bar12为
，请将此设置为false

我熟悉Grouping，\xrefitem，ALIASES，Custom Commands，但我无法弄清楚如何将它们结合使用来实现上述目标。< / p>

\xrefitem为每个自定义命令创建一个单独的页面。分组将文档放置在源中的任何位置。这些对于一次向用户显示所有可用的配置设置没有多大帮助。

我可以尝试采用哪种方法来实现这一目标？解决方案不需要干净或优雅，使用变通方法是可以的。

Answer 1

这有什么好处吗？

在doxyfile中设置别名

ALIASES  =  "wibble=@xrefitem wibble \"Wibbles!\" \"Wibble List\""

并使用

@wibble
- \b Config fobbling 
- \b Default 4245345346
- \b Range 500 yards

代码中的

。

输出并不完美，但看起来对我来说是可行的（我刚尝试过）。

将各种文件中的自定义命令收集到单独的页面中

1 个答案: