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

Procedural File: create_examples.php

Source Location: /scripts/create_examples.php

Page Details

This file creates example documentation output of all templates.

Filesource:  Source Code for this file
Globals
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 51]

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 45]

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

Default value:  "/home/jeichorn/phpdoc"

[ Top ]

string   $title [line 40]

Title of the generated documentation

Default value:  "phpDocumentor Generated Documentation"

[ Top ]



Documentation generated on Tue, 24 Oct 2006 09:22:01 -0500 by phpDocumentor 1.3.1