change log updated
[public/netxms.git] / Doxyfile
1 #---------------------------------------------------------------------------
2 # Project related configuration options
3 #---------------------------------------------------------------------------
4 DOXYFILE_ENCODING = UTF-8
5 PROJECT_NAME = NetXMS
6 PROJECT_NUMBER = 1.2.5
7 PROJECT_BRIEF =
8 PROJECT_LOGO = doc/logo.png
9 OUTPUT_DIRECTORY = doc/doxygen
10 CREATE_SUBDIRS = YES
11 OUTPUT_LANGUAGE = English
12
13 ABBREVIATE_BRIEF = "The $name class" \
14 "The $name widget" \
15 "The $name file" \
16 is \
17 provides \
18 specifies \
19 contains \
20 represents \
21 a \
22 an \
23 the
24 JAVADOC_AUTOBRIEF = YES
25 TAB_SIZE = 3
26 IDL_PROPERTY_SUPPORT = NO
27 INLINE_SIMPLE_STRUCTS = YES
28 SYMBOL_CACHE_SIZE = 5
29 LOOKUP_CACHE_SIZE = 5
30
31 #---------------------------------------------------------------------------
32 # Build related configuration options
33 #---------------------------------------------------------------------------
34
35 EXTRACT_ALL = YES
36 #EXTRACT_ALL = NO
37
38 EXTRACT_STATIC = NO
39 #EXTRACT_LOCAL_CLASSES = YES
40 EXTRACT_LOCAL_CLASSES = NO
41 SHOW_INCLUDE_FILES = NO
42
43 SORT_BRIEF_DOCS = YES
44 SORT_MEMBERS_CTORS_1ST = YES
45 SORT_GROUP_NAMES = YES
46
47 STRICT_PROTO_MATCHING = NO
48 #
49 #---------------------------------------------------------------------------
50 # configuration options related to warning and progress messages
51 #---------------------------------------------------------------------------
52 QUIET = YES
53 WARNINGS = YES
54 WARN_IF_UNDOCUMENTED = YES
55 WARN_IF_DOC_ERROR = YES
56 WARN_NO_PARAMDOC = NO
57
58 #---------------------------------------------------------------------------
59 # configuration options related to the input files
60 #---------------------------------------------------------------------------
61
62 INPUT = include src/agent/core src/agent/libnxsd src/db/libnxdb src/libnetxms src/libnxcl src/libnxlp src/libnxmap src/libnxmb src/libnxsl src/libtre src/snmp/libnxsnmp src/server/core src/server/include src/server/libnxsrv src/server/netxmsd
63 FILE_PATTERNS = *.c \
64 *.cpp \
65 *.h
66 RECURSIVE = YES
67 EXCLUDE = src/libnxsl/lex.parser.cpp src/snmp/nxmibc/lex.parser.cpp
68 USE_MDFILE_AS_MAINPAGE = doc/doxygen.md
69
70 #---------------------------------------------------------------------------
71 # configuration options related to the HTML output
72 #---------------------------------------------------------------------------
73
74 GENERATE_HTML = YES
75 HTML_OUTPUT = html
76 HTML_FILE_EXTENSION = .html
77
78 #---------------------------------------------------------------------------
79 # configuration options related to the LaTeX output
80 #---------------------------------------------------------------------------
81
82 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
83 # generate Latex output.
84
85 GENERATE_LATEX = NO
86
87 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
88 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
89 # put in front of it. If left blank `latex' will be used as the default path.
90
91 LATEX_OUTPUT = latex
92
93 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
94 # invoked. If left blank `latex' will be used as the default command name.
95 # Note that when enabling USE_PDFLATEX this option is only used for
96 # generating bitmaps for formulas in the HTML output, but not in the
97 # Makefile that is written to the output directory.
98
99 LATEX_CMD_NAME = latex
100
101 # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to
102 # generate index for LaTeX. If left blank `makeindex' will be used as the
103 # default command name.
104
105 MAKEINDEX_CMD_NAME = makeindex
106
107 # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact
108 # LaTeX documents. This may be useful for small projects and may help to
109 # save some trees in general.
110
111 COMPACT_LATEX = NO
112
113 # The PAPER_TYPE tag can be used to set the paper type that is used
114 # by the printer. Possible values are: a4, letter, legal and
115 # executive. If left blank a4wide will be used.
116
117 PAPER_TYPE = a4
118
119 # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX
120 # packages that should be included in the LaTeX output.
121
122 EXTRA_PACKAGES =
123
124 # The LATEX_HEADER tag can be used to specify a personal LaTeX header for
125 # the generated latex document. The header should contain everything until
126 # the first chapter. If it is left blank doxygen will generate a
127 # standard header. Notice: only use this tag if you know what you are doing!
128
129 LATEX_HEADER =
130
131 # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for
132 # the generated latex document. The footer should contain everything after
133 # the last chapter. If it is left blank doxygen will generate a
134 # standard footer. Notice: only use this tag if you know what you are doing!
135
136 LATEX_FOOTER =
137
138 # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated
139 # is prepared for conversion to pdf (using ps2pdf). The pdf file will
140 # contain links (just like the HTML output) instead of page references
141 # This makes the output suitable for online browsing using a pdf viewer.
142
143 PDF_HYPERLINKS = YES
144
145 # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of
146 # plain latex in the generated Makefile. Set this option to YES to get a
147 # higher quality PDF documentation.
148
149 USE_PDFLATEX = YES
150
151 # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode.
152 # command to the generated LaTeX files. This will instruct LaTeX to keep
153 # running if errors occur, instead of asking the user for help.
154 # This option is also used when generating formulas in HTML.
155
156 LATEX_BATCHMODE = NO
157
158 # If LATEX_HIDE_INDICES is set to YES then doxygen will not
159 # include the index chapters (such as File Index, Compound Index, etc.)
160 # in the output.
161
162 LATEX_HIDE_INDICES = NO
163
164 # If LATEX_SOURCE_CODE is set to YES then doxygen will include
165 # source code with syntax highlighting in the LaTeX output.
166 # Note that which sources are shown also depends on other settings
167 # such as SOURCE_BROWSER.
168
169 LATEX_SOURCE_CODE = NO
170
171 # The LATEX_BIB_STYLE tag can be used to specify the style to use for the
172 # bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See
173 # http://en.wikipedia.org/wiki/BibTeX for more info.
174
175 LATEX_BIB_STYLE = plain
176
177 #---------------------------------------------------------------------------
178 # Configuration options related to the preprocessor
179 #---------------------------------------------------------------------------
180 SEARCH_INCLUDES = YES
181 INCLUDE_PATH = . include src/server/include
182 INCLUDE_FILE_PATTERNS = *.h
183 PREDEFINED = __cplusplus LIBNXCL_NO_DECLARATIONS
184
185 #---------------------------------------------------------------------------
186 # Configuration::additions related to external references
187 #---------------------------------------------------------------------------
188 PERL_PATH = /usr/bin/perl
189
190 #---------------------------------------------------------------------------
191 # Configuration options related to the dot tool
192 #---------------------------------------------------------------------------
193
194 # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will
195 # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base
196 # or super classes. Setting the tag to NO turns the diagrams off. Note that
197 # this option also works with HAVE_DOT disabled, but it is recommended to
198 # install and use dot, since it yields more powerful graphs.
199
200 CLASS_DIAGRAMS = NO
201
202 # You can define message sequence charts within doxygen comments using the \msc
203 # command. Doxygen will then run the mscgen tool (see
204 # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the
205 # documentation. The MSCGEN_PATH tag allows you to specify the directory where
206 # the mscgen tool resides. If left empty the tool is assumed to be found in the
207 # default search path.
208
209 MSCGEN_PATH =
210
211 # If set to YES, the inheritance and collaboration graphs will hide
212 # inheritance and usage relations if the target is undocumented
213 # or is not a class.
214
215 HIDE_UNDOC_RELATIONS = YES
216
217 # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
218 # available from the path. This tool is part of Graphviz, a graph visualization
219 # toolkit from AT&T and Lucent Bell Labs. The other options in this section
220 # have no effect if this option is set to NO (the default)
221
222 HAVE_DOT = YES
223
224 # The DOT_NUM_THREADS specifies the number of dot invocations doxygen is
225 # allowed to run in parallel. When set to 0 (the default) doxygen will
226 # base this on the number of processors available in the system. You can set it
227 # explicitly to a value larger than 0 to get control over the balance
228 # between CPU load and processing speed.
229
230 DOT_NUM_THREADS = 0
231
232 # By default doxygen will use the Helvetica font for all dot files that
233 # doxygen generates. When you want a differently looking font you can specify
234 # the font name using DOT_FONTNAME. You need to make sure dot is able to find
235 # the font, which can be done by putting it in a standard location or by setting
236 # the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the
237 # directory containing the font.
238
239 DOT_FONTNAME = Helvetica
240
241 # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs.
242 # The default size is 10pt.
243
244 DOT_FONTSIZE = 10
245
246 # By default doxygen will tell dot to use the Helvetica font.
247 # If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to
248 # set the path where dot can find it.
249
250 DOT_FONTPATH =
251
252 # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen
253 # will generate a graph for each documented class showing the direct and
254 # indirect inheritance relations. Setting this tag to YES will force the
255 # CLASS_DIAGRAMS tag to NO.
256
257 CLASS_GRAPH = YES
258
259 # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen
260 # will generate a graph for each documented class showing the direct and
261 # indirect implementation dependencies (inheritance, containment, and
262 # class references variables) of the class with other documented classes.
263
264 COLLABORATION_GRAPH = YES
265
266 # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen
267 # will generate a graph for groups, showing the direct groups dependencies
268
269 GROUP_GRAPHS = YES
270
271 # If the UML_LOOK tag is set to YES doxygen will generate inheritance and
272 # collaboration diagrams in a style similar to the OMG's Unified Modeling
273 # Language.
274
275 UML_LOOK = NO
276
277 # If the UML_LOOK tag is enabled, the fields and methods are shown inside
278 # the class node. If there are many fields or methods and many nodes the
279 # graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS
280 # threshold limits the number of items for each type to make the size more
281 # managable. Set this to 0 for no limit. Note that the threshold may be
282 # exceeded by 50% before the limit is enforced.
283
284 UML_LIMIT_NUM_FIELDS = 10
285
286 # If set to YES, the inheritance and collaboration graphs will show the
287 # relations between templates and their instances.
288
289 TEMPLATE_RELATIONS = NO
290
291 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT
292 # tags are set to YES then doxygen will generate a graph for each documented
293 # file showing the direct and indirect include dependencies of the file with
294 # other documented files.
295
296 INCLUDE_GRAPH = YES
297
298 # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and
299 # HAVE_DOT tags are set to YES then doxygen will generate a graph for each
300 # documented header file showing the documented files that directly or
301 # indirectly include this file.
302
303 INCLUDED_BY_GRAPH = YES
304
305 # If the CALL_GRAPH and HAVE_DOT options are set to YES then
306 # doxygen will generate a call dependency graph for every global function
307 # or class method. Note that enabling this option will significantly increase
308 # the time of a run. So in most cases it will be better to enable call graphs
309 # for selected functions only using the \callgraph command.
310
311 CALL_GRAPH = YES
312
313 # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then
314 # doxygen will generate a caller dependency graph for every global function
315 # or class method. Note that enabling this option will significantly increase
316 # the time of a run. So in most cases it will be better to enable caller
317 # graphs for selected functions only using the \callergraph command.
318
319 CALLER_GRAPH = YES
320
321 # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen
322 # will generate a graphical hierarchy of all classes instead of a textual one.
323
324 GRAPHICAL_HIERARCHY = YES
325
326 # If the DIRECTORY_GRAPH and HAVE_DOT tags are set to YES
327 # then doxygen will show the dependencies a directory has on other directories
328 # in a graphical way. The dependency relations are determined by the #include
329 # relations between the files in the directories.
330
331 DIRECTORY_GRAPH = YES
332
333 # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
334 # generated by dot. Possible values are svg, png, jpg, or gif.
335 # If left blank png will be used. If you choose svg you need to set
336 # HTML_FILE_EXTENSION to xhtml in order to make the SVG files
337 # visible in IE 9+ (other browsers do not have this requirement).
338
339 DOT_IMAGE_FORMAT = png
340
341 # If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
342 # enable generation of interactive SVG images that allow zooming and panning.
343 # Note that this requires a modern browser other than Internet Explorer.
344 # Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you
345 # need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files
346 # visible. Older versions of IE do not have SVG support.
347
348 INTERACTIVE_SVG = NO
349
350 # The tag DOT_PATH can be used to specify the path where the dot tool can be
351 # found. If left blank, it is assumed the dot tool can be found in the path.
352
353 DOT_PATH =
354
355 # The DOTFILE_DIRS tag can be used to specify one or more directories that
356 # contain dot files that are included in the documentation (see the
357 # \dotfile command).
358
359 DOTFILE_DIRS =
360
361 # The MSCFILE_DIRS tag can be used to specify one or more directories that
362 # contain msc files that are included in the documentation (see the
363 # \mscfile command).
364
365 MSCFILE_DIRS =
366
367 # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of
368 # nodes that will be shown in the graph. If the number of nodes in a graph
369 # becomes larger than this value, doxygen will truncate the graph, which is
370 # visualized by representing a node as a red box. Note that doxygen if the
371 # number of direct children of the root node in a graph is already larger than
372 # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note
373 # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
374
375 DOT_GRAPH_MAX_NODES = 50
376
377 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the
378 # graphs generated by dot. A depth value of 3 means that only nodes reachable
379 # from the root by following a path via at most 3 edges will be shown. Nodes
380 # that lay further from the root node will be omitted. Note that setting this
381 # option to 1 or 2 may greatly reduce the computation time needed for large
382 # code bases. Also note that the size of a graph can be further restricted by
383 # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
384
385 MAX_DOT_GRAPH_DEPTH = 0
386
387 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
388 # background. This is disabled by default, because dot on Windows does not
389 # seem to support this out of the box. Warning: Depending on the platform used,
390 # enabling this option may lead to badly anti-aliased labels on the edges of
391 # a graph (i.e. they become hard to read).
392
393 DOT_TRANSPARENT = NO
394
395 # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output
396 # files in one run (i.e. multiple -o and -T options on the command line). This
397 # makes dot run faster, but since only newer versions of dot (>1.8.10)
398 # support this, this feature is disabled by default.
399
400 DOT_MULTI_TARGETS = NO