Set WeberTrivia.com to be my default homepage.   Suggest a Question                                               

Suggest A Question : :  Frequently Asked Questions : :  Search : :  Relevant Manuals : : 
PHP Questions : :  Linux Questions : :  MySQL Questions : : 
home  [ Login ] 

Using the PHPDoc tool

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.

#!/usr/local/bin/php -Cq

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 -------------------

Who's Online
Guest Users: 5
Google
Web
WeberTrivia
WeberDev
WeberForums
 Free Sample Chapters  Free Sample Chapters
  Deliver First Class Web Sites: 101 Essential Checklists
Want to learn how to make your web sites usable and accessible? Want to ensure that your sites meet current best practice, without spending hours trawling through incomprehensible specifications and recommendations from dozens of different books, research papers, and web sites? Want to make sure that the sites you build are "right the first time," requiring no costly redevelopments?

More Sample Chapters

PHP General