4

プロジェクト用の Doxygen ドキュメントを作成しています。最近、\addtogroupタグを使用して関連するクラスをグループ化しました。この後、ドキュメントにモジュール タブが追加されました。すべてのモジュールが表示されます。同じページのモジュール名の下のモジュール名のすぐ下に説明を追加したいと思います。Doxygen を使用してそれを行うにはどうすればよいですか?

これが私のタグです

/*! \addtogroup test test
 *  Test Testing a group in doxygen
 *  @{
 */
4

1 に答える 1

19

コメントのみを含む専用の .h ファイルを作成する必要があります。グループごとに、次のようにコメントを定義します。

/** @defgroup FooGroup
 *
 * This module does yada yada yada
 *
 */

次に、次のように定義をグループに割り当てます (異なるファイルであっても)。

/** @addtogroup FooGroup */
/*@{*/

/** Summon a goat
 *
 * @param name The name of the goat;
 * @return The summoned goat;
 */
Goat summon_goat (const char *name);

...
...

/*@}*/

編集：

また、こうなります。「詳細説明」を参照してください。@verbatimおよび@endverbatimコマンド内にコード スニペットと例を追加することもできます。

于 2010-08-04T16:19:24.770 に答える