【问题标题】:Exclude documenting every functions排除记录每个功能
【发布时间】:2013-11-28 16:31:08
【问题描述】:

我正在尝试使用 doxygen 为我的 C 应用程序生成文档,但仅限于宏 (#define)。 INPUT 头文件包含宏和一些函数原型,但我不希望 Doxygen 为原型生成文档。因此问题。如何仅使用宏生成文档?我尝试了很多选择。 EXCLUDE_PATTERN 无济于事,因为有些宏和原型总是有一个共同的模式,并且未来可能不是唯一的模式。我还尝试将所有宏移动到特定组 (\addgroup) 下,但找不到排除函数原型所属组的方法。 我确信在 doxygen 中应该可以做到这样的事情,但我就是找不到它(doxygen 文档/stackoverflow/一般谷歌搜索)。请帮忙。

【问题讨论】:

    标签: c doxygen


    【解决方案1】:

    最快最简单的方法是用@cond@endcond 包围您希望doxygen 处理的部分。

    宏和东西

    /** @cond */

    int 原型();

    /** @endcond */

    【讨论】:

    • 感谢您的回复。这很有效,听起来很简单,但这是唯一的方法吗?如果我可以在不对源代码进行此类修改的情况下实现这一点,那就太好了,因为我还有其他 doxyfiles 也可以为 API 生成文档。如果我使用 /cont,我必须在 ENABLED_SECTIONS 下为我的其他 doxyfile 启用它们,如果可以选择的话,我想避免这种情况。尽管如此,我非常感谢这个回应。
    • @VishnuS 你所要求的,排除函数原型之类的东西,与 Doxygenis 的设计目的相反,所以我认为你需要在源代码中进行一些明确的修改才能实现这一点。如果您只是永久希望忽略原型,那么您可以只使用@cond(无参数)和endcond,并且不更改ENABLED_SECTIONS。
    猜你喜欢
    • 1970-01-01
    • 1970-01-01
    • 2011-11-12
    • 1970-01-01
    • 2018-07-02
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    相关资源
    最近更新 更多