5

我想将我的文档的整个页面设置为“内部”，以便仅在INTERNAL_DOCS = YES. 我对本文档的大容量文本使用降价格式，因此所有这些文件都是.md扩展名，而不是应该有所作为。

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

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

但是，我的一些页面很长，我已将它们分解为单独的文件。

# Page Title

Extensive text here.

第一行 markdown 标题使用页面标题的文件名停止 Doxygen。

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

@internal
# Page Title

Extensive text here.
@endinternal

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

颠倒顶部行的顺序并没有真正的区别——它只是意味着空白页的标题不同。

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

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

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

4

1 回答 1

2

我在涉及页面的地方使用@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
于 2014-02-04T16:26:08.223 回答