PHP on T R A X
Rapid Application Development Made Easy

root/trunk/trax/doc/phpdoc.ini

Revision 199, 3.7 kB (checked in by haas, 3 years ago)

many fixes, documentation improvements

Line 
1 ;; phpDocumentor parse configuration file
2 ;;
3 ;; This file is designed to cut down on repetitive typing on the
4 ;; command-line or web interface.
5 ;; You can copy this file to create a number of configuration files
6 ;; that can be used with the command-line switch -c, as in phpdoc -c
7 ;; default.ini or phpdoc -c myini.ini.  The web interface will
8 ;; automatically generate a list of .ini files that can be used.
9 ;;
10 ;; Copyright 2002, Greg Beaver <cellog@users.sourceforge.net>
11 ;;
12 ;; WARNING: do not change the name of any command-line parameters,
13 ;; phpDocumentor will ignore them
14
15 [Parse Data]
16 ;; title of all the documentation
17 ;; legal values: any string
18 title = PHP On Trax Documentation
19
20 ;; parse files that start with a . like .bash_profile
21 ;; legal values: true, false
22 hidden = false
23
24 ;; show elements marked @access private in documentation by setting this to on
25 ;; legal values: on, off
26 parseprivate = on
27
28 ;; parse with javadoc-like description (first sentence is always the short description)
29 ;; legal values: on, off
30 javadocdesc = off
31
32 ;; add any custom @tags separated by commas here
33 ;; legal values: any legal tagname separated by commas.
34 ;customtags = mytag1,mytag2
35
36 ;; This is only used by the XML:DocBook/peardoc2 converter
37 defaultcategoryname = Documentation
38
39 ;; what is the main package?
40 ;; legal values: alphanumeric string plus - and _
41 defaultpackagename = PHPonTrax
42
43 ;; output any parsing information?  set to on for cron jobs
44 ;; legal values: on
45 quiet = on
46
47 ;; parse a PEAR-style repository.  Do not turn this on if your project does
48 ;; not have a parent directory named "pear"
49 ;; legal values: on/off
50 ;pear = on
51
52 ;; where should the documentation be written?
53 ;; legal values: a legal path
54 target = .
55
56 ;; Which files should be parsed out as special documentation files, such as README,
57 ;; INSTALL and CHANGELOG?  This overrides the default files found in
58 ;; phpDocumentor.ini (this file is not a user .ini file, but the global file)
59 readmeinstallchangelog = README, INSTALL, CHANGELOG, NEWS, FAQ, LICENSE
60
61 ;; limit output to the specified packages, even if others are parsed
62 ;; legal values: package names separated by commas
63 ;packageoutput = package1,package2
64
65 ;; comma-separated list of files to parse
66 ;; legal values: paths separated by commas
67 ;filename = /path/to/file1,/path/to/file2,fileincurrentdirectory
68
69 ;; comma-separated list of directories to parse
70 ;; legal values: directory paths separated by commas
71 ;directory = /path1,/path2,.,..,subdirectory
72 ;directory = /home/jeichorn/cvs/pear
73 directory = ../
74
75 ;; template base directory (the equivalent directory of <installdir>/phpDocumentor)
76 ;templatebase = /path/to/my/templates
77
78 ;; directory to find any example files in through @example and {@example} tags
79 ;examplesdir = /path/to/my/templates
80
81 ;; comma-separated list of files, directories or wildcards ? and * (any wildcard) to ignore
82 ;; legal values: any wildcard strings separated by commas
83 ;ignore = /path/to/ignore*,*list.php,myfile.php,subdirectory/
84
85 ;; comma-separated list of Converters to use in outputformat:Convertername:templatedirectory format
86 ;; legal values: HTML:frames:default,HTML:frames:l0l33t,HTML:frames:phpdoc.de,HTML:frames:phphtmllib,
87 ;;               HTML:frames:earthli,
88 ;;               HTML:frames:DOM/default,HTML:frames:DOM/l0l33t,HTML:frames:DOM/phpdoc.de,
89 ;;               HTML:frames:DOM/phphtmllib,HTML:frames:DOM/earthli
90 ;;               HTML:Smarty:default,HTML:Smarty:PHP,HTML:Smarty:HandS
91 ;;               PDF:default:default,CHM:default:default,XML:DocBook/peardoc2:default
92 output=HTML:Smarty:PHP
93
94 ;; turn this option on if you want highlighted source code for every file
95 ;; legal values: on/off
96 sourcecode = on
Note: See TracBrowser for help on using the browser.