Added description of what phpdoc.sh does
[isso.git] / 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
8 #################
9 ## OUTPUT LIST ##
10 #################
11 # HTML:frames:default (purple, white)
12 # HTML:frames:phpdoc.de (grey, tonal)
13 # HTML:frames:phphtmllib (grey, blue, red)
14 # HTML:frames:DOM/XX (JS: replace XX with above options)
15 # HTML:Smarty:PHP (php.net style)
16 # HTML:Smarty:HandS (light tans)
17 # PDF:default:default (PDF, ugly)
18
19 ##################
20 ## OPTIONS LIST ##
21 ##################
22 # parse/directory
23 # target/result
24 # ignore
25 # do hidden files
26 # title
27 # parse private
28 # default name/package
29 # default category
30 # hilight source code
31 # output options
32
33 phpdoc -d . -t ./apidoc -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