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

Source for file create_examples.php

Documentation is available at create_examples.php

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

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