Где я должен поместить файл phpdoc.xml?

phpdoc может быть настроен либо с использованием XML-файла, либо с помощью .ini-файла. Документация неоднозначна, но кажется, что в настоящее время предпочтительным является использование XML-файла. Согласен?Где я должен поместить файл phpdoc.xml?

Где я могу поместить файл .xml?

Согласно http://www.phpdoc.org/docs/latest/for-users/configuration.html ...

Самым простым решением было бы поместить файл конфигурации в корне вашего проекта с названием: phpdoc.dist.xml.

В какой директории они упоминаются как «корень вашего проекта»? Я пробовал все, т. Е.

/usr/share/pear/phpDocumentor, 
/var/www/phpDocumentor, 
/var/www,

и ничего не работает.

источник

2013-12-12 user1032531

ли вы когда-нибудь это отсортирован? Кажется, у меня такая же проблема. Вы используете файл phar? – mattl

корень вашего проекта - это место, где вы помещаете код, необходимый для генерации документа. Например: вам нужно сгенерировать документ для кода внутри каталога /var/www/example, а затем phpdoc.dist.xml. будьте в нем. Он работает так же, как composer и phpunit.

пример еще раз:

$ phpdoc -d ./src -t ./docs/api

phpdoc.dist.xml должен би в ./src

источник

2013-12-12 04:37:15 egig

Спасибо egig. Итак, при запуске phpdoc мне также нужно находиться в том же каталоге? В противном случае, как dod phpdoc знает, какой phpdoc.dist.xml использовать? Кроме того, если я хочу разобрать/var/www/thisDir и/var/www/thatDir, поместить его в/var/www? – user1032531

'Мне тоже нужно быть в том же каталоге?' Нет, но вы должны указать опцию '-d/your/src/path'. 'как phpdoc знает, какой phpdoc.dist.xml использовать?' тот, который существует в '/ your/src/path'. 'Я помещаю его в/var/www?' ... '$ phpdoc -d/var/www/thisDir -t/var/www' и' $ phpdoc -d/var/www/thatDir -t/var/www ' – egig

Но http://www.phpdoc.org/docs/latest/for-users/configuration.html заявляет, что вам не нужно вводить что-либо с помощью' phpdoc', поскольку вся необходимая информация находится в XML-файле. – user1032531

Где я должен поместить файл phpdoc.xml?

ответ

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