Doxygen не перечисляет вложенные пространства имен - PullRequest
Новая
       2

Doxygen не перечисляет вложенные пространства имен

5 голосов
/ 12 сентября 2011

Я обновил наши комментарии класса c ++ до формата doxygen, и они выглядят хорошо ... но список / вкладка пространств имен совсем не полезен. У нас есть родительское пространство имен, например, john, а затем подпространства имен для каждой библиотеки или функциональной области, например, john::graphics, john::sound и т. Д. Doxygen перечисляет только одно пространство имен: john. Нужно ли просто менять некоторые настройки или обязательно документировать мои пространства имен, чтобы doxygen их подобрал?

Ответы [ 3 ]

5 голосов
/ 15 октября 2012

Если вы установите флаг сборки EXTRACT_ALL (см. http://www.doxygen.nl/manual/config.html#cfg_extract_all)), это извлечет информацию из информации о вложенном пространстве имен без необходимости специально их документировать.

5 голосов
/ 12 сентября 2011

В общем, вы должны документировать что-либо, чтобы Doxygen решил, что это важно.Пространства имен в комплекте.Но вам не нужно документировать их особенно хорошо;Достаточно краткого описания того, для чего они нужны, чтобы Doxygen документировал их.

4 голосов
/ 14 декабря 2013

У меня была похожая проблема, когда Doxygen не видел, что пространство имен было вложенным.Я исправил это, указав область действия:

До: 

/**
* @namespace outer
* @brief the outer namespace
*/
namespace outer
{
  /**
  * @namespace inner
  * @brief the inner namespace
  */
  namespace inner
  {
  }
}

После: 

/**
* @namespace outer
* @brief the outer namespace
*/
namespace outer
{
  /**
  * @namespace outer::inner
  * @brief the inner namespace
  */
  namespace inner
  {
  }
}
...