我的库的所有类都在名称空间中定义。当我为Doxygen创建主页时,必须在注释中显式使用此命名空间,以使Doxygen生成链接。我想在整个注释块中使用“使用命名空间”之类的内容。
一个例子:
/**
* \mainpage My Library
*
* Use MyLibraryNamespace::MyClass to ...
*/
在这里Doxygen自动生成指向MyLibraryNamespace :: MyClass文档的链接。
/**
* \mainpage My Library
*
* Use MyClass to ...
*/
这里Doxygen不会生成指向MyLibraryNamespace :: MyClass文档的链接(因为我想在不同的命名空间中可能有多个MyClass定义)。为了简化阅读,我想在注释中省略名称空间前缀。是否可以不必每次都键入
\ref MyLibraryNamespace::MyClass "MyClass"
? 最佳答案
您可以通过将注释放入命名空间中来使此功能适用于一个命名空间。这给我带来了很大的麻烦,因为我们有多个嵌套的名称空间,我讨厌不得不在Doxygen注释中使用它们。
namespace MyLibraryNamespace {
/**
* \mainpage My Library
*
* Use MyClass to ...
*/
};
Markdown观点的2016年更新
我正在将Doxygen用于Realm的C#文档(是的,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)
您可以看到渲染的版本online here