Doxygen private function

Question

doxygenに個々のプライベート関数のドキュメントを表示する方法はありますか？私はdoxygenにプライベート関数の大部分のドキュメントを表示しないようにしたいが、いくつかのプライベート関数をいくつか表示するようにしたい。私のモチベーションは、これらのC++のプライベート関数がPythonに拡張として提供されており、そのドキュメントがDoxygenに表示されるようにすることです。しかし、クラスそのものにしか必要ではないので、私はそれらを公開したくありません。彼らは間違いなく民間部門に属しています。

ありがとうございました

Answer 1

これを達成するにはいくつかの方法があります。

表示したくない機能を簡単に文書化することはできません。デフォルトでは、Doxygenはあなたが文書化していないメンバーを表示しません。したがって、あなたは秘密を示すように伝えることができ、文書化されていないプライベートメンバーは表示されません。

Answer 2

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

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

    /// @cond COND1 

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

    /// @endcond 
}; 

COND1のセクションを参照してくださいしないcond help

を参照してください：ちょうどENABLED_SECTIONS設定オプションに追加しないでください。