将包含文件/目录列表的文件传递给Doxygen INPUT标签

时间:2018-10-23 19:43:54

标签: doxygen

我正在尝试确定是否可以将包含文件/目录列表的文件传递给Doxygen INPUT标签。 如果上面的句子没有清楚地描述我的意图,请考虑一个示例,其中我想包括这些文件和目录,以便Doxygen进行扫描并生成一些文档: ./file_1.c ./file_1.h ./file_2.c ./dir_1 ./dir_2/file_20.c ./dir_3/file_31.c ...等

如果只想包含那些项,我可以简单地将其附加到INPUT标记中,并使它看起来像这样:

INPUT = ./file_1.c \
        ./file_1.h \
        ./file_2.c \
        ./dir_1    \
        ./dir_2/file_20.c \
        ./dir_3/file_31.c

但是,如果列表增加,并且文件不一定限于特定目录,则最好将该列表放在单独的文件中,将其称为doxyInput.lst,然后将其“传递”到Doxygen。

我尝试过。我将上面的列表放到doxyInput.lst中,然后将我的Doxy配置文件中的INPUT标记设置为此:

INPUT = doxyInput.lst

但这不起作用。

我在这里尝试做的是Doxygen支持吗?

我尝试在Internet上查找它,但是我猜我不知道正确的搜索词,因此找不到所需的内容。非常感谢!

1 个答案:

答案 0 :(得分:1)

无法将包含文件名的列表直接添加到例如INPUT,但有一些可能性,例如:

  • 您不必单独列出所有文件,但也可以使用INPUT中的目录,并使用FILE_PATTERNS仅选择相关的文件扩展名。使用RECURSIVE进入子目录,使用EXCLUDE_PATTERNS排除文件(模式)。
  • 将所有文件名放在单独的文件中(不要忘记在文件名的反斜杠 结束!),并在doxygen配置文件(Doxyfile)中使用@INCLUDE