Как включать пользовательские файлы в Doxygen
Я хотел бы добавить пользовательские файлы (непроекта) для генерации некоторых дополнительных страниц с Doxygen.
Я (был на самом деле), не уверенный, как эти файлы нужно назвать и как их содержание должно быть отформатировано.
2 ответа
Я довольно много искал, прежде чем нашел ответ, поэтому подумал, что было бы неплохо поделиться!
В соответствии с этой статьей Doxygen gotchas я наконец обнаружил, что: вам нужно добавить файл с расширением dox . Его содержимое должно содержать блоки комментариев в стиле C:
/*!
\page My test page
contents
...
more contents
*/
Убедитесь, что ваши пользовательские файлы помещены в каталог, который включен в настройку INPUT , или в текущий каталог, если INPUT оставлен пустым, чтобы эти файлы могли быть найденным.
Просто перечислите ваши пользовательские файлы в макросе INPUT в вашем doxyfile. Вы можете выбрать любое имя, которое сочтете подходящим. Формат - текст с тегами Doxygen.