如何获取 Doxygen 文档中的纯文本文件？

Question

我无法在 Doxygen 文档中包含任何文本文件。唯一的例外是README.md我设置为主页的文件。

特别是，我想Changelog.txt在文档中查看该文件。我试图在INPUT字段和字段中显式添加它FILE_PATTERNS，但没有成功。在生成的 HTML 文档中，我无法在文件列表中找到任何内容，也无法进行搜索。

唯一的跟踪位于 Doxygen 的日志文件中：

Preprocessing C:/Source/Changelog.txt...
Parsing file C:/Source/Changelog.txt...
...
Parsing code for file Changelog.txt...

---

如果我将文件的扩展名从 更改为txt，md该文件将添加到文档中。

Answer 1

EXTENSION_MAPPING=txt=md否则，您需要.txt将文件作为源文件处理C / C++，并且缺少注释符号，从而导致没有输出。

从文档中：

EXTENSION_MAPPING Doxygen 根据其解析的文件的扩展名选择要使用的解析器。使用此标签，您可以指定用于给定扩展的解析器。Doxygen 有一个内置映射，但您可以使用此标签覆盖或扩展它。格式为 ext=language，其中 ext 是文件扩展名，语言是 doxygen 支持的解析器之一：IDL、Java、Javascript、C#、C、C++、D、PHP、Objective-C、Python、Fortran（固定格式 Fortran：FortranFixed，自由格式 Fortran：FortranFree，未知格式 Fortran：Fortran。在后一种情况下，解析器会尝试猜测代码是固定格式还是自由格式代码（这是 Fortran 类型文件的默认值）、VHDL。例如，要使 doxygen 将 .inc 文件视为 Fortran 文件（默认为 PHP），将 .f 文件视​​为 C 文件（默认为 Fortran），请使用：inc=Fortran f=C。注意：对于没有扩展名的文件，您可以使用 no_extension 作为占位符。请注意，对于自定义扩展，您还需要设置 FILE_PATTERNS，否则 doxygen 不会读取文件。