Как мне использовать doxygen для генерации внутренней документации для Unity?
Файл взлома для Unity гласит:
Внутренняя документация может быть создана для Unity, если установить и запустить doxygen
make doxygen.Я не знаком с doxygen и мог бы использовать некоторую помощь в определенных командах для использования.
Я скачал источник Unity, используя:
bzr branch lp:unityи запустилdoxygen Doxyfile.in.Он сгенерировал
api-doc/htmlс несколькими файлами, ноindex.htmlзагружает пустой фреймворк.Я прочитал файл man и онлайн-руководство / faq , но все еще не уверен, что мне нужно делать.
1 ответ
Я получил это работает. Я предполагал, что файл Doxyfile.in был настроен для любой системы, и все, что мне нужно было сделать, это запустить doxygen Doxyfile.in.
На самом деле я обнаружил, что doxygen должен быть запущен как цель cmake, но я пока не собирался делать всю сборку.
Чтобы запустить doxygen как самостоятельный процесс, мне нужно было отредактировать раздел Input в Doxyfile.in, указав фактический путь к каталогу исходного файла, закомментировав существующие переменные пути, которые есть для использования с make. файл.
После этого doxygen Doxyfile.in работал нормально.