我应该在哪里放置phpdoc.xml文件?

时间:2013-12-12 04:29:49

标签: php phpdoc

可以使用.xml文件或.ini文件配置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,

似乎没什么用。

1 个答案:

答案 0 :(得分:0)

项目的根目录是您放置生成文档所需的代码的位置。示例:您需要为/var/www/example目录中的代码生成文档,然后生成phpdoc.dist.xml。应该在里面。它就像composerphpunit一样工作。

再次举例:

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

phpdoc.dist.xml应该在./src