Doxygen评论的"使用命名空间"

Question

我的库的所有类都在命名空间中定义.当我为Doxygen创建一个主页时,我必须在注释中明确使用这个命名空间来使Doxygen生成链接.我想对整个注释块使用"using namespace"之类的东西.

一个例子:

/**
* \mainpage My Library
*
* Use MyLibraryNamespace::MyClass to ...
*/

这里Doxygen自动生成MyLibraryNamespace :: MyClass文档的链接.

/**
* \mainpage My Library
*
* Use MyClass to ...
*/

这里Doxygen没有生成MyLibraryNamespace :: MyClass文档的链接(因为我想在不同的命名空间中可能有多个MyClass定义).为了简化阅读,我想在注释中省略名称空间前缀.这可能而不必\ref MyLibraryNamespace::MyClass "MyClass"每次都打字吗？

Answer 1

通过将注释放在命名空间内,可以使这个工作对于一个命名空间.由于我们有多个嵌套的命名空间而且我讨厌在Doxygen评论中使用它们,这让我很烦恼.

namespace MyLibraryNamespace {
/**
* \mainpage My Library
*
* Use MyClass to ...
*/
};

Markdown透视2016年更新

我正在使用Doxygen作为Realm的C#docs(是的Doxygen也处理典型的C#XML注释格式!).Markdown主页使用@ref来引用命名空间类:

The main classes you will use are:

- [Realm](@ref Realms.Realm)
- [RealmObject](@ref Realms.RealmObject)
- [RealmList](@ref Realms.RealmList)
- [Transaction](@ref Realms.Transaction)

您可以在此处在线查看呈现的版本