Документирование пространств имен, которые охватывают несколько файлов doxygen

Question

Считайте, что у меня есть 2 заголовочных файла.

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

&&

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

Как мне справиться с этим при документировании с помощью Doxygen?

Answer 1

Возможно, нет.

Например, представьте, что у вас есть "<root>/utility/header1.hpp", у которого есть содержимое в namespace utility и "<root>/utility/header2.hpp", которое также имеет.

Вы можете добавить файл: "<root>/utility.hpp", который документирует пространство имен утилиты. Вы можете поместить это в верхнюю часть #error Documentation only., чтобы убедиться, что оно случайно не включено.

Но я бы порекомендовал сделать хотя бы какой-нибудь нестандартный файл, чтобы держать его в здравом месте (и не смешивать случайно с каким-то классом.)

Answer 2

Найдите лучшее место для документации, находится ли она в одном из этих файлов или в другом полностью. Используйте блок комментариев с тегом пространства имен Doxygen:

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

Документы здесь: http://www.doxygen.nl/manual/commands.html#cmdnamespace