从doxygen的"File documentation"列表中排除"README.md"

Exclude "README.md" from doxygen's "File documentation" list

本文关键字：排除 README md 列表 documentation doxygen File      更新时间：2023-10-16

我正在努力解决以下问题。我使用 doxygen 来记录我的C++代码，并使用 README.md 来记录我的代码文档的主页，通过

INPUT += README.md
USE_MDFILE_AS_MAINPAGE = README.md

在我的 Doyxgen 配置文件中。一切正常，除了文件README.md出现在我生成的.pdf refman.tex文件中的"文件文档"部分中（它没有出现在"文件列表"部分中），例如

8.24 /Users/username/qpp/README.md File Reference . . . . . . 123

这非常烦人，因为我不希望此文件出现在任何文件列表中。有什么方法可以删除它吗？我不能只是将其添加到EXCLUDE =列表中，就像我这样做一样，它将不再用于生成主页。

截至今天，我仍然没有找到一个优雅的解决方案。如果您不希望README.md出现在.pdf内的"文件引用"部分中，您可以做的是手动注释该行

%input{_r_e_a_d_m_e_8md}

在生成的refman.tex文件中，然后才编译.tex文件以生成最终.pdf

latexmk -pdf refman.tex

该问题不会出现在html生成的文档中，只会出现在latex文档中。

<小时 />

另一种选择是将.添加到STRIP_FROM_PATH中Doxyfile 

STRIP_FROM_PATH = .

现在，至少完整路径将不再出现，因此而不是类似

8.24 /Users/username/qpp/README.md File Reference . . . . . . 123

你只会看到

8.24 README.md File Reference . . . . . . 123
相关文章：