【问题标题】:Picking Certain Documentation with DOXYGEN使用 DOXYGEN 选择某些文档
【发布时间】:2014-02-26 15:07:31
【问题描述】:

我想实现几乎完全相反的目标 使用命令 \internal 执行。存在一个巨大的doxygen 已经有一个项目的文档,但现在我想挑选 几个块(函数、常量等)来创建一个非常小的手册 只包含重要的东西。

与其将 99% 的 cmets 标记为 \internal 不如这样做 为需要的 1% 的 cmets 使用类似 \external 的命令 在我的情况下被导出。

类似于禁用“默认部分”(所有内容,即 不是部分的一部分)当然也可以。然后我可以使用 ENABLED_SECTIONS...

不幸的是,有问题的 cmets 不仅仅存在于一个文件中。 此外,这些文件包含许多其他 cmets,它们应该 不会被导出。

我已经考虑将这些 cmets 移动到单独的头文件中 可以包含在原始位置中,但这意味着 进行大量重组并拆分文件。

有人知道如何解决我的问题吗?

提前致谢, 妮可

【问题讨论】:

    标签: hide external doxygen internal sections


    【解决方案1】:

    我认为 ENABLED_SECTIONS 是前进的方向,但有几件事可能会减少工作量。

    首先是为您的特定要求创建一个单独的 doxyfile,然后您可以自定义它而不会打扰任何主文件。

    在那个新的 doxyfile 显式列表中,在 INPUT 文件列表中,只有那些包含您需要的内容的文件。很有可能它当前设置为拉入整个文件夹树 - 编辑它以挑选单个文件;不要忘记您可能需要定义文档的“结构”的文件。

    之后,使用 ENABLED_SECTIONS 和相应的 @if <SECTION_NAME> @endif 标记将选择细化为小于文件的单位。

    【讨论】:

    • 这就是我的意思:可以使用 ENABLED_SECTIONS (并通过限制输入源)。但是,问题仍然存在:我必须修改每个“原子”(函数、宏、变量、常量......)中的剩余头文件,这些头文件不应该是结果的一部分。因此,它再次不是选择我想要的,而是选择我不想要的,这比相反的工作要多得多。
    • @user3356415 好的,我认为您的代码必须以我无法想象的方式排列。我现在没有主意了。祝你好运。
    猜你喜欢
    • 1970-01-01
    • 2014-05-01
    • 1970-01-01
    • 2021-02-04
    • 2015-07-17
    • 1970-01-01
    • 2010-11-28
    • 1970-01-01
    • 2011-11-11
    相关资源
    最近更新 更多