0

アプリケーションにいくつかの C++ クラスがあり、エンド ユーザーが実行時に変更してさまざまな構成を選択できる "config" メンバーがいくつかあります。(これがカバーの下でどのように実装されているかは関係がなく、スキップされます。) このようなすべての構成メンバーのカスタム ドキュメントを、ユーザーが参照できる別の 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;    
};

これにより、次のような出力が生成されます。

Config: Foo12
Default true
Range true, false
Foo12が必要ない場合は false に

設定 Config: Foo34
Default false
Range true, false
目的Foo34 が必要な場合は false に

設定 Config: Bar12
Default true
Range true, false
目的は false Bar12が必要ない場合

Grouping\xrefitemALIASESCustom Commandsにはある程度精通していますが、それらを一緒に使用して上記を達成する方法を理解できません。

\xrefitemカスタム コマンドごとに別のページを作成します。グループ化すると、ドキュメントはソース内のどこにでも配置されます。これらは、利用可能なすべての構成設定を一度にユーザーに表示するのにはあまり役に立ちません。

これを機能させるには、どのようなアプローチを試みることができますか? ソリューションはクリーンまたはエレガントである必要はありません。回避策を使用してもかまいません。

4

1 に答える 1