2014-02-19 18 views
0

Я написал html5 игру api с haxe, и теперь я хочу автоматически генерировать документацию из комментариев в коде. Однако я понятия не имею, как начать с этого. Я хочу, чтобы попытаться использовать haxedoc но только документация у меня есть на этом сайте, и это не очень полезно на всех: http://haxe.org/doc/haxedocИспользование Haxedoc для создания документации для моего проекта

Когда я запускаю эту команду: Haxe -xml output.xml build.hxml

его говорит, что build.hxml не существует.

Как мне получить haxedoc для прохождения моего проекта и создания документации? Особые шаги очень ценятся.

ответ

1

Вы можете создать .hxml для использования в документации. Как создать файл .hxml зарегистрирован здесь http://haxe.org/doc/compiler#example

+0

Вам нужно сделать hxml-файл? Это очень утомительно для количества файлов, которые у меня есть. – user1261710

+0

Файл hxml содержит только инструкции по созданию проекта, который необходим для документации. Так что да, я думаю, что это необходимо. –

+0

Ну что ж, я просто хочу документировать фреймворк, а не игру, поэтому сама игра имеет файл сборки, но не фреймворк. Я никогда не строил рамки, поэтому я нахожу это странным. Структура не работает сама по себе, поэтому мне все равно нужно сделать этот файл. – user1261710

Смежные вопросы