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

Release notes for the newest version are in Release-0.2.6

Notes that you might find helpful in using phpdoc style documentation in your
code are located in doc-notes


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


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

phpdoc release 0.2.0 sports a new parser that should work on all code, it 
also has a new template system for producing output, this should make
creating custom output much easier.

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 

it might work in anything greater then 4.0.2 but array_map is missing
and i haven't written a work around for it yet, you want the newest version
of php anyway

for information about writing phpdoc comments, try howto.html


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

  -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
When ignoring directories and filenames you can use the * wildcard.  For example */hold would
ignore any hold subdirectory


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