phpdoc.sh

   1 #!/bin/sh
   2
   3 # This script creates the developer documentation for ISSO with all of the necessary options set to their proper values
   4 # SVN $Id$
   5
   6 rm -rf ./apidoc
   7 mkdir apidoc
   8
   9 #################
  10 ## OUTPUT LIST ##
  11 #################
  12 # HTML:frames:default (purple, white)
  13 # HTML:frames:phpdoc.de (grey, tonal)
  14 # HTML:frames:phphtmllib (grey, blue, red)
  15 # HTML:frames:DOM/XX (JS: replace XX with above options)
  16 # HTML:Smarty:PHP (php.net style)
  17 # HTML:Smarty:HandS (light tans)
  18 # PDF:default:default (PDF, ugly)
  19
  20 ##################
  21 ## OPTIONS LIST ##
  22 ##################
  23 # parse/directory
  24 # target/result
  25 # ignore
  26 # do hidden files
  27 # title
  28 # parse private
  29 # default name/package
  30 # default category
  31 # hilight source code
  32 # output options
  33
  34 phpdoc -d . -t ./apidoc,./dev -i _*.php -dh off -ti "Iris Studios Shared Object Framework" -pp on -dn ISSO -dc ISSO -s off -o HTML:Smarty:PHP > ./apidoc/log.txt