使用DOXYGEN选择某些文档

时间:2014-02-26 15:07:32

标签: hide external doxygen internal sections

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

而不是将99%的评论标记为\ internal,这样会很好 对于需要的1%的注释,有一个像\ external这样的命令 在我的情况下出口。

禁用“默认部分”之类的东西(一切都是 当然,也不是部分的一部分。然后我可以使用 ENABLED_SECTIONS ...

不幸的是,有问题的评论不仅仅存在于一个文件中。 此外,这些文件还包含许多其他注释 不出口。

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

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

提前致谢, 尼科

1 个答案:

答案 0 :(得分:0)

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

第一种是为您的特定需求创建一个单独的doxy文件,然后您可以自定义它而不会破坏任何主要文件。

在新的doxyfile中明确列出INPUT文件列表中仅包含您需要的内容的文件。有可能它目前设置为拉入整个文件夹树 - 编辑它以挑选单个文件;不要忘记您可能需要定义文档“结构”的文件。

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