c - 非标准的特殊文档 block 和 doxygen

标签 c doxygen

我正在使用第 3 方 API C 源,其中特殊文档 block 如下所示

/****************************************************************************************
 * @fn          fn
 *
 * @brief       brief
 *
 * @param       param
 *
 * @return      return
 ****************************************************************************************
 */
void fn(void)
{
 ...
}

有没有办法让 Doxygen 相信这些是真正的特殊文档 block ,而无需修改源代码以匹配标准 block (例如, block 开始处恰好有两个星号)?

提前谢谢你。

最佳答案

我建议创建一个输入过滤器,将 /****** 替换为 /** 并将其添加到 INPUT_FILTER 配置文件中的选项。如果您的系统上有 Unix 命令 sed,下面的命令可以解决问题:

INPUT_FILTER           = "sed -e 's|/\*\*\**|/**|g'"

关于c - 非标准的特殊文档 block 和 doxygen,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/9174634/

相关文章:

C 文档 : help Doxygen recognize class structure

editor - 凯特(Kate)中的Doxygen风格评论

c - 尝试从管道读取字符串,但它没有读取整个字符串

c - 如何分割图像并将其保存在一维数组中

c++ - 构建 VTK 'INSTALL' 项目时出现 CMake 错误

c - 如何让 doxygen 为 c 函数生成调用和调用者图

objective-c - 如何评论 Apple 对 Doxygen 的 block 扩展?

c - QuickSort 无法正确排序

在 OpenWRT 上针对 gpsd 进行编译 - 链接失败

c - 尝试读取文本文件时遇到错误