5

我不能在我的 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...

如果我将文件的扩展名从 更改txtmd,则该文件将添加到文档中。

4

1 回答 1

4

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

从文档中:

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

于 2018-08-07T12:16:05.407 回答