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

Question

Я не могу включить любой текстовый файл в мою документацию Doxygen. Единственным исключением является README.md файл, который я установил в качестве главной страницы.

В частности, я хотел бы увидеть Changelog.txt файл в документации. Я пытался добавить это явно в INPUT поле и в FILE_PATTERNS поле, без успеха. В сгенерированной документации HTML я ничего не могу найти ни в списке файлов, ни в поиске.

Единственный след находится в файле журнала Doxygen:

Preprocessing C:/Source/Changelog.txt...
Parsing file C:/Source/Changelog.txt...
...
Parsing code for file Changelog.txt...

---

Если я изменю расширение файла с txt в md, файл добавлен в документацию.

Answer 1

Тебе нужно EXTENSION_MAPPING=txt=md в противном случае .txt файл обрабатывается как C / C++ в исходном файле отсутствуют знаки комментария, что не приводит к выводу.

Из документации:

EXTENSION_MAPPING Doxygen выбирает анализатор для использования в зависимости от расширения файлов, которые он анализирует. С помощью этого тега вы можете назначить, какой синтаксический анализатор использовать для данного расширения. У Doxygen есть встроенное отображение, но вы можете переопределить или расширить его, используя этот тег. Формат: ext=language, где ext - расширение файла, а language - один из анализаторов, поддерживаемых doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP, Objective-C, Python, Fortran (исправлено формат Fortran: FortranFixed, свободно отформатированный Fortran: FortranFree, неизвестно отформатированный Fortran: Fortran. В последнем случае парсер пытается угадать, является ли код фиксированным или свободно отформатированным, это по умолчанию для файлов типа Fortran), VHDL. Например, чтобы doxygen рассматривал файлы.inc как файлы Fortran (по умолчанию это PHP), а файлы.f как C (по умолчанию это Fortran), используйте: inc=Fortran f=C. Примечание. Для файлов без расширения вы можете использовать no_extension в качестве заполнителя. Обратите внимание, что для пользовательских расширений вам также нужно установить FILE_PATTERNS, иначе файлы не будут прочитаны doxygen.