mods/phpdoc2/PhpDocumentor/scripts/create_examples.php

   1 <?php\r
   2 //\r
   3 // +------------------------------------------------------------------------+\r
   4 // | phpDocumentor                                                          |\r
   5 // +------------------------------------------------------------------------+\r
   6 // | Copyright (c) 2000-2003 Joshua Eichorn, Gregory Beaver                 |\r
   7 // | Email         jeichorn@phpdoc.org, cellog@phpdoc.org                   |\r
   8 // | Web           http://www.phpdoc.org                                    |\r
   9 // | Mirror        http://phpdocu.sourceforge.net/                          |\r
  10 // | PEAR          http://pear.php.net/package/PhpDocumentor                |\r
  11 // +------------------------------------------------------------------------+\r
  12 // | This source file is subject to version 3.00 of the PHP License,        |\r
  13 // | that is available at http://www.php.net/license/3_0.txt.               |\r
  14 // | If you did not receive a copy of the PHP license and are unable to     |\r
  15 // | obtain it through the world-wide-web, please send a note to            |\r
  16 // | license@php.net so we can mail you a copy immediately.                 |\r
  17 // +------------------------------------------------------------------------+\r
  18 //\r
  19 // ./phpdoc -d /home/jeichorn/phpdoc -dn phpDocumentor -ti "phpDocumentor generated docs" -td templates/DOM/l0l33t -t /tmp/phpdoc_DOM_l0l33t\r
  20 /**\r
  21 * This file creates example documentation output of all templates.\r
  22 * @package phpDocumentor\r
  23 */\r
  24 \r
  25 /**\r
  26 * Directory the output should go to.\r
  27 * Change this variable to an output directory on your computer\r
  28 * @global       string  $output_directory\r
  29 */\r
  30 $output_directory = "/tmp";\r
  31 /**\r
  32 * default package name, used to change all non-included files to this package\r
  33 * @global       string  $base_package\r
  34 */\r
  35 $base_package = "phpDocumentor";\r
  36 /**\r
  37 * Title of the generated documentation\r
  38 * @global       string  $title\r
  39 */\r
  40 $title = "phpDocumentor Generated Documentation";\r
  41 /**\r
  42 * location of the files to parse.  Change to a location on your computer.\r
  43 * Example:\r
  44 * <code>\r
  45 * $parse_directory = "/home/jeichorn/phpdoc";\r
  46 * </code>\r
  47 * @global       string  $parse_directory\r
  48 */\r
  49 $parse_directory = "/you-MUST/change-me/to-fit/your-environment";\r
  50 \r
  51 /**\r
  52 * directories to output examples into.\r
  53 * @global       array   $output\r
  54 */\r
  55 $output = array(\r
  56         $output_directory.'/docs/phpdoc_default'                => 'HTML:default:default',\r
  57         $output_directory.'/docs/phpdoc_l0l33t'                 => 'HTML:default:l0l33t',\r
  58         $output_directory.'/docs/phpdoc_phpdoc_de'              => 'HTML:default:phpdoc.de',\r
  59         $output_directory.'/docs/phpdoc_DOM_default'            => 'HTML:default:DOM/default',\r
  60         $output_directory.'/docs/phpdoc_DOM_l0l33t'             => 'HTML:default:DOM/l0l33t',\r
  61         $output_directory.'/docs/phpdoc_DOM_phpdoc_de'          => 'HTML:default:DOM/phpdoc.de',\r
  62         $output_directory.'/docs/phpdoc_smarty_default'         => 'HTML:Smarty:default',\r
  63         $output_directory.'/docs/phpdoc_pdf_default'            => 'PDF:default:default',\r
  64         $output_directory.'/docs/phpdoc_chm_default'            => 'CHM:default:default',\r
  65         );\r
  66 \r
  67 foreach($output as $output => $template)\r
  68 {\r
  69         passthru("./phpdoc -d /home/jeichorn/phpdoc -dn $base_package -ti \"$title\" -td $template -t $output");\r
  70 }\r