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

文本 body 已正确隐藏，但（空白）页面仍然存在于输出中，显示文件名作为页面标题。

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

我在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

Doxygen：如何使整个文件“内部”？

1 个答案: