我想将我的文档的整个页面设为“内部”,以便它仅在 INTERNAL_DOCS = YES
时生成.我对本文档的批量文本使用 Markdown 格式,所以所有这些文件都是 .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。
一种不受欢迎的解决方案是将分离的页面“分解”回始终可见的页面,并使用顶部描述的技术。但是,有很多这样的页面。
有谁知道如何将整个文件制作成完全内部的,或者有任何其他方法可以解决这个问题?
最佳答案
我在页面相关的地方使用@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
关于markdown - Doxygen:如何制作整个文件 "Internal"?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/19835890/