在doxygen文件列表中隐藏文件

时间:2016-11-20 00:21:53

标签: c# html doxygen

我们有一个文件'documentation.cs',我们不希望在Doxygen文件列表中显示。我应该将什么添加到我们的配置或文件中以将其隐藏在文件列表中?

We want this gone

2 个答案:

答案 0 :(得分:2)

EXCLUDE的Doxygen documentation说明:

  

EXCLUDE标记可用于指定应从INPUT源文件中排除的文件和/或目录。这样,您可以轻松地从目录树中排除子目录,该目录树的根目录是使用INPUT标记指定的。   请注意,相对路径是相对于运行doxygen的目录。

因此,您可以将此行添加到doxygen配置文件中以删除documentation.cs

EXCLUDE_PATTERNS = documentation.cs
# EXCLUDE_PATTERNS = */documentation.cs

然后如果你想隐藏更多文件......

EXCLUDE_PATTERNS += another_file.cs

这也适用于整个目录。

EXCLUDE_PATTERNS += */directory/*

答案 1 :(得分:2)

您也可以直接更改文件名.dox.doc.txt扩展名。请参阅this answer

  

有三种可能的扩展,doxygen将其视为附加文档文件:.dox,.txt和.doc。
  文件[带]此类扩展名对文件索引隐藏。在文件内部,您需要放置一个或多个C / C ++样式注释块。

所以将'documentation.cs'重命名为'documentation.dox',但保留C风格的注释。 (假设你使用的是什么 - 不确定为什么你决定添加.cs扩展名,它似乎不是它实际上是一个C#源文件)

确保将文件保留在当前目录中(如果INPUT保留为空)或将其添加到INPUT设置中包含的目录中。

编辑:根据this网页,您可能需要将FILE_PATTERNS += *.dox添加到您的Doxyfile。我不知道现在是否自动支持文件扩展名,但是在撰写博客时却不是这样。