2011-09-12 38 views
4

私はC++クラスのコメントをdoxygen形式に更新していますが、見栄えはいいですが、名前空間リスト/タブはあまり役に立ちません。親の名前空間はjohn、次に各ライブラリまたは機能領域のサブネームスペースはjohn::graphics,john::soundなどです。 Doxygenは1つの名前空間:johnをリストしています。 単に設定を変更する必要がありますか、doxygenが名前空間を取得するために名前空間を文書化することは必須ですか?Doxygenにネストされた名前空間がリストされていない

+0

私のポストを参照してください: http://stackoverflow.com/questions/2275601/documenting-namespaces -with-doxygen 可能な重複。 –

答えて

5

一般に、Doxygenが重要であると判断するためには何かを文書化する必要があります。名前空間は含まれています。しかし、それらを特にうまく文書化する必要はありません。 Doxygenがそれらを文書化するためには、それらが何であるかの簡単な記法だけで十分です。

+0

しかし、名前空間には文書化されたクラスが含まれています...名前空間によるリスト表示がコードをナビゲートする明白な方法であるため、これはうまくいかないようです。ああ... –

+2

@ジョン:私が言ったように、それはDoxygenの仕組みです:それは、文書化されていないものだけでなく、文書化されていないものに含まれているものはスキップします。たとえば、グローバル関数を持っている場合、それらを定義するファイルが文書化されていないか、またはそれらがモジュールの一部でない限り、それらは表示されません。 –

4

私はDoxygenが名前空間がネストされているのを見ていないのと同様の問題がありました。後

/** 
* @namespace outer 
* @brief the outer namespace 
*/ 
namespace outer 
{ 
    /** 
    * @namespace inner 
    * @brief the inner namespace 
    */ 
    namepsace inner 
    { 
    } 
} 

::前

:私は範囲を指定することによって、それを固定

/** 
* @namespace outer 
* @brief the outer namespace 
*/ 
namespace outer 
{ 
    /** 
    * @namespace outer::inner 
    * @brief the inner namespace 
    */ 
    namespace inner 
    { 
    } 
} 
関連する問題