Assembla home | Assembla project page
 

Documentation: grabbldoc.ini

File grabbldoc.ini, 1.7 kB (added by bas, 2 years ago)

phpDocumentor configuration file for Grabbl

Line 
1 ;; phpDocumentor parse configuration file
2 ;;
3 ;; Copyright 2002, Greg Beaver <cellog@users.sourceforge.net>
4 ;;
5 ;; WARNING: do not change the name of any command-line parameters, phpDocumentor will ignore them
6
7 [Parse Data]
8 ;; title of all the documentation
9 ;; legal values: any string
10 title = Grabbl Development Manual
11
12 ;; This is only used by the XML:DocBook/peardoc2 converter
13 defaultcategoryname = Documentation
14
15 ;; what is the main package?
16 ;; legal values: alphanumeric string plus - and _
17 defaultpackagename = grabbl
18
19 ;; comma-separated list of directories to parse
20 ;; legal values: directory paths separated by commas
21 directory = /path/to/Grabbl/trunk
22
23 ;; where should the documentation be written?
24 ;; legal values: a legal path
25 target = /path/to/Grabbldoc
26
27 ;; comma-separated list of Converters to use in outputformat:Convertername:templatedirectory format
28 output=HTML:Smarty:Grabbl
29
30 ;; turn this option on if you want highlighted source code for every file
31 ;; legal values: on/off
32 sourcecode = on
33
34 ;; parse files that start with a . like .bash_profile
35 ;; legal values: true, false
36 hidden = false
37
38 ;; show elements marked @access private in documentation by setting this to on
39 ;; legal values: on, off
40 parseprivate = off
41
42 ;; parse with javadoc-like description (first sentence is always the short description)
43 ;; legal values: on, off
44 javadocdesc = off
45
46 ;; Which files should be parsed out as special documentation files, such as README,
47 ;; INSTALL and CHANGELOG?
48 readmeinstallchangelog = README, INSTALL, FAQ, LICENSE, COPYING
49
50 ;; comma-separated list of files, directories or wildcards ? and * (any wildcard) to ignore
51 ;; legal values: any wildcard strings separated by commas
52 ignore = .svn/