Как настроить Doxygen для генерации документов только для одного файла? - PullRequest
Новая
       22

Как настроить Doxygen для генерации документов только для одного файла?

0 голосов
/ 05 марта 2020

Я хочу сгенерировать документы для одного Java класса очень большого проекта. Как я могу это сделать? Я уверен, что сделал это несколько лет назад. У него много зависимостей, поэтому я не могу просто скопировать класс в другой каталог.

Я могу использовать командную строку или OSX Doxywizard.

1 Ответ

1 голос
/ 05 марта 2020

Если вы хотите использовать doxygen для создания документации из одного файла, скажем, aa.java, вы можете использовать обычный файл конфигурации doxygen и установить в нем: 

INPUT = aa.java

в зависимости от того, что все присутствует в * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *; 1014 *

  • INPUT: http://doxygen.nl/manual/config.html#cfg_input

    Тег INPUT используется для указания файлов и / или каталогов, которые содержат документированные исходные файлы. Вы можете ввести имена файлов, например, myfile. cpp или каталоги, например / usr / src / myproject.

  • EXCLUDE_SYMBOLS: http://doxygen.nl/manual/config.html#cfg_exclude_symbols

    Тег EXCLUDE_SYMBOLS можно использовать для указания одного или нескольких имен символов (пространств имен , классы, функции и т. д. c.), которые следует исключить из вывода. Имя символа может быть полностью определенным именем, словом или, если используется подстановочный знак *, подстрокой. Примеры: ANamespace, AClass, AClass :: ANamespace, ANamespace :: * Test

...