doxygen包括另一个文件的评论

发布于 2025-02-10 22:09:18 字数 309 浏览 1 评论 0原文

我通常在.c文件顶部的某个地方的评论中包括一个模块概述和使用指南。我希望此信息出现在Doxygen生成的详细说明中,但我不想在.H文件中重复相同的信息。

I could include the .c file in the docs and use DOXYGEN_SHOULD_SKIP_THIS or \cond around everything apart from the little bit I'd like to include, but this seems inelegant.

是否有某种方法可以在.h文件的文档中包含 /链接.c文件中的特定注释部分?

I usually include a module overview and usage guidelines in comments somewhere at the top of .c files. I would like this information to appear within the detailed description generated by Doxygen but I would not like to repeat this same information in the .h file.

I could include the .c file in the docs and use DOXYGEN_SHOULD_SKIP_THIS or \cond around everything apart from the little bit I'd like to include, but this seems inelegant.

Is there some way to include / link a specific comment section from the .c file within the docs for the .h file?

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

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

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。
列表为空,暂无数据
我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
原文