Документирование пространств имен с помощью Doxygen
У меня проблемы с распознаванием пространств имен и модулей Doxygen. Я считаю, что вопрос заключается в том, чтобы разместить\addtogroup
в пространстве имен или вне пространства имен.
/*!
* \addtogroup Records
* @{
*/
//! Generic record interfaces and implementations
namespace Records
{
//! Describes the record interface
class Interface;
} // End namespace Records
/*! @} End of Doxygen Groups*/
Пример 2 - внутри пространства имен//! Generic record interfaces and implementations
namespace Records
{
/*!
* \addtogroup Records
* @{
*/
//! Describes the record interface
class Interface;
/*! @} End of Doxygen Groups*/
} // End namespace Records
Я хотел быnamespace Records
появляться под DoxygenПространства имен вкладка и косвенно подМодули Вкладка. Нажав на элемент вПространства имен страница должна создать страницу, содержащуюRecords::Interface
, Нажав на элемент вМодули вкладка должна также создать страницу, содержащуюRecords::Interface
.
В моей документации по Doxygen отсутствуют элементы изПространства имен вкладка, которая находится вМодули и наоборот, из-за моей непоследовательности, возникшей в результате этой дилеммы.
Итак, какой метод является правильным, Пример 1 или Пример 2? {Руководство Doxygen не ясно по этой теме.}
Doxygen: \ addtogroup
Doxygen: документирование пространств имен