非标准特殊文档块和 doxygen

发布于 2025-01-03 09:40:31 字数 447 浏览 2 评论 0原文

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

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

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

先感谢您。

I'm using a 3rd party API C sources where special documentation blocks are as following

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

Is there a way to convince Doxygen these are real special documentation blocks without modifying sources in order to match standard block (e.g. exactly two asterisks at block start)?

Thank you in advance.

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。

评论(1

蓝海似她心 2025-01-10 09:40:31

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

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

I suggest to create an input filter that replaces /****** by /** and add that to the INPUT_FILTER
option in the configuration file. If you have the Unix command sed on your system, the following would do the trick:

INPUT_FILTER           = "sed -e 's|/\*\*\**|/**|g'"
~没有更多了~
我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
原文