Using the PHPDoc tool --
Calling the PHPDoc commandline program
Options
-h -?
Display help/usage
-f
Force the deletion of the destination directory for HTML/XML output file.
-s
Directory where your source files reside.
-d
Destination directory for the generated doc files.
-t
Directory with the PHPDoc template directories. This is normally the
PHPDoc directory in your pear/data directory.
See the 'Setup' section.
-e
The template to use from the template directory. Currently two
templates are provided, the 'default' template and the 'timmyg'
template.
Set up the program
The PHPDoc program phpdoc resides in
<pearpath>/phpdoc/. It is automatically
setup when you install the package with "pear install PHPDoc".
Unix specific settings
Check the first line to ensure it points to your php binary
(installed as CGI, not as webserver module!). This should be set
automatically by the installer.
Windows specific settings
For running the PHPDoc program on Windows, the PHPDoc directory
contains a batch file phpdoc.bat. Edit the
following lines to match the path of your PHP executable (not
webserver module!).
REM -------------------
set PHP_PATH=c:\php
REM ------------------- |
|
