root/tags/gdal_1_2_4/Doxyfile

Revision 6080, 9.2 kB (checked in by warmerda, 5 years ago)

added NEWS to example list

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
Line 
1 # This file describes the settings to be used by doxygen for a project
2 #
3 # All text after a hash (#) is considered a comment and will be ignored
4 # The format is:
5 #       TAG = value [value, ...]
6 # Values that contain spaces should be placed between quotes (" ")
7
8 #---------------------------------------------------------------------------
9 # General configuration options
10 #---------------------------------------------------------------------------
11
12 # The PROJECT_NAME tag is a single word (or a sequence of word surrounded
13 # by quotes) that should identify the project.
14
15 PROJECT_NAME         =  GDAL
16
17 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
18 # This could be handy for archiving the generated documentation or
19 # if some version control system is used.
20
21 PROJECT_NUMBER       = 
22
23 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
24 # base path where the generated documentation will be put.
25 # If a relative path is entered, it will be relative to the location
26 # where doxygen was started. If left blank the current directory will be used.
27
28 OUTPUT_DIRECTORY     =
29
30 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put.
31 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
32 # put in front of it. If left blank `html' will be used as the default path.
33
34 HTML_OUTPUT          =
35
36 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
37 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
38 # put in front of it. If left blank `latex' will be used as the default path.
39
40 LATEX_OUTPUT          =
41
42 # The HTML_HEADER tag can be used to specify a personal HTML header for
43 # each generated HTML page. If it is left blank doxygen will generate a
44 # standard header.
45
46 #HTML_HEADER          = html/gdal_header.html
47
48 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
49 # each generated HTML page. If it is left blank doxygen will generate a
50 # standard footer.
51
52 #HTML_FOOTER          = html/gdal_footer.html
53
54 # The QUIET tag can be used to turn on/off the messages that are generated
55 # by doxygen. Possible values are YES and NO. If left blank NO is used.
56
57 QUIET                = NO
58
59 # The WARNINGS tag can be used to turn on/off the warning messages that are
60 # generated by doxygen. Possible values are YES and NO. If left blank
61 # NO is used.
62
63 WARNINGS             = YES
64
65 # The DISABLE_INDEX tag can be used to turn on/off the condensed index at
66 # top of each page. A value of NO (the default) enables the index and the
67 # value YES disables it.
68
69 DISABLE_INDEX        = NO
70
71 # If the EXTRACT_ALL tag is set to YES all classes and functions will be
72 # included in the documentation, even if no documentation was available.
73
74 EXTRACT_ALL          = NO
75
76 # If the EXTRACT_PRIVATE tag is set to YES all private members of a class
77 # will be included in the documentation.
78
79 EXTRACT_PRIVATE      = NO
80
81 # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
82 # undocumented members inside documented classes or files.
83
84 HIDE_UNDOC_MEMBERS   = NO
85
86 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
87 # generate Latex output.
88
89 GENERATE_LATEX       = NO
90
91 # If the GENERATE_HTML tag is set to YES (the default) Doxygen will
92 # generate HTML output
93
94 GENERATE_HTML        = YES
95
96 # Disable RTF
97
98 GENERATE_RTF         = NO
99
100 # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will
101 # include brief member descriptions after the members that are listed in
102 # the file and class documentation (similar to JavaDoc).
103 # Set to NO to disable this.
104
105 BRIEF_MEMBER_DESC = YES
106
107 # If the FULL_PATH_NAMES tag is set to YES Doxygen will prepend the full
108 # path before files name in the file list and in the header files. If set
109 # to NO the shortest path that makes the file name unique will be used
110
111 FULL_PATH_NAMES = NO
112
113 #---------------------------------------------------------------------------
114 # configuration options related to the input files
115 #---------------------------------------------------------------------------
116
117 # The INPUT tag is used to specify the files and/or directories that contain
118 # documented source files. You may enter file names like "myfile.cpp" or
119 # directories like "/usr/src/myproject". Separate the files or directories
120 # with spaces.
121
122 INPUT            =      port gcore frmts/gdalallregister.cpp alg frmts/vrt
123
124
125 # If the value of the INPUT tag contains directories, you can use the
126 # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp
127 # and *.h) to filter out the source-files in the directories. If left
128 # blank all files are included.
129
130 FILE_PATTERNS    =      *.h *.cpp *.c *.dox
131
132 # The EXAMPLE_PATH tag can be used to specify one or more files or
133 # directories that contain example code fragments that are included (see
134 # the \include command).
135
136 EXAMPLE_PATH     = apps frmts frmts/jdem NEWS
137
138 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
139 # should be searched for input files as well. Possible values are YES and NO.
140 # If left blank NO is used.
141
142 RECURSIVE        = NO
143
144 # The INPUT_FILTER tag can be used to specify a program that doxygen should
145 # invoke to filter for each input file. Doxygen will invoke the filter program
146 # by executing (via popen()) the command <filter> <input-file>, where <filter>
147 # is the value of the INPUT_FILTER tag, and <input-file> is the name of an
148 # input file. Doxygen will then use the output that the filter program writes
149 # to standard output.
150
151 INPUT_FILTER     =
152
153 #---------------------------------------------------------------------------
154 # Configuration options related to the preprocessor
155 #---------------------------------------------------------------------------
156
157 # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will
158 # evaluate all C-preprocessor directives found in the sources and include
159 # files.
160
161 ENABLE_PREPROCESSING = YES
162
163 # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro
164 # names in the source code. If set to NO (the default) only conditional
165 # compilation will be performed.
166
167 MACRO_EXPANSION = YES
168
169 # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files
170 # in the INCLUDE_PATH (see below) will be search if a #include is found.
171
172 SEARCH_INCLUDES = YES
173
174 # The INCLUDE_PATH tag can be used to specify one or more directories that
175 # contain include files that are not input files but should be processed by
176 # the preprocessor.
177
178 INCLUDE_PATH =
179
180 # The PREDEFINED tag can be used to specify one or more macro names that
181 # are defined before the preprocessor is started (similar to the -D option of
182 # gcc). The argument of the tag is a list of macros of the form: name
183 # or name=definition (no spaces). In the former case 1 is used as the
184 # definition.
185
186 PREDEFINED = HAVE_DLFCN_H CPL_DLL CPL_C_START CPL_C_END __cplusplus
187
188 # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
189 # then the macro expansion is limited to the macros specified with the
190 # PREDEFINED tag.
191
192 EXPAND_ONLY_PREDEF = YES
193
194 #---------------------------------------------------------------------------
195 # Configuration options related to external references
196 #---------------------------------------------------------------------------
197
198 # The TAGFILES tag can be used to specify one or more tagfiles.
199
200 TAGFILES         =
201
202 # When a file name is specified after GENERATE_TAGFILE, doxygen will create
203 # a tag file that is based on the input files it reads.
204
205 GENERATE_TAGFILE =
206
207 # If the ALLEXTERNALS tag is set to YES all external classes will be listed
208 # in the class index. If set to NO only the inherited external classes
209 # will be listed.
210
211 ALLEXTERNALS     = NO
212
213 # The PERL_PATH should be the absolute path and name of the perl script
214 # interpreter (i.e. the result of `which perl').
215
216 PERL_PATH        = /usr/local/bin/perl
217
218 #---------------------------------------------------------------------------
219 # Configuration options related to the search engine
220 #---------------------------------------------------------------------------
221
222 # The SEARCHENGINE tag specifies whether or not a search engine should be
223 # used. If set to NO the values of all tags below this one will be ignored.
224
225 SEARCHENGINE     = NO
226
227 # The CGI_NAME tag should be the name of the CGI script that
228 # starts the search engine (doxysearch) with the correct parameters.
229 # A script with this name will be generated by doxygen.
230
231 CGI_NAME         = search.cgi
232
233 # The CGI_URL tag should be the absolute URL to the directory where the
234 # cgi binaries are located. See the documentation of your http daemon for
235 # details.
236
237 CGI_URL          =
238
239 # The DOC_URL tag should be the absolute URL to the directory where the
240 # documentation is located. If left blank the absolute path to the
241 # documentation, with file:// prepended to it, will be used.
242
243 DOC_URL          =
244
245 # The DOC_ABSPATH tag should be the absolute path to the directory where the
246 # documentation is located. If left blank the directory on the local machine
247 # will be used.
248
249 DOC_ABSPATH      =
250
251 # The BIN_ABSPATH tag must point to the directory where the doxysearch binary
252 # is installed.
253
254 BIN_ABSPATH      = /usr/local/bin/
255
256 # The EXT_DOC_PATHS tag can be used to specify one or more paths to
257 # documentation generated for other projects. This allows doxysearch to search
258 # the documentation for these projects as well.
259
260 EXT_DOC_PATHS    =
Note: See TracBrowser for help on using the browser.