Doxygen:如何使整个文件"内部"？

Question

我想将我的文档的整个页面设置为"内部",以便仅在生成时生成INTERNAL_DOCS = YES.我正在使用markdown格式来处理本文档的批量文本,因此所有这些文件都是.md扩展名,而不是那应该有所不同.

如果我在源文本文件的@page 一部分中应用它,则以下工作正常,因为页面的所有证据都从输出中消失:

@internal
@page hidden_page Blah Blah
Text is here.    
@endinternal

但是,我的一些页面很长,我已将它们考虑到一个单独的文件中.

# Page Title

Extensive text here.

第一行降价标题使用页面标题的文件名停止Doxygen.

问题是,如果我这样做......

@internal
# Page Title

Extensive text here.
@endinternal

文本正文是隐藏的,但(空白)页面仍然存在于输出中,显示文件名作为页面标题.

颠倒顶行的顺序没有什么区别 - 它只是意味着空白页面的标题不同.

我在Doxygen手册的相关部分找不到任何内容.我正在使用1.8.5.

一个不受欢迎的解决方案是将分离的页面"解构"回一个始终可见的页面,并使用顶部描述的技术.但是,有很多这样的页面.

有谁知道整个文件是如何完全内部制作的,或者有任何其他可能适用于此的方法？

Answer 1

我在涉及页面的情况下使用 @internal 并没有取得很大的成功，因此我成功的方法是使用 @if 和 ENABLED_SECTIONS，请参阅Doxygen if command。我已经用 python 文件测试了以下内容，尽管这确实生成了一些警告，但它满足了我认为您需要的功能。

## @if COND1
# @file cond_file.py Conditional File
#
# Conditional documentation.
#
# @page conditional_page Conditional Page
#
# This page will only exist if COND1 is set.
#
# @endif

如果您希望该部分包含在文档中，只需将以下内容添加到 doxygen 配置文件中：

ENABLED_SECTIONS = COND1