У меня возникают проблемы с Doxygen, распознающим пространства имен и модули. Я считаю, что проблема связана с тем, размещать ли \addtogroup
в пространстве имен или вне пространства имен.
Пример 1 за пределами пространства имен:
/*!
* \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
отображался на вкладке Damesgen Namespaces и косвенно на вкладке "Модули". Нажав на элемент на странице "Пространства имен", вы должны создать страницу, содержащую Records::Interface
. Нажатие на элемент на вкладке "Модули" также должно содержать страницу, содержащую Records::Interface
.
В документации Doxygen у меня есть элементы, отсутствующие на вкладке Пространства имен, которые находятся в модулях и наоборот, из-за моей несогласованности, вызванной этой дилеммой.
Итак, каков правильный метод, пример 1 или пример 2?
{Руководство по Doxygen не ясно в этой теме.}
Doxygen:\addtogroup
Doxygen: документирование пространств имен