+++ /dev/null
-$Id: README,v 1.12 2007/09/26 02:57:11 ashnazg Exp $\r
-\r
-################################################################################\r
- phpDocumentor\r
-\r
-################################################################################\r
-Installation\r
-################################################################################\r
-\r
-Installation for phpDocumentor is as simple as installing PHP and a web server.\r
-If you need help installing a webserver or php, refer to the documentation that\r
-comes with the webserver or with php. phpDocumentor also runs from the \r
-command-line, and only requires that PHP CLI version be installed.\r
-\r
-All users with PEAR should either install this version directly from the \r
-package.xml file included in the distribution, or install via \r
-"pear install PhpDocumentor." \r
-\r
-The command-line interface "phpdoc" will be in the path, you can use it \r
-immediately on both windows and unix. The web interface is in a subdirectory of \r
-your document root, be sure to "pear config-set data_dir /path/to/my/htdocs" \r
-prior to installation.\r
-\r
-To use phpDocumentor as a command-line tool in *nix-based systems, simply run \r
-the phpdoc script. In windows, run\r
-"c:\php\php.exe phpdoc" where C:\php is the path to the cli version of php.\r
-The phpdoc command-line interface will not run with the ISAPI module of PHP.\r
-To see the command line options, use phpdoc -h or read at the bottom of this\r
-README.\r
-\r
-There is a BASH shell script that you can put inside your project that can save\r
-time writing command-line options of phpdoc. Simply copy makedoc.sh to your\r
-project path and edit it. When you wish to rebuild the documentation, run it again. \r
-Note that .ini scripts are far easier to edit and are supported via "phpdoc -c file.ini"\r
-\r
-To use phpDocumentor's web interface, install the files into a subdirectory of\r
-your document root (read the webserver's documentation for more information if you\r
-don't understand how to install into a subdirectory of your document root).\r
-Then, browse to the web page as you would to any other web page. If you encounter\r
-problems, make sure that the web server has write access permissions to the output\r
-directory that you choose. Again, your web server documentation has detailed\r
-information on how to do this. The command-line interface will not have problems\r
-with access.\r
-\r
-If you need more detailed help, check out INSTALL.\r
-\r
-################################################################################\r
-Release Notes\r
-################################################################################\r
-\r
-Release notes for the newest version are in Release-1.4.1.\r
-\r
-1.4.1 is out, a stable release.\r
-\r
-To learn how to write PHPDoc-style documentation, run phpDocumentor on itself, \r
-with ./phpdoc -c makedocs. Before you do, modify users/makedocs.ini to contain \r
-the proper path values.\r
-\r
-If you find a bug please post it at:\r
-http://pear.php.net/bugs/search.php?cmd=display&package_name%5B%5D=PhpDocumentor\r
-\r
-################################################################################\r
-General Notes\r
-################################################################################\r
-phpDocumentor is hosted at phpdoc.org, with downloads and mailing list through \r
-sourceforge.net, and primary support at PEAR.\r
-\r
-webpage: http://phpdoc.org/\r
-documentation: http://phpdoc.org/manual.php\r
-mirror: http://phpdocu.sourceforge.net\r
-projectpage: http://www.phpdoc.org\r
-PEAR: http://pear.php.net/package/PhpDocumentor\r
-\r
-For a list of people who have helped work on this project please read the \r
-Authors file.\r
-\r
-phpDocumentor 1.4.1 is released under the LGPL version 2.1, text is in\r
-LICENSE.\r
-\r
-################################################################################\r
-Feature Notes\r
-################################################################################\r
-\r
-phpDocumentor is a JavaDoc-like automatic documentation generator for PHP,\r
-written in PHP. It is the most versatile tool for documenting PHP.\r
-\r
-For users new to phpDocumentor, phpDocumentor uses an event-driven parser\r
-and intermediary data structures that allow it to perform at a level other\r
-automatic documentors for PHP cannot achieve:\r
- --parsing any php file, with multiple classes and functions in the same file\r
- --fully compliant with even the most esoteric php syntax \r
- ($string = <<< EOF, for example)\r
- --ability to generate multiple output formats\r
- --extremely fast parsing\r
- --error/warnings by line number and file to allow for debugging of\r
- documentation tags\r
- --multiple output templates to easily customize the look of generated\r
- documentation\r
- --extensive documentation of the package, including a detailed specification\r
- for tags and templates\r
- --LGPL License\r
- \r
-New since version 1.3.0:\r
- --PHP 5 Parsing\r
- --hundreds of bugfixes from version 1.2.3\r
-\r
-If something is missing from this list make sure sure to file\r
-a feature request at PEAR:\r
-http://pear.php.net/bugs/search.php?cmd=display&package_name%5B%5D=PhpDocumentor\r
-\r
-If you want to help code that new feature and get it just right, please let us know.\r
-Any help is greatly appreciated, just contact the \r
-phpDocumentor team for information on getting started.\r
-\r
-phpDocumentor needs php 4.1.0 or greater, but you'll see the best performance\r
-in the newest version. The recommended version for phpDocumentor 1.3.0 and up \r
-is PHP 5.1.3 or newer.\r
-\r
-################################################################################\r
-Command Line notes\r
-################################################################################\r
-\r
-Read the documentation at http://www.phpdoc.org/docs for the most up-to-date\r
-command-line information.\r
-\r
-You can also generate documentation from the source using:\r
-\r
-phpdoc -c makedocs\r
-\r
-Run this command from the installation directory, and make sure you have full\r
-write and directory creation permissions or it will not work.\r
-\r
-Generated documentation is accessible via Documentation/new/index.html\r
-\r
-################################################################################\r
-\r
-If you run phpdoc and get :\r
-bash: ./phpdoc: No such file or directory\r
-\r
-Then you haven't installed the cgi version of php.\r
-Go to your php src dir and try\r
-make clean\r
-./configure\r
-make\r
-make install\r
-\r
-phpdoc should work now.\r
-\r
-If you're using php 4.2.0 or higher you will want to use the cli version\r
-instead of the cgi. Checkout php.net for details on these changes\r
-\r
-\r
-################################################################################\r
-Web Interface notes\r
-################################################################################\r
-Put phpdoc.php together with the *.inc files someplace on your webserver.\r
-NEVER USE THE WEB INTERFACE ON A PRODUCTION WEBSERVER. Allowing your server\r
-to write files to disk is a serious security risk, and phpDocumentor is not\r
-designed to work on insecure systems. Setup php on a development machine\r
-that has a firewall or no internet connection, and run phpDocumentor from there.\r
-\r
-Make sure your webserver can write to wherever you specify as a target or you\r
-will get lots of errors.\r
-\r
-################################################################################\r
-Thanks\r
-################################################################################\r
-Thanks to Sam Blum for his assistance with @example and other enhancements.\r
-Thanks to William K. Hardeman for his HTML:Smarty:HandS design.\r
-Thanks to Marco von Ballmoos for transforming the HTML:frames converter and\r
- templates into a magnificent work of art.\r
-Thanks to Andrew Eddie for docbuilder and the CHM Converter enhancements.\r
-Thanks to Darren Cook for suggesting exciting new features, and making sure that\r
- they worked when implemented.\r
-Thanks to Marko Kaening, Dan Convissor for policing the source and finding bugs\r
- that would have otherwise gone undetected.\r
-Thanks to Juan Pablo Morales for the web interface.\r
-Thanks to whoever sent me the patch to make phpDocumentor work better in NT...\r
- I have your diff and patched the program but i seem to have lost your name...\r
- if you send it to me i'll add it to the Authors file.\r
-Thanks to Florian Clever for the newest set of win32 patches... they seem to have\r
- fixed the last of the problems.\r
- \r
- Thanks to EVERYONE who has provided ideas and input, without you,\r
- phpDocumentor would be nothing.\r
-\r
-################################################################################\r
-################################################################################\r
-If you have any questions please try our mailing list at \r
-phpdocu-general@sourceforge.net.\r
-\r
-joshua eichorn jeichorn@phpdoc.org\r
-gregory beaver cellog@php.net\r
-chuck burgess ashnazg@php.net\r
-\r
-\r
-\r
-vim: set expandtab: \r
projects / atutor.git / blobdiff