// Joshua Eichorn // Gregory Beaver // // phpDocumentor, a program for creating javadoc style documentation from php code // Copyright (C) 2000-2002 Joshua Eichorn // // This program is free software; you can redistribute it and/or modify // it under the terms of the GNU General Public License as published by // the Free Software Foundation; either version 2 of the License, or // (at your option) any later version. // // This program is distributed in the hope that it will be useful, // but WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. // // You should have received a copy of the GNU General Public License // along with this program; if not, write to the Free Software // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA // // // Copyleft 2001 Juan Pablo Morales // set up include path so we can find all files, no matter what $GLOBALS['_phpDocumentor_install_dir'] = dirname(realpath(__FILE__)); // add my directory to the include path, and make it first, should fix any errors if (substr(PHP_OS, 0, 3) == 'WIN') ini_set('include_path',$GLOBALS['_phpDocumentor_install_dir'].';'.ini_get('include_path')); else ini_set('include_path',$GLOBALS['_phpDocumentor_install_dir'].':'.ini_get('include_path')); /** * common file information */ include_once("phpDocumentor/common.inc.php"); if (!function_exists('version_compare')) { print "phpDocumentor requires PHP version 4.1.0 or greater to function"; exit; } // find the .ini directory by parsing phpDocumentor.ini and extracting _phpDocumentor_options[userdir] $ini = phpDocumentor_parse_ini_file($_phpDocumentor_install_dir . PATH_DELIMITER . 'phpDocumentor.ini', true); if (isset($ini['_phpDocumentor_options']['userdir'])) $configdir = $ini['_phpDocumentor_options']['userdir']; else $configdir = $_phpDocumentor_install_dir . '/user'; // allow the user to change this at runtime if (!empty($_REQUEST['altuserdir'])) $configdir = $_REQUEST['altuserdir']; ?> Form to submit to phpDocumentor v<?php print PHPDOCUMENTOR_VER; ?> "; echo "

Parsing Files ...

"; flush(); echo "
\n";
    /** phpdoc.inc */
    include("phpDocumentor/phpdoc.inc");
    echo "
\n"; echo "

Operation Completed!!

"; } else { ?>

Form to submit to phpDocumentor v

Use a pre-created config file for form values.
Normally, phpDocumentor uses the form values from this form to set up parsing. In version 1.2, phpDocumentor allows you to "save" form values in configuration files so that you can replicate common complicated documentation tasks with only one time. Just choose a config file below or create a new one and refresh this page to choose it.
change config directory:changed to "'.$_REQUEST['altuserdir'].'"'; ?> Choose a config:
Generated Documentation Title
Choose a title for the generated documentation
Default Package Name
Choose a name for the default package
Target
Target is the directory where the output produced by phpDocumentor will reside

Add the directory in the help box
Custom Tags
Custom Tags is a comma-separated list of tags you want phpDocumentor to include as valid tags in this parse. An example would be "value, size" to allow @value and @size tags.
Packages to parse
The parameter packages is a group of comma separated names of abstract packages that will be processed by phpDocumentor. All package names must be separated by commas.
Files to parse
This is a group of comma-separated names of php files or tutorials that will be processed by phpDocumentor.

Add the file in the help box
Directory to parse
This is a group of comma-separated directories where php files or tutorials are found that will be processed by phpDocumentor. phpDocumentor automatically parses subdirectories

Add the directory in the help box
Output Information

Output Information is a comma-separated list of Outputformat:Converter:Templates to apply to the output. The Converters must be classes descended from Converter defined in the phpDocumentor files, or parsing will not work. Outputformat may be HTML, XML, PDF, or CHM (case-sensitive) in version 1.2. There is only one Converter for both CHM and PDF, default. There are 2 HTML Converters, frames and Smarty. frames templates may be any of:

default, l0l33t, phpdoc.de, phphtmllib, phpedit, DOM/default, DOM/l0l33t, or DOM/phpdoc.de. Smarty templates may be any of:

default or PHP.
There is only 1 template for all other Converters, default
Output type:Converter name:template name

Add the converter in the help box
Files to ignore
A list of files (full path or filename), and patterns to ignore. Patterns may use wildcards * and ?. To ignore all subdirectories named "test" for example, using "test/" To ignore all files and directories with test in their name use "*test*"
Add the directory in the help box
Parse @access private
The parameter Parse @access private tells phpDocumentor whether to parse elements with an "@access private" tag in their docblock
Parse private
JavaDoc-compliant Description parsing.
Normally, phpDocumentor uses several rules to determine the short description. This switch asks phpDocumentor to simply search for the first period (.) and use it to delineate the short description. In addition, the short description will not be separated from the long description
JavaDoc-compliant Description


A little help
Since remember long path is not that easy here is a little file control to view names of files that can the be aggregated to the different properties

Web-Interface Author:

Juan Pablo Morales
ju-moral@uniandes.edu.co
Gregory Beaver
cellog@users.sourceforge.net, all post-0.3.0 modifications

If you have any problems with phpDocumentor, please visit the website: phpdocu.sourceforge.net and submit a bug 

Last modified: $Date: 2005/10/17 18:15:16 $
Revision: $Revision: 1.1 $