使用DOXYGEN选择某些文档

Question

我想实现与\\ internal命令可以执行的操作几乎完全相反的操作。 已经有一个项目的庞大的doxygen文档，但是现在我想挑选一些块（函数，常量等）来创建一个仅包含重要内容的非常小的手册。

与其将99％的注释标记为\\ internal，不如将\\ external这样的命令用于我需要导出的1％注释，将是很好的。

当然，诸如禁用“默认部分”（所有内容，都不属于该部分）之类的东西也可以工作。 然后我可以使用ENABLED_SECTIONS ...

不幸的是，有问题的注释不仅仅存在于一个文件中。 此外，这些文件包含许多其他注释，不应将其导出。

我已经考虑过将这些注释移到可以包含在原始位置的单独的头文件中，但这将意味着要进行大量重组并将文件拆散。

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

在此先感谢Nico

Answer 1

我认为ENABLED_SECTIONS是前进的方向，但是有些事情可能会减少工作量。

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

在该新doxyfile中，在INPUT文件列表中显式列出仅那些包含所需内容的文件。 当前，它可能会拉入整个文件夹树-编辑该文件以挑选单个文件； 不要忘记可能需要定义文档“结构”的文件。

之后，将ENABLED_SECTIONS与相应的@if <SECTION_NAME> @endif标记一起使用，以将选择范围缩小到小于文件的单位。