Как создать документацию / документацию по 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 - пакетname, а $MODULE - это имя модуля, а $MAGENTO_PATH - это место, где установлен Magento.

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