APIDOCJS - Как создать версию

Question

Я играл с APIdoc.js в течение последних нескольких дней, и я не могу понять, как сделать работу по управлению версиями. Я понимаю, что мне нужно сохранить старый код комментария APIDOC в другой файл с @APIVersioning на новый/старый код в соответствии с APIDOC. Независимо от того, где я прикрепляю этот старый файл, я не могу заставить его работать, и в этом примере нет никаких намеков о том, как его загрузка старого кода для создания этого управления версиями. Любая помощь будет принята с благодарностью.

Answer 1

Предположим, что вы уже создали документацию файла, скажем File1.php. Теперь, если в File1.php необходимо внести какие-либо изменения в некоторые параметры или, возможно, что-либо, просто скопируйте текущую документацию этого файла в _apidoc.js и внесите необходимые изменения.

Генерирование документации File1.php снова и BOOOM теперь у вас есть две версии документации.

Пожалуйста, проверьте следующее:

1) Поместите @apiVersion тег с различными значениями в обеих версиях.

2) _apidoc.js должен быть в том же каталоге, в котором присутствует File1.php.

Answer 2

Информация об этом на http://apidocjs.com/ может быть более конкретной. После некоторых экспериментов я обнаружил, что вам просто нужно положить _apidoc.js (если вы следуете примерам) в той же папке, что и остальные ваши файлы. Так что, если вы запустите его с командой, например:

apidoc -i myapp/ -o apidoc/ -t mytemplate/ 

Тогда _apidoc.js должен быть в MyApp/.