root/eaccelerator/trunk/doc/phpdoc.ini

Revision 179, 3.3 kB (checked in by bart, 3 years ago)

Added eAccelerator API documentation php stub files. These files can be used to generate docs with PhpDocumentor?

  • Property svn:executable set to *
Line 
1 ;; eAccelerator project
2 ;; Copyright (c) 2005 - 2006 eAccelerator
3 ;; http://www.eaccelerator.net
4 ;;
5 ;; phpDocumentor parse configuration file for eAccelerator php documentation
6 ;;
7 ;; This configuration file is based on the original default.ini file in the
8 ;; phpdoc distibution.
9 ;;
10 ;; You can create the documentation be going to the directory where this file is located
11 ;; and executing phpdoc -c phpdoc.ini
12 ;; The documentation will be create from the php source files in php, the html documentation
13 ;; will be generated in phpdoc. Check for errors.html for parse errors.
14 ;;
15 ;; Author: Bart Vanbrabant <bart vanbrabant at zoeloelip be>
16
17 [Parse Data]
18 ;; title of all the documentation
19 title = eAccelerator 0.9.5 PHP interface documentation
20
21 ;; parse files that start with a . like .bash_profile
22 ;; legal values: true, false
23 hidden = false
24
25 ;; show elements marked @access private in documentation by setting this to on
26 ;; legal values: on, off
27 parseprivate = off
28
29 ;; parse with javadoc-like description (first sentence is always the short description)
30 ;; legal values: on, off
31 javadocdesc = off
32
33 ;; This is only used by the XML:DocBook/peardoc2 converter
34 defaultcategoryname = Documentation
35
36 ;; what is the main package?
37 ;; legal values: alphanumeric string plus - and _
38 defaultpackagename = eAccelerator
39
40 ;; output any parsing information?  set to on for cron jobs
41 ;; legal values: on
42 ;quiet = on
43
44 ;; parse a PEAR-style repository.  Do not turn this on if your project does
45 ;; not have a parent directory named "pear"
46 ;; legal values: on/off
47 ;pear = on
48
49 ;; where should the documentation be written?
50 ;; legal values: a legal path
51 target = phpdoc
52
53 ;; Which files should be parsed out as special documentation files, such as README,
54 ;; INSTALL and CHANGELOG?  This overrides the default files found in
55 ;; phpDocumentor.ini (this file is not a user .ini file, but the global file)
56 ;readmeinstallchangelog =
57
58 ;; limit output to the specified packages, even if others are parsed
59 ;; legal values: package names separated by commas
60 ;packageoutput = package1,package2
61
62 ;; comma-separated list of files to parse
63 ;; legal values: paths separated by commas
64 ;filename = /path/to/file1,/path/to/file2,fileincurrentdirectory
65
66 ;; comma-separated list of directories to parse
67 ;; legal values: directory paths separated by commas
68 directory = php
69
70 ;; directory to find any example files in through @example and {@example} tags
71 examplesdir = php/examples
72
73 ;; comma-separated list of files, directories or wildcards ? and * (any wildcard) to ignore
74 ;; legal values: any wildcard strings separated by commas
75 ;ignore = /path/to/ignore*,*list.php,myfile.php,subdirectory/
76 ignore = templates_c/,*HTML/default/*,spec/
77
78 ;; comma-separated list of Converters to use in outputformat:Convertername:templatedirectory format
79 ;; legal values: HTML:frames:default,HTML:frames:l0l33t,HTML:frames:phpdoc.de,HTML:frames:phphtmllib,
80 ;;               HTML:frames:earthli,
81 ;;               HTML:frames:DOM/default,HTML:frames:DOM/l0l33t,HTML:frames:DOM/phpdoc.de,
82 ;;               HTML:frames:DOM/phphtmllib,HTML:frames:DOM/earthli
83 ;;               HTML:Smarty:default,HTML:Smarty:PHP,HTML:Smarty:HandS
84 ;;               PDF:default:default,CHM:default:default,XML:DocBook/peardoc2:default
85 output=HTML:frames:default
86
87 ;; turn this option on if you want highlighted source code for every file
88 ;; legal values: on/off
89 sourcecode = on
Note: See TracBrowser for help on using the browser.