Doxygen引用实体时如何包括描述 [英] doxygen how to include description when referencing an entity

问题描述

在某些文件中有一个函数

///some description of the function foo.
void foo();

在文档的页面中

ef foo()

我得到了指向foo()的链接，但有没有办法包括描述

"///some description of the function foo."

以及链接。

推荐答案

ef命令的第二个参数是可以显示文本，但该文本必须位于引号之间，并且将显示为链接文本。这意味着您必须再次键入文本。

当我们假设请求的文本是函数的简要描述时，我们可以这样做：

/// 
ef foo() copybrief foo()

完整示例：

/// file
///
/// 
ef foo()
///
/// 
ef foo() copybrief foo()
///
/// 
ef bar()
///
/// 
ef bar() "some description of the function bar."
///
/// 
ef bar() copybrief bar()

/// some description of the function foo.
void foo();

/// rief some description of the function bar.
void bar();

导致：

当请求的文本不是简要描述时，用户可能会使用copydetails/copydoc或snippet{doc}这样的命令来完成某些操作。

这篇关于Doxygen引用实体时如何包括描述的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！