summaryrefslogtreecommitdiffstats
path: root/xbmc/addons/kodi-addon-dev-kit/doxygen
diff options
context:
space:
mode:
Diffstat (limited to 'xbmc/addons/kodi-addon-dev-kit/doxygen')
-rw-r--r--xbmc/addons/kodi-addon-dev-kit/doxygen/Doxyfile2532
-rw-r--r--xbmc/addons/kodi-addon-dev-kit/doxygen/DoxygenLayout.xml207
-rw-r--r--xbmc/addons/kodi-addon-dev-kit/doxygen/General/DoxygenOnAddon.dox90
-rw-r--r--xbmc/addons/kodi-addon-dev-kit/doxygen/General/General.dox29
-rw-r--r--xbmc/addons/kodi-addon-dev-kit/doxygen/Modules/logo-python.pngbin0 -> 6550 bytes
-rw-r--r--xbmc/addons/kodi-addon-dev-kit/doxygen/Modules/modules_general.dox8
-rw-r--r--xbmc/addons/kodi-addon-dev-kit/doxygen/Modules/modules_python.dox179
-rw-r--r--xbmc/addons/kodi-addon-dev-kit/doxygen/Skin/skin.dox24
-rw-r--r--xbmc/addons/kodi-addon-dev-kit/doxygen/kodi-dev.pngbin0 -> 2208 bytes
-rw-r--r--xbmc/addons/kodi-addon-dev-kit/doxygen/main.txt49
10 files changed, 3118 insertions, 0 deletions
diff --git a/xbmc/addons/kodi-addon-dev-kit/doxygen/Doxyfile b/xbmc/addons/kodi-addon-dev-kit/doxygen/Doxyfile
new file mode 100644
index 0000000..184b34e
--- /dev/null
+++ b/xbmc/addons/kodi-addon-dev-kit/doxygen/Doxyfile
@@ -0,0 +1,2532 @@
1# Doxyfile 1.8.9.1
2
3# This file describes the settings to be used by the documentation system
4# doxygen (www.doxygen.org) for a project.
5#
6# All text after a double hash (##) is considered a comment and is placed in
7# front of the TAG it is preceding.
8#
9# All text after a single hash (#) is considered a comment and will be ignored.
10# The format is:
11# TAG = value [value, ...]
12# For lists, items can also be appended using:
13# TAG += value [value, ...]
14# Values that contain spaces should be placed between quotes (\" \").
15
16#---------------------------------------------------------------------------
17# Project related configuration options
18#---------------------------------------------------------------------------
19
20# This tag specifies the encoding used for all characters in the config file
21# that follow. The default is UTF-8 which is also the encoding used for all text
22# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv
23# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv
24# for the list of possible encodings.
25# The default value is: UTF-8.
26
27DOXYFILE_ENCODING = UTF-8
28
29# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
30# double-quotes, unless you are using Doxywizard) that should identify the
31# project for which the documentation is generated. This name is used in the
32# title of most generated pages and in a few other places.
33# The default value is: My Project.
34
35PROJECT_NAME = "Kodi Development"
36
37# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
38# could be handy for archiving the generated documentation or if some version
39# control system is used.
40
41PROJECT_NUMBER = 17.0
42
43# Using the PROJECT_BRIEF tag one can provide an optional one line description
44# for a project that appears at the top of each page and should give viewer a
45# quick idea about the purpose of the project. Keep the description short.
46
47PROJECT_BRIEF = "for Binary (API Level 2) and Script based Add-Ons"
48
49# With the PROJECT_LOGO tag one can specify a logo or an icon that is included
50# in the documentation. The maximum height of the logo should not exceed 55
51# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
52# the logo to the output directory.
53
54PROJECT_LOGO = ./kodi-dev.png
55
56# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
57# into which the generated documentation will be written. If a relative path is
58# entered, it will be relative to the location where doxygen was started. If
59# left blank the current directory will be used.
60
61OUTPUT_DIRECTORY = ../docs
62
63# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
64# directories (in 2 levels) under the output directory of each output format and
65# will distribute the generated files over these directories. Enabling this
66# option can be useful when feeding doxygen a huge amount of source files, where
67# putting all generated files in the same directory would otherwise causes
68# performance problems for the file system.
69# The default value is: NO.
70
71CREATE_SUBDIRS = NO
72
73# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
74# characters to appear in the names of generated files. If set to NO, non-ASCII
75# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
76# U+3044.
77# The default value is: NO.
78
79ALLOW_UNICODE_NAMES = NO
80
81# The OUTPUT_LANGUAGE tag is used to specify the language in which all
82# documentation generated by doxygen is written. Doxygen will use this
83# information to generate all constant output in the proper language.
84# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
85# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
86# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
87# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
88# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
89# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
90# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
91# Ukrainian and Vietnamese.
92# The default value is: English.
93
94OUTPUT_LANGUAGE = English
95
96# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
97# descriptions after the members that are listed in the file and class
98# documentation (similar to Javadoc). Set to NO to disable this.
99# The default value is: YES.
100
101BRIEF_MEMBER_DESC = YES
102
103# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
104# description of a member or function before the detailed description
105#
106# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
107# brief descriptions will be completely suppressed.
108# The default value is: YES.
109
110REPEAT_BRIEF = YES
111
112# This tag implements a quasi-intelligent brief description abbreviator that is
113# used to form the text in various listings. Each string in this list, if found
114# as the leading text of the brief description, will be stripped from the text
115# and the result, after processing the whole list, is used as the annotated
116# text. Otherwise, the brief description is used as-is. If left blank, the
117# following values are used ($name is automatically replaced with the name of
118# the entity):The $name class, The $name widget, The $name file, is, provides,
119# specifies, contains, represents, a, an and the.
120
121ABBREVIATE_BRIEF = "The $name class" \
122 "The $name widget" \
123 "The $name file" \
124 is \
125 provides \
126 specifies \
127 contains \
128 represents \
129 a \
130 an \
131 the
132
133# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
134# doxygen will generate a detailed section even if there is only a brief
135# description.
136# The default value is: NO.
137
138ALWAYS_DETAILED_SEC = YES
139
140# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
141# inherited members of a class in the documentation of that class as if those
142# members were ordinary class members. Constructors, destructors and assignment
143# operators of the base classes will not be shown.
144# The default value is: NO.
145
146INLINE_INHERITED_MEMB = NO
147
148# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
149# before files name in the file list and in the header files. If set to NO the
150# shortest path that makes the file name unique will be used
151# The default value is: YES.
152
153FULL_PATH_NAMES = YES
154
155# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
156# Stripping is only done if one of the specified strings matches the left-hand
157# part of the path. The tag can be used to show relative paths in the file list.
158# If left blank the directory from which doxygen is run is used as the path to
159# strip.
160#
161# Note that you can specify absolute paths here, but also relative paths, which
162# will be relative from the directory where doxygen is started.
163# This tag requires that the tag FULL_PATH_NAMES is set to YES.
164
165STRIP_FROM_PATH =
166
167# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
168# path mentioned in the documentation of a class, which tells the reader which
169# header file to include in order to use a class. If left blank only the name of
170# the header file containing the class definition is used. Otherwise one should
171# specify the list of include paths that are normally passed to the compiler
172# using the -I flag.
173
174STRIP_FROM_INC_PATH = .
175
176# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
177# less readable) file names. This can be useful is your file systems doesn't
178# support long names like on DOS, Mac, or CD-ROM.
179# The default value is: NO.
180
181SHORT_NAMES = NO
182
183# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
184# first line (until the first dot) of a Javadoc-style comment as the brief
185# description. If set to NO, the Javadoc-style will behave just like regular Qt-
186# style comments (thus requiring an explicit @brief command for a brief
187# description.)
188# The default value is: NO.
189
190JAVADOC_AUTOBRIEF = NO
191
192# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
193# line (until the first dot) of a Qt-style comment as the brief description. If
194# set to NO, the Qt-style will behave just like regular Qt-style comments (thus
195# requiring an explicit \brief command for a brief description.)
196# The default value is: NO.
197
198QT_AUTOBRIEF = NO
199
200# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
201# multi-line C++ special comment block (i.e. a block of //! or /// comments) as
202# a brief description. This used to be the default behavior. The new default is
203# to treat a multi-line C++ comment block as a detailed description. Set this
204# tag to YES if you prefer the old behavior instead.
205#
206# Note that setting this tag to YES also means that rational rose comments are
207# not recognized any more.
208# The default value is: NO.
209
210MULTILINE_CPP_IS_BRIEF = NO
211
212# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
213# documentation from any documented member that it re-implements.
214# The default value is: YES.
215
216INHERIT_DOCS = YES
217
218# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
219# page for each member. If set to NO, the documentation of a member will be part
220# of the file/class/namespace that contains it.
221# The default value is: NO.
222
223SEPARATE_MEMBER_PAGES = NO
224
225# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
226# uses this value to replace tabs by spaces in code fragments.
227# Minimum value: 1, maximum value: 16, default value: 4.
228
229TAB_SIZE = 4
230
231# This tag can be used to specify a number of aliases that act as commands in
232# the documentation. An alias has the form:
233# name=value
234# For example adding
235# "sideeffect=@par Side Effects:\n"
236# will allow you to put the command \sideeffect (or @sideeffect) in the
237# documentation, which will result in a user-defined paragraph with heading
238# "Side Effects:". You can put \n's in the value part of an alias to insert
239# newlines.
240
241ALIASES = "table_start=<table width= 100% style= border bgcolor= 576f9f border= 0>" \
242 "table_end=</table>" \
243 "table_h2_l{2}=<tr bgcolor= 576f9f><th width= 40% align=left>\1</th><th width= 60% align=left>\2</th></tr>" \
244 "table_row2_l{2}=<tr bgcolor=white><td width= 40% align=left>\1</td><td width= 60% align=left>\2</td></tr>" \
245 "table_h3{3}=<tr bgcolor= 576f9f><th width= 30% align=left>\1</th><th width= 10% align=left>\2</th><th width= 60% align=left>\3</th></tr>" \
246 "table_row3{3}=<tr bgcolor=white><td width= 30% align=left>\1</td><td width= 10% align=left>\2</td><td width= 60% align=left>\3</td></tr>" \
247 "python_func{1}=\htmlonly <h4><code><span style=\"font-style: italic;\">Function: </span><span style=\"font-style: bold;\"><font color=31363b><big>\1</big></font></span></code></h4> \endhtmlonly" \
248 "python_func_with_rev{2}=\htmlonly <h4><code><span style=\"font-style: italic;\">Function: </span><span style=\"font-style: bold;\"><font color=31363b><big>\1</big></font></span></code><span style="float:right;"><small>\2</small></span></h4> \endhtmlonly" \
249 "python_class{1}=\htmlonly <h4><code><span style=\"font-style: italic;\">Class: </span><span style=\"font-style: bold;\"><font color=31363b><big>\1</big></font></span></code></h4> \endhtmlonly" \
250 "python_class_with_rev{2}=\htmlonly <h4><code><span style=\"font-style: italic;\">Class: </span><span style=\"font-style: bold;\"><font color=31363b><big>\1</big></font></span></code><span style="float:right;"><small>\2</small></span></h4> \endhtmlonly" \
251 "doc_header{1}=\htmlonly <h3><span style=\"text-decoration: underline;\"><span style=\"font-style: italic;\"><span style=\"color: rgb(102, 102, 102);\">\1</span></span></span></h3> \endhtmlonly" \
252 "python_v12=\xrefitem python_v12 \"v12 Python API changes\" \"\"" \
253 "python_v13=\xrefitem python_v13 \"v13 Python API changes\" \"\"" \
254 "python_v14=\xrefitem python_v14 \"v14 Python API changes\" \"\"" \
255 "python_v15=\xrefitem python_v15 \"v15 Python API changes\" \"\"" \
256 "python_v16=\xrefitem python_v16 \"v16 Python API changes\" \"\"" \
257 "python_v17=\xrefitem python_v17 \"v17 Python API changes\" \"\"" \
258 "python_v18=\xrefitem python_v18 \"v18 Python API changes\" \"\""
259
260# This tag can be used to specify a number of word-keyword mappings (TCL only).
261# A mapping has the form "name=value". For example adding "class=itcl::class"
262# will allow you to use the command class in the itcl::class meaning.
263
264TCL_SUBST =
265
266# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
267# only. Doxygen will then generate output that is more tailored for C. For
268# instance, some of the names that are used will be different. The list of all
269# members will be omitted, etc.
270# The default value is: NO.
271
272OPTIMIZE_OUTPUT_FOR_C = NO
273
274# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
275# Python sources only. Doxygen will then generate output that is more tailored
276# for that language. For instance, namespaces will be presented as packages,
277# qualified scopes will look different, etc.
278# The default value is: NO.
279
280OPTIMIZE_OUTPUT_JAVA = NO
281
282# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
283# sources. Doxygen will then generate output that is tailored for Fortran.
284# The default value is: NO.
285
286OPTIMIZE_FOR_FORTRAN = NO
287
288# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
289# sources. Doxygen will then generate output that is tailored for VHDL.
290# The default value is: NO.
291
292OPTIMIZE_OUTPUT_VHDL = NO
293
294# Doxygen selects the parser to use depending on the extension of the files it
295# parses. With this tag you can assign which parser to use for a given
296# extension. Doxygen has a built-in mapping, but you can override or extend it
297# using this tag. The format is ext=language, where ext is a file extension, and
298# language is one of the parsers supported by doxygen: IDL, Java, Javascript,
299# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran:
300# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran:
301# Fortran. In the later case the parser tries to guess whether the code is fixed
302# or free formatted code, this is the default for Fortran type files), VHDL. For
303# instance to make doxygen treat .inc files as Fortran files (default is PHP),
304# and .f files as C (default is Fortran), use: inc=Fortran f=C.
305#
306# Note: For files without extension you can use no_extension as a placeholder.
307#
308# Note that for custom extensions you also need to set FILE_PATTERNS otherwise
309# the files are not read by doxygen.
310
311EXTENSION_MAPPING =
312
313# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
314# according to the Markdown format, which allows for more readable
315# documentation. See http://daringfireball.net/projects/markdown/ for details.
316# The output of markdown processing is further processed by doxygen, so you can
317# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
318# case of backward compatibilities issues.
319# The default value is: YES.
320
321MARKDOWN_SUPPORT = YES
322
323# When enabled doxygen tries to link words that correspond to documented
324# classes, or namespaces to their corresponding documentation. Such a link can
325# be prevented in individual cases by putting a % sign in front of the word or
326# globally by setting AUTOLINK_SUPPORT to NO.
327# The default value is: YES.
328
329AUTOLINK_SUPPORT = YES
330
331# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
332# to include (a tag file for) the STL sources as input, then you should set this
333# tag to YES in order to let doxygen match functions declarations and
334# definitions whose arguments contain STL classes (e.g. func(std::string);
335# versus func(std::string) {}). This also make the inheritance and collaboration
336# diagrams that involve STL classes more complete and accurate.
337# The default value is: NO.
338
339BUILTIN_STL_SUPPORT = NO
340
341# If you use Microsoft's C++/CLI language, you should set this option to YES to
342# enable parsing support.
343# The default value is: NO.
344
345CPP_CLI_SUPPORT = NO
346
347# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
348# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen
349# will parse them like normal C++ but will assume all classes use public instead
350# of private inheritance when no explicit protection keyword is present.
351# The default value is: NO.
352
353SIP_SUPPORT = NO
354
355# For Microsoft's IDL there are propget and propput attributes to indicate
356# getter and setter methods for a property. Setting this option to YES will make
357# doxygen to replace the get and set methods by a property in the documentation.
358# This will only work if the methods are indeed getting or setting a simple
359# type. If this is not the case, or you want to show the methods anyway, you
360# should set this option to NO.
361# The default value is: YES.
362
363IDL_PROPERTY_SUPPORT = YES
364
365# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
366# tag is set to YES then doxygen will reuse the documentation of the first
367# member in the group (if any) for the other members of the group. By default
368# all members of a group must be documented explicitly.
369# The default value is: NO.
370
371DISTRIBUTE_GROUP_DOC = YES
372
373# Set the SUBGROUPING tag to YES to allow class member groups of the same type
374# (for instance a group of public functions) to be put as a subgroup of that
375# type (e.g. under the Public Functions section). Set it to NO to prevent
376# subgrouping. Alternatively, this can be done per class using the
377# \nosubgrouping command.
378# The default value is: YES.
379
380SUBGROUPING = YES
381
382# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
383# are shown inside the group in which they are included (e.g. using \ingroup)
384# instead of on a separate page (for HTML and Man pages) or section (for LaTeX
385# and RTF).
386#
387# Note that this feature does not work in combination with
388# SEPARATE_MEMBER_PAGES.
389# The default value is: NO.
390
391INLINE_GROUPED_CLASSES = NO
392
393# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
394# with only public data fields or simple typedef fields will be shown inline in
395# the documentation of the scope in which they are defined (i.e. file,
396# namespace, or group documentation), provided this scope is documented. If set
397# to NO, structs, classes, and unions are shown on a separate page (for HTML and
398# Man pages) or section (for LaTeX and RTF).
399# The default value is: NO.
400
401INLINE_SIMPLE_STRUCTS = NO
402
403# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
404# enum is documented as struct, union, or enum with the name of the typedef. So
405# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
406# with name TypeT. When disabled the typedef will appear as a member of a file,
407# namespace, or class. And the struct will be named TypeS. This can typically be
408# useful for C code in case the coding convention dictates that all compound
409# types are typedef'ed and only the typedef is referenced, never the tag name.
410# The default value is: NO.
411
412TYPEDEF_HIDES_STRUCT = YES
413
414# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
415# cache is used to resolve symbols given their name and scope. Since this can be
416# an expensive process and often the same symbol appears multiple times in the
417# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
418# doxygen will become slower. If the cache is too large, memory is wasted. The
419# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
420# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
421# symbols. At the end of a run doxygen will report the cache usage and suggest
422# the optimal cache size from a speed point of view.
423# Minimum value: 0, maximum value: 9, default value: 0.
424
425LOOKUP_CACHE_SIZE = 0
426
427#---------------------------------------------------------------------------
428# Build related configuration options
429#---------------------------------------------------------------------------
430
431# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
432# documentation are documented, even if no documentation was available. Private
433# class members and static file members will be hidden unless the
434# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
435# Note: This will also disable the warnings about undocumented members that are
436# normally produced when WARNINGS is set to YES.
437# The default value is: NO.
438
439EXTRACT_ALL = NO
440
441# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
442# be included in the documentation.
443# The default value is: NO.
444
445EXTRACT_PRIVATE = NO
446
447# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
448# scope will be included in the documentation.
449# The default value is: NO.
450
451EXTRACT_PACKAGE = NO
452
453# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
454# included in the documentation.
455# The default value is: NO.
456
457EXTRACT_STATIC = NO
458
459# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
460# locally in source files will be included in the documentation. If set to NO,
461# only classes defined in header files are included. Does not have any effect
462# for Java sources.
463# The default value is: YES.
464
465EXTRACT_LOCAL_CLASSES = NO
466
467# This flag is only useful for Objective-C code. If set to YES, local methods,
468# which are defined in the implementation section but not in the interface are
469# included in the documentation. If set to NO, only methods in the interface are
470# included.
471# The default value is: NO.
472
473EXTRACT_LOCAL_METHODS = NO
474
475# If this flag is set to YES, the members of anonymous namespaces will be
476# extracted and appear in the documentation as a namespace called
477# 'anonymous_namespace{file}', where file will be replaced with the base name of
478# the file that contains the anonymous namespace. By default anonymous namespace
479# are hidden.
480# The default value is: NO.
481
482EXTRACT_ANON_NSPACES = NO
483
484# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
485# undocumented members inside documented classes or files. If set to NO these
486# members will be included in the various overviews, but no documentation
487# section is generated. This option has no effect if EXTRACT_ALL is enabled.
488# The default value is: NO.
489
490HIDE_UNDOC_MEMBERS = NO
491
492# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
493# undocumented classes that are normally visible in the class hierarchy. If set
494# to NO, these classes will be included in the various overviews. This option
495# has no effect if EXTRACT_ALL is enabled.
496# The default value is: NO.
497
498HIDE_UNDOC_CLASSES = NO
499
500# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
501# (class|struct|union) declarations. If set to NO, these declarations will be
502# included in the documentation.
503# The default value is: NO.
504
505HIDE_FRIEND_COMPOUNDS = NO
506
507# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
508# documentation blocks found inside the body of a function. If set to NO, these
509# blocks will be appended to the function's detailed documentation block.
510# The default value is: NO.
511
512HIDE_IN_BODY_DOCS = NO
513
514# The INTERNAL_DOCS tag determines if documentation that is typed after a
515# \internal command is included. If the tag is set to NO then the documentation
516# will be excluded. Set it to YES to include the internal documentation.
517# The default value is: NO.
518
519INTERNAL_DOCS = NO
520
521# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
522# names in lower-case letters. If set to YES, upper-case letters are also
523# allowed. This is useful if you have classes or files whose names only differ
524# in case and if your file system supports case sensitive file names. Windows
525# and Mac users are advised to set this option to NO.
526# The default value is: system dependent.
527
528CASE_SENSE_NAMES = NO
529
530# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
531# their full class and namespace scopes in the documentation. If set to YES, the
532# scope will be hidden.
533# The default value is: NO.
534
535HIDE_SCOPE_NAMES = YES
536
537# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
538# append additional text to a page's title, such as Class Reference. If set to
539# YES the compound reference will be hidden.
540# The default value is: NO.
541
542HIDE_COMPOUND_REFERENCE= YES
543
544# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
545# the files that are included by a file in the documentation of that file.
546# The default value is: YES.
547
548SHOW_INCLUDE_FILES = NO
549
550# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
551# grouped member an include statement to the documentation, telling the reader
552# which file to include in order to use the member.
553# The default value is: NO.
554
555SHOW_GROUPED_MEMB_INC = NO
556
557# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
558# files with double quotes in the documentation rather than with sharp brackets.
559# The default value is: NO.
560
561FORCE_LOCAL_INCLUDES = NO
562
563# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
564# documentation for inline members.
565# The default value is: YES.
566
567INLINE_INFO = YES
568
569# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
570# (detailed) documentation of file and class members alphabetically by member
571# name. If set to NO, the members will appear in declaration order.
572# The default value is: YES.
573
574SORT_MEMBER_DOCS = NO
575
576# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
577# descriptions of file, namespace and class members alphabetically by member
578# name. If set to NO, the members will appear in declaration order. Note that
579# this will also influence the order of the classes in the class list.
580# The default value is: NO.
581
582SORT_BRIEF_DOCS = YES
583
584# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
585# (brief and detailed) documentation of class members so that constructors and
586# destructors are listed first. If set to NO the constructors will appear in the
587# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
588# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
589# member documentation.
590# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
591# detailed member documentation.
592# The default value is: NO.
593
594SORT_MEMBERS_CTORS_1ST = NO
595
596# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
597# of group names into alphabetical order. If set to NO the group names will
598# appear in their defined order.
599# The default value is: NO.
600
601SORT_GROUP_NAMES = NO
602
603# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
604# fully-qualified names, including namespaces. If set to NO, the class list will
605# be sorted only by class name, not including the namespace part.
606# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
607# Note: This option applies only to the class list, not to the alphabetical
608# list.
609# The default value is: NO.
610
611SORT_BY_SCOPE_NAME = YES
612
613# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
614# type resolution of all parameters of a function it will reject a match between
615# the prototype and the implementation of a member function even if there is
616# only one candidate or it is obvious which candidate to choose by doing a
617# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
618# accept a match between prototype and implementation in such cases.
619# The default value is: NO.
620
621STRICT_PROTO_MATCHING = YES
622
623# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
624# list. This list is created by putting \todo commands in the documentation.
625# The default value is: YES.
626
627GENERATE_TODOLIST = YES
628
629# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
630# list. This list is created by putting \test commands in the documentation.
631# The default value is: YES.
632
633GENERATE_TESTLIST = YES
634
635# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
636# list. This list is created by putting \bug commands in the documentation.
637# The default value is: YES.
638
639GENERATE_BUGLIST = YES
640
641# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
642# the deprecated list. This list is created by putting \deprecated commands in
643# the documentation.
644# The default value is: YES.
645
646GENERATE_DEPRECATEDLIST= YES
647
648# The ENABLED_SECTIONS tag can be used to enable conditional documentation
649# sections, marked by \if <section_label> ... \endif and \cond <section_label>
650# ... \endcond blocks.
651
652ENABLED_SECTIONS =
653
654# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
655# initial value of a variable or macro / define can have for it to appear in the
656# documentation. If the initializer consists of more lines than specified here
657# it will be hidden. Use a value of 0 to hide initializers completely. The
658# appearance of the value of individual variables and macros / defines can be
659# controlled using \showinitializer or \hideinitializer command in the
660# documentation regardless of this setting.
661# Minimum value: 0, maximum value: 10000, default value: 30.
662
663MAX_INITIALIZER_LINES = 30
664
665# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
666# the bottom of the documentation of classes and structs. If set to YES, the
667# list will mention the files that were used to generate the documentation.
668# The default value is: YES.
669
670SHOW_USED_FILES = YES
671
672# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
673# will remove the Files entry from the Quick Index and from the Folder Tree View
674# (if specified).
675# The default value is: YES.
676
677SHOW_FILES = NO
678
679# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
680# page. This will remove the Namespaces entry from the Quick Index and from the
681# Folder Tree View (if specified).
682# The default value is: YES.
683
684SHOW_NAMESPACES = NO
685
686# The FILE_VERSION_FILTER tag can be used to specify a program or script that
687# doxygen should invoke to get the current version for each file (typically from
688# the version control system). Doxygen will invoke the program by executing (via
689# popen()) the command command input-file, where command is the value of the
690# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
691# by doxygen. Whatever the program writes to standard output is used as the file
692# version. For an example see the documentation.
693
694FILE_VERSION_FILTER =
695
696# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
697# by doxygen. The layout file controls the global structure of the generated
698# output files in an output format independent way. To create the layout file
699# that represents doxygen's defaults, run doxygen with the -l option. You can
700# optionally specify a file name after the option, if omitted DoxygenLayout.xml
701# will be used as the name of the layout file.
702#
703# Note that if you run doxygen from a directory containing a file called
704# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
705# tag is left empty.
706
707LAYOUT_FILE = DoxygenLayout.xml
708
709# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
710# the reference definitions. This must be a list of .bib files. The .bib
711# extension is automatically appended if omitted. This requires the bibtex tool
712# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
713# For LaTeX the style of the bibliography can be controlled using
714# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
715# search path. See also \cite for info how to create references.
716
717CITE_BIB_FILES =
718
719#---------------------------------------------------------------------------
720# Configuration options related to warning and progress messages
721#---------------------------------------------------------------------------
722
723# The QUIET tag can be used to turn on/off the messages that are generated to
724# standard output by doxygen. If QUIET is set to YES this implies that the
725# messages are off.
726# The default value is: NO.
727
728QUIET = NO
729
730# The WARNINGS tag can be used to turn on/off the warning messages that are
731# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
732# this implies that the warnings are on.
733#
734# Tip: Turn warnings on while writing the documentation.
735# The default value is: YES.
736
737WARNINGS = YES
738
739# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
740# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
741# will automatically be disabled.
742# The default value is: YES.
743
744WARN_IF_UNDOCUMENTED = YES
745
746# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
747# potential errors in the documentation, such as not documenting some parameters
748# in a documented function, or documenting parameters that don't exist or using
749# markup commands wrongly.
750# The default value is: YES.
751
752WARN_IF_DOC_ERROR = YES
753
754# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
755# are documented, but have no documentation for their parameters or return
756# value. If set to NO, doxygen will only warn about wrong or incomplete
757# parameter documentation, but not about the absence of documentation.
758# The default value is: NO.
759
760WARN_NO_PARAMDOC = NO
761
762# The WARN_FORMAT tag determines the format of the warning messages that doxygen
763# can produce. The string should contain the $file, $line, and $text tags, which
764# will be replaced by the file and line number from which the warning originated
765# and the warning text. Optionally the format may contain $version, which will
766# be replaced by the version of the file (if it could be obtained via
767# FILE_VERSION_FILTER)
768# The default value is: $file:$line: $text.
769
770WARN_FORMAT = "$file:$line: $text"
771
772# The WARN_LOGFILE tag can be used to specify a file to which warning and error
773# messages should be written. If left blank the output is written to standard
774# error (stderr).
775
776WARN_LOGFILE =
777
778#---------------------------------------------------------------------------
779# Configuration options related to the input files
780#---------------------------------------------------------------------------
781
782# The INPUT tag is used to specify the files and/or directories that contain
783# documented source files. You may enter file names like myfile.cpp or
784# directories like /usr/src/myproject. Separate the files or directories with
785# spaces.
786# Note: If this tag is empty the current directory is searched.
787
788INPUT = main.txt \
789 General/General.dox \
790 General/DoxygenOnAddon.dox \
791 ../../../../CODING_GUIDELINES.dox \
792 ../../../GUIInfoManager.cpp \
793 Modules/modules_general.dox \
794 Modules/modules_python.dox \
795 Skin/skin.dox \
796 ../../../guilib/GUIRenderingControl.dox \
797 ../../../guilib/GUIButtonControl.dox \
798 ../../../guilib/GUIEditControl.dox \
799 ../../../epg/GUIEPGGridContainer.dox \
800 ../../../guilib/GUIFadeLabelControl.dox \
801 ../../../guilib/GUIFixedListContainer.dox \
802 ../../../guilib/GUIControlGroup.dox \
803 ../../../guilib/GUIListContainer.dox \
804 ../../../guilib/GUIImage.dox \
805 ../../../guilib/GUILabelControl.dox \
806 ../../../guilib/GUIListGroup.dox \
807 ../../../guilib/GUIMoverControl.dox \
808 ../../../guilib/GUIMultiImage.dox \
809 ../../../guilib/GUIPanelContainer.dox \
810 ../../../guilib/GUIProgressControl.dox \
811 ../../../guilib/GUIRadioButtonControl.dox \
812 ../../../guilib/GUIResizeControl.dox \
813 ../../../guilib/GUIRSSControl.dox \
814 ../../../guilib/GUIScrollBarControl.dox \
815 ../../../guilib/GUISettingsSliderControl.dox \
816 ../../../guilib/GUISpinControlEx.dox \
817 ../../../guilib/GUISliderControl.dox \
818 ../../../guilib/GUISpinControl.dox \
819 ../../../guilib/GUITextBox.dox \
820 ../../../guilib/GUIToggleButtonControl.dox \
821 ../../../guilib/GUIVideoControl.dox \
822 ../../../guilib/GUIVisualisationControl.dox \
823 ../../../guilib/GUIWrappingListContainer.dox \
824 ../../../guilib/_Controls.dox \
825 ../../../interfaces/builtins/AddonBuiltins.cpp \
826 ../../../interfaces/builtins/AndroidBuiltins.cpp \
827 ../../../interfaces/builtins/ApplicationBuiltins.cpp \
828 ../../../interfaces/builtins/CECBuiltins.cpp \
829 ../../../interfaces/builtins/GUIBuiltins.cpp \
830 ../../../interfaces/builtins/GUIContainerBuiltins.cpp \
831 ../../../interfaces/builtins/GUIControlBuiltins.cpp \
832 ../../../interfaces/builtins/LibraryBuiltins.cpp \
833 ../../../interfaces/builtins/OpticalBuiltins.cpp \
834 ../../../interfaces/builtins/PictureBuiltins.cpp \
835 ../../../interfaces/builtins/PlayerBuiltins.cpp \
836 ../../../interfaces/builtins/ProfileBuiltins.cpp \
837 ../../../interfaces/builtins/PVRBuiltins.cpp \
838 ../../../interfaces/builtins/SkinBuiltins.cpp \
839 ../../../interfaces/builtins/SystemBuiltins.cpp \
840 ../../../interfaces/builtins/WeatherBuiltins.cpp \
841 ../../../interfaces/legacy/Keyboard.h \
842 ../../../interfaces/legacy/InfoTagMusic.h \
843 ../../../interfaces/legacy/InfoTagVideo.h \
844 ../../../interfaces/legacy/Addon.h \
845 ../../../interfaces/legacy/Dialog.h \
846 ../../../interfaces/legacy/ModuleXbmc.h \
847 ../../../interfaces/legacy/ModuleXbmcgui.h \
848 ../../../interfaces/legacy/File.h \
849 ../../../interfaces/legacy/ListItem.h \
850 ../../../interfaces/legacy/Monitor.h \
851 ../../../interfaces/legacy/ModuleXbmcvfs.h \
852 ../../../interfaces/legacy/ModuleXbmcplugin.h \
853 ../../../interfaces/legacy/InfoTagRadioRDS.h \
854 ../../../interfaces/legacy/Window.h \
855 ../../../interfaces/legacy/WindowDialog.h \
856 ../../../interfaces/legacy/WindowXML.h \
857 ../../../interfaces/legacy/Stat.h \
858 ../../../interfaces/legacy/PlayList.h \
859 ../../../interfaces/legacy/Player.h \
860 ../../../interfaces/legacy/RenderCapture.h \
861 ../../../interfaces/legacy/Control.h \
862 ../../../interfaces/legacy/wsgi/WsgiErrorStream.h \
863 ../../../interfaces/legacy/wsgi/WsgiInputStream.h \
864 ../../../interfaces/legacy/wsgi/WsgiResponseBody.h \
865 ../../../interfaces/legacy/wsgi/WsgiResponse.h \
866 ../../../pictures/PictureInfoTag.cpp
867
868# This tag can be used to specify the character encoding of the source files
869# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
870# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
871# documentation (see: http://www.gnu.org/software/libiconv) for the list of
872# possible encodings.
873# The default value is: UTF-8.
874
875INPUT_ENCODING = UTF-8
876
877# If the value of the INPUT tag contains directories, you can use the
878# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
879# *.h) to filter out the source-files in the directories. If left blank the
880# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii,
881# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp,
882# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown,
883# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf,
884# *.qsf, *.as and *.js.
885
886FILE_PATTERNS = *.c \
887 *.cc \
888 *.cxx \
889 *.cpp \
890 *.c++ \
891 *.java \
892 *.ii \
893 *.ixx \
894 *.ipp \
895 *.i++ \
896 *.inl \
897 *.idl \
898 *.ddl \
899 *.odl \
900 *.h \
901 *.hh \
902 *.hxx \
903 *.hpp \
904 *.h++ \
905 *.cs \
906 *.d \
907 *.php \
908 *.php4 \
909 *.php5 \
910 *.phtml \
911 *.inc \
912 *.m \
913 *.markdown \
914 *.md \
915 *.mm \
916 *.dox \
917 *.py \
918 *.f90 \
919 *.f \
920 *.for \
921 *.tcl \
922 *.vhd \
923 *.vhdl \
924 *.ucf \
925 *.qsf \
926 *.as \
927 *.js \
928 *.GPL
929
930# The RECURSIVE tag can be used to specify whether or not subdirectories should
931# be searched for input files as well.
932# The default value is: NO.
933
934RECURSIVE = YES
935
936# The EXCLUDE tag can be used to specify files and/or directories that should be
937# excluded from the INPUT source files. This way you can easily exclude a
938# subdirectory from a directory tree whose root is specified with the INPUT tag.
939#
940# Note that relative paths are relative to the directory from which doxygen is
941# run.
942
943EXCLUDE =
944
945# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
946# directories that are symbolic links (a Unix file system feature) are excluded
947# from the input.
948# The default value is: NO.
949
950EXCLUDE_SYMLINKS = NO
951
952# If the value of the INPUT tag contains directories, you can use the
953# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
954# certain files from those directories.
955#
956# Note that the wildcards are matched against the file with absolute path, so to
957# exclude all test directories for example use the pattern */test/*
958
959EXCLUDE_PATTERNS =
960
961# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
962# (namespaces, classes, functions, etc.) that should be excluded from the
963# output. The symbol name can be a fully qualified name, a word, or if the
964# wildcard * is used, a substring. Examples: ANamespace, AClass,
965# AClass::ANamespace, ANamespace::*Test
966#
967# Note that the wildcards are matched against the file with absolute path, so to
968# exclude all test directories use the pattern */test/*
969
970EXCLUDE_SYMBOLS =
971
972# The EXAMPLE_PATH tag can be used to specify one or more files or directories
973# that contain example code fragments that are included (see the \include
974# command).
975
976EXAMPLE_PATH = .
977
978# If the value of the EXAMPLE_PATH tag contains directories, you can use the
979# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
980# *.h) to filter out the source-files in the directories. If left blank all
981# files are included.
982
983EXAMPLE_PATTERNS =
984
985# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
986# searched for input files to be used with the \include or \dontinclude commands
987# irrespective of the value of the RECURSIVE tag.
988# The default value is: NO.
989
990EXAMPLE_RECURSIVE = NO
991
992# The IMAGE_PATH tag can be used to specify one or more files or directories
993# that contain images that are to be included in the documentation (see the
994# \image command).
995
996IMAGE_PATH = .
997
998# The INPUT_FILTER tag can be used to specify a program that doxygen should
999# invoke to filter for each input file. Doxygen will invoke the filter program
1000# by executing (via popen()) the command:
1001#
1002# <filter> <input-file>
1003#
1004# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
1005# name of an input file. Doxygen will then use the output that the filter
1006# program writes to standard output. If FILTER_PATTERNS is specified, this tag
1007# will be ignored.
1008#
1009# Note that the filter must not add or remove lines; it is applied before the
1010# code is scanned, but not when the output code is generated. If lines are added
1011# or removed, the anchors will not be placed correctly.
1012
1013INPUT_FILTER =
1014
1015# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
1016# basis. Doxygen will compare the file name with each pattern and apply the
1017# filter if there is a match. The filters are a list of the form: pattern=filter
1018# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
1019# filters are used. If the FILTER_PATTERNS tag is empty or if none of the
1020# patterns match the file name, INPUT_FILTER is applied.
1021
1022FILTER_PATTERNS =
1023
1024# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
1025# INPUT_FILTER) will also be used to filter the input files that are used for
1026# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
1027# The default value is: NO.
1028
1029FILTER_SOURCE_FILES = NO
1030
1031# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
1032# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
1033# it is also possible to disable source filtering for a specific pattern using
1034# *.ext= (so without naming a filter).
1035# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
1036
1037FILTER_SOURCE_PATTERNS =
1038
1039# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
1040# is part of the input, its contents will be placed on the main page
1041# (index.html). This can be useful if you have a project on for instance GitHub
1042# and want to reuse the introduction page also for the doxygen output.
1043
1044USE_MDFILE_AS_MAINPAGE =
1045
1046#---------------------------------------------------------------------------
1047# Configuration options related to source browsing
1048#---------------------------------------------------------------------------
1049
1050# If the SOURCE_BROWSER tag is set to YES then a list of source files will be
1051# generated. Documented entities will be cross-referenced with these sources.
1052#
1053# Note: To get rid of all source code in the generated output, make sure that
1054# also VERBATIM_HEADERS is set to NO.
1055# The default value is: NO.
1056
1057SOURCE_BROWSER = NO
1058
1059# Setting the INLINE_SOURCES tag to YES will include the body of functions,
1060# classes and enums directly into the documentation.
1061# The default value is: NO.
1062
1063INLINE_SOURCES = NO
1064
1065# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
1066# special comment blocks from generated source code fragments. Normal C, C++ and
1067# Fortran comments will always remain visible.
1068# The default value is: YES.
1069
1070STRIP_CODE_COMMENTS = YES
1071
1072# If the REFERENCED_BY_RELATION tag is set to YES then for each documented
1073# function all documented functions referencing it will be listed.
1074# The default value is: NO.
1075
1076REFERENCED_BY_RELATION = NO
1077
1078# If the REFERENCES_RELATION tag is set to YES then for each documented function
1079# all documented entities called/used by that function will be listed.
1080# The default value is: NO.
1081
1082REFERENCES_RELATION = NO
1083
1084# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
1085# to YES then the hyperlinks from functions in REFERENCES_RELATION and
1086# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
1087# link to the documentation.
1088# The default value is: YES.
1089
1090REFERENCES_LINK_SOURCE = YES
1091
1092# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
1093# source code will show a tooltip with additional information such as prototype,
1094# brief description and links to the definition and documentation. Since this
1095# will make the HTML file larger and loading of large files a bit slower, you
1096# can opt to disable this feature.
1097# The default value is: YES.
1098# This tag requires that the tag SOURCE_BROWSER is set to YES.
1099
1100SOURCE_TOOLTIPS = YES
1101
1102# If the USE_HTAGS tag is set to YES then the references to source code will
1103# point to the HTML generated by the htags(1) tool instead of doxygen built-in
1104# source browser. The htags tool is part of GNU's global source tagging system
1105# (see http://www.gnu.org/software/global/global.html). You will need version
1106# 4.8.6 or higher.
1107#
1108# To use it do the following:
1109# - Install the latest version of global
1110# - Enable SOURCE_BROWSER and USE_HTAGS in the config file
1111# - Make sure the INPUT points to the root of the source tree
1112# - Run doxygen as normal
1113#
1114# Doxygen will invoke htags (and that will in turn invoke gtags), so these
1115# tools must be available from the command line (i.e. in the search path).
1116#
1117# The result: instead of the source browser generated by doxygen, the links to
1118# source code will now point to the output of htags.
1119# The default value is: NO.
1120# This tag requires that the tag SOURCE_BROWSER is set to YES.
1121
1122USE_HTAGS = NO
1123
1124# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
1125# verbatim copy of the header file for each class for which an include is
1126# specified. Set to NO to disable this.
1127# See also: Section \class.
1128# The default value is: YES.
1129
1130VERBATIM_HEADERS = YES
1131
1132# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the
1133# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the
1134# cost of reduced performance. This can be particularly helpful with template
1135# rich C++ code for which doxygen's built-in parser lacks the necessary type
1136# information.
1137# Note: The availability of this option depends on whether or not doxygen was
1138# compiled with the --with-libclang option.
1139# The default value is: NO.
1140
1141CLANG_ASSISTED_PARSING = NO
1142
1143# If clang assisted parsing is enabled you can provide the compiler with command
1144# line options that you would normally use when invoking the compiler. Note that
1145# the include paths will already be set by doxygen for the files and directories
1146# specified with INPUT and INCLUDE_PATH.
1147# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
1148
1149CLANG_OPTIONS =
1150
1151#---------------------------------------------------------------------------
1152# Configuration options related to the alphabetical class index
1153#---------------------------------------------------------------------------
1154
1155# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
1156# compounds will be generated. Enable this if the project contains a lot of
1157# classes, structs, unions or interfaces.
1158# The default value is: YES.
1159
1160ALPHABETICAL_INDEX = YES
1161
1162# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
1163# which the alphabetical index list will be split.
1164# Minimum value: 1, maximum value: 20, default value: 5.
1165# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1166
1167COLS_IN_ALPHA_INDEX = 5
1168
1169# In case all classes in a project start with a common prefix, all classes will
1170# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
1171# can be used to specify a prefix (or a list of prefixes) that should be ignored
1172# while generating the index headers.
1173# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1174
1175IGNORE_PREFIX =
1176
1177#---------------------------------------------------------------------------
1178# Configuration options related to the HTML output
1179#---------------------------------------------------------------------------
1180
1181# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
1182# The default value is: YES.
1183
1184GENERATE_HTML = YES
1185
1186# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1187# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1188# it.
1189# The default directory is: html.
1190# This tag requires that the tag GENERATE_HTML is set to YES.
1191
1192HTML_OUTPUT = html
1193
1194# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
1195# generated HTML page (for example: .htm, .php, .asp).
1196# The default value is: .html.
1197# This tag requires that the tag GENERATE_HTML is set to YES.
1198
1199HTML_FILE_EXTENSION = .html
1200
1201# The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1202# each generated HTML page. If the tag is left blank doxygen will generate a
1203# standard header.
1204#
1205# To get valid HTML the header file that includes any scripts and style sheets
1206# that doxygen needs, which is dependent on the configuration options used (e.g.
1207# the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1208# default header using
1209# doxygen -w html new_header.html new_footer.html new_stylesheet.css
1210# YourConfigFile
1211# and then modify the file new_header.html. See also section "Doxygen usage"
1212# for information on how to generate the default header that doxygen normally
1213# uses.
1214# Note: The header is subject to change so you typically have to regenerate the
1215# default header when upgrading to a newer version of doxygen. For a description
1216# of the possible markers and block names see the documentation.
1217# This tag requires that the tag GENERATE_HTML is set to YES.
1218
1219HTML_HEADER =
1220
1221# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1222# generated HTML page. If the tag is left blank doxygen will generate a standard
1223# footer. See HTML_HEADER for more information on how to generate a default
1224# footer and what special commands can be used inside the footer. See also
1225# section "Doxygen usage" for information on how to generate the default footer
1226# that doxygen normally uses.
1227# This tag requires that the tag GENERATE_HTML is set to YES.
1228
1229HTML_FOOTER =
1230
1231# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1232# sheet that is used by each HTML page. It can be used to fine-tune the look of
1233# the HTML output. If left blank doxygen will generate a default style sheet.
1234# See also section "Doxygen usage" for information on how to generate the style
1235# sheet that doxygen normally uses.
1236# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
1237# it is more robust and this tag (HTML_STYLESHEET) will in the future become
1238# obsolete.
1239# This tag requires that the tag GENERATE_HTML is set to YES.
1240
1241HTML_STYLESHEET =
1242
1243# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1244# cascading style sheets that are included after the standard style sheets
1245# created by doxygen. Using this option one can overrule certain style aspects.
1246# This is preferred over using HTML_STYLESHEET since it does not replace the
1247# standard style sheet and is therefore more robust against future updates.
1248# Doxygen will copy the style sheet files to the output directory.
1249# Note: The order of the extra style sheet files is of importance (e.g. the last
1250# style sheet in the list overrules the setting of the previous ones in the
1251# list). For an example see the documentation.
1252# This tag requires that the tag GENERATE_HTML is set to YES.
1253
1254HTML_EXTRA_STYLESHEET =
1255
1256# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1257# other source files which should be copied to the HTML output directory. Note
1258# that these files will be copied to the base HTML output directory. Use the
1259# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1260# files. In the HTML_STYLESHEET file, use the file name only. Also note that the
1261# files will be copied as-is; there are no commands or markers available.
1262# This tag requires that the tag GENERATE_HTML is set to YES.
1263
1264HTML_EXTRA_FILES = LICENSE.GPL
1265
1266# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
1267# will adjust the colors in the style sheet and background images according to
1268# this color. Hue is specified as an angle on a colorwheel, see
1269# http://en.wikipedia.org/wiki/Hue for more information. For instance the value
1270# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
1271# purple, and 360 is red again.
1272# Minimum value: 0, maximum value: 359, default value: 220.
1273# This tag requires that the tag GENERATE_HTML is set to YES.
1274
1275HTML_COLORSTYLE_HUE = 220
1276
1277# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
1278# in the HTML output. For a value of 0 the output will use grayscales only. A
1279# value of 255 will produce the most vivid colors.
1280# Minimum value: 0, maximum value: 255, default value: 100.
1281# This tag requires that the tag GENERATE_HTML is set to YES.
1282
1283HTML_COLORSTYLE_SAT = 100
1284
1285# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
1286# luminance component of the colors in the HTML output. Values below 100
1287# gradually make the output lighter, whereas values above 100 make the output
1288# darker. The value divided by 100 is the actual gamma applied, so 80 represents
1289# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
1290# change the gamma.
1291# Minimum value: 40, maximum value: 240, default value: 80.
1292# This tag requires that the tag GENERATE_HTML is set to YES.
1293
1294HTML_COLORSTYLE_GAMMA = 80
1295
1296# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1297# page will contain the date and time when the page was generated. Setting this
1298# to YES can help to show when doxygen was last run and thus if the
1299# documentation is up to date.
1300# The default value is: NO.
1301# This tag requires that the tag GENERATE_HTML is set to YES.
1302
1303HTML_TIMESTAMP = NO
1304
1305# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1306# documentation will contain sections that can be hidden and shown after the
1307# page has loaded.
1308# The default value is: NO.
1309# This tag requires that the tag GENERATE_HTML is set to YES.
1310
1311HTML_DYNAMIC_SECTIONS = NO
1312
1313# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
1314# shown in the various tree structured indices initially; the user can expand
1315# and collapse entries dynamically later on. Doxygen will expand the tree to
1316# such a level that at most the specified number of entries are visible (unless
1317# a fully collapsed tree already exceeds this amount). So setting the number of
1318# entries 1 will produce a full collapsed tree by default. 0 is a special value
1319# representing an infinite number of entries and will result in a full expanded
1320# tree by default.
1321# Minimum value: 0, maximum value: 9999, default value: 100.
1322# This tag requires that the tag GENERATE_HTML is set to YES.
1323
1324HTML_INDEX_NUM_ENTRIES = 100
1325
1326# If the GENERATE_DOCSET tag is set to YES, additional index files will be
1327# generated that can be used as input for Apple's Xcode 3 integrated development
1328# environment (see: http://developer.apple.com/tools/xcode/), introduced with
1329# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
1330# Makefile in the HTML output directory. Running make will produce the docset in
1331# that directory and running make install will install the docset in
1332# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
1333# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
1334# for more information.
1335# The default value is: NO.
1336# This tag requires that the tag GENERATE_HTML is set to YES.
1337
1338GENERATE_DOCSET = NO
1339
1340# This tag determines the name of the docset feed. A documentation feed provides
1341# an umbrella under which multiple documentation sets from a single provider
1342# (such as a company or product suite) can be grouped.
1343# The default value is: Doxygen generated docs.
1344# This tag requires that the tag GENERATE_DOCSET is set to YES.
1345
1346DOCSET_FEEDNAME = "Doxygen generated docs"
1347
1348# This tag specifies a string that should uniquely identify the documentation
1349# set bundle. This should be a reverse domain-name style string, e.g.
1350# com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1351# The default value is: org.doxygen.Project.
1352# This tag requires that the tag GENERATE_DOCSET is set to YES.
1353
1354DOCSET_BUNDLE_ID = org.doxygen.Project
1355
1356# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
1357# the documentation publisher. This should be a reverse domain-name style
1358# string, e.g. com.mycompany.MyDocSet.documentation.
1359# The default value is: org.doxygen.Publisher.
1360# This tag requires that the tag GENERATE_DOCSET is set to YES.
1361
1362DOCSET_PUBLISHER_ID = org.doxygen.Publisher
1363
1364# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
1365# The default value is: Publisher.
1366# This tag requires that the tag GENERATE_DOCSET is set to YES.
1367
1368DOCSET_PUBLISHER_NAME = Publisher
1369
1370# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1371# additional HTML index files: index.hhp, index.hhc, and index.hhk. The
1372# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1373# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
1374# Windows.
1375#
1376# The HTML Help Workshop contains a compiler that can convert all HTML output
1377# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
1378# files are now used as the Windows 98 help format, and will replace the old
1379# Windows help format (.hlp) on all Windows platforms in the future. Compressed
1380# HTML files also contain an index, a table of contents, and you can search for
1381# words in the documentation. The HTML workshop also contains a viewer for
1382# compressed HTML files.
1383# The default value is: NO.
1384# This tag requires that the tag GENERATE_HTML is set to YES.
1385
1386GENERATE_HTMLHELP = NO
1387
1388# The CHM_FILE tag can be used to specify the file name of the resulting .chm
1389# file. You can add a path in front of the file if the result should not be
1390# written to the html output directory.
1391# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1392
1393CHM_FILE =
1394
1395# The HHC_LOCATION tag can be used to specify the location (absolute path
1396# including file name) of the HTML help compiler (hhc.exe). If non-empty,
1397# doxygen will try to run the HTML help compiler on the generated index.hhp.
1398# The file has to be specified with full path.
1399# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1400
1401HHC_LOCATION =
1402
1403# The GENERATE_CHI flag controls if a separate .chi index file is generated
1404# (YES) or that it should be included in the master .chm file (NO).
1405# The default value is: NO.
1406# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1407
1408GENERATE_CHI = NO
1409
1410# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
1411# and project file content.
1412# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1413
1414CHM_INDEX_ENCODING =
1415
1416# The BINARY_TOC flag controls whether a binary table of contents is generated
1417# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
1418# enables the Previous and Next buttons.
1419# The default value is: NO.
1420# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1421
1422BINARY_TOC = NO
1423
1424# The TOC_EXPAND flag can be set to YES to add extra items for group members to
1425# the table of contents of the HTML help documentation and to the tree view.
1426# The default value is: NO.
1427# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1428
1429TOC_EXPAND = NO
1430
1431# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1432# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
1433# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1434# (.qch) of the generated HTML documentation.
1435# The default value is: NO.
1436# This tag requires that the tag GENERATE_HTML is set to YES.
1437
1438GENERATE_QHP = NO
1439
1440# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1441# the file name of the resulting .qch file. The path specified is relative to
1442# the HTML output folder.
1443# This tag requires that the tag GENERATE_QHP is set to YES.
1444
1445QCH_FILE =
1446
1447# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
1448# Project output. For more information please see Qt Help Project / Namespace
1449# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
1450# The default value is: org.doxygen.Project.
1451# This tag requires that the tag GENERATE_QHP is set to YES.
1452
1453QHP_NAMESPACE = org.doxygen.Project
1454
1455# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
1456# Help Project output. For more information please see Qt Help Project / Virtual
1457# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
1458# folders).
1459# The default value is: doc.
1460# This tag requires that the tag GENERATE_QHP is set to YES.
1461
1462QHP_VIRTUAL_FOLDER = doc
1463
1464# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1465# filter to add. For more information please see Qt Help Project / Custom
1466# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1467# filters).
1468# This tag requires that the tag GENERATE_QHP is set to YES.
1469
1470QHP_CUST_FILTER_NAME =
1471
1472# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
1473# custom filter to add. For more information please see Qt Help Project / Custom
1474# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
1475# filters).
1476# This tag requires that the tag GENERATE_QHP is set to YES.
1477
1478QHP_CUST_FILTER_ATTRS =
1479
1480# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1481# project's filter section matches. Qt Help Project / Filter Attributes (see:
1482# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
1483# This tag requires that the tag GENERATE_QHP is set to YES.
1484
1485QHP_SECT_FILTER_ATTRS =
1486
1487# The QHG_LOCATION tag can be used to specify the location of Qt's
1488# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
1489# generated .qhp file.
1490# This tag requires that the tag GENERATE_QHP is set to YES.
1491
1492QHG_LOCATION =
1493
1494# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1495# generated, together with the HTML files, they form an Eclipse help plugin. To
1496# install this plugin and make it available under the help contents menu in
1497# Eclipse, the contents of the directory containing the HTML and XML files needs
1498# to be copied into the plugins directory of eclipse. The name of the directory
1499# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
1500# After copying Eclipse needs to be restarted before the help appears.
1501# The default value is: NO.
1502# This tag requires that the tag GENERATE_HTML is set to YES.
1503
1504GENERATE_ECLIPSEHELP = NO
1505
1506# A unique identifier for the Eclipse help plugin. When installing the plugin
1507# the directory name containing the HTML and XML files should also have this
1508# name. Each documentation set should have its own identifier.
1509# The default value is: org.doxygen.Project.
1510# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1511
1512ECLIPSE_DOC_ID = org.doxygen.Project
1513
1514# If you want full control over the layout of the generated HTML pages it might
1515# be necessary to disable the index and replace it with your own. The
1516# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
1517# of each HTML page. A value of NO enables the index and the value YES disables
1518# it. Since the tabs in the index contain the same information as the navigation
1519# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
1520# The default value is: NO.
1521# This tag requires that the tag GENERATE_HTML is set to YES.
1522
1523DISABLE_INDEX = YES
1524
1525# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1526# structure should be generated to display hierarchical information. If the tag
1527# value is set to YES, a side panel will be generated containing a tree-like
1528# index structure (just like the one that is generated for HTML Help). For this
1529# to work a browser that supports JavaScript, DHTML, CSS and frames is required
1530# (i.e. any modern browser). Windows users are probably better off using the
1531# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
1532# further fine-tune the look of the index. As an example, the default style
1533# sheet generated by doxygen has an example that shows how to put an image at
1534# the root of the tree instead of the PROJECT_NAME. Since the tree basically has
1535# the same information as the tab index, you could consider setting
1536# DISABLE_INDEX to YES when enabling this option.
1537# The default value is: NO.
1538# This tag requires that the tag GENERATE_HTML is set to YES.
1539
1540GENERATE_TREEVIEW = YES
1541
1542# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1543# doxygen will group on one line in the generated HTML documentation.
1544#
1545# Note that a value of 0 will completely suppress the enum values from appearing
1546# in the overview section.
1547# Minimum value: 0, maximum value: 20, default value: 4.
1548# This tag requires that the tag GENERATE_HTML is set to YES.
1549
1550ENUM_VALUES_PER_LINE = 4
1551
1552# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
1553# to set the initial width (in pixels) of the frame in which the tree is shown.
1554# Minimum value: 0, maximum value: 1500, default value: 250.
1555# This tag requires that the tag GENERATE_HTML is set to YES.
1556
1557TREEVIEW_WIDTH = 250
1558
1559# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
1560# external symbols imported via tag files in a separate window.
1561# The default value is: NO.
1562# This tag requires that the tag GENERATE_HTML is set to YES.
1563
1564EXT_LINKS_IN_WINDOW = NO
1565
1566# Use this tag to change the font size of LaTeX formulas included as images in
1567# the HTML documentation. When you change the font size after a successful
1568# doxygen run you need to manually remove any form_*.png images from the HTML
1569# output directory to force them to be regenerated.
1570# Minimum value: 8, maximum value: 50, default value: 10.
1571# This tag requires that the tag GENERATE_HTML is set to YES.
1572
1573FORMULA_FONTSIZE = 10
1574
1575# Use the FORMULA_TRANSPARENT tag to determine whether or not the images
1576# generated for formulas are transparent PNGs. Transparent PNGs are not
1577# supported properly for IE 6.0, but are supported on all modern browsers.
1578#
1579# Note that when changing this option you need to delete any form_*.png files in
1580# the HTML output directory before the changes have effect.
1581# The default value is: YES.
1582# This tag requires that the tag GENERATE_HTML is set to YES.
1583
1584FORMULA_TRANSPARENT = YES
1585
1586# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
1587# http://www.mathjax.org) which uses client side Javascript for the rendering
1588# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
1589# installed or if you want to formulas look prettier in the HTML output. When
1590# enabled you may also need to install MathJax separately and configure the path
1591# to it using the MATHJAX_RELPATH option.
1592# The default value is: NO.
1593# This tag requires that the tag GENERATE_HTML is set to YES.
1594
1595USE_MATHJAX = NO
1596
1597# When MathJax is enabled you can set the default output format to be used for
1598# the MathJax output. See the MathJax site (see:
1599# http://docs.mathjax.org/en/latest/output.html) for more details.
1600# Possible values are: HTML-CSS (which is slower, but has the best
1601# compatibility), NativeMML (i.e. MathML) and SVG.
1602# The default value is: HTML-CSS.
1603# This tag requires that the tag USE_MATHJAX is set to YES.
1604
1605MATHJAX_FORMAT = HTML-CSS
1606
1607# When MathJax is enabled you need to specify the location relative to the HTML
1608# output directory using the MATHJAX_RELPATH option. The destination directory
1609# should contain the MathJax.js script. For instance, if the mathjax directory
1610# is located at the same level as the HTML output directory, then
1611# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1612# Content Delivery Network so you can quickly see the result without installing
1613# MathJax. However, it is strongly recommended to install a local copy of
1614# MathJax from http://www.mathjax.org before deployment.
1615# The default value is: http://cdn.mathjax.org/mathjax/latest.
1616# This tag requires that the tag USE_MATHJAX is set to YES.
1617
1618MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
1619
1620# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
1621# extension names that should be enabled during MathJax rendering. For example
1622# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
1623# This tag requires that the tag USE_MATHJAX is set to YES.
1624
1625MATHJAX_EXTENSIONS =
1626
1627# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1628# of code that will be used on startup of the MathJax code. See the MathJax site
1629# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
1630# example see the documentation.
1631# This tag requires that the tag USE_MATHJAX is set to YES.
1632
1633MATHJAX_CODEFILE =
1634
1635# When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1636# the HTML output. The underlying search engine uses javascript and DHTML and
1637# should work on any modern browser. Note that when using HTML help
1638# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
1639# there is already a search function so this one should typically be disabled.
1640# For large projects the javascript based search engine can be slow, then
1641# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1642# search using the keyboard; to jump to the search box use <access key> + S
1643# (what the <access key> is depends on the OS and browser, but it is typically
1644# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
1645# key> to jump into the search results window, the results can be navigated
1646# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
1647# the search. The filter options can be selected when the cursor is inside the
1648# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
1649# to select a filter and <Enter> or <escape> to activate or cancel the filter
1650# option.
1651# The default value is: YES.
1652# This tag requires that the tag GENERATE_HTML is set to YES.
1653
1654SEARCHENGINE = YES
1655
1656# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1657# implemented using a web server instead of a web client using Javascript. There
1658# are two flavors of web server based searching depending on the EXTERNAL_SEARCH
1659# setting. When disabled, doxygen will generate a PHP script for searching and
1660# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
1661# and searching needs to be provided by external tools. See the section
1662# "External Indexing and Searching" for details.
1663# The default value is: NO.
1664# This tag requires that the tag SEARCHENGINE is set to YES.
1665
1666SERVER_BASED_SEARCH = NO
1667
1668# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
1669# script for searching. Instead the search results are written to an XML file
1670# which needs to be processed by an external indexer. Doxygen will invoke an
1671# external search engine pointed to by the SEARCHENGINE_URL option to obtain the
1672# search results.
1673#
1674# Doxygen ships with an example indexer (doxyindexer) and search engine
1675# (doxysearch.cgi) which are based on the open source search engine library
1676# Xapian (see: http://xapian.org/).
1677#
1678# See the section "External Indexing and Searching" for details.
1679# The default value is: NO.
1680# This tag requires that the tag SEARCHENGINE is set to YES.
1681
1682EXTERNAL_SEARCH = NO
1683
1684# The SEARCHENGINE_URL should point to a search engine hosted by a web server
1685# which will return the search results when EXTERNAL_SEARCH is enabled.
1686#
1687# Doxygen ships with an example indexer (doxyindexer) and search engine
1688# (doxysearch.cgi) which are based on the open source search engine library
1689# Xapian (see: http://xapian.org/). See the section "External Indexing and
1690# Searching" for details.
1691# This tag requires that the tag SEARCHENGINE is set to YES.
1692
1693SEARCHENGINE_URL =
1694
1695# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
1696# search data is written to a file for indexing by an external tool. With the
1697# SEARCHDATA_FILE tag the name of this file can be specified.
1698# The default file is: searchdata.xml.
1699# This tag requires that the tag SEARCHENGINE is set to YES.
1700
1701SEARCHDATA_FILE = searchdata.xml
1702
1703# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
1704# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
1705# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
1706# projects and redirect the results back to the right project.
1707# This tag requires that the tag SEARCHENGINE is set to YES.
1708
1709EXTERNAL_SEARCH_ID =
1710
1711# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1712# projects other than the one defined by this configuration file, but that are
1713# all added to the same external search index. Each project needs to have a
1714# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
1715# to a relative location where the documentation can be found. The format is:
1716# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
1717# This tag requires that the tag SEARCHENGINE is set to YES.
1718
1719EXTRA_SEARCH_MAPPINGS =
1720
1721#---------------------------------------------------------------------------
1722# Configuration options related to the LaTeX output
1723#---------------------------------------------------------------------------
1724
1725# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
1726# The default value is: YES.
1727
1728GENERATE_LATEX = NO
1729
1730# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1731# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1732# it.
1733# The default directory is: latex.
1734# This tag requires that the tag GENERATE_LATEX is set to YES.
1735
1736LATEX_OUTPUT = latex
1737
1738# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1739# invoked.
1740#
1741# Note that when enabling USE_PDFLATEX this option is only used for generating
1742# bitmaps for formulas in the HTML output, but not in the Makefile that is
1743# written to the output directory.
1744# The default file is: latex.
1745# This tag requires that the tag GENERATE_LATEX is set to YES.
1746
1747LATEX_CMD_NAME = latex
1748
1749# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
1750# index for LaTeX.
1751# The default file is: makeindex.
1752# This tag requires that the tag GENERATE_LATEX is set to YES.
1753
1754MAKEINDEX_CMD_NAME = makeindex
1755
1756# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
1757# documents. This may be useful for small projects and may help to save some
1758# trees in general.
1759# The default value is: NO.
1760# This tag requires that the tag GENERATE_LATEX is set to YES.
1761
1762COMPACT_LATEX = NO
1763
1764# The PAPER_TYPE tag can be used to set the paper type that is used by the
1765# printer.
1766# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
1767# 14 inches) and executive (7.25 x 10.5 inches).
1768# The default value is: a4.
1769# This tag requires that the tag GENERATE_LATEX is set to YES.
1770
1771PAPER_TYPE = a4
1772
1773# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
1774# that should be included in the LaTeX output. To get the times font for
1775# instance you can specify
1776# EXTRA_PACKAGES=times
1777# If left blank no extra packages will be included.
1778# This tag requires that the tag GENERATE_LATEX is set to YES.
1779
1780EXTRA_PACKAGES =
1781
1782# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
1783# generated LaTeX document. The header should contain everything until the first
1784# chapter. If it is left blank doxygen will generate a standard header. See
1785# section "Doxygen usage" for information on how to let doxygen write the
1786# default header to a separate file.
1787#
1788# Note: Only use a user-defined header if you know what you are doing! The
1789# following commands have a special meaning inside the header: $title,
1790# $datetime, $date, $doxygenversion, $projectname, $projectnumber,
1791# $projectbrief, $projectlogo. Doxygen will replace $title with the empty
1792# string, for the replacement values of the other commands the user is referred
1793# to HTML_HEADER.
1794# This tag requires that the tag GENERATE_LATEX is set to YES.
1795
1796LATEX_HEADER =
1797
1798# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
1799# generated LaTeX document. The footer should contain everything after the last
1800# chapter. If it is left blank doxygen will generate a standard footer. See
1801# LATEX_HEADER for more information on how to generate a default footer and what
1802# special commands can be used inside the footer.
1803#
1804# Note: Only use a user-defined footer if you know what you are doing!
1805# This tag requires that the tag GENERATE_LATEX is set to YES.
1806
1807LATEX_FOOTER =
1808
1809# The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1810# LaTeX style sheets that are included after the standard style sheets created
1811# by doxygen. Using this option one can overrule certain style aspects. Doxygen
1812# will copy the style sheet files to the output directory.
1813# Note: The order of the extra style sheet files is of importance (e.g. the last
1814# style sheet in the list overrules the setting of the previous ones in the
1815# list).
1816# This tag requires that the tag GENERATE_LATEX is set to YES.
1817
1818LATEX_EXTRA_STYLESHEET =
1819
1820# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
1821# other source files which should be copied to the LATEX_OUTPUT output
1822# directory. Note that the files will be copied as-is; there are no commands or
1823# markers available.
1824# This tag requires that the tag GENERATE_LATEX is set to YES.
1825
1826LATEX_EXTRA_FILES =
1827
1828# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
1829# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
1830# contain links (just like the HTML output) instead of page references. This
1831# makes the output suitable for online browsing using a PDF viewer.
1832# The default value is: YES.
1833# This tag requires that the tag GENERATE_LATEX is set to YES.
1834
1835PDF_HYPERLINKS = YES
1836
1837# If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
1838# the PDF file directly from the LaTeX files. Set this option to YES, to get a
1839# higher quality PDF documentation.
1840# The default value is: YES.
1841# This tag requires that the tag GENERATE_LATEX is set to YES.
1842
1843USE_PDFLATEX = YES
1844
1845# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
1846# command to the generated LaTeX files. This will instruct LaTeX to keep running
1847# if errors occur, instead of asking the user for help. This option is also used
1848# when generating formulas in HTML.
1849# The default value is: NO.
1850# This tag requires that the tag GENERATE_LATEX is set to YES.
1851
1852LATEX_BATCHMODE = NO
1853
1854# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
1855# index chapters (such as File Index, Compound Index, etc.) in the output.
1856# The default value is: NO.
1857# This tag requires that the tag GENERATE_LATEX is set to YES.
1858
1859LATEX_HIDE_INDICES = NO
1860
1861# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
1862# code with syntax highlighting in the LaTeX output.
1863#
1864# Note that which sources are shown also depends on other settings such as
1865# SOURCE_BROWSER.
1866# The default value is: NO.
1867# This tag requires that the tag GENERATE_LATEX is set to YES.
1868
1869LATEX_SOURCE_CODE = NO
1870
1871# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1872# bibliography, e.g. plainnat, or ieeetr. See
1873# http://en.wikipedia.org/wiki/BibTeX and \cite for more info.
1874# The default value is: plain.
1875# This tag requires that the tag GENERATE_LATEX is set to YES.
1876
1877LATEX_BIB_STYLE = plain
1878
1879#---------------------------------------------------------------------------
1880# Configuration options related to the RTF output
1881#---------------------------------------------------------------------------
1882
1883# If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
1884# RTF output is optimized for Word 97 and may not look too pretty with other RTF
1885# readers/editors.
1886# The default value is: NO.
1887
1888GENERATE_RTF = NO
1889
1890# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
1891# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1892# it.
1893# The default directory is: rtf.
1894# This tag requires that the tag GENERATE_RTF is set to YES.
1895
1896RTF_OUTPUT = rtf
1897
1898# If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
1899# documents. This may be useful for small projects and may help to save some
1900# trees in general.
1901# The default value is: NO.
1902# This tag requires that the tag GENERATE_RTF is set to YES.
1903
1904COMPACT_RTF = NO
1905
1906# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
1907# contain hyperlink fields. The RTF file will contain links (just like the HTML
1908# output) instead of page references. This makes the output suitable for online
1909# browsing using Word or some other Word compatible readers that support those
1910# fields.
1911#
1912# Note: WordPad (write) and others do not support links.
1913# The default value is: NO.
1914# This tag requires that the tag GENERATE_RTF is set to YES.
1915
1916RTF_HYPERLINKS = NO
1917
1918# Load stylesheet definitions from file. Syntax is similar to doxygen's config
1919# file, i.e. a series of assignments. You only have to provide replacements,
1920# missing definitions are set to their default value.
1921#
1922# See also section "Doxygen usage" for information on how to generate the
1923# default style sheet that doxygen normally uses.
1924# This tag requires that the tag GENERATE_RTF is set to YES.
1925
1926RTF_STYLESHEET_FILE =
1927
1928# Set optional variables used in the generation of an RTF document. Syntax is
1929# similar to doxygen's config file. A template extensions file can be generated
1930# using doxygen -e rtf extensionFile.
1931# This tag requires that the tag GENERATE_RTF is set to YES.
1932
1933RTF_EXTENSIONS_FILE =
1934
1935# If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
1936# with syntax highlighting in the RTF output.
1937#
1938# Note that which sources are shown also depends on other settings such as
1939# SOURCE_BROWSER.
1940# The default value is: NO.
1941# This tag requires that the tag GENERATE_RTF is set to YES.
1942
1943RTF_SOURCE_CODE = NO
1944
1945#---------------------------------------------------------------------------
1946# Configuration options related to the man page output
1947#---------------------------------------------------------------------------
1948
1949# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
1950# classes and files.
1951# The default value is: NO.
1952
1953GENERATE_MAN = NO
1954
1955# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
1956# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1957# it. A directory man3 will be created inside the directory specified by
1958# MAN_OUTPUT.
1959# The default directory is: man.
1960# This tag requires that the tag GENERATE_MAN is set to YES.
1961
1962MAN_OUTPUT = man
1963
1964# The MAN_EXTENSION tag determines the extension that is added to the generated
1965# man pages. In case the manual section does not start with a number, the number
1966# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
1967# optional.
1968# The default value is: .3.
1969# This tag requires that the tag GENERATE_MAN is set to YES.
1970
1971MAN_EXTENSION = .3
1972
1973# The MAN_SUBDIR tag determines the name of the directory created within
1974# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
1975# MAN_EXTENSION with the initial . removed.
1976# This tag requires that the tag GENERATE_MAN is set to YES.
1977
1978MAN_SUBDIR =
1979
1980# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
1981# will generate one additional man file for each entity documented in the real
1982# man page(s). These additional files only source the real man page, but without
1983# them the man command would be unable to find the correct page.
1984# The default value is: NO.
1985# This tag requires that the tag GENERATE_MAN is set to YES.
1986
1987MAN_LINKS = NO
1988
1989#---------------------------------------------------------------------------
1990# Configuration options related to the XML output
1991#---------------------------------------------------------------------------
1992
1993# If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
1994# captures the structure of the code including all documentation.
1995# The default value is: NO.
1996
1997GENERATE_XML = NO
1998
1999# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
2000# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2001# it.
2002# The default directory is: xml.
2003# This tag requires that the tag GENERATE_XML is set to YES.
2004
2005XML_OUTPUT = xml
2006
2007# If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
2008# listings (including syntax highlighting and cross-referencing information) to
2009# the XML output. Note that enabling this will significantly increase the size
2010# of the XML output.
2011# The default value is: YES.
2012# This tag requires that the tag GENERATE_XML is set to YES.
2013
2014XML_PROGRAMLISTING = YES
2015
2016#---------------------------------------------------------------------------
2017# Configuration options related to the DOCBOOK output
2018#---------------------------------------------------------------------------
2019
2020# If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
2021# that can be used to generate PDF.
2022# The default value is: NO.
2023
2024GENERATE_DOCBOOK = NO
2025
2026# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
2027# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
2028# front of it.
2029# The default directory is: docbook.
2030# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
2031
2032DOCBOOK_OUTPUT = docbook
2033
2034# If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
2035# program listings (including syntax highlighting and cross-referencing
2036# information) to the DOCBOOK output. Note that enabling this will significantly
2037# increase the size of the DOCBOOK output.
2038# The default value is: NO.
2039# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
2040
2041DOCBOOK_PROGRAMLISTING = NO
2042
2043#---------------------------------------------------------------------------
2044# Configuration options for the AutoGen Definitions output
2045#---------------------------------------------------------------------------
2046
2047# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
2048# AutoGen Definitions (see http://autogen.sf.net) file that captures the
2049# structure of the code including all documentation. Note that this feature is
2050# still experimental and incomplete at the moment.
2051# The default value is: NO.
2052
2053GENERATE_AUTOGEN_DEF = NO
2054
2055#---------------------------------------------------------------------------
2056# Configuration options related to the Perl module output
2057#---------------------------------------------------------------------------
2058
2059# If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
2060# file that captures the structure of the code including all documentation.
2061#
2062# Note that this feature is still experimental and incomplete at the moment.
2063# The default value is: NO.
2064
2065GENERATE_PERLMOD = NO
2066
2067# If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
2068# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
2069# output from the Perl module output.
2070# The default value is: NO.
2071# This tag requires that the tag GENERATE_PERLMOD is set to YES.
2072
2073PERLMOD_LATEX = NO
2074
2075# If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
2076# formatted so it can be parsed by a human reader. This is useful if you want to
2077# understand what is going on. On the other hand, if this tag is set to NO, the
2078# size of the Perl module output will be much smaller and Perl will parse it
2079# just the same.
2080# The default value is: YES.
2081# This tag requires that the tag GENERATE_PERLMOD is set to YES.
2082
2083PERLMOD_PRETTY = YES
2084
2085# The names of the make variables in the generated doxyrules.make file are
2086# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
2087# so different doxyrules.make files included by the same Makefile don't
2088# overwrite each other's variables.
2089# This tag requires that the tag GENERATE_PERLMOD is set to YES.
2090
2091PERLMOD_MAKEVAR_PREFIX =
2092
2093#---------------------------------------------------------------------------
2094# Configuration options related to the preprocessor
2095#---------------------------------------------------------------------------
2096
2097# If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
2098# C-preprocessor directives found in the sources and include files.
2099# The default value is: YES.
2100
2101ENABLE_PREPROCESSING = YES
2102
2103# If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
2104# in the source code. If set to NO, only conditional compilation will be
2105# performed. Macro expansion can be done in a controlled way by setting
2106# EXPAND_ONLY_PREDEF to YES.
2107# The default value is: NO.
2108# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2109
2110MACRO_EXPANSION = NO
2111
2112# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
2113# the macro expansion is limited to the macros specified with the PREDEFINED and
2114# EXPAND_AS_DEFINED tags.
2115# The default value is: NO.
2116# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2117
2118EXPAND_ONLY_PREDEF = NO
2119
2120# If the SEARCH_INCLUDES tag is set to YES, the include files in the
2121# INCLUDE_PATH will be searched if a #include is found.
2122# The default value is: YES.
2123# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2124
2125SEARCH_INCLUDES = YES
2126
2127# The INCLUDE_PATH tag can be used to specify one or more directories that
2128# contain include files that are not input files but should be processed by the
2129# preprocessor.
2130# This tag requires that the tag SEARCH_INCLUDES is set to YES.
2131
2132INCLUDE_PATH =
2133
2134# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
2135# patterns (like *.h and *.hpp) to filter out the header-files in the
2136# directories. If left blank, the patterns specified with FILE_PATTERNS will be
2137# used.
2138# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2139
2140INCLUDE_FILE_PATTERNS =
2141
2142# The PREDEFINED tag can be used to specify one or more macro names that are
2143# defined before the preprocessor is started (similar to the -D option of e.g.
2144# gcc). The argument of the tag is a list of macros of the form: name or
2145# name=definition (no spaces). If the definition and the "=" are omitted, "=1"
2146# is assumed. To prevent a macro definition from being undefined via #undef or
2147# recursively expanded use the := operator instead of the = operator.
2148# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2149
2150PREDEFINED = DOXYGEN_SHOULD_SKIP_THIS \
2151 DOXYGEN_SHOULD_USE_THIS
2152
2153# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
2154# tag can be used to specify a list of macro names that should be expanded. The
2155# macro definition that is found in the sources will be used. Use the PREDEFINED
2156# tag if you want to use a different macro definition that overrules the
2157# definition found in the source code.
2158# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2159
2160EXPAND_AS_DEFINED =
2161
2162# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
2163# remove all references to function-like macros that are alone on a line, have
2164# an all uppercase name, and do not end with a semicolon. Such function macros
2165# are typically used for boiler-plate code, and will confuse the parser if not
2166# removed.
2167# The default value is: YES.
2168# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2169
2170SKIP_FUNCTION_MACROS = YES
2171
2172#---------------------------------------------------------------------------
2173# Configuration options related to external references
2174#---------------------------------------------------------------------------
2175
2176# The TAGFILES tag can be used to specify one or more tag files. For each tag
2177# file the location of the external documentation should be added. The format of
2178# a tag file without this location is as follows:
2179# TAGFILES = file1 file2 ...
2180# Adding location for the tag files is done as follows:
2181# TAGFILES = file1=loc1 "file2 = loc2" ...
2182# where loc1 and loc2 can be relative or absolute paths or URLs. See the
2183# section "Linking to external documentation" for more information about the use
2184# of tag files.
2185# Note: Each tag file must have a unique name (where the name does NOT include
2186# the path). If a tag file is not located in the directory in which doxygen is
2187# run, you must also specify the path to the tagfile here.
2188
2189TAGFILES =
2190
2191# When a file name is specified after GENERATE_TAGFILE, doxygen will create a
2192# tag file that is based on the input files it reads. See section "Linking to
2193# external documentation" for more information about the usage of tag files.
2194
2195GENERATE_TAGFILE =
2196
2197# If the ALLEXTERNALS tag is set to YES, all external class will be listed in
2198# the class index. If set to NO, only the inherited external classes will be
2199# listed.
2200# The default value is: NO.
2201
2202ALLEXTERNALS = NO
2203
2204# If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
2205# in the modules index. If set to NO, only the current project's groups will be
2206# listed.
2207# The default value is: YES.
2208
2209EXTERNAL_GROUPS = YES
2210
2211# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
2212# the related pages index. If set to NO, only the current project's pages will
2213# be listed.
2214# The default value is: YES.
2215
2216EXTERNAL_PAGES = YES
2217
2218# The PERL_PATH should be the absolute path and name of the perl script
2219# interpreter (i.e. the result of 'which perl').
2220# The default file (with absolute path) is: /usr/bin/perl.
2221
2222PERL_PATH = /usr/bin/perl
2223
2224#---------------------------------------------------------------------------
2225# Configuration options related to the dot tool
2226#---------------------------------------------------------------------------
2227
2228# If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
2229# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
2230# NO turns the diagrams off. Note that this option also works with HAVE_DOT
2231# disabled, but it is recommended to install and use dot, since it yields more
2232# powerful graphs.
2233# The default value is: YES.
2234
2235CLASS_DIAGRAMS = NO
2236
2237# You can define message sequence charts within doxygen comments using the \msc
2238# command. Doxygen will then run the mscgen tool (see:
2239# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
2240# documentation. The MSCGEN_PATH tag allows you to specify the directory where
2241# the mscgen tool resides. If left empty the tool is assumed to be found in the
2242# default search path.
2243
2244MSCGEN_PATH =
2245
2246# You can include diagrams made with dia in doxygen documentation. Doxygen will
2247# then run dia to produce the diagram and insert it in the documentation. The
2248# DIA_PATH tag allows you to specify the directory where the dia binary resides.
2249# If left empty dia is assumed to be found in the default search path.
2250
2251DIA_PATH =
2252
2253# If set to YES the inheritance and collaboration graphs will hide inheritance
2254# and usage relations if the target is undocumented or is not a class.
2255# The default value is: YES.
2256
2257HIDE_UNDOC_RELATIONS = YES
2258
2259# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2260# available from the path. This tool is part of Graphviz (see:
2261# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
2262# Bell Labs. The other options in this section have no effect if this option is
2263# set to NO
2264# The default value is: YES.
2265
2266HAVE_DOT = NO
2267
2268# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
2269# to run in parallel. When set to 0 doxygen will base this on the number of
2270# processors available in the system. You can set it explicitly to a value
2271# larger than 0 to get control over the balance between CPU load and processing
2272# speed.
2273# Minimum value: 0, maximum value: 32, default value: 0.
2274# This tag requires that the tag HAVE_DOT is set to YES.
2275
2276DOT_NUM_THREADS = 0
2277
2278# When you want a differently looking font in the dot files that doxygen
2279# generates you can specify the font name using DOT_FONTNAME. You need to make
2280# sure dot is able to find the font, which can be done by putting it in a
2281# standard location or by setting the DOTFONTPATH environment variable or by
2282# setting DOT_FONTPATH to the directory containing the font.
2283# The default value is: Helvetica.
2284# This tag requires that the tag HAVE_DOT is set to YES.
2285
2286DOT_FONTNAME = Helvetica
2287
2288# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
2289# dot graphs.
2290# Minimum value: 4, maximum value: 24, default value: 10.
2291# This tag requires that the tag HAVE_DOT is set to YES.
2292
2293DOT_FONTSIZE = 10
2294
2295# By default doxygen will tell dot to use the default font as specified with
2296# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
2297# the path where dot can find it using this tag.
2298# This tag requires that the tag HAVE_DOT is set to YES.
2299
2300DOT_FONTPATH =
2301
2302# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
2303# each documented class showing the direct and indirect inheritance relations.
2304# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
2305# The default value is: YES.
2306# This tag requires that the tag HAVE_DOT is set to YES.
2307
2308CLASS_GRAPH = YES
2309
2310# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2311# graph for each documented class showing the direct and indirect implementation
2312# dependencies (inheritance, containment, and class references variables) of the
2313# class with other documented classes.
2314# The default value is: YES.
2315# This tag requires that the tag HAVE_DOT is set to YES.
2316
2317COLLABORATION_GRAPH = YES
2318
2319# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2320# groups, showing the direct groups dependencies.
2321# The default value is: YES.
2322# This tag requires that the tag HAVE_DOT is set to YES.
2323
2324GROUP_GRAPHS = YES
2325
2326# If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
2327# collaboration diagrams in a style similar to the OMG's Unified Modeling
2328# Language.
2329# The default value is: NO.
2330# This tag requires that the tag HAVE_DOT is set to YES.
2331
2332UML_LOOK = NO
2333
2334# If the UML_LOOK tag is enabled, the fields and methods are shown inside the
2335# class node. If there are many fields or methods and many nodes the graph may
2336# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
2337# number of items for each type to make the size more manageable. Set this to 0
2338# for no limit. Note that the threshold may be exceeded by 50% before the limit
2339# is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2340# but if the number exceeds 15, the total amount of fields shown is limited to
2341# 10.
2342# Minimum value: 0, maximum value: 100, default value: 10.
2343# This tag requires that the tag HAVE_DOT is set to YES.
2344
2345UML_LIMIT_NUM_FIELDS = 10
2346
2347# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2348# collaboration graphs will show the relations between templates and their
2349# instances.
2350# The default value is: NO.
2351# This tag requires that the tag HAVE_DOT is set to YES.
2352
2353TEMPLATE_RELATIONS = NO
2354
2355# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
2356# YES then doxygen will generate a graph for each documented file showing the
2357# direct and indirect include dependencies of the file with other documented
2358# files.
2359# The default value is: YES.
2360# This tag requires that the tag HAVE_DOT is set to YES.
2361
2362INCLUDE_GRAPH = YES
2363
2364# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
2365# set to YES then doxygen will generate a graph for each documented file showing
2366# the direct and indirect include dependencies of the file with other documented
2367# files.
2368# The default value is: YES.
2369# This tag requires that the tag HAVE_DOT is set to YES.
2370
2371INCLUDED_BY_GRAPH = YES
2372
2373# If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2374# dependency graph for every global function or class method.
2375#
2376# Note that enabling this option will significantly increase the time of a run.
2377# So in most cases it will be better to enable call graphs for selected
2378# functions only using the \callgraph command.
2379# The default value is: NO.
2380# This tag requires that the tag HAVE_DOT is set to YES.
2381
2382CALL_GRAPH = NO
2383
2384# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2385# dependency graph for every global function or class method.
2386#
2387# Note that enabling this option will significantly increase the time of a run.
2388# So in most cases it will be better to enable caller graphs for selected
2389# functions only using the \callergraph command.
2390# The default value is: NO.
2391# This tag requires that the tag HAVE_DOT is set to YES.
2392
2393CALLER_GRAPH = NO
2394
2395# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2396# hierarchy of all classes instead of a textual one.
2397# The default value is: YES.
2398# This tag requires that the tag HAVE_DOT is set to YES.
2399
2400GRAPHICAL_HIERARCHY = YES
2401
2402# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2403# dependencies a directory has on other directories in a graphical way. The
2404# dependency relations are determined by the #include relations between the
2405# files in the directories.
2406# The default value is: YES.
2407# This tag requires that the tag HAVE_DOT is set to YES.
2408
2409DIRECTORY_GRAPH = YES
2410
2411# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
2412# generated by dot.
2413# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
2414# to make the SVG files visible in IE 9+ (other browsers do not have this
2415# requirement).
2416# Possible values are: png, png:cairo, png:cairo:cairo, png:cairo:gd, png:gd,
2417# png:gd:gd, jpg, jpg:cairo, jpg:cairo:gd, jpg:gd, jpg:gd:gd, gif, gif:cairo,
2418# gif:cairo:gd, gif:gd, gif:gd:gd and svg.
2419# The default value is: png.
2420# This tag requires that the tag HAVE_DOT is set to YES.
2421
2422DOT_IMAGE_FORMAT = png
2423
2424# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2425# enable generation of interactive SVG images that allow zooming and panning.
2426#
2427# Note that this requires a modern browser other than Internet Explorer. Tested
2428# and working are Firefox, Chrome, Safari, and Opera.
2429# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
2430# the SVG files visible. Older versions of IE do not have SVG support.
2431# The default value is: NO.
2432# This tag requires that the tag HAVE_DOT is set to YES.
2433
2434INTERACTIVE_SVG = NO
2435
2436# The DOT_PATH tag can be used to specify the path where the dot tool can be
2437# found. If left blank, it is assumed the dot tool can be found in the path.
2438# This tag requires that the tag HAVE_DOT is set to YES.
2439
2440DOT_PATH =
2441
2442# The DOTFILE_DIRS tag can be used to specify one or more directories that
2443# contain dot files that are included in the documentation (see the \dotfile
2444# command).
2445# This tag requires that the tag HAVE_DOT is set to YES.
2446
2447DOTFILE_DIRS =
2448
2449# The MSCFILE_DIRS tag can be used to specify one or more directories that
2450# contain msc files that are included in the documentation (see the \mscfile
2451# command).
2452
2453MSCFILE_DIRS =
2454
2455# The DIAFILE_DIRS tag can be used to specify one or more directories that
2456# contain dia files that are included in the documentation (see the \diafile
2457# command).
2458
2459DIAFILE_DIRS =
2460
2461# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
2462# path where java can find the plantuml.jar file. If left blank, it is assumed
2463# PlantUML is not used or called during a preprocessing step. Doxygen will
2464# generate a warning when it encounters a \startuml command in this case and
2465# will not generate output for the diagram.
2466
2467PLANTUML_JAR_PATH =
2468
2469# When using plantuml, the specified paths are searched for files specified by
2470# the !include statement in a plantuml block.
2471
2472PLANTUML_INCLUDE_PATH =
2473
2474# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2475# that will be shown in the graph. If the number of nodes in a graph becomes
2476# larger than this value, doxygen will truncate the graph, which is visualized
2477# by representing a node as a red box. Note that doxygen if the number of direct
2478# children of the root node in a graph is already larger than
2479# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
2480# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2481# Minimum value: 0, maximum value: 10000, default value: 50.
2482# This tag requires that the tag HAVE_DOT is set to YES.
2483
2484DOT_GRAPH_MAX_NODES = 50
2485
2486# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2487# generated by dot. A depth value of 3 means that only nodes reachable from the
2488# root by following a path via at most 3 edges will be shown. Nodes that lay
2489# further from the root node will be omitted. Note that setting this option to 1
2490# or 2 may greatly reduce the computation time needed for large code bases. Also
2491# note that the size of a graph can be further restricted by
2492# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
2493# Minimum value: 0, maximum value: 1000, default value: 0.
2494# This tag requires that the tag HAVE_DOT is set to YES.
2495
2496MAX_DOT_GRAPH_DEPTH = 0
2497
2498# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
2499# background. This is disabled by default, because dot on Windows does not seem
2500# to support this out of the box.
2501#
2502# Warning: Depending on the platform used, enabling this option may lead to
2503# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
2504# read).
2505# The default value is: NO.
2506# This tag requires that the tag HAVE_DOT is set to YES.
2507
2508DOT_TRANSPARENT = NO
2509
2510# Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
2511# files in one run (i.e. multiple -o and -T options on the command line). This
2512# makes dot run faster, but since only newer versions of dot (>1.8.10) support
2513# this, this feature is disabled by default.
2514# The default value is: NO.
2515# This tag requires that the tag HAVE_DOT is set to YES.
2516
2517DOT_MULTI_TARGETS = NO
2518
2519# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2520# explaining the meaning of the various boxes and arrows in the dot generated
2521# graphs.
2522# The default value is: YES.
2523# This tag requires that the tag HAVE_DOT is set to YES.
2524
2525GENERATE_LEGEND = YES
2526
2527# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot
2528# files that are used to generate the various graphs.
2529# The default value is: YES.
2530# This tag requires that the tag HAVE_DOT is set to YES.
2531
2532DOT_CLEANUP = YES
diff --git a/xbmc/addons/kodi-addon-dev-kit/doxygen/DoxygenLayout.xml b/xbmc/addons/kodi-addon-dev-kit/doxygen/DoxygenLayout.xml
new file mode 100644
index 0000000..f0d9268
--- /dev/null
+++ b/xbmc/addons/kodi-addon-dev-kit/doxygen/DoxygenLayout.xml
@@ -0,0 +1,207 @@
1<doxygenlayout version="1.0">
2 <!-- Generated by doxygen 1.8.9.1 -->
3 <!-- Navigation index tabs for HTML output -->
4 <navindex>
5 <tab type="mainpage" visible="yes" title=""/>
6 <tab type="pages" visible="yes" title="" intro=""/>
7 <tab type="modules" visible="yes" title="Language Development" intro=""/>
8<!-- <tab type="namespaces" visible="yes" title="">
9 <tab type="namespacelist" visible="yes" title="" intro=""/>
10 <tab type="namespacemembers" visible="yes" title="" intro=""/>
11 </tab>
12 <tab type="classes" visible="yes" title="">
13 <tab type="classlist" visible="yes" title="" intro=""/>
14 <tab type="classindex" visible="$ALPHABETICAL_INDEX" title=""/>
15 <tab type="hierarchy" visible="yes" title="" intro=""/>
16 <tab type="classmembers" visible="yes" title="" intro=""/>
17 </tab>-->
18 <tab type="files" visible="yes" title="">
19 <tab type="filelist" visible="yes" title="" intro=""/>
20 <tab type="globals" visible="yes" title="" intro=""/>
21 </tab>
22 <tab type="examples" visible="yes" title="" intro=""/>
23 <tab type="usergroup" title="Older versions">
24 <tab type="user" url="http://mirrors.kodi.tv/docs/python-docs/16.x-jarvis/" title="Kodi 16.x Jarvis"/>
25 <tab type="user" url="http://mirrors.kodi.tv/docs/python-docs/15.x-isengard/" title="Kodi 15.x Isengard"/>
26 <tab type="user" url="http://mirrors.kodi.tv/docs/python-docs/14.x-helix/" title="Kodi 14.x Helix"/>
27 <tab type="user" url="http://mirrors.kodi.tv/docs/python-docs/13.0-gotham/" title="XBMC 13.x Gotham"/>
28 <tab type="user" url="http://mirrors.kodi.tv/docs/python-docs/12.2-frodo/" title="XBMC 12.x Frodo"/>
29 </tab>
30 </navindex>
31
32 <!-- Layout definition for a class page -->
33 <class>
34 <briefdescription visible="yes"/>
35 <detaileddescription title=""/>
36 <includes visible="$SHOW_INCLUDE_FILES"/>
37 <inheritancegraph visible="$CLASS_GRAPH"/>
38 <collaborationgraph visible="$COLLABORATION_GRAPH"/>
39 <memberdecl>
40 <nestedclasses visible="yes" title=""/>
41 <publictypes title=""/>
42 <services title=""/>
43 <interfaces title=""/>
44 <publicslots title=""/>
45 <signals title=""/>
46 <publicmethods title=""/>
47 <publicstaticmethods title=""/>
48 <publicattributes title=""/>
49 <publicstaticattributes title=""/>
50 <protectedtypes title=""/>
51 <protectedslots title=""/>
52 <protectedmethods title=""/>
53 <protectedstaticmethods title=""/>
54 <protectedattributes title=""/>
55 <protectedstaticattributes title=""/>
56 <packagetypes title=""/>
57 <packagemethods title=""/>
58 <packagestaticmethods title=""/>
59 <packageattributes title=""/>
60 <packagestaticattributes title=""/>
61 <properties title=""/>
62 <events title=""/>
63 <privatetypes title=""/>
64 <privateslots title=""/>
65 <privatemethods title=""/>
66 <privatestaticmethods title=""/>
67 <privateattributes title=""/>
68 <privatestaticattributes title=""/>
69 <friends title=""/>
70 <related title="" subtitle=""/>
71 <membergroups visible="yes"/>
72 </memberdecl>
73<!-- <detaileddescription title=""/> -->
74 <memberdef>
75 <inlineclasses title=""/>
76 <typedefs title=""/>
77 <enums title=""/>
78 <services title=""/>
79 <interfaces title=""/>
80 <constructors title=""/>
81 <functions title=""/>
82 <related title=""/>
83 <variables title=""/>
84 <properties title=""/>
85 <events title=""/>
86 </memberdef>
87 <allmemberslink visible="yes"/>
88 <usedfiles visible="$SHOW_USED_FILES"/>
89 <authorsection visible="yes"/>
90 </class>
91
92 <!-- Layout definition for a namespace page -->
93 <namespace>
94 <briefdescription visible="yes"/>
95 <detaileddescription title=""/>
96 <memberdecl>
97 <nestednamespaces visible="yes" title=""/>
98 <constantgroups visible="yes" title=""/>
99 <classes visible="yes" title=""/>
100 <typedefs title=""/>
101 <enums title=""/>
102 <functions title=""/>
103 <variables title=""/>
104 <membergroups visible="yes"/>
105 </memberdecl>
106<!-- <detaileddescription title=""/> -->
107 <memberdef>
108 <inlineclasses title=""/>
109 <typedefs title=""/>
110 <enums title=""/>
111 <functions title=""/>
112 <variables title=""/>
113 </memberdef>
114 <authorsection visible="yes"/>
115 </namespace>
116
117 <!-- Layout definition for a file page -->
118 <file>
119 <briefdescription visible="yes"/>
120 <detaileddescription title=""/>
121 <includes visible="$SHOW_INCLUDE_FILES"/>
122 <includegraph visible="$INCLUDE_GRAPH"/>
123 <includedbygraph visible="$INCLUDED_BY_GRAPH"/>
124 <sourcelink visible="yes"/>
125 <memberdecl>
126 <classes visible="yes" title=""/>
127 <namespaces visible="yes" title=""/>
128 <constantgroups visible="yes" title=""/>
129 <defines title=""/>
130 <typedefs title=""/>
131 <enums title=""/>
132 <functions title=""/>
133 <variables title=""/>
134 <membergroups visible="yes"/>
135 </memberdecl>
136<!-- <detaileddescription title=""/> -->
137 <memberdef>
138 <inlineclasses title=""/>
139 <defines title=""/>
140 <typedefs title=""/>
141 <enums title=""/>
142 <functions title=""/>
143 <variables title=""/>
144 </memberdef>
145 <authorsection/>
146 </file>
147
148 <!-- Layout definition for a group page -->
149 <group>
150<!-- <briefdescription visible="yes"/> -->
151 <detaileddescription title=""/>
152 <groupgraph visible="$GROUP_GRAPHS"/>
153 <memberdecl>
154 <nestedgroups visible="yes" title=""/>
155 <dirs visible="yes" title=""/>
156 <files visible="yes" title=""/>
157 <namespaces visible="yes" title=""/>
158<!-- <classes visible="yes" title=""/> -->
159 <defines title=""/>
160 <typedefs title=""/>
161<!-- <enums title=""/> -->
162 <enumvalues title=""/>
163<!-- <functions title=""/> -->
164 <variables title=""/>
165 <signals title=""/>
166 <publicslots title=""/>
167 <protectedslots title=""/>
168 <privateslots title=""/>
169 <events title=""/>
170 <properties title=""/>
171 <friends title=""/>
172<!-- <membergroups visible="yes"/>-->
173 </memberdecl>
174<!-- <detaileddescription title=""/> -->
175 <memberdef>
176 <pagedocs/>
177 <inlineclasses title=""/>
178 <defines title=""/>
179 <typedefs title=""/>
180 <enums title=""/>
181 <enumvalues title=""/>
182 <functions title=""/>
183 <variables title=""/>
184 <signals title=""/>
185 <publicslots title=""/>
186 <protectedslots title=""/>
187 <privateslots title=""/>
188 <events title=""/>
189 <properties title=""/>
190 <friends title=""/>
191 </memberdef>
192 <authorsection visible="yes"/>
193 </group>
194
195 <!-- Layout definition for a directory page -->
196 <directory>
197 <briefdescription visible="yes"/>
198 <directorygraph visible="yes"/>
199 <detaileddescription title=""/>
200 <memberdecl>
201 <dirs visible="yes"/>
202 <files visible="yes"/>
203 </memberdecl>
204<!-- <detaileddescription title=""/> -->
205 </directory>
206
207</doxygenlayout>
diff --git a/xbmc/addons/kodi-addon-dev-kit/doxygen/General/DoxygenOnAddon.dox b/xbmc/addons/kodi-addon-dev-kit/doxygen/General/DoxygenOnAddon.dox
new file mode 100644
index 0000000..7502e5e
--- /dev/null
+++ b/xbmc/addons/kodi-addon-dev-kit/doxygen/General/DoxygenOnAddon.dox
@@ -0,0 +1,90 @@
1/*!
2
3@page Doxygen_On_Addon Doxygen on Kodi's Add-On headers
4
5### This page is for notes on using Doxygen to document the Kodi's Add-On headers source code.
6
7[Doxygen](http://www.stack.nl/~dimitri/doxygen/index.html), is a documentation
8system for C++, C, Java, and some other weird languages. It can generate html
9docs documenting a projects source code, by either extracting special tags from
10the source code (put there by people wanting to make use of doxygen), or doxygen
11attempts to build documentation from existing source.
12
13Doxygen seems to be installed on the NMR systems, type:
14~~~~~~~~~~~~~
15doxygen --version
16~~~~~~~~~~~~~
17
18
19_ _ _
20
21Start doxygen documentation for add-ons always with `///` and on Kodi itself with `/*!`, this makes it more easy to see for which place the documentation is.
22
23<b>Here an example on add-on about function coding style:</b>
24
25\verbatim
26#ifdef DOXYGEN_SHOULD_USE_THIS
27 ///
28 /// \ingroup python_xbmcgui_window
29 /// @brief Sets the resolution
30 ///
31 /// That the coordinates of all controls are defined in. Allows Kodi
32 /// to scale control positions and width/heights to whatever resolution
33 /// Kodi is currently using.
34 ///
35 /// @param[in] res Coordinate resolution to set
36 /// Resolution is one of the following:
37 /// | value | Resolution |
38 /// |:-----:|:--------------------------|
39 /// | 0 | 1080i (1920x1080)
40 /// | 1 | 720p (1280x720)
41 /// | 2 | 480p 4:3 (720x480)
42 /// | 3 | 480p 16:9 (720x480)
43 /// | 4 | NTSC 4:3 (720x480)
44 /// | 5 | NTSC 16:9 (720x480)
45 /// | 6 | PAL 4:3 (720x576)
46 /// | 7 | PAL 16:9 (720x576)
47 /// | 8 | PAL60 4:3 (720x480)
48 /// | 9 | PAL60 16:9 (720x480)
49 /// @return Nothing only added as example here :)
50 /// @param[out] nothingExample Example here, if on value pointer data becomes
51 /// returned.
52 /// @throws TypeError If supplied argument is not of List type, or a
53 /// control is not of Control type
54 /// @throws ReferenceError If control is already used in another window
55 /// @throws RuntimeError Should not happen :-)
56 ///
57 ///
58 ///--------------------------------------------------------------------------
59 ///
60 /// **Example:**
61 /// ~~~~~~~~~~~~~{.py}
62 /// ..
63 /// win = xbmcgui.Window(xbmcgui.getCurrentWindowId())
64 /// win.setCoordinateResolution(0)
65 /// ..
66 /// ~~~~~~~~~~~~~
67 ///
68 setCoordinateResolution(...);
69#else
70 SWIGHIDDENVIRTUAL bool setCoordinateResolution(long res, int &nothingExample);
71#endif
72\endverbatim
73- \verbatim /// \ingroup\endverbatim - Define the group where the documentation part comes in.
74- \verbatim /// @brief\endverbatim - Add a small text of part there.
75- \verbatim /// TEXT_FIELD\endverbatim - Add a bigger text there if needed.
76- \verbatim /// @param[in] VALUE_NAME VALUE_TEXT\endverbatim - To set input parameter defined by name and add a description. There the example also add a small table which is useful to describe values.
77- \verbatim /// @param[out] VALUE_NAME VALUE_TEXT\endverbatim - To set output parameter defined by name and add a description.
78- \verbatim /// @return VALUE_TEXT\endverbatim - To add a description of return value.
79- \verbatim /// @throws ERROR_TYPE ERROR_TEXT\endverbatim - If also exception becomes handled, can you use this for description.
80- \verbatim /// TEXT_FIELD\endverbatim - Add a much bigger text there if needed.
81- \verbatim /// ------------------\endverbatim - Use this to define a field line, e.g. if you add example add this always before, further must you make two empty lines before to prevent add of them on string before!
82- \verbatim /// ~~~~~~~~~~~~~ \endverbatim - Here can you define a code example which must start and end with the defination string, also can you define the code style with e.g. <b>{.py}</b> for Python or <b>{.cpp}</b> for CPP code on the first line of them.
83
84@note Start all `VALUE_TEXT` at same character to hold a clean code on <c>*.cpp</c> or <c>*.h</c> files.\n\n
85 The `#ifdef DOXYGEN_SHOULD_USE_THIS` on example above can be becomes used
86 if for Doxygen another function is needed to describe.
87
88If you want to prevent a part from doxygen can you define <b>`#ifndef DOXYGEN_SHOULD_SKIP_THIS`</b>
89or <b>`#ifdef DOXYGEN_SHOULD_USE_THIS`</b> on the related code.
90*/
diff --git a/xbmc/addons/kodi-addon-dev-kit/doxygen/General/General.dox b/xbmc/addons/kodi-addon-dev-kit/doxygen/General/General.dox
new file mode 100644
index 0000000..ef7ccf0
--- /dev/null
+++ b/xbmc/addons/kodi-addon-dev-kit/doxygen/General/General.dox
@@ -0,0 +1,29 @@
1/*!
2
3\page general General
4\brief \doc_header{ General descriptions }
5
6The used code guidelines from Kodi
7@note Is not direct needed on C++ add-ons but makes it more easy for reviews and
8changes from the others.
9
10\subpage code_guidelines
11
12--------------------------------------------------------------------------------
13
14Guideline for Kodi's developers to create documentation
15
16\subpage Doxygen_On_Addon
17
18*/
19
20---------------------------------------------------------------------------------
21
22@subpage revisions "Revisions against older versions"
23*/
24
25/*!
26\page revisions Revisions
27
28\subpage python_revisions
29*/ \ No newline at end of file
diff --git a/xbmc/addons/kodi-addon-dev-kit/doxygen/Modules/logo-python.png b/xbmc/addons/kodi-addon-dev-kit/doxygen/Modules/logo-python.png
new file mode 100644
index 0000000..26867b0
--- /dev/null
+++ b/xbmc/addons/kodi-addon-dev-kit/doxygen/Modules/logo-python.png
Binary files differ
diff --git a/xbmc/addons/kodi-addon-dev-kit/doxygen/Modules/modules_general.dox b/xbmc/addons/kodi-addon-dev-kit/doxygen/Modules/modules_general.dox
new file mode 100644
index 0000000..481a0db
--- /dev/null
+++ b/xbmc/addons/kodi-addon-dev-kit/doxygen/Modules/modules_general.dox
@@ -0,0 +1,8 @@
1/*!
2
3\page general_parts General Development parts
4\brief \doc_header{ General Add-On Development parts }
5
6\subpage modules__General__List_of_gui_access
7\subpage page_List_of_built_in_functions
8*/
diff --git a/xbmc/addons/kodi-addon-dev-kit/doxygen/Modules/modules_python.dox b/xbmc/addons/kodi-addon-dev-kit/doxygen/Modules/modules_python.dox
new file mode 100644
index 0000000..2812c8a
--- /dev/null
+++ b/xbmc/addons/kodi-addon-dev-kit/doxygen/Modules/modules_python.dox
@@ -0,0 +1,179 @@
1/*!
2
3
4\defgroup python Python
5\image html logo-python.png
6\brief \htmlonly
7 <h3><span style="text-decoration: underline;"><span style="font-style: italic;"><span
8 style="color: rgb(102, 102, 102);">Python Script Add-On Development</span></span></span></h3>
9 \endhtmlonly
10
11Kodi includes a built-in [Python interpreter](http://en.wikipedia.org/wiki/Python_%28programming_language%29)
12that allows users to develop add-ons (scripts and plugins) that interface easily
13and cleanly with the Kodi dashboard. These add-ons can extend the functionality
14of Kodi without requiring extensive programming experience or ability. While you
15may not feel comfortable browsing the Kodi source code and submitting patches (or
16even bug reports), you can learn how to write a script or plugin with just a few
17hours' practice, using the information available in these pages.
18
19This page is intended as an introduction to Kodi Python for new developers, and
20a quick reference for more experienced programmers. If you're not interested in
21programming, you might want to visit [this page](http://kodi.wiki/view/Add-ons)
22for information about installing and using Python add-ons as an end user. If
23you're already familiar with Kodi Python, you can probably skip on down to the
24[environment details](http://kodi.wiki/view/Python_Development#Environment_details)
25or the [resource links](http://kodi.wiki/view/Python_Development#Resource_links)
26below for quick reference material.
27
28_ _ _
29
30Built-in modules
31----------------
32
33In addition to the standard libraries, Kodi [Python](https://www.python.org/)
34uses a handful of custom modules to expose Kodi functionality to Python.
35
36| Module | Description |
37|------------------------------------:|:-----------------------------------------------------------|
38| \ref python_xbmc "xbmc" | Offers classes and functions that provide information about the media currently playing and that allow manipulation of the media player (such as starting a new song). You can also find system information using the functions available in this library.
39| \ref python_xbmcgui "xbmcgui" | Offers classes and functions that manipulate the Graphical User Interface through windows, dialogs, and various control widgets.
40| \ref python_xbmcplugin "xbmcplugin" | Offers classes and functions that allow a developer to present information through Kodi's standard menu structure. While plugins don't have the same flexibility as scripts, they boast significantly quicker development time and a more consistent user experience.
41| \ref python_xbmcaddon "xbmcaddon" | Offers classes and functions that manipulate the add-on settings, information and localization.
42| \ref python_xbmcvfs "xbmcvfs" | Offers classes and functions offers access to the Virtual File Server (VFS) which you can use to manipulate files and folders.
43| \ref python_xbmcwsgi "xbmcwsgi" | The [<b>Web Server Gateway Interface (WSGI)</b>](https://en.wikipedia.org/wiki/Web_Server_Gateway_Interface) is a specification for simple and universal interface between web servers and web applications or frameworks for the Python programming language.
44
45_ _ _
46
47Installing additional modules
48----------------
49
50Additional modules may be installed by simply adding the module to the root
51folder of your add-on.
52
53A common way to organized third-party modules that are not part of add-on source
54code itself, is to add a lib directory and place an __init__.py file and other
55third-party modules inside it. These modules may then normally be imported using
56from lib import some module.
57
58_ _ _
59
60Python plugins versus scripts
61----------------
62
63Please do not confuse "Plugins" with "Scripts". Unlike the Scripts, Plugins are
64not meant to be directly invoked by the user. Instead, Plugins are automatically
65invoked when the user enters such a virtual folder. Do not try to run Plugins
66files from the scripts window as that will only give you a weird error message.
67Plugins, unlike Scripts, do not really provide new functionality to Kodi,
68instead what they do do is provide an easy way to present content listings in
69Kodi through the native GUI interface.
70
71_ _ _
72
73Script development
74----------------
75
76If you're new to Python programming (or just new to Kodi Python), the easiest
77way to get started is with a script. The traditional Hello World program,
78written as an Kodi Python script, would look like this:
79~~~~~~~~~~~~~{.py}
80print("Hello World!")
81~~~~~~~~~~~~~
82That's the same code you would enter at the Python command line, because Kodi
83runs a full-featured, standard Python interpreter (for more information
84concerning the current version number and included modules see the environment
85details below). If you're already familiar with Python programming, the only new
86challenge is learning the custom modules that allow you to gather information
87from Kodi and manipulate the Graphical User Interface (GUI).
88
89There are some excellent tutorials available to introduce you to Kodi scripting
90(and Python in general). See the [HOW-TO](http://kodi.wiki/view/HOW-TO_write_Python_Scripts)
91included in the Kodi Online Manual, or visit Alexpoet's Kodi Scripting site for
92a popular beginner's tutorial (PDF).
93
94_ _ _
95Plugin development
96----------------
97
98While scripts offer you flexibility and full control over the Kodi GUI, plugins
99allow you to quickly and consistently present information to the user through
100the standard Kodi menu structure.
101
102When a user launches a plugin, the plugin generates a list of menu items and
103hands them to Kodi to draw on the screen (regardless of screen resolution, skin,
104or any other user setting). While plugin developers lose some amount of control
105over the presentation, they no longer have to make up their own UIs, or worry
106about creating a usable look and feel across multiple displays.
107
108Plugins are most commonly used to scrape websites for links to streaming videos,
109displaying the video list in Kodi just like it would movie files on the local
110hard drive, but a plugin can be used anywhere a script could, as long as the
111menu structure is a sufficient GUI for the add-on's needs.
112
113Also, note that a script can launch a plugin, and a plugin can launch a script
114(and, for that matter, it can call all the same functions available to a script)
115so the distinction is more theoretical than practical.
116
117
118@{
119\ingroup python
120\defgroup python_xbmc Library - xbmc
121
122\ingroup python
123\defgroup python_xbmcgui Library - xbmcgui
124
125\ingroup python
126\defgroup python_xbmcplugin Library - xbmcplugin
127
128\ingroup python
129\defgroup python_xbmcaddon Library - xbmcaddon
130
131\ingroup python
132\defgroup python_xbmcvfs Library - xbmcvfs
133
134\ingroup python
135\defgroup python_xbmcwsgi Library - xbmcwsgi
136@brief **Web Server Gateway Interface**
137
138The [<b>Web Server Gateway Interface (WSGI)</b>](https://en.wikipedia.org/wiki/Web_Server_Gateway_Interface)
139is a specification for simple and universal interface between web servers and
140web applications or frameworks for the Python programming language.
141@}
142
143*/
144
145/*!
146@page python_v12 Python API v12
147*/
148/*!
149@page python_v13 Python API v13
150*/
151/*!
152@page python_v14 Python API v14
153*/
154/*!
155@page python_v15 Python API v15
156*/
157/*!
158@page python_v16 Python API v16
159*/
160/*!
161@page python_v17 Python API v17
162*/
163/*!
164@page python_v18 Python API v18
165*/
166
167/*!
168@page python_revisions Python API Changes
169@brief Overview of changes on Python API for Kodi
170
171- @subpage python_v12
172- @subpage python_v13
173- @subpage python_v14
174- @subpage python_v15
175- @subpage python_v16
176- @subpage python_v17
177- @subpage python_v18
178+*/
179 \ No newline at end of file
diff --git a/xbmc/addons/kodi-addon-dev-kit/doxygen/Skin/skin.dox b/xbmc/addons/kodi-addon-dev-kit/doxygen/Skin/skin.dox
new file mode 100644
index 0000000..4bb26fb
--- /dev/null
+++ b/xbmc/addons/kodi-addon-dev-kit/doxygen/Skin/skin.dox
@@ -0,0 +1,24 @@
1/*!
2
3\page skin_parts Skin Development
4@brief \doc_header{ Skin Add-On Development }
5
6Kodi includes a GUI library that allows you to skin/change everything you see.
7The images, sizes and positions of controls, colours, fonts, text, through to
8altering navigation and even adding new functionality.
9
10The skin system is quite complex. This portion of the manual is dedicated to
11providing in depth information on how it all works. It contains tips to make the
12experience a little more pleasant.
13
14If you are just getting started with skinning Kodi, then it is suggested that the
15best way to learn is by modifying one of the many existing skins that are
16available. The default skin, Estuary, includes almost all the various tricks
17and features that make the Kodi skinning engine so powerful, so is an ideal place
18to start. You may wish to start by having a look through the tutorial section on
19skinning Kodi as well as the "Skinning Kodi" article, and try modifying a window
20or two by adding a button, or altering the textures or layout.
21
22- \subpage skin_controls - Controls are the substance of your skin.
23
24*/
diff --git a/xbmc/addons/kodi-addon-dev-kit/doxygen/kodi-dev.png b/xbmc/addons/kodi-addon-dev-kit/doxygen/kodi-dev.png
new file mode 100644
index 0000000..e513ef2
--- /dev/null
+++ b/xbmc/addons/kodi-addon-dev-kit/doxygen/kodi-dev.png
Binary files differ
diff --git a/xbmc/addons/kodi-addon-dev-kit/doxygen/main.txt b/xbmc/addons/kodi-addon-dev-kit/doxygen/main.txt
new file mode 100644
index 0000000..7eddbf8
--- /dev/null
+++ b/xbmc/addons/kodi-addon-dev-kit/doxygen/main.txt
@@ -0,0 +1,49 @@
1/*!
2
3@mainpage
4
5### Welcome to the Documentation of Kodi for Add-On Development.
6
7__Kodi®__ media center, formerly known as XBMC Media Center, is a free and
8open-source media player software developed by the XBMC Foundation, a non-profit
9technology consortium. Kodi is available for multiple operating systems and
10hardware platforms, with a software 10-foot user interface for use with
11televisions and remote controls. It allows users to play and view most videos,
12music, such as audio and video podcasts from the internet, and all common
13digital media files from local and network storage media.
14
15Add-ons are extensions that can be run from inside the Kodi GUI and in
16addition to binary add-ons for the use of different systems. They are usual
17written by third party developers and published to our official repository.
18Add-ons can also be published in other repositories or as stand alone zip
19files anywhere on the internet. Examples of Add-ons include video website
20streams, scrapers, skins and scripts.
21
22#### Supported systems
23
24Currently support Kodi Add-Ons based upon Python and C++.
25
26#### Tutorials and Examples
27
28In the distribution of the library you find the two directories *tutorials*
29and *examples*. They contain subdirectories for the packages...
30The demos use third party libraries for the graphical user interface. The
31examples don't have this dependency and most examples are refered to in the
32user manual.
33
34#### License
35
36Kodi is distributed under a [GNU General Public License version 2](./LICENSE.GPL).
37
38\htmlonly
39<div style="display:none">
40\endhtmlonly
41
42\subpage general
43\subpage general_parts
44
45\htmlonly
46</div>
47\endhtmlonly
48
49*/