Передача файла, содержащего список файлов / каталогов в тэг Doxygen INPUT - PullRequest
0 голосов
/ 23 октября 2018

Я пытаюсь выяснить, можно ли передать файл, содержащий список файлов / каталогов, в тег 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.и "передай" его Doxygen.

Я попробовал.Я поместил приведенный выше список в doxyInput.lst и просто установил тег INPUT в моем файле конфигурации Doxy следующим образом:

INPUT = doxyInput.lst

Но это не работает.

Это то, что япытаешься делать тут поддерживаемый Doxygen?

Я пытался найти его в Интернете, но, похоже, я не знаю правильного поискового запроса, поэтому не нашел того, что искал.Большое спасибо!

1 Ответ

0 голосов
/ 24 октября 2018

Невозможно добавить список с именами файлов непосредственно, например, к INPUT, но есть некоторые возможности, такие как:

  • , вам не нужно перечислять все файлы по отдельности, но вы можетеиспользуйте также каталоги в INPUT и используйте FILE_PATTERNS для выбора только соответствующих расширений файлов.Используйте RECURSIVE, чтобы перейти в подкаталоги, и EXCLUDE_PATTERNS, чтобы исключить файл (шаблоны).
  • поместите все имена файлов в отдельный файл (не забудьте обратную косую черту в конце!) И используйте@INCLUDE в файле конфигурации doxygen (Doxyfile).
...