在Doxygen中记录txt文件

Question

我正在使用Doxygen来为一个Python项目写文档。这个应用程序使用一些小的txt文件，里面包含配置、日志等信息。出于明显的原因，这些文件里不能直接包含Doxygen的信息（因为解析会出问题，而且这些文件可能不存在）——我需要在其他文件中写这些文档（包含代码的文件）。

问题是，我不能在一个代码文件中为两个文件生成文档（或者说，标准的doxyconf不允许这样做——对于那些小文件或不存在的文件，不会生成文档）。

你知道怎么解决这个问题吗？在配置中应该做什么具体的调整？或者我应该创建一个.py文件（和相关文件在同一个目录下），只包含注释（文档）呢？

提前谢谢你。

编辑。好的，我再试着解释得更清楚一些。假设我的代码在以下文件中：

(...)/project/functions.py
(...)/project/interface.py
(...)/project/data/js/functions.js

如果运行的话，应用程序会生成一些目录：

(...)/project/data/gallery/gallery1
(...)/project/data/gallery/gallery2
(...)/project/data/gallery/gallery3

在gallery1里，我们有3个jpg和3个xml，在gallery2里有1个jpg，gallery3里有5个jpg和5个xml。这些都是用户上传的。因为gallery 1、2和3的使用方式有点不同，所以在创建这些目录后，我们还会创建一个文件：

(...)/project/data/gallery/types.info

这个文件包含的信息格式是：

gallery1#galleryType1
gallery2#galleryType2
gallery3#galleryType1

注意。如果应用程序处于闲置状态（用户没有任何操作），那么就没有画廊，也没有types.info文件……现在，我想为这个可怜的types.info创建一个Doxygen条目，以便它能在文件标签中可见。@verbinclude不起作用 :( 我添加了@package标签，这可能是个变通办法，但如果我能在文档页面的文件标签中看到这个文件的文档，那就太好了……这样清楚了吗？ :)

Answer 1

你可以试试在文档块里用 @file 属性来实现这个功能，像这样：

/**
 * @file project/data/gallery/types.info
 * Documentation for types.info in project/data/gallery/.
 */

为了让这个方法有效，你还需要在 doxygen 的配置里把 types.info 加入到有效的输入文件名中（确保 INPUT 和 FILE_PATTERNS 这两个配置项里包含它），而且这个文件必须存在（不过它可以是空的）。

我发现这个方法的一个主要问题是，它似乎不支持 Python 风格的 doxygen 注释：

## @file project/data/gallery/types.info
# Documentation for types.info in project/data/gallery/.

你需要有一个可以包含 C/C++ 风格注释的源文件，而且这个文件也会在文件标签下显示出来。