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