Documenting namespaces that span multiple files doxygen
Consider I have 2 header files.
// HEADER 1
/**
* Doc for Foo here?
*/
namespace Foo {
class This {...};
}
&&
// HEADER 2
/**
* Doc for Foo here?
*/
namespace Foo {
class That {...};
}
How should I handle this when documenting with Doxygen?
2 ответа
Возможно, ни то, ни другое.
Например, представьте, что у вас есть ", содержимое которого находится в пространстве имен utility, и ", который также это делает.
Вы можете добавить файл: ", который документирует пространство имен утилиты. Вы можете поместить это в начало #error Только документация. , чтобы убедиться, что он не будет случайно включен.
Но я бы рекомендовал по крайней мере сделать какой-нибудь файл в стороне, чтобы держать его в нормальном месте (а не смешивать случайно с каким-нибудь классом)
.Найдите лучшее место для документации, находится ли она в одном из этих файлов или полностью в другом. Используйте блок комментариев с тегом пространства имен Doxygen:
/**
* @namespace Foo
* Documentation for Foo here. More docs for Foo here,
* and down here.
*/
Документы здесь: http://www.doxygen.nl/manual/commands.html#cmdnamespace