我已经使用PEAR在Ubuntu 11.10上安装了最新的0.18.1 DocBlox。如果我在命令行中指定了所有内容,那么一切似乎都很好。但是,单独使用docblox在当前目录中找不到docblox.xml。指定doxblox-c(或-config)/docblox.xml也不起作用。我已验证权限,并且该文件存在。
我有一个目录Testing,里面有一些简单的测试文件。
/home/Testing$ docblox --config ./docblox.xml
DocBlox version 0.18.1
ERROR: The given template default could not be found or is not readable
/home/Testing$ ls -l
total 20
-rw-rw-rw- 1 dev dev 992 2012-01-17 12:03 docblox.xml
-rw-rw-rw- 1 dev dev 107 2012-01-17 11:59 index.php
-rw-rw-rw- 1 dev dev 769 2012-01-17 12:01 SOME_CLASS.class
-rw-rw-rw- 1 dev dev 1335 2012-01-17 12:02 SOME_CLASS.class.test
default
模板在0.18.0版本之前是事实上的模板,在0.18版本中已重命名为new_black
。也许您在自己的配置中直接提到了default
模板?
尝试安装new_black
模板,然后在配置中省略模板名称或定义new_black
。
您必须安装主题。在维护人员将主题与核心分离后,我不得不在第一个版本中自己做这件事
$ pear list-all -c docblox
All packages [Channel docblox]:
===============================
Package Latest Local
docblox/DocBlox 0.18.1 0.18.1 PHP 5.3 compatible API Documentation generator aimed at projects of all sizes and Continuous Integration
docblox/DocBlox_Template_abstract 1.0.1 The abstract template for DocBlox
docblox/DocBlox_Template_checkstyle 1.0.0 1.0.0 The checkstyle template for DocBlox
docblox/DocBlox_Template_new_black 1.0.1 1.0.1 The new_black template for DocBlox
docblox/DocBlox_Template_old_ocean 1.0.0 The old_ocean template for DocBlox
docblox/DocBlox_Template_pdf_old_ocean 1.0.0 The pdf_old_ocean template for DocBlox
docblox/DocBlox_Template_zend 1.0.0 The zend template for DocBlox
docblox/DocBlox_Theme_default 1.0.0 The default theme for DocBlox
$ pear install docblox/DocBlox_Theme_default
删除模板部分后,这纠正了我的问题,我可以生成报告和类图。下面是新的docblox.xml,供任何需要它的人使用。
<?xml version="1.0" encoding="UTF-8" ?>
<docblox>
<title>My project</title>
<parser>
<target>output</target>
<markers>
<item>TODO</item>
<item>FIXME</item>
</markers>
<extensions>
<extension>class</extension>
<extension>fn</extension>
<extension>php</extension>
</extensions>
<visibility></visibility>
</parser>
<transformer>
<target>output</target>
</transformer>
<logging>
<level>warn</level>
<paths>
<default>{APP_ROOT}/data/log/{DATE}.log</default>
<errors>{APP_ROOT}/data/log/{DATE}.errors.log</errors>
</paths>
</logging>
<files>
<file>*</file>
<file>bin/*</file>
<directory>src</directory>
<directory>tes??</directory>
<ignore>test/*</ignore>
</files>
</docblox>