Как создать документацию / документацию по API для Magento?

Question

У меня установлен Magento, и я хотел знать, как сгенерировать полные документы API, такие как на http://docs.magentocommerce.com/, сгенерированные с использованием phpdoc. Есть ли файл конфигурации, включенный в Magento для phpdoc, который я могу использовать для создания документации?

Answer 1

Фактическая программа называется phpDocumentor, и вы можете использовать ее в командной строке для документирования основного кода Magento, используя phpdoc -d $MAGENTO_PATH/app/code/core/Mage/ -t docs, Не забудьте создать каталог с именем docs, или вы можете установить целевой каталог так, как вам нравится.

Для документирования API расширения вы можете использовать phpdoc -d $MAGENTO_PATH/app/code/local/$PACKAGE/$MODULE где $PACKAGE это имя пакета, и $MODULE это имя модуля, и $MAGENTO_PATH это где Magento установлен.

Предупреждение: генерация всей документации по API может занять некоторое время, так как Magento - довольно большая программа.