| 1 |
lars |
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 |
;; ALL .ini files must be in the user subdirectory of phpDocumentor with an extension of .ini
|
|
|
9 |
;;
|
|
|
10 |
;; Copyright 2002, Greg Beaver <cellog@php.net>
|
|
|
11 |
;;
|
|
|
12 |
;; WARNING: do not change the
|
|
|
13 |
|
|
|
14 |
[Parse Data]
|
|
|
15 |
;; title of all the documentation
|
|
|
16 |
;; legal values: any string
|
|
|
17 |
title = phpDocumentor Manual
|
|
|
18 |
|
|
|
19 |
;; parse files that start with a . like .bash_profile
|
|
|
20 |
;; legal values: true, false
|
|
|
21 |
hidden = false
|
|
|
22 |
|
|
|
23 |
;; follow symlinks
|
|
|
24 |
;; legal values: true, false, on, off
|
|
|
25 |
;ignoresymlinks = false
|
|
|
26 |
|
|
|
27 |
;; show elements marked @access private in documentation by setting this to on
|
|
|
28 |
;; legal values: on, off
|
|
|
29 |
parseprivate = off
|
|
|
30 |
|
|
|
31 |
;; parse with javadoc-like description (first sentence is always the short description)
|
|
|
32 |
;; legal values: on, off
|
|
|
33 |
javadocdesc = off
|
|
|
34 |
|
|
|
35 |
;; add any custom @tags separated by commas here
|
|
|
36 |
;; legal values: any legal tagname separated by commas.
|
|
|
37 |
;customtags = mytag1,mytag2
|
|
|
38 |
|
|
|
39 |
;; what is the main package?
|
|
|
40 |
;; legal values: alphanumeric string plus - and _
|
|
|
41 |
defaultpackagename = phpDocumentor
|
|
|
42 |
|
|
|
43 |
;; what is main category?
|
|
|
44 |
;; legal values: one alphanumeric "word"
|
|
|
45 |
defaultcategoryname = ToolsAndUtilities
|
|
|
46 |
|
|
|
47 |
;; output any parsing information? set to on for cron jobs
|
|
|
48 |
;; legal values: on
|
|
|
49 |
;quiet = on
|
|
|
50 |
|
|
|
51 |
;; capture undocumented elements and list in errors.html
|
|
|
52 |
;; legal values: true, false, on, off
|
|
|
53 |
;undocumentedelements = on
|
|
|
54 |
|
|
|
55 |
;; where should the documentation be written?
|
|
|
56 |
;; legal values: a legal path
|
|
|
57 |
target = /usr/share/php/docs/PhpDocumentor/Documentation/new
|
|
|
58 |
|
|
|
59 |
;; limit output to the specified packages, even if others are parsed
|
|
|
60 |
;; legal values: package names separated by commas
|
|
|
61 |
;packageoutput = package1,package2
|
|
|
62 |
|
|
|
63 |
;; comma-separated list of files to parse
|
|
|
64 |
;; legal values: paths separated by commas
|
|
|
65 |
;filename = /path/to/file1,/path/to/file2,fileincurrentdirectory
|
|
|
66 |
;filename = /usr/share/php/docs/PhpDocumentor/README,/usr/share/php/docs/PhpDocumentor/ChangeLog,/usr/share/php/docs/PhpDocumentor/Release-1.4.3,/usr/share/php/docs/PhpDocumentor/FAQ
|
|
|
67 |
|
|
|
68 |
;; comma-separated list of directories to parse
|
|
|
69 |
;; legal values: directory paths separated by commas
|
|
|
70 |
;directory = /path1,/path2,.,..,subdirectory
|
|
|
71 |
;directory = /home/jeichorn/cvs/pear
|
|
|
72 |
;directory = /you-MUST/change-me/to-fit/your-environment
|
|
|
73 |
directory = /usr/share/php/PhpDocumentor,/usr/share/php/docs/PhpDocumentor
|
|
|
74 |
|
|
|
75 |
releaseinstallchangelog = Release-1.4.3,ChangeLog,README,FAQ,INSTALL,LICENSE,Authors
|
|
|
76 |
|
|
|
77 |
;; comma-separated list of files, directories or wildcards ? and * (any wildcard) to ignore
|
|
|
78 |
;; legal values: any wildcard strings separated by commas
|
|
|
79 |
;; remember, this pathing is RELATIVE to the top-most directory in your "directory" value
|
|
|
80 |
;ignore = path/to/ignore*,*list.php,myfile.php,subdirectory/
|
|
|
81 |
ignore = scripts/,Documentation/
|
|
|
82 |
|
|
|
83 |
;; comma-separated list of Converters to use in outputformat:Convertername:templatedirectory format
|
|
|
84 |
;; legal values: HTML:frames:default,HTML:frames:earthli,HTML:frames:l0l33t,HTML:frames:phpdoc.de,HTML:frames:phpedit,HTML:frames:phphtmllib,
|
|
|
85 |
;; HTML:frames:DOM/default,HTML:frames:DOM/earthli,HTML:frames:DOM/l0l33t,HTML:frames:DOM/phpdoc.de,HTML:frames:DOM/phphtmllib,
|
|
|
86 |
;; HTML:Smarty:default,HTML:Smarty:PHP,HTML:Smarty:HandS,
|
|
|
87 |
;; PDF:default:default,
|
|
|
88 |
;; CHM:default:default,
|
|
|
89 |
;; XML:DocBook/peardoc2:default
|
|
|
90 |
output=HTML:Smarty:HandS
|
|
|
91 |
|
|
|
92 |
;; turn this option on if you want highlighted source code for every file
|
|
|
93 |
;; legal values: on/off
|
|
|
94 |
;sourcecode = on
|