Question

我正在使用Doxygen来记录Python项目。该应用程序使用一些小的txt文件，包含例如配置信息，日志等。由于显而易见的原因，没有Doxygen信息可以直接包含在这些文件中（解析问题，这些文件可能不存在） - 我需要在其他文件（包含代码）中编写此文档。

问题是，我不能在一个代码文件中执行2个文件（或者至少 - std 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个jpgs和3xmls，在gallery2 - 1 jpg，gallery3-5xJPG＆amp; 5xXML。所有这些 - 由用户上传。作为画廊1,2和＆amp; 3有一些不同的用法，在创建这些目录后，我们还创建了一个文件：

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

此文件包含以下格式的信息：

gallery1#galleryType1
gallery2#galleryType2
gallery3#galleryType1

请注意。如果应用程序空闲（用户没有做任何事情），没有画廊，也没有types.info文件... 现在，我想创建一个关于这个可怜的types.info的doxygen条目，以便它在文件选项卡中可见。 @verbinclude不起作用:( 我添加了@package标签，它可能是一种解决方法，但如果我在doc页面的Files选项卡中记录了这个文件，那真的很好...... 更清晰？：）

Answer 1

您可以使用文档块中的@file属性完成此操作，例如：

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

为了使其正常工作，您还需要添加types.info作为有效的doxygen输入文件名（验证INPUT和FILE_PATTERNS doxygen配置属性是否包含它），文件必须存在（但可以为空）。

我发现这种方法的主要警告是它似乎不适用于python风格的doxygen评论：

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

您需要拥有可包含C / C ++样式注释的源文件，该文件也将显示在“文件”选项卡下。

记录Doxygen中的txt文件

1 个答案: