c++ - 関数定義の後にいくつかのマクロ #defines が続くドキュメントを生成できません

Question

私は .cpp ファイルを持っていますが、Doxygen は次の形式を含む関数を文書化できないことがわかりました:

//!
//! \brief Test
//!        and perform operations on those points.
//!
void CTest::TestTri()
EH_Start("CTest::TestTri")
{
}
EH_Stop

およびは例外処理メカニズムであり、問​​題を引き起こしますEH_Start。EH_Stop

どうすればそれらを除外できますか?

Answer 1

より明示的な doxygen 形式を使用してみてください。以下は、ドキュメント化する関数を dox​​ygen に正確に伝えるため、ドキュメントを添付する対象を理解するためにコードを理解する必要はありません。

/// \fn void CTest::TestTri()
/// \brief Test and perform operations on those points
EH_STart("CTest::TestTri") {} EH_Stop

Answer 2

EH_Start と EH_Stop が定義されていると仮定すると、コードを処理するときに doxygen にこれらのマクロを展開させることができます。

EXPAND_AS_DEFINED = EH_Start EH_Stop

関数とクラスの宣言用に多数のマクロがあります。がないEXPAND_AS_DEFINEDと、doxygen は正しいドキュメントを生成しません。

例えば：

/* C++ Code */
#define STANDARD_CONSTRUCTORS_HEADER(iCLASS) \
  public:  iCLASS(); \
  public:  virtual ~iCLASS(); \
  private: iCLASS(const iCLASS & iCopy); \
  private: iCLASS& operator=(const iCLASS &);

class Foo {
  STANDARD_CONSTRUCTORS_HEADER(Foo)
}

/* Doxyfile */
EXPAND_AS_DEFINED = STANDARD_CONSTRUCTORS_HEADER

がないEXPAND_AS_DEFINEDと、ドキュメントで Foo コンストラクターを取得できません。