时间戳

首页 > 解决方案 > 是否可以在 doxygen 中提取函数注释并在 markdown 中显示？

c - 是否可以在 doxygen 中提取函数注释并在 markdown 中显示？

问题描述

我正在使用 Doxygen 为 C 项目生成 HTML 文件，并且有几个状态和警告。我已经在 C 中记录了状态函数和警告，但我想将注释提取到降价文件中。我知道我可以使用@ref function_name 生成指向将显示注释的函数的链接，但我希望将它们收集在同一个降价页面上并添加不适合源代码的其他注释，而不必须手动复制粘贴它们。我查看了 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;
}

我多么希望我可以在降价文件中提取评论。

@ref_doc_detailed foo()
That you could never imagine.

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

This function does stuff.
That you could never imagine

标签： cdoxygen

解决方案

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

@copydetails foo
That you could never imagine.

如果您有多个 foo 函数，则可能需要提供参数列表。copybrief如果您只想要简短的描述并且两者都想要，还有一种情况copydoc。

推荐阅读