• Home
  • History
  • Annotate
Name Date Size #Lines LOC

..03-May-2022-

Documentation/H03-May-2022-7,8235,614

HTML_TreeMenu-1.1.2/H03-May-2022-598200

docbuilder/H03-May-2022-1,5701,159

phpDocumentor/H03-May-2022-103,54189,251

scripts/H03-May-2022-548330

tests/H03-May-2022-2,7731,002

tutorials/H03-May-2022-7,0046,777

user/H03-May-2022-542433

AuthorsH A D03-Dec-2011990 2420

ChangeLogH A D03-Dec-2011296 106

FAQH A D03-Dec-20116.5 KiB188158

INSTALLH A D03-Dec-20113 KiB8257

LICENSEH A D03-Dec-201123.4 KiB14574

READMEH A D03-Dec-20118.5 KiB199152

Release-1.4.3H A D03-Dec-20114.2 KiB9979

new_phpdoc.phpH A D03-Dec-20111,021 3413

pear-phpdocH A D03-Dec-20111.4 KiB4240

pear-phpdoc.batH A D03-Dec-20114.7 KiB146125

phpDocumentor.iniH A D03-Dec-20112.3 KiB123113

phpdocH A D03-Dec-20112 KiB6460

phpdoc.batH A D03-Dec-20114.6 KiB145125

phpdoc.phpH A D03-Dec-2011995 3313

README

