Doxygen中的\ copydoc命令输出被排除在\ brief content

时间:2015-07-06 20:51:38

标签: documentation javadoc doxygen

我想使用\ copydoc包含一些可能在成员的简要描述中发生变化的值。

不幸的是,\ copydoc命令之后的所有内容都从\ brief描述中排除,然后被破坏。

e.g。

/** 
* \class macro_num_apples_range
* 5-10
*/

/** \brief an apple tree with \copydoc macro_num_apples_range apples in it. 
*/
apple_tree;

其中macro_num_apples_range是我之前在文件中创建的类(在Doxy文件中使用EXCLUDE_SYMBOLS = macro *,因此它实际上不会出现在Doxygen的输出中),就像一个可以轻松更新的变量。 / p>

以上所需的输出是:“一棵苹果树,里面有5-10个苹果。”放在会员的简要说明中。

上面的实际结果是“一棵苹果树”最终出现在简短的文档中,然后其余部分在详细文档中以错误状态结束:“苹果在其中.5-10苹果在它。“

一般来说,我注意到如果未在自己的行上调用\ copydoc会发生非常奇怪的事情。

事实上,几乎解决方法是执行以下操作:

/** 
* \class macro_num_apples_range
* 5-10
*/

/** \brief an apple tree with 
*\copydoc macro_num_apples_range 
* apples in it. 
*/
apple_tree;

在这种情况下,“苹果在其中”的奇怪加倍。不会发生。但是,/简要描述仅从单行注释中获取其内容,因此这并不是很有效。

我是否遗漏了一些关于Doxygen命令如何工作的基本原因,也许?

0 个答案:

没有答案