Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 126 lines (75 sloc) 3.732 kb
27c391ff »
2010-04-29 first commit
1 ; Default configuration file for PHPDoctor
2
3 ; This config file will cause PHPDoctor to generate API documentation of
4 ; itself.
5
6
7 ; PHPDoctor settings
8 ; -----------------------------------------------------------------------------
9
10 ; Names of files to parse. This can be a single filename, or a comma separated
11 ; list of filenames. Wildcards are allowed.
12
13 files = "*.php"
14
15 ; Names of files or directories to ignore. This can be a single filename, or a
16 ; comma separated list of filenames. Wildcards are NOT allowed.
17
18 ignore = "CVS, .svn, .git, _compiled"
19
20 ; The directory to look for files in, if not used the PHPDoctor will look in
21 ; the current directory (the directory it is run from).
22
23 source_path = "./data/source/orm1.2/lib"
24
25 ; If you do not want PHPDoctor to look in each sub directory for files
26 ; uncomment this line.
27
28 ;subdirs = off
29
30 ; Set how loud PHPDoctor is as it runs. Quiet mode suppresses all output other
31 ; than warnings and errors. Verbose mode outputs additional messages during
32 ; execution.
33
34 ;quiet = on
35 ;verbose = on
36
37 ; Select the doclet to use for generating output.
38
39 doclet = doctrineapi
40 ;doclet = debug
41
42 ; The directory to find the doclet in. Doclets are expected to be in a
43 ; directory named after themselves at the location given.
44
45 ;doclet_path = ./doclets
46
47 ; The directory to find taglets in. Taglets allow you to make PHPDoctor handle
48 ; new tags and to alter the behavour of existing tags and their output.
49
50 ;taglet_path = ./taglets
51
52 ; If the code you are parsing does not use package tags or not all elements
53 ; have package tags, use this setting to place unbound elements into a
54 ; particular package.
55
56 default_package = "Doctrine"
57
58 ; Specifies the name of a HTML file containing text for the overview
59 ; documentation to be placed on the overview page. The path is relative to
60 ; "source_path" unless an absolute path is given.
61
62 overview = README
63
64 ; Package comments will be looked for in a file named package.html in the same
65 ; directory as the first source file parsed in that package or in the directory
66 ; given below. If package comments are placed in the directory given below then
67 ; they should be named "<packageName>.html".
68
69 package_comment_dir = ./
70
71 ; Parse out global variables and/or global constants?
72
73 globals = off
74 constants = off
75
76 ; Generate documentation for all class members
77
10983bd1 »
2010-05-12 Updating to not generate private api docs
78 private = off
27c391ff »
2010-04-29 first commit
79
80 ; Generate documentation for public and protected class members
81
82 protected = on
83
84 ; Generate documentation for only public class members
85
86 public = on
87
88 ; Use the PEAR compatible handling of the docblock first sentence
89
90 pear_compat = on
91
92 ; Standard doclet settings
93 ; -----------------------------------------------------------------------------
94
95 ; The directory to place generated documentation in. If the given path is
96 ; relative to it will be relative to "source_path".
97
98 d = "...//...//...//...//web/api/orm/1.2"
99
100 ; Specifies the title to be placed in the HTML <title> tag.
101
102 windowtitle = "Doctrine 1.2 ORM"
103
104 ; Specifies the title to be placed near the top of the overview summary file.
105
106 doctitle = "Doctrine - PHP Object Relational Mapper"
107
108 ; Specifies the header text to be placed at the top of each output file. The
109 ; header will be placed to the right of the upper navigation bar.
110
111 header = "Doctrine"
112
113 ; Specifies the footer text to be placed at the bottom of each output file. The
114 ; footer will be placed to the right of the lower navigation bar.
115
116 footer = "Doctrine"
117
118 ; Specifies the text to be placed at the bottom of each output file. The text
119 ; will be placed at the bottom of the page, below the lower navigation bar.
120
121 ;bottom = "This document was generated by <a href="http://phpdoctor.sourceforge.net/">PHPDoctor: The PHP Documentation Creator</a>"
122
123 ; Create a class tree?
124
125 tree = on
Something went wrong with that request. Please try again.