mods/phpdoc2/PhpDocumentor/scripts/makedoc.sh

   1 #!/bin/bash\r
   2 # $Id: makedoc.sh,v 1.2 2007/12/10 01:11:19 ashnazg Exp $ \r
   3 \r
   4 #/**\r
   5 #  * makedoc - PHPDocumentor script to save your settings\r
   6 #  * \r
   7 #  * Put this file inside your PHP project homedir, edit its variables and run whenever you wants to\r
   8 #  * re/make your project documentation.\r
   9 #  * \r
  10 #  * The version of this file is the version of PHPDocumentor it is compatible.\r
  11 #  * \r
  12 #  * It simples run phpdoc with the parameters you set in this file.\r
  13 #  * NOTE: Do not add spaces after bash variables.\r
  14 #  *\r
  15 #  * @copyright         makedoc.sh is part of PHPDocumentor project {@link http://freshmeat.net/projects/phpdocu/} and its LGPL\r
  16 #  * @author            Roberto Berto <darkelder (inside) users (dot) sourceforge (dot) net>\r
  17 #  * @version           Release-1.1.0\r
  18 #  */\r
  19 \r
  20 \r
  21 ##############################\r
  22 # should be edited\r
  23 ##############################\r
  24 \r
  25 #/**\r
  26 #  * title of generated documentation, default is 'Generated Documentation'\r
  27 #  * \r
  28 #  * @var               string TITLE\r
  29 #  */\r
  30 TITLE="Your Project Documentation"\r
  31 \r
  32 #/** \r
  33 #  * name to use for the default package. If not specified, uses 'default'\r
  34 #  *\r
  35 #  * @var               string PACKAGES\r
  36 #  */\r
  37 PACKAGES="yourProject"\r
  38 \r
  39 #/** \r
  40 #  * name of a directory(s) to parse directory1,directory2\r
  41 #  * $PWD is the directory where makedoc.sh \r
  42 #  *\r
  43 #  * @var               string PATH_PROJECT\r
  44 #  */\r
  45 PATH_PROJECT=$PWD\r
  46 \r
  47 #/**\r
  48 #  * path of PHPDoc executable\r
  49 #  *\r
  50 #  * @var               string PATH_PHPDOC\r
  51 #  */\r
  52 PATH_PHPDOC=~/phpdoc/phpdoc\r
  53 \r
  54 #/**\r
  55 #  * where documentation will be put\r
  56 #  *\r
  57 #  * @var               string PATH_DOCS\r
  58 #  */\r
  59 PATH_DOCS=$PWD/docs\r
  60 \r
  61 #/**\r
  62 #  * what outputformat to use (html/pdf)\r
  63 #  *\r
  64 #  * @var               string OUTPUTFORMAT\r
  65 #  */\r
  66 OUTPUTFORMAT=HTML\r
  67 \r
  68 #/** \r
  69 #  * converter to be used\r
  70 #  *\r
  71 #  * @var               string CONVERTER\r
  72 #  */\r
  73 CONVERTER=Smarty\r
  74 \r
  75 #/**\r
  76 #  * template to use\r
  77 #  *\r
  78 #  * @var               string TEMPLATE\r
  79 #  */\r
  80 TEMPLATE=default\r
  81 \r
  82 #/**\r
  83 #  * parse elements marked as private\r
  84 #  *\r
  85 #  * @var               bool (on/off)           PRIVATE\r
  86 #  */\r
  87 PRIVATE=off\r
  88 \r
  89 # make documentation\r
  90 "$PATH_PHPDOC" -d "$PATH_PROJECT" -t "$PATH_DOCS" -ti "$TITLE" -dn $PACKAGES \\r
  91 -o $OUTPUTFORMAT:$CONVERTER:$TEMPLATE -pp $PRIVATE\r
  92 \r
  93 \r
  94 # vim: set expandtab :\r