phpDocumentor
[ class tree: phpDocumentor ] [ index: phpDocumentor ] [ all elements ]

File: create_examples.php

Source Location: /PhpDocumentor-1.5.0a1/scripts/create_examples.php

Classes:

Page Details:

This file creates example documentation output of all templates.

string $base_package [line 35]

default package name, used to change all non-included files to this package
Default value:   "phpDocumentor"


[ Top ]



array $output [line 55]

directories to output examples into.
Default value:   array(
   $output_directory.'/docs/phpdoc_default'      => 'HTML:default:default',
   $output_directory.'/docs/phpdoc_l0l33t'         => 'HTML:default:l0l33t',
   $output_directory.'/docs/phpdoc_phpdoc_de'      => 'HTML:default:phpdoc.de',
   $output_directory.'/docs/phpdoc_DOM_default'      => 'HTML:default:DOM/default',
   $output_directory.'/docs/phpdoc_DOM_l0l33t'      => 'HTML:default:DOM/l0l33t',
   $output_directory.'/docs/phpdoc_DOM_phpdoc_de'       => 'HTML:default:DOM/phpdoc.de',
   $output_directory.'/docs/phpdoc_smarty_default'    => 'HTML:Smarty:default',
   $output_directory.'/docs/phpdoc_pdf_default'       => 'PDF:default:default',
   $output_directory.'/docs/phpdoc_chm_default'       => 'CHM:default:default',
   )


[ Top ]



string $output_directory [line 30]

Directory the output should go to.

Change this variable to an output directory on your computer

Default value:   "/tmp"


[ Top ]



string $parse_directory [line 49]

location of the files to parse. Change to a location on your computer.

Example:

  1.  $parse_directory "/home/jeichorn/phpdoc";

Default value:   "/you-MUST/change-me/to-fit/your-environment"


[ Top ]



string $title [line 40]

Title of the generated documentation
Default value:   "phpDocumentor Generated Documentation"


[ Top ]



Documentation generated on Sun, 02 Sep 2012 00:01:23 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.