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

Question

我正在尝试弄清楚是否可以将包含文件/目录列表的文件传递给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的支持？

我尝试在互联网上查找它，但我想我不知道正确的搜索词，所以我没有找到我要找的东西。多谢！

Answer 1

无法直接添加带有文件名的列表，例如INPUT但有一些可能性，例如：

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