c++ - Doxygen を使用した C++ での関数のドキュメント化

Question

ドキュメントを生成するために Doxygen を使用しているプロジェクトがあります。クラスのドキュメンテーションは問題ありませんが、オブジェクトなどを作成するために使用する非メンバー関数もいくつかあります。これらもドキュメンテーションしたいのですが、何を試しても、Doxygen はドキュメンテーションを生成しません。関数の上に付けたコメント。Doxygen がグローバル名前空間の関数のドキュメントを生成しないのはなぜですか? また、これを機能させるにはどうすればよいですか?

Answer 1

クラスのメンバーであるエンティティは、そのクラスが文書化されている場合にのみ文書化されます。名前空間スコープで宣言されたエンティティは、名前空間が文書化されている場合にのみ文書化されます。ファイル スコープで宣言されたエンティティは、そのファイルがドキュメント化されている場合にのみドキュメント化されます。

したがって、グローバル名前空間で自由な関数を文書化するには、それが宣言されているヘッダー ファイルのどこかに次のような行も必要です。

/** @file */

またはこのように：

/*! \file */

Answer 2

ブロック内の\fn他の場所で使用\classする\\*! *\

http://www.doxygen.nl/manual/docblocks.html 「他の場所のドキュメント」を探します

http://www.doxygen.nl/manual/commands.html#cmdfn
メンバー関数の文書化と同様に機能します

Answer 3

このパターンは私たちにとってうまくいきました。

/*! Convert counts to kg for the reservoir.  
    \param counts The A/D counts to convert.` 
    \return The calculated kg based on the parameter.  
*/  
float RES_ConvertCountsToValue(uint_16 counts);  

Answer 4

私はこのパターンが好きです

   ///////////////////////////////////////////////////////////////////////
   /// \brief setX
   /// \param x offset of the image.
   /// \return a new image as an QImage.
   /////////////////////////////////////////////////////////////////////////
    QImage  setX(int x);