1

コマンド@fileは、doxygenによって生成されたHTMLドキュメントのdescriptionセクションの生成を中断します。

/**
 @file Class.h

 @brief Brief desc.

 Description text.
*/

Class.hの出力では、説明セクションは生成されません。したがって、「Briefdesc」および「Descriptiontext」というテキストは表示されません。

/**
 Class.h

 @brief Brief desc.

 Description text.
*/

期待どおりに説明セクションを生成します。

グローバルtypdefを文書化したいので、@fileコマンドが必要です。

説明の生成を強制するためのパラメーターが構成にありますか?

4

1 に答える 1

1

不足している情報が見つかりました。

ドキュメントにhttp://www.doxygen.nl/manual/commands.html#cmdfileと記載されているように、@ fileコマンドを追加することにより、ファイルがドキュメント化されます。

これは、doxygenがそのヘッダーファイル用に[ファイル]タブと通常の[クラス]タブに追加のドキュメントを作成することを意味します。

@fileがないと、「クラス」のファイルのみが生成されます。この場合(@fileなし)、最初のコメントとObjective-Cs @interfaceの上のコメントは、CLASSの結合された説明として解釈されます。

@fileコマンドが存在する場合、最初のコメントがファイルの説明に使用されます。これは[ファイル]タブにあります。

クラスの説明は、@interface行のすぐ上にコメントを指定した場合にのみ使用できます。

于 2013-02-25T13:26:14.077 に答える