是否可以提取功能注释并在Doxygen的markdown中显示？

Question

我正在使用Doxygen为C项目生成HTML文件，并且有几种状态和警告。我已经用C记录了状态函数和警告，但是我想将注释提取到markdown文件中。 我知道我可以使用@ref function_name生成指向要在其中显示注释的函数的链接，但是我想让它们聚集在同一markdown页面上，并添加不适合源代码的其他注释，而无需必须手动复制粘贴。 我已经研究了Doxygen文档和网络，但没有找到解决方案。有没有可以帮助我的命令或其他方法？

示例代码

/**
 * @brief This is a function 
 *
 * @detailed This function does stuff.
 *
 * @param bar Value that has no meaning
 * 
 * @return Another value
 */
void foo(int bar)
{
 return 0;
}

我希望如何将评论提取到markdown文件中。

@ref_doc_detailed foo()
That you could never imagine. 

生成HTML文件时想要的结果。

This function does stuff.
That you could never imagine

Answer 1

这听起来像您想使用@copydetails。它将标记为详细文档的所有内容复制到使用的位置。

@copydetails foo
That you could never imagine.

如果您具有多个foo函数，则可能需要提供参数列表。如果只需要简要说明，则还有copybrief，如果需要，则还有copydoc。