Start adding basic login infrastructure (still needs styling)
[gitphp.git] / util / phpdoc.ini
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
;; phpDocumentor parse configuration file
 
[Parse Data]
;; title of all the documentation
;; legal values: any string
title = GitPHP Documentation
 
;; parse files that start with a . like .bash_profile
;; legal values: true, false
hidden = false
 
;; show elements marked @access private in documentation by setting this to on
;; legal values: on, off
parseprivate = on
 
;; parse with javadoc-like description (first sentence is always the short description)
;; legal values: on, off
javadocdesc = off
 
;; add any custom @tags separated by commas here
;; legal values: any legal tagname separated by commas.
;customtags = mytag1,mytag2
 
;; This is only used by the XML:DocBook/peardoc2 converter
defaultcategoryname = Documentation
 
;; what is the main package?
;; legal values: alphanumeric string plus - and _
defaultpackagename = GitPHP
 
;; output any parsing information?  set to on for cron jobs
;; legal values: on
;quiet = on
 
;; parse a PEAR-style repository.  Do not turn this on if your project does
;; not have a parent directory named "pear"
;; legal values: on/off
;pear = on
 
;; where should the documentation be written?
;; legal values: a legal path
;target = /home/cellog/output
target = doc/code
 
;; Which files should be parsed out as special documentation files, such as README,
;; INSTALL and CHANGELOG?  This overrides the default files found in
;; phpDocumentor.ini (this file is not a user .ini file, but the global file)
readmeinstallchangelog = AUTHORS, COPYING, README, TRANSLATING
 
;; limit output to the specified packages, even if others are parsed
;; legal values: package names separated by commas
;packageoutput = package1,package2
 
;; comma-separated list of files to parse
;; legal values: paths separated by commas
filename = index.php
 
;; comma-separated list of directories to parse
;; legal values: directory paths separated by commas
;directory = /path1,/path2,.,..,subdirectory
;directory = /home/jeichorn/cvs/pear
;directory = /home/cellog/workspace/phpdoc
directory = config,include,doc
 
;; template base directory (the equivalent directory of <installdir>/phpDocumentor)
;templatebase = /path/to/my/templates
 
;; directory to find any example files in through @example and {@example} tags
;examplesdir = /path/to/my/templates
 
;; comma-separated list of files, directories or wildcards ? and * (any wildcard) to ignore
;; legal values: any wildcard strings separated by commas
;; remember, this pathing is RELATIVE to the top-most directory in your "directory" value
;ignore = path/to/ignore*,*list.php,myfile.php,subdirectory/
ignore = pear-*,templates/,Documentation/,test*.php,Lexer.inc,gitphp.conf.php,projects.conf.php,block.t.php
 
;; comma-separated list of Converters to use in outputformat:Convertername:templatedirectory format
;; legal values: HTML:frames:default,HTML:frames:l0l33t,HTML:frames:phpdoc.de,HTML:frames:phphtmllib,
;;               HTML:frames:earthli,
;;               HTML:frames:DOM/default,HTML:frames:DOM/l0l33t,HTML:frames:DOM/phpdoc.de,
;;               HTML:frames:DOM/phphtmllib,HTML:frames:DOM/earthli
;;               HTML:Smarty:default,HTML:Smarty:PHP,HTML:Smarty:HandS
;;               PDF:default:default,CHM:default:default,XML:DocBook/peardoc2:default
output=HTML:frames:DOM/earthli
 
;; turn this option on if you want highlighted source code for every file
;; legal values: on/off
sourcecode = off
 
comments