Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 106 lines (86 sloc) 4.469 kB
2023260 @dleffler PHPDocumentor configuration file to create Exponent API Documentation…
dleffler authored
1 ;; Exponent CMS phpDocumentor parse configuration file
2 ;;
3 ;; This is a configuration file that can be used with the command-line switch -c, as in phpdoc -c phpdoc.ini or
4 ;; loaded in the web interface.
5 ;;
6 ;; It is assumed you have a fully functional installation of phpDocumentor
7 ;;
8 ;; (shell)
9 ;; 'cd' to the project folder
10 ;; 'phpdoc -c phpdoc.ini'
11 ;;
12 ;; (web)
13 ;; browse to the phpDocumentor folder of your web server
14 ;; select the 'Config' tab
15 ;; enter the project folder name in the 'change config directory: box and click the 'Change' button
16 ;; select the 'phpdoc.ini' config in the dropdown and click on the 'Go' button
17 ;;
18
19 [Parse Data]
20 ;; title of all the documentation
21 ;; legal values: any string
abb1b83 @dleffler Updates copyright to 2012 and standardizes header across ALL files
dleffler authored
22 title = Exponent 2.0.5 API Documentation
2023260 @dleffler PHPDocumentor configuration file to create Exponent API Documentation…
dleffler authored
23
24 ;; parse files that start with a . like .bash_profile
25 ;; legal values: true, false
26 hidden = false
27
28 ;; show elements marked @access private in documentation by setting this to on
29 ;; legal values: on, off
30 parseprivate = off
31
32 ;; parse with javadoc-like description (first sentence is always the short description)
33 ;; legal values: on, off
34 javadocdesc = off
35
36 ;; add any custom @tags separated by commas here
37 ;; legal values: any legal tagname separated by commas.
38 ;customtags = mytag1,mytag2
39
40 ;; This is only used by the XML:DocBook/peardoc2 converter
41 defaultcategoryname = Documentation
42
43 ;; what is the main package?
44 ;; legal values: alphanumeric string plus - and _
c49d1d1 @dleffler Updates the format and organization of the api documentation. This i…
dleffler authored
45 defaultpackagename = Framework
2023260 @dleffler PHPDocumentor configuration file to create Exponent API Documentation…
dleffler authored
46
47 ;; output any parsing information? set to on for cron jobs
48 ;; legal values: on
49 ;quiet = on
50
51 ;; parse a PEAR-style repository. Do not turn this on if your project does
52 ;; not have a parent directory named "pear"
53 ;; legal values: on/off
54 ;pear = on
55
56 ;; where should the documentation be written?
57 ;; legal values: a legal path
58 ;target = /home/cellog/output
671514f @dleffler Updated phpdoc.ini file to use new output folder name (which is the n…
dleffler authored
59 target = ../exponent-api
2023260 @dleffler PHPDocumentor configuration file to create Exponent API Documentation…
dleffler authored
60
61 ;; Which files should be parsed out as special documentation files, such as README,
62 ;; INSTALL and CHANGELOG? This overrides the default files found in
63 ;; phpDocumentor.ini (this file is not a user .ini file, but the global file)
cc9e928 @dleffler Deleted deprecated deps.php & manifest.php files (1.0), updated phpdo…
dleffler authored
64 readmeinstallchangelog = README, INSTALLATION, LICENSE, CHANGELOG
2023260 @dleffler PHPDocumentor configuration file to create Exponent API Documentation…
dleffler authored
65
66 ;; limit output to the specified packages, even if others are parsed
67 ;; legal values: package names separated by commas
68 ;packageoutput = package1,package2
69
70 ;; comma-separated list of files to parse
71 ;; legal values: paths separated by commas
72 ;filename = /path/to/file1,/path/to/file2,fileincurrentdirectory
73
74 ;; comma-separated list of directories to parse
75 ;; legal values: directory paths separated by commas
76 ;directory = /path1,/path2,.,..,subdirectory
77 ;directory = /home/jeichorn/cvs/pear
78 ;directory = /home/cellog/workspace/phpdoc
79 directory = .
80
81 ;; template base directory (the equivalent directory of <installdir>/phpDocumentor)
82 ;templatebase = /path/to/my/templates
83
84 ;; directory to find any example files in through @example and {@example} tags
85 ;examplesdir = /path/to/my/templates
86
87 ;; comma-separated list of files, directories or wildcards ? and * (any wildcard) to ignore
88 ;; legal values: any wildcard strings separated by commas
89 ;; remember, this pathing is RELATIVE to the top-most directory in your "directory" value
90 ;ignore = path/to/ignore*,*list.php,myfile.php,subdirectory/
c845ee5 @dleffler Trying to change template class file names
dleffler authored
91 ignore = external/,tmp/,framework/modules/pixidou/
2023260 @dleffler PHPDocumentor configuration file to create Exponent API Documentation…
dleffler authored
92
93 ;; comma-separated list of Converters to use in outputformat:Convertername:templatedirectory format
94 ;; legal values: HTML:frames:default,HTML:frames:l0l33t,HTML:frames:phpdoc.de,HTML:frames:phphtmllib,
d578162 @dleffler Updated some issues involving the "flash" function (used wrong name/t…
dleffler authored
95 ;; HTML:frames:earthli, HTML:frames:phpedit,
2023260 @dleffler PHPDocumentor configuration file to create Exponent API Documentation…
dleffler authored
96 ;; HTML:frames:DOM/default,HTML:frames:DOM/l0l33t,HTML:frames:DOM/phpdoc.de,
97 ;; HTML:frames:DOM/phphtmllib,HTML:frames:DOM/earthli
c49d1d1 @dleffler Updates the format and organization of the api documentation. This i…
dleffler authored
98 ;; HTML:Smarty:default,HTML:Smarty:PHP,HTML:Smarty:HandS,HTML:Smarty/Evolve:default
2023260 @dleffler PHPDocumentor configuration file to create Exponent API Documentation…
dleffler authored
99 ;; PDF:default:default,CHM:default:default,XML:DocBook/peardoc2:default
c49d1d1 @dleffler Updates the format and organization of the api documentation. This i…
dleffler authored
100 ;;output=HTML:frames:earthli,HTML:frames:default,HTML:frames:l0l33t,HTML:frames:phpdoc.de,HTML:frames:phphtmllib,HTML:frames:DOM/default,HTML:frames:DOM/l0l33t,HTML:frames:DOM/phpdoc.de,HTML:frames:DOM/earthli,HTML:frames:DOM/phphtmllib,HTML:frames:phpedit,HTML:Smarty:default,HTML:Smarty:PHP,HTML:Smarty:HandS,HTML:Smarty/Evolve:default
25be85b @dleffler Removed custom phpdoc theme inadvertantly left when added 'pixidou' t…
dleffler authored
101 output=HTML:Smarty:HandS
2023260 @dleffler PHPDocumentor configuration file to create Exponent API Documentation…
dleffler authored
102
103 ;; turn this option on if you want highlighted source code for every file
104 ;; legal values: on/off
105 sourcecode = off
Something went wrong with that request. Please try again.