################################################################################
				PhpDocumentor
				
################################################################################
Release Notes
################################################################################

Release notes for the newest version are in Release-0.4.1

0.4.X is the beta series, were well on our way to 1.0 :-)

To learn howto write PHPDoc style documentation checkout howto.html
You can also read spec its in the spec directory.

If you find a bug please post it at:
http://sourceforge.net/tracker/?func=add&group_id=11194&atid=111194

################################################################################
General Notes
################################################################################
phpDocumentor is hosted at phpdoc.org, with downloads and mailing list through 
sourceforge.net

webpage: 	http://phpdoc.org/
mirror: 	http://phpdocu.sourceforge.net
projectpage: 	http://sourceforge.net/projects/phpdocu

For a list of people who have helped work on this project please read the 
Authors file

phpDocumentor is released under the GPL the text of the license is in COPYING

################################################################################
Feature Notes
################################################################################

The 0.4.x series is the beta series, we're working on adding any missing features
and making everything stable and well-documented.

Any help would be appreciated, just contact me for information on getting 
started.

phpdoc is able to generate documentation from a single php file or it can 
recursively parse through a directory

phpdoc needs php 4.0.6 or greater, but i only check it on the Newest release of
php, which for Relese 0.3.1 is 4.1.2, you should be able to run the newest
version too since you don't need to run phpdocumentor on your production server

Note: it works with php 4.0.6 as well -- GB

################################################################################
Command Line notes
################################################################################

  -f	--filename			name of file(s) to parse ',' file1,file2

  -d	--directory			name of a directory(s) to parse directory1,directory2

  -t	--target			path where to save the generated files

  -dh	--hidden			set equal to on (-dh on) to descend into hidden directories
					(directories starting with '.'), default is off
					
  -pp	--parseprivate		set equal to on (-pp on) to parse documentation for elements
  					with tag "@access private"

  -td	--template			template directory, default is 'templates/default/'

  -h	--help				show this help message

  		


You can have multiple directories and multiple files, as well as a combination of both options

if you run phpdoc and get :
bash: ./phpdoc: No such file or directory

Then you haven't installed the cgi version of php
goto your php src dir and try
make clean
./configure
make
make install

phpdoc should work now


################################################################################
Web Interface notes
################################################################################
Put phpdoc.php together with the *.inc files someplace on your webserver.
Make sure you webserver can write to where ever you specify as a target or you
will get lots of errors

################################################################################
Thanks
################################################################################
Thanks to Gregory Beaver for all his work on adding features and fixing bugs
	without him it would have taken a lot longer to get where we are now.
Thanks to Juan Pablo Morales for the web interface.
Thanks to whoever sent me the patch to make phpdocumentor work better in NT
	I have your diff and pathed the program but i seem to have lost your
	name if you send it to me i'll add it to the Authors file
Thanks to Florian Clever for the newest set of win32 patches they seem to have
	fixed the last of the problems.

################################################################################
################################################################################
if you have any questions please email me
joshua eichorn
jeichorn@phpdoc.org