1$Id: README 317024 2011-09-19 21:09:16Z ashnazg $
2
3################################################################################
4				phpDocumentor
5
6################################################################################
7Installation
8################################################################################
9
10Installation for phpDocumentor is as simple as installing PHP and a web server.
11If you need help installing a webserver or php, refer to the documentation that
12comes with the webserver or with php.  phpDocumentor also runs from the
13command-line, and only requires that PHP CLI version be installed.
14
15All users with PEAR should either install this version directly from the
16package.xml file included in the distribution, or install via
17"pear install PhpDocumentor."
18
19The command-line interface "phpdoc" will be in the path, you can use it
20immediately on both windows and unix.  The web interface is in a subdirectory of
21your document root, be sure to "pear config-set data_dir /path/to/my/htdocs"
22prior to installation.
23
24To use phpDocumentor as a command-line tool in *nix-based systems, simply run
25the phpdoc script.  In windows, run
26"c:\php\php.exe phpdoc" where C:\php is the path to the cli version of php.
27The phpdoc command-line interface will not run with the ISAPI module of PHP.
28To see the command line options, use phpdoc -h or read at the bottom of this
29README.
30
31There is a BASH shell script that you can put inside your project that can save
32time writing command-line options of phpdoc. Simply copy makedoc.sh to your
33project path and edit it. When you wish to rebuild the documentation, run it again.
34Note that .ini scripts are far easier to edit and are supported via "phpdoc -c file.ini"
35
36To use phpDocumentor's web interface, install the files into a subdirectory of
37your document root (read the webserver's documentation for more information if you
38don't understand how to install into a subdirectory of your document root).
39Then, browse to the web page as you would to any other web page.  If you encounter
40problems, make sure that the web server has write access permissions to the output
41directory that you choose.  Again, your web server documentation has detailed
42information on how to do this.  The command-line interface will not have problems
43with access.
44
45If you need more detailed help, check out INSTALL.
46
47################################################################################
48Release Notes
49################################################################################
50
51Release notes for the newest version are in Release-1.4.4.
52
531.4.4 is out, a stable release.
54
55To learn how to write PHPDoc-style documentation, run phpDocumentor on itself,
56with ./phpdoc -c makedocs.  Before you do, modify users/makedocs.ini to contain
57the proper path values.
58
59If you find a bug please post it at:
60http://pear.php.net/bugs/search.php?cmd=display&package_name%5B%5D=PhpDocumentor
61
62################################################################################
63General Notes
64################################################################################
65phpDocumentor is hosted at phpdoc.org, with downloads and mailing list through
66sourceforge.net, and primary support at PEAR.
67
68webpage:            http://phpdoc.org/
69documentation:      http://phpdoc.org/manual.php
70mirror:             http://phpdocu.sourceforge.net
71projectpage:        http://www.phpdoc.org
72PEAR:               http://pear.php.net/package/PhpDocumentor
73
74For a list of people who have helped work on this project please read the
75Authors file.
76
77phpDocumentor 1.4.4 is released under the LGPL version 2.1, text is in
78LICENSE.
79
80################################################################################
81Feature Notes
82################################################################################
83
84phpDocumentor is a JavaDoc-like automatic documentation generator for PHP,
85written in PHP.  It is the most versatile tool for documenting PHP.
86
87For users new to phpDocumentor, phpDocumentor uses an event-driven parser
88and intermediary data structures that allow it to perform at a level other
89automatic documentors for PHP cannot achieve:
90  --parsing any php file, with multiple classes and functions in the same file
91  --fully compliant with even the most esoteric php syntax
92  	($string = <<< EOF, for example)
93  --ability to generate multiple output formats
94  --extremely fast parsing
95  --error/warnings by line number and file to allow for debugging of
96	documentation tags
97  --multiple output templates to easily customize the look of generated
98	documentation
99  --extensive documentation of the package, including a detailed specification
100	for tags and templates
101  --LGPL License
102
103New since version 1.3.0:
104  --PHP 5 Parsing
105  --hundreds of bugfixes from version 1.2.3
106
107If something is missing from this list make sure sure to file
108a feature request at PEAR:
109http://pear.php.net/bugs/search.php?cmd=display&package_name%5B%5D=PhpDocumentor
110
111If you want to help code that new feature and get it just right, please let us know.
112Any help is greatly appreciated, just contact the
113phpDocumentor team for information on getting started.
114
115phpDocumentor needs php 4.1.0 or greater, but you'll see the best performance
116in the newest version.  The recommended version for phpDocumentor 1.3.0 and up
117is PHP 5.1.3 or newer.
118
119################################################################################
120Command Line notes
121################################################################################
122
123Read the documentation at http://www.phpdoc.org/docs for the most up-to-date
124command-line information.
125
126You can also generate documentation from the source using:
127
128phpdoc -c makedocs
129
130Run this command from the installation directory, and make sure you have full
131write and directory creation permissions or it will not work.
132
133Generated documentation is accessible via Documentation/new/index.html
134
135################################################################################
136
137If you run phpdoc and get :
138bash: ./phpdoc: No such file or directory
139
140Then you haven't installed the cgi version of php.
141Go to your php src dir and try
142make clean
143./configure
144make
145make install
146
147phpdoc should work now.
148
149If you're using php 4.2.0 or higher you will want to use the cli version
150instead of the cgi.  Checkout php.net for details on these changes
151
152
153################################################################################
154Web Interface notes
155################################################################################
156Put phpdoc.php together with the *.inc files someplace on your webserver.
157NEVER USE THE WEB INTERFACE ON A PRODUCTION WEBSERVER.  Allowing your server
158to write files to disk is a serious security risk, and phpDocumentor is not
159designed to work on insecure systems.  Setup php on a development machine
160that has a firewall or no internet connection, and run phpDocumentor from there.
161
162Make sure your webserver can write to wherever you specify as a target or you
163will get lots of errors.
164
165################################################################################
166Thanks
167################################################################################
168Thanks to Sam Blum for his assistance with @example and other enhancements.
169Thanks to William K. Hardeman for his HTML:Smarty:HandS design.
170Thanks to Marco von Ballmoos for transforming the HTML:frames converter and
171    templates into a magnificent work of art.
172Thanks to Andrew Eddie for docbuilder and the CHM Converter enhancements.
173Thanks to Darren Cook for suggesting exciting new features, and making sure that
174    they worked when implemented.
175Thanks to Marko Kaening, Dan Convissor for policing the source and finding bugs
176    that would have otherwise gone undetected.
177Thanks to Juan Pablo Morales for the web interface.
178Thanks to whoever sent me the patch to make phpDocumentor work better in NT...
179	I have your diff and patched the program but i seem to have lost your name...
180	if you send it to me i'll add it to the Authors file.
181Thanks to Florian Clever for the newest set of win32 patches... they seem to have
182	fixed the last of the problems.
183
184    Thanks to EVERYONE who has provided ideas and input, without you,
185                     phpDocumentor would be nothing.
186
187################################################################################
188################################################################################
189If you have any questions please try our mailing list at
190phpdocu-general@lists.sourceforge.net.
191
192joshua eichorn jeichorn@phpdoc.org
193gregory beaver cellog@php.net
194chuck burgess ashnazg@php.net
195
196
197
198vim: set expandtab:
199