Introduction

Welcome to docBuilder.

This is the new web-interface for running, in our opinion, the best in-code documentation compiler there is: phpDocumentor.

What's new in this release? Heaps of things, but here are the headlines:

  • Much greater support for PEAR on both windows and linux
  • CHM, PDF and XML:DocBook/peardoc2 converters are all stable!
  • New tokenizer-based parser is literally twice as fast as the old parser (requires PHP 4.3.0+)
  • New external user-level manual parsing and generation allows cross-linking between API docs and DocBook-format tutorials/manuals!
  • Color syntax source highlighting and cross-referencing with documentation of source code in HTML, CHM and PDF with customizable templating
  • New Configuration files simplify repetitive and complex documentation tasks
  • Brand new extensive manual - which can be generated directly from the source using makedocs.ini!
  • Many improvements to in-code API documentation including new tags, and better handling of in-code html tags
  • New XML:DocBook/peardoc converter makes generating PEAR manual formats easy for PEAR developers along with the --pear command-line switch
  • Many new HTML templates, all of them beautiful thanks to Marco von Ballmoos
  • A brand new web interface thanks to Andrew Eddie!

Config

Use a pre-created config file for form values.
change config directory:
Choose a config:
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.

Files

Files
to parse
This is a group of comma-separated names of php files or tutorials that will be processed by phpDocumentor.
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
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*"
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.

Output

Target
Target is the directory where the output produced by phpDocumentor will reside.
Output
Format
Output type:Converter name:template name

Add the converter in the help box

Screen Shot 		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 or Smarty.
frames templates may be any of:
default, earthli, l0l33t, phpdoc.de, phphtmllib, phpedit, DOM/default, DOM/earthli, DOM/l0l33t, DOM/phphtmllib, or DOM/phpdoc.de.
Smarty templates may be any of:
default, HandS, or PHP
XML:DocBook/peardoc2:default is the only choice for XML in 1.2.2

Options

Generated Documentation Title Choose a title for the generated documentation
Default Package Name Choose a name for the default package
Default Category Name Choose a name for the default category. This is only used by the peardoc2 converter
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.
Parse @access private and @internal/{@internal}} The parameter Parse @access private tells phpDocumentor whether to parse elements with an '@access private' tag in their docblock. In addition, it will turn on parsing of @internal tags and inline {@internal}} sections
Generate Highlighted Source Code The parameter Generate Highlighted Source Code tells phpDocumentor whether to generate highlighted XRef source code similar to PHP-XRef output.
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.
PEAR package repository parsing PEAR package repositories have specific requirements:
  1. Every package is in a directory with the same name.
  2. All private data members and methods begin with an underscore (function _privfunction()).
  3. _Classname() is a destructor
This option recognizes these facts and uses them to make assumptions about packaging and access levels. Note that with PHP 5, the destructor option will be obsolete.

Credits

phpDocumentor written by Joshua Eichorn
Web Interface originally written by Juan Pablo Morales, enhanced by Greg Beaver and super-charged by Andrew Eddie

Joshua Eichorn jeichorn@phpdoc.org
Juan Pablo Morales ju-moral@uniandes.edu.co
Gregory Beaver cellog@php.net
Andrew Eddie eddieajau@users.sourceforge.net

If you have any problems with phpDocumentor, please visit the website: phpdoc.org, or submit a bug at PEAR. 

		Last modified: $Date: 2007-04-19 15:20:57 -0500 (Thu, 19 Apr 2007) $
		Revision: $Revision: 234145 $

Links