Ubuntu + phpDocumentor + чучуть Drupal

 

Установка phpDocumentor

 

pear channel-discover pear.phpdoc.org
 
pear install phpdoc/phpDocumentor

 

Отступление

Как то криво установил php на Ubuntu по этому выскакивали ошибки 

как это

Cannot find module (SNMPv2-TC)

Лечится удалением пакета

sudo apt-get remove php5-snmp

 

Настройка phpDocumentor

Тут я чуток затупил, но в итоге всё как всегда просто .

Нужно создать файл phpdoc.dist.xml — я взял стандартный здесь  и слегка модифицировал


<?xml version="1.0" encoding="UTF-8" ?>
 
<phpdoc>
 
  <parser>
 
    <target>data/output</target>
 
     <extensions>
 
      <extension>php</extension>
 
      <extension>php3</extension>
 
      <extension>phtml</extension>
 
      <extension>module</extension>
 
      <extension>inc</extension>
 
    </extensions>
 
  </parser>
 
  <transformer>
 
    <target>data/output</target>
 
  </transformer>
 
  <files>
 
    <directory>.</directory>
 
  </files>
 
</phpdoc>

Основной момент по конфигу

 

  • что бы phpDocumentor видел моуле друпала нужно в phpdoc.dist.xml дописать  <extension>module</extension>
  • что бы phpDocumentor видел файлы с расширением inc нужно в phpdoc.dist.xml  дописать <extension>inc</extension>
 
При первом запуске, если поспешили это сделать, скорее всего возникнет ошибка на подобии этой 

Unable to find `dot` command of the GraphViz package

Решается простой установкой этого пакета

sudo apt-get install graphviz

 

Запуск phpDocumentor

 

После всех настроек можно и запустить на генерацию отчетности phpDocumentor
О формировании phpdoc в самом коде , а также интеграции с phpstorm  говорить не будет это смотрим тут

Итак запуск

Первым делом положим файл  phpdoc.dist.xml именно туда где лежит весь проект . 

Если нужно сделать документацию только по одному модулю то файл конфига, пути, и запуски phpdoc нужно рассматривать так , что модуль и есть проект
потом перейдем в папку проекта в консоле
 

cd /path1/patch2/project1

и запустим опять же в консоле

phpdoc -d . -t /home/username/temp/php_doc

home/username/temp/php_doc - я заблаговременно создал. Кстати если создать папку за пределами home/username или на другом диске к примеру то появляются куча вопросов с правами доступа и phpdoc выдает ошибки.   А оно Вам надо?

 

Если понадобится запустить только для одного файла то я делал это так

Преходил в корень (иначе подхватывает конфиг из проекта и собирает весь проект)
 
cd /
 
phpdoc -f /path1/patch2/project1/modules/custom/name_module/name_module.module -t /home/username/temp/php_doc

 

Наслаждаемся
 

Весь результат будут как Вы уже догадались  в папке /home/username/temp/php_doc

Комментарии: 0

Комментировать

Содержание этого поля является приватным и не предназначено к показу. Если у вас есть аккаунт в Gravatar, связанный с этим e-mail адресом, то он будет использован для отображения аватара.

ЧТО ТО НОВЕНЬКОЕ

О НАС

i-Drup - Это команда молодых и энергичных людей, которые занимаются разработкой и продвижением сайтов. Наша цель - Ваш успех!

КОНТАКТЫ

По всем вопросам создания сайта или других услугах Вы можете написать в форме обратной связи либо нам на почту idrupstudio@gmail.com