Skip to content

Latest commit

 

History

History
111 lines (65 loc) · 4.5 KB

README.markdown

File metadata and controls

111 lines (65 loc) · 4.5 KB
Raw

phpDox

phpDox is a documentation generator for generating API documentation in HTML format, for instance, from PHP source code.

Requirements

User Installation

phpDox should be installed using the PEAR Installer, the backbone of the PHP Extension and Application Repository that provides a distribution system for PHP packages.

Depending on your OS distribution and/or your PHP environment, you may need to install PEAR or update your existing PEAR installation before you can proceed with the following instructions. sudo pear upgrade PEAR usually suffices to upgrade an existing PEAR installation. The PEAR Manual explains how to perform a fresh installation of PEAR.

The following two commands (which you may have to run as root) are all that is required to install phpDox using the PEAR Installer:

sudo pear config-set auto_discover 1
sudo pear install pear.netpirates.net/phpDox

This should take care of installing all the required dependencies for you.

Developer Installation

In case you want to go bleeding edge or hack on the source, you will have to clone this repository.

Note: The phpdox.php bootstrap file assumes that all depedencies have been installed using the PEAR Installer. In case you do clone all the source repositories yourself, you have to adjust the include paths for them.

To make things work, you now have to manually install the following dependencies using the PEAR Installer (or clone their repositories and then adjust the paths in the phpdox.php bootstrap file):

pear channel-discover nikic.github.com/pear
pear install channel://nikic.github.com/pear/PHPParser-0.9.2
sudo pear install phpunit/PHP_Timer
sudo pear install ezc/ConsoleTools
sudo pear install theseer/DirectoryScanner
sudo pear install theseer/fDOMDocument
sudo pear install theseer/fXSL

Now you are ready to check out the source code of phpDox from its Git repository:

git clone git://github.com/theseer/phpdox.git

Usage Examples

(The examples assume you installed phpDox from pear. In case you use a developer checkout, you have to replace phpdox by ./phpdox.php in the following paragraph.)

You can run phpDox like this:

phpdox --help

As of version 0.4 phpDox requires an xml configuration file. In case a project you want to generate documentation for does not come with one, you can create it by calling

phpdox.php --skel > phpdox.xml.dist

Sample invocation to parse and generate output based on the default phpdox.xml configuration file

./phpdox.php

Trouble Shooting

  • If you try to install theseer/fXSL and get the following error:

      theseer/fXSL requires PHP extension "xsl"
  No valid packages found
  install failed

    Try to install the xsl extention of PHP. On Ubuntu, you can simply use:

      sudo apt-get install php5-xsl

    For Redhat based distributions:

      sudo yum install php-xsl

    Once the extension is installed, you can retry to install the fXSL package.

The following problems should only occur in case you are on a developer checkout:

  • If you run phpdox.php and get the following error:

      PHP Fatal error:  require_once(): Failed opening required 'ezc/Base/base.php' (include_path='.:/usr/share/php:/usr/share/pear') in /var/www/phpdox/phpdox.php ...

    Make sure you have installed ezc/ConsoleTools (see above). Make sure that the ezc/ folder is located in one of the include_path. If not, create a symbolic link or fix your include_path setting.

  • If you run phpdox.php and get the following error:

      PHP Warning:  require(TheSeer/DirectoryScanner/autoload.php): failed to open stream: No such file or directory in /var/www/phpdox/phpdox.php on line 44

    Make sure you have installed all the dependencies mentioned above, or in case you have installed an older version upgrade accordingly.