複数のファイルにまたがる名前空間のドキュメント化doxygen

c++ doxygen namespaces
複数のファイルにまたがる名前空間のドキュメント化doxygen

2つのヘッダーファイルがあるとします。

// HEADER 1
/**
 * Doc  for Foo here?
 */
namespace Foo {
  class This {...};
}

&&

// HEADER 2
/**
 * Doc for Foo here?
 */
namespace Foo {
  class That {...};
}

Doxygenで文書化するとき、これをどのように処理すればよいですか?

  8  3


ベストアンサー

たぶんどちらも。

たとえば、 " /utility/header1.hpp "`の内容が `namespace utility`にあり、 “/utility/header2.hpp” `があることを想像してください。

ファイルを追加することができます: `” /utility.hpp “`はユーティリティの名前空間を文書化します。 これを最上位の「#errorドキュメントのみ」に配置して、誤って含まれないようにすることができます。

しかし、私はそれを健全な場所に保つために、少なくともいくつかの不自然なファイルを作成することをお勧めします(そして、あるクラスとランダムに混ざらないでください)。

4


これらのファイルのいずれにあるか、完全に別のファイルにあるかに関係なく、ドキュメントの最適な場所を見つけます。 Doxygenの名前空間タグでコメントブロックを使用します。

/**
 * @namespace Foo
 * Documentation for Foo here. More docs for Foo here,
 * and down here.
 */

ここのドキュメント:http://www.stack.nl/~dimitri/doxygen/commands.html#cmdnamespace

1


タイトルとURLをコピーしました