c++ - Doxygen プライベート関数

Question

doxygen に個々のプライベート関数のドキュメントを表示させる方法はありますか? 私は、doxygen が大多数のプライベート関数のドキュメントを表示するのではなく、選択されたいくつかのプライベート関数のドキュメントを表示することを望んでいます。私の動機は、これらの C++ プライベート関数が拡張機能として Python に提供され、それらのドキュメントが Doxygen に表示されることです。ただし、クラス自体でのみ必要になるため、公開したくありません。彼らは間違いなく民間部門に属しています。

ありがとう

Answer 1

\condコマンドと\endcondコマンドの間のセクションは、そのセクションラベルをENABLED_SECTIONS構成オプションに追加することで含めることができます。セクションラベルを省略した場合、無条件での処理から除外されます。

/** An interface */
class Intf
{
  public:
    /** A method */
    virtual void func() = 0;

    /// @cond COND1

    /** A method used for testing */
    virtual void test() = 0;

    /// @endcond
};

condヘルプを参照してください

COND1セクションが表示されない：ENABLED_SECTIONS構成オプションに追加しないでください。

Answer 2

これを実現するには、いくつかの方法があります。

表示したくない関数を単に文書化することはできません。デフォルトでは、Doxygen は文書化されていないメンバーを表示しません。したがって、プライベートを表示するように指示するだけで、文書化されていないプライベート メンバーは表示されません。