CODEWITHSUNDEEP
c++doxygen
Mr. Boy
Mr. Boy

Reputation: 63710

Doxygen not listing nested namespaces

I have updated our c++ class comments to doxygen format and they look nice... but the namespaces list/tab is not at all useful. We have a parent namespace e.g john and then sub-namespaces for each library or functional area e.g john::graphics, john::sound, etc. Doxygen is only listing a single namespace: john. Do I have to simply change some setting, or is it mandatory to document my namespaces for doxygen to pick them up?

Upvotes: 6

Views: 5705

Answers (3)

pugdogfan
pugdogfan

Reputation: 331

If you set the EXTRACT_ALL Build flag (see http://www.doxygen.nl/manual/config.html#cfg_extract_all) this will extract information from nested namespace information without you needing to specifically document them.

Upvotes: 6

Carl
Carl

Reputation: 991

I had a similar problem where Doxygen wasn't seeing that the namespace was nested. I fixed it by specifying the scope:

Before:

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

After:

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

Upvotes: 6

Nicol Bolas
Nicol Bolas

Reputation: 473212

In general, you have to document anything for Doxygen to decide that it's important. Namespaces in included. But you don't have to document them particularly well; just a brief notation of what they're for is sufficient for Doxygen to document them.

Upvotes: 6

Related Questions