Doxygen 未列出嵌套命名空间
我已经将我们的 C++ 类注释更新为 doxygen 格式,它们看起来不错...但是命名空间列表/选项卡根本没有用。我们有一个父命名空间,例如 john
,然后是每个库或功能区域的子命名空间,例如 john::graphics
、john::sound
、 ETC。 Doxygen 仅列出一个命名空间:john
。 我是否必须简单地更改某些设置,或者是否必须记录我的名称空间以便 doxygen 来获取它们?
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?
如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。
绑定邮箱获取回复消息
由于您还没有绑定你的真实邮箱,如果其他用户或者作者回复了您的评论,将不能在第一时间通知您!
发布评论
评论(3)
一般来说,您必须记录任何内容,以便 Doxygen 判断它是否重要。包含命名空间。但你不必把它们记录得特别好;只需简单说明它们的用途就足以让 Doxygen 记录它们。
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.
我遇到了类似的问题,Doxygen 没有看到命名空间是嵌套的。我通过指定范围修复了它:
之前:
之后:
I had a similar problem where Doxygen wasn't seeing that the namespace was nested. I fixed it by specifying the scope:
Before:
After:
如果设置 EXTRACT_ALL 构建标志(请参阅 http://www.doxygen.nl/manual /config.html#cfg_extract_all)这将从嵌套命名空间信息中提取信息,而无需您专门记录它们。
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.