aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTheJackiMonster <thejackimonster@gmail.com>2021-08-09 18:24:56 +0200
committerTheJackiMonster <thejackimonster@gmail.com>2021-08-09 18:24:56 +0200
commitd503de69add0545240bdbf6c5a039f5b11f36604 (patch)
treef69f36d179779ad235028686c2e6ccc4b54189d1
parent20986c3046f7cfc0d1c014cf1d6ee371b6ff5bbf (diff)
downloadlibgnunetchat-d503de69add0545240bdbf6c5a039f5b11f36604.tar.gz
libgnunetchat-d503de69add0545240bdbf6c5a039f5b11f36604.zip
Added Doxyfile to generate basic documentation of the API
Signed-off-by: TheJackiMonster <thejackimonster@gmail.com>
-rw-r--r--Doxyfile2623
-rw-r--r--doc/.gitignore3
-rw-r--r--include/gnunet_chat_lib.h126
3 files changed, 2689 insertions, 63 deletions
diff --git a/Doxyfile b/Doxyfile
new file mode 100644
index 0000000..1a829c6
--- /dev/null
+++ b/Doxyfile
@@ -0,0 +1,2623 @@
1# Doxyfile 1.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 configuration
21# file that follow. The default is UTF-8 which is also the encoding used for all
22# text before the first occurrence of this tag. Doxygen uses libiconv (or the
23# iconv built into libc) for the transcoding. See
24# https://www.gnu.org/software/libiconv/ 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 = libgnunetchat
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 =
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 =
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 =
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 = ./doc
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# The OUTPUT_TEXT_DIRECTION tag is used to specify the direction in which all
97# documentation generated by doxygen is written. Doxygen will use this
98# information to generate all generated output in the proper direction.
99# Possible values are: None, LTR, RTL and Context.
100# The default value is: None.
101
102OUTPUT_TEXT_DIRECTION = None
103
104# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
105# descriptions after the members that are listed in the file and class
106# documentation (similar to Javadoc). Set to NO to disable this.
107# The default value is: YES.
108
109BRIEF_MEMBER_DESC = YES
110
111# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
112# description of a member or function before the detailed description
113#
114# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
115# brief descriptions will be completely suppressed.
116# The default value is: YES.
117
118REPEAT_BRIEF = YES
119
120# This tag implements a quasi-intelligent brief description abbreviator that is
121# used to form the text in various listings. Each string in this list, if found
122# as the leading text of the brief description, will be stripped from the text
123# and the result, after processing the whole list, is used as the annotated
124# text. Otherwise, the brief description is used as-is. If left blank, the
125# following values are used ($name is automatically replaced with the name of
126# the entity):The $name class, The $name widget, The $name file, is, provides,
127# specifies, contains, represents, a, an and the.
128
129ABBREVIATE_BRIEF = "The $name class" \
130 "The $name widget" \
131 "The $name file" \
132 is \
133 provides \
134 specifies \
135 contains \
136 represents \
137 a \
138 an \
139 the
140
141# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
142# doxygen will generate a detailed section even if there is only a brief
143# description.
144# The default value is: NO.
145
146ALWAYS_DETAILED_SEC = NO
147
148# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
149# inherited members of a class in the documentation of that class as if those
150# members were ordinary class members. Constructors, destructors and assignment
151# operators of the base classes will not be shown.
152# The default value is: NO.
153
154INLINE_INHERITED_MEMB = NO
155
156# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
157# before files name in the file list and in the header files. If set to NO the
158# shortest path that makes the file name unique will be used
159# The default value is: YES.
160
161FULL_PATH_NAMES = YES
162
163# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
164# Stripping is only done if one of the specified strings matches the left-hand
165# part of the path. The tag can be used to show relative paths in the file list.
166# If left blank the directory from which doxygen is run is used as the path to
167# strip.
168#
169# Note that you can specify absolute paths here, but also relative paths, which
170# will be relative from the directory where doxygen is started.
171# This tag requires that the tag FULL_PATH_NAMES is set to YES.
172
173STRIP_FROM_PATH =
174
175# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
176# path mentioned in the documentation of a class, which tells the reader which
177# header file to include in order to use a class. If left blank only the name of
178# the header file containing the class definition is used. Otherwise one should
179# specify the list of include paths that are normally passed to the compiler
180# using the -I flag.
181
182STRIP_FROM_INC_PATH =
183
184# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
185# less readable) file names. This can be useful is your file systems doesn't
186# support long names like on DOS, Mac, or CD-ROM.
187# The default value is: NO.
188
189SHORT_NAMES = NO
190
191# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
192# first line (until the first dot) of a Javadoc-style comment as the brief
193# description. If set to NO, the Javadoc-style will behave just like regular Qt-
194# style comments (thus requiring an explicit @brief command for a brief
195# description.)
196# The default value is: NO.
197
198JAVADOC_AUTOBRIEF = YES
199
200# If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line
201# such as
202# /***************
203# as being the beginning of a Javadoc-style comment "banner". If set to NO, the
204# Javadoc-style will behave just like regular comments and it will not be
205# interpreted by doxygen.
206# The default value is: NO.
207
208JAVADOC_BANNER = NO
209
210# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
211# line (until the first dot) of a Qt-style comment as the brief description. If
212# set to NO, the Qt-style will behave just like regular Qt-style comments (thus
213# requiring an explicit \brief command for a brief description.)
214# The default value is: NO.
215
216QT_AUTOBRIEF = NO
217
218# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
219# multi-line C++ special comment block (i.e. a block of //! or /// comments) as
220# a brief description. This used to be the default behavior. The new default is
221# to treat a multi-line C++ comment block as a detailed description. Set this
222# tag to YES if you prefer the old behavior instead.
223#
224# Note that setting this tag to YES also means that rational rose comments are
225# not recognized any more.
226# The default value is: NO.
227
228MULTILINE_CPP_IS_BRIEF = NO
229
230# By default Python docstrings are displayed as preformatted text and doxygen's
231# special commands cannot be used. By setting PYTHON_DOCSTRING to NO the
232# doxygen's special commands can be used and the contents of the docstring
233# documentation blocks is shown as doxygen documentation.
234# The default value is: YES.
235
236PYTHON_DOCSTRING = YES
237
238# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
239# documentation from any documented member that it re-implements.
240# The default value is: YES.
241
242INHERIT_DOCS = YES
243
244# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
245# page for each member. If set to NO, the documentation of a member will be part
246# of the file/class/namespace that contains it.
247# The default value is: NO.
248
249SEPARATE_MEMBER_PAGES = NO
250
251# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
252# uses this value to replace tabs by spaces in code fragments.
253# Minimum value: 1, maximum value: 16, default value: 4.
254
255TAB_SIZE = 2
256
257# This tag can be used to specify a number of aliases that act as commands in
258# the documentation. An alias has the form:
259# name=value
260# For example adding
261# "sideeffect=@par Side Effects:\n"
262# will allow you to put the command \sideeffect (or @sideeffect) in the
263# documentation, which will result in a user-defined paragraph with heading
264# "Side Effects:". You can put \n's in the value part of an alias to insert
265# newlines (in the resulting output). You can put ^^ in the value part of an
266# alias to insert a newline as if a physical newline was in the original file.
267# When you need a literal { or } or , in the value part of an alias you have to
268# escape them by means of a backslash (\), this can lead to conflicts with the
269# commands \{ and \} for these it is advised to use the version @{ and @} or use
270# a double escape (\\{ and \\})
271
272ALIASES =
273
274# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
275# only. Doxygen will then generate output that is more tailored for C. For
276# instance, some of the names that are used will be different. The list of all
277# members will be omitted, etc.
278# The default value is: NO.
279
280OPTIMIZE_OUTPUT_FOR_C = YES
281
282# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
283# Python sources only. Doxygen will then generate output that is more tailored
284# for that language. For instance, namespaces will be presented as packages,
285# qualified scopes will look different, etc.
286# The default value is: NO.
287
288OPTIMIZE_OUTPUT_JAVA = NO
289
290# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
291# sources. Doxygen will then generate output that is tailored for Fortran.
292# The default value is: NO.
293
294OPTIMIZE_FOR_FORTRAN = NO
295
296# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
297# sources. Doxygen will then generate output that is tailored for VHDL.
298# The default value is: NO.
299
300OPTIMIZE_OUTPUT_VHDL = NO
301
302# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice
303# sources only. Doxygen will then generate output that is more tailored for that
304# language. For instance, namespaces will be presented as modules, types will be
305# separated into more groups, etc.
306# The default value is: NO.
307
308OPTIMIZE_OUTPUT_SLICE = NO
309
310# Doxygen selects the parser to use depending on the extension of the files it
311# parses. With this tag you can assign which parser to use for a given
312# extension. Doxygen has a built-in mapping, but you can override or extend it
313# using this tag. The format is ext=language, where ext is a file extension, and
314# language is one of the parsers supported by doxygen: IDL, Java, JavaScript,
315# Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice, VHDL,
316# Fortran (fixed format Fortran: FortranFixed, free formatted Fortran:
317# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser
318# tries to guess whether the code is fixed or free formatted code, this is the
319# default for Fortran type files). For instance to make doxygen treat .inc files
320# as Fortran files (default is PHP), and .f files as C (default is Fortran),
321# use: inc=Fortran f=C.
322#
323# Note: For files without extension you can use no_extension as a placeholder.
324#
325# Note that for custom extensions you also need to set FILE_PATTERNS otherwise
326# the files are not read by doxygen. When specifying no_extension you should add
327# * to the FILE_PATTERNS.
328#
329# Note see also the list of default file extension mappings.
330
331EXTENSION_MAPPING =
332
333# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
334# according to the Markdown format, which allows for more readable
335# documentation. See https://daringfireball.net/projects/markdown/ for details.
336# The output of markdown processing is further processed by doxygen, so you can
337# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
338# case of backward compatibilities issues.
339# The default value is: YES.
340
341MARKDOWN_SUPPORT = YES
342
343# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
344# to that level are automatically included in the table of contents, even if
345# they do not have an id attribute.
346# Note: This feature currently applies only to Markdown headings.
347# Minimum value: 0, maximum value: 99, default value: 5.
348# This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
349
350TOC_INCLUDE_HEADINGS = 5
351
352# When enabled doxygen tries to link words that correspond to documented
353# classes, or namespaces to their corresponding documentation. Such a link can
354# be prevented in individual cases by putting a % sign in front of the word or
355# globally by setting AUTOLINK_SUPPORT to NO.
356# The default value is: YES.
357
358AUTOLINK_SUPPORT = YES
359
360# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
361# to include (a tag file for) the STL sources as input, then you should set this
362# tag to YES in order to let doxygen match functions declarations and
363# definitions whose arguments contain STL classes (e.g. func(std::string);
364# versus func(std::string) {}). This also make the inheritance and collaboration
365# diagrams that involve STL classes more complete and accurate.
366# The default value is: NO.
367
368BUILTIN_STL_SUPPORT = NO
369
370# If you use Microsoft's C++/CLI language, you should set this option to YES to
371# enable parsing support.
372# The default value is: NO.
373
374CPP_CLI_SUPPORT = NO
375
376# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
377# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen
378# will parse them like normal C++ but will assume all classes use public instead
379# of private inheritance when no explicit protection keyword is present.
380# The default value is: NO.
381
382SIP_SUPPORT = NO
383
384# For Microsoft's IDL there are propget and propput attributes to indicate
385# getter and setter methods for a property. Setting this option to YES will make
386# doxygen to replace the get and set methods by a property in the documentation.
387# This will only work if the methods are indeed getting or setting a simple
388# type. If this is not the case, or you want to show the methods anyway, you
389# should set this option to NO.
390# The default value is: YES.
391
392IDL_PROPERTY_SUPPORT = YES
393
394# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
395# tag is set to YES then doxygen will reuse the documentation of the first
396# member in the group (if any) for the other members of the group. By default
397# all members of a group must be documented explicitly.
398# The default value is: NO.
399
400DISTRIBUTE_GROUP_DOC = NO
401
402# If one adds a struct or class to a group and this option is enabled, then also
403# any nested class or struct is added to the same group. By default this option
404# is disabled and one has to add nested compounds explicitly via \ingroup.
405# The default value is: NO.
406
407GROUP_NESTED_COMPOUNDS = NO
408
409# Set the SUBGROUPING tag to YES to allow class member groups of the same type
410# (for instance a group of public functions) to be put as a subgroup of that
411# type (e.g. under the Public Functions section). Set it to NO to prevent
412# subgrouping. Alternatively, this can be done per class using the
413# \nosubgrouping command.
414# The default value is: YES.
415
416SUBGROUPING = YES
417
418# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
419# are shown inside the group in which they are included (e.g. using \ingroup)
420# instead of on a separate page (for HTML and Man pages) or section (for LaTeX
421# and RTF).
422#
423# Note that this feature does not work in combination with
424# SEPARATE_MEMBER_PAGES.
425# The default value is: NO.
426
427INLINE_GROUPED_CLASSES = NO
428
429# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
430# with only public data fields or simple typedef fields will be shown inline in
431# the documentation of the scope in which they are defined (i.e. file,
432# namespace, or group documentation), provided this scope is documented. If set
433# to NO, structs, classes, and unions are shown on a separate page (for HTML and
434# Man pages) or section (for LaTeX and RTF).
435# The default value is: NO.
436
437INLINE_SIMPLE_STRUCTS = NO
438
439# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
440# enum is documented as struct, union, or enum with the name of the typedef. So
441# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
442# with name TypeT. When disabled the typedef will appear as a member of a file,
443# namespace, or class. And the struct will be named TypeS. This can typically be
444# useful for C code in case the coding convention dictates that all compound
445# types are typedef'ed and only the typedef is referenced, never the tag name.
446# The default value is: NO.
447
448TYPEDEF_HIDES_STRUCT = NO
449
450# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
451# cache is used to resolve symbols given their name and scope. Since this can be
452# an expensive process and often the same symbol appears multiple times in the
453# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
454# doxygen will become slower. If the cache is too large, memory is wasted. The
455# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
456# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
457# symbols. At the end of a run doxygen will report the cache usage and suggest
458# the optimal cache size from a speed point of view.
459# Minimum value: 0, maximum value: 9, default value: 0.
460
461LOOKUP_CACHE_SIZE = 0
462
463# The NUM_PROC_THREADS specifies the number threads doxygen is allowed to use
464# during processing. When set to 0 doxygen will based this on the number of
465# cores available in the system. You can set it explicitly to a value larger
466# than 0 to get more control over the balance between CPU load and processing
467# speed. At this moment only the input processing can be done using multiple
468# threads. Since this is still an experimental feature the default is set to 1,
469# which efficively disables parallel processing. Please report any issues you
470# encounter. Generating dot graphs in parallel is controlled by the
471# DOT_NUM_THREADS setting.
472# Minimum value: 0, maximum value: 32, default value: 1.
473
474NUM_PROC_THREADS = 8
475
476#---------------------------------------------------------------------------
477# Build related configuration options
478#---------------------------------------------------------------------------
479
480# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
481# documentation are documented, even if no documentation was available. Private
482# class members and static file members will be hidden unless the
483# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
484# Note: This will also disable the warnings about undocumented members that are
485# normally produced when WARNINGS is set to YES.
486# The default value is: NO.
487
488EXTRACT_ALL = NO
489
490# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
491# be included in the documentation.
492# The default value is: NO.
493
494EXTRACT_PRIVATE = NO
495
496# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual
497# methods of a class will be included in the documentation.
498# The default value is: NO.
499
500EXTRACT_PRIV_VIRTUAL = NO
501
502# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
503# scope will be included in the documentation.
504# The default value is: NO.
505
506EXTRACT_PACKAGE = NO
507
508# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
509# included in the documentation.
510# The default value is: NO.
511
512EXTRACT_STATIC = NO
513
514# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
515# locally in source files will be included in the documentation. If set to NO,
516# only classes defined in header files are included. Does not have any effect
517# for Java sources.
518# The default value is: YES.
519
520EXTRACT_LOCAL_CLASSES = YES
521
522# This flag is only useful for Objective-C code. If set to YES, local methods,
523# which are defined in the implementation section but not in the interface are
524# included in the documentation. If set to NO, only methods in the interface are
525# included.
526# The default value is: NO.
527
528EXTRACT_LOCAL_METHODS = NO
529
530# If this flag is set to YES, the members of anonymous namespaces will be
531# extracted and appear in the documentation as a namespace called
532# 'anonymous_namespace{file}', where file will be replaced with the base name of
533# the file that contains the anonymous namespace. By default anonymous namespace
534# are hidden.
535# The default value is: NO.
536
537EXTRACT_ANON_NSPACES = NO
538
539# If this flag is set to YES, the name of an unnamed parameter in a declaration
540# will be determined by the corresponding definition. By default unnamed
541# parameters remain unnamed in the output.
542# The default value is: YES.
543
544RESOLVE_UNNAMED_PARAMS = YES
545
546# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
547# undocumented members inside documented classes or files. If set to NO these
548# members will be included in the various overviews, but no documentation
549# section is generated. This option has no effect if EXTRACT_ALL is enabled.
550# The default value is: NO.
551
552HIDE_UNDOC_MEMBERS = NO
553
554# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
555# undocumented classes that are normally visible in the class hierarchy. If set
556# to NO, these classes will be included in the various overviews. This option
557# has no effect if EXTRACT_ALL is enabled.
558# The default value is: NO.
559
560HIDE_UNDOC_CLASSES = NO
561
562# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
563# declarations. If set to NO, these declarations will be included in the
564# documentation.
565# The default value is: NO.
566
567HIDE_FRIEND_COMPOUNDS = NO
568
569# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
570# documentation blocks found inside the body of a function. If set to NO, these
571# blocks will be appended to the function's detailed documentation block.
572# The default value is: NO.
573
574HIDE_IN_BODY_DOCS = NO
575
576# The INTERNAL_DOCS tag determines if documentation that is typed after a
577# \internal command is included. If the tag is set to NO then the documentation
578# will be excluded. Set it to YES to include the internal documentation.
579# The default value is: NO.
580
581INTERNAL_DOCS = NO
582
583# With the correct setting of option CASE_SENSE_NAMES doxygen will better be
584# able to match the capabilities of the underlying filesystem. In case the
585# filesystem is case sensitive (i.e. it supports files in the same directory
586# whose names only differ in casing), the option must be set to YES to properly
587# deal with such files in case they appear in the input. For filesystems that
588# are not case sensitive the option should be be set to NO to properly deal with
589# output files written for symbols that only differ in casing, such as for two
590# classes, one named CLASS and the other named Class, and to also support
591# references to files without having to specify the exact matching casing. On
592# Windows (including Cygwin) and MacOS, users should typically set this option
593# to NO, whereas on Linux or other Unix flavors it should typically be set to
594# YES.
595# The default value is: system dependent.
596
597CASE_SENSE_NAMES = NO
598
599# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
600# their full class and namespace scopes in the documentation. If set to YES, the
601# scope will be hidden.
602# The default value is: NO.
603
604HIDE_SCOPE_NAMES = NO
605
606# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
607# append additional text to a page's title, such as Class Reference. If set to
608# YES the compound reference will be hidden.
609# The default value is: NO.
610
611HIDE_COMPOUND_REFERENCE= NO
612
613# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
614# the files that are included by a file in the documentation of that file.
615# The default value is: YES.
616
617SHOW_INCLUDE_FILES = YES
618
619# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
620# grouped member an include statement to the documentation, telling the reader
621# which file to include in order to use the member.
622# The default value is: NO.
623
624SHOW_GROUPED_MEMB_INC = NO
625
626# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
627# files with double quotes in the documentation rather than with sharp brackets.
628# The default value is: NO.
629
630FORCE_LOCAL_INCLUDES = NO
631
632# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
633# documentation for inline members.
634# The default value is: YES.
635
636INLINE_INFO = YES
637
638# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
639# (detailed) documentation of file and class members alphabetically by member
640# name. If set to NO, the members will appear in declaration order.
641# The default value is: YES.
642
643SORT_MEMBER_DOCS = YES
644
645# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
646# descriptions of file, namespace and class members alphabetically by member
647# name. If set to NO, the members will appear in declaration order. Note that
648# this will also influence the order of the classes in the class list.
649# The default value is: NO.
650
651SORT_BRIEF_DOCS = NO
652
653# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
654# (brief and detailed) documentation of class members so that constructors and
655# destructors are listed first. If set to NO the constructors will appear in the
656# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
657# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
658# member documentation.
659# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
660# detailed member documentation.
661# The default value is: NO.
662
663SORT_MEMBERS_CTORS_1ST = NO
664
665# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
666# of group names into alphabetical order. If set to NO the group names will
667# appear in their defined order.
668# The default value is: NO.
669
670SORT_GROUP_NAMES = NO
671
672# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
673# fully-qualified names, including namespaces. If set to NO, the class list will
674# be sorted only by class name, not including the namespace part.
675# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
676# Note: This option applies only to the class list, not to the alphabetical
677# list.
678# The default value is: NO.
679
680SORT_BY_SCOPE_NAME = NO
681
682# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
683# type resolution of all parameters of a function it will reject a match between
684# the prototype and the implementation of a member function even if there is
685# only one candidate or it is obvious which candidate to choose by doing a
686# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
687# accept a match between prototype and implementation in such cases.
688# The default value is: NO.
689
690STRICT_PROTO_MATCHING = NO
691
692# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
693# list. This list is created by putting \todo commands in the documentation.
694# The default value is: YES.
695
696GENERATE_TODOLIST = YES
697
698# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
699# list. This list is created by putting \test commands in the documentation.
700# The default value is: YES.
701
702GENERATE_TESTLIST = YES
703
704# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
705# list. This list is created by putting \bug commands in the documentation.
706# The default value is: YES.
707
708GENERATE_BUGLIST = YES
709
710# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
711# the deprecated list. This list is created by putting \deprecated commands in
712# the documentation.
713# The default value is: YES.
714
715GENERATE_DEPRECATEDLIST= YES
716
717# The ENABLED_SECTIONS tag can be used to enable conditional documentation
718# sections, marked by \if <section_label> ... \endif and \cond <section_label>
719# ... \endcond blocks.
720
721ENABLED_SECTIONS =
722
723# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
724# initial value of a variable or macro / define can have for it to appear in the
725# documentation. If the initializer consists of more lines than specified here
726# it will be hidden. Use a value of 0 to hide initializers completely. The
727# appearance of the value of individual variables and macros / defines can be
728# controlled using \showinitializer or \hideinitializer command in the
729# documentation regardless of this setting.
730# Minimum value: 0, maximum value: 10000, default value: 30.
731
732MAX_INITIALIZER_LINES = 30
733
734# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
735# the bottom of the documentation of classes and structs. If set to YES, the
736# list will mention the files that were used to generate the documentation.
737# The default value is: YES.
738
739SHOW_USED_FILES = YES
740
741# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
742# will remove the Files entry from the Quick Index and from the Folder Tree View
743# (if specified).
744# The default value is: YES.
745
746SHOW_FILES = YES
747
748# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
749# page. This will remove the Namespaces entry from the Quick Index and from the
750# Folder Tree View (if specified).
751# The default value is: YES.
752
753SHOW_NAMESPACES = YES
754
755# The FILE_VERSION_FILTER tag can be used to specify a program or script that
756# doxygen should invoke to get the current version for each file (typically from
757# the version control system). Doxygen will invoke the program by executing (via
758# popen()) the command command input-file, where command is the value of the
759# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
760# by doxygen. Whatever the program writes to standard output is used as the file
761# version. For an example see the documentation.
762
763FILE_VERSION_FILTER =
764
765# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
766# by doxygen. The layout file controls the global structure of the generated
767# output files in an output format independent way. To create the layout file
768# that represents doxygen's defaults, run doxygen with the -l option. You can
769# optionally specify a file name after the option, if omitted DoxygenLayout.xml
770# will be used as the name of the layout file.
771#
772# Note that if you run doxygen from a directory containing a file called
773# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
774# tag is left empty.
775
776LAYOUT_FILE =
777
778# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
779# the reference definitions. This must be a list of .bib files. The .bib
780# extension is automatically appended if omitted. This requires the bibtex tool
781# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info.
782# For LaTeX the style of the bibliography can be controlled using
783# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
784# search path. See also \cite for info how to create references.
785
786CITE_BIB_FILES =
787
788#---------------------------------------------------------------------------
789# Configuration options related to warning and progress messages
790#---------------------------------------------------------------------------
791
792# The QUIET tag can be used to turn on/off the messages that are generated to
793# standard output by doxygen. If QUIET is set to YES this implies that the
794# messages are off.
795# The default value is: NO.
796
797QUIET = NO
798
799# The WARNINGS tag can be used to turn on/off the warning messages that are
800# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
801# this implies that the warnings are on.
802#
803# Tip: Turn warnings on while writing the documentation.
804# The default value is: YES.
805
806WARNINGS = YES
807
808# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
809# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
810# will automatically be disabled.
811# The default value is: YES.
812
813WARN_IF_UNDOCUMENTED = YES
814
815# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
816# potential errors in the documentation, such as not documenting some parameters
817# in a documented function, or documenting parameters that don't exist or using
818# markup commands wrongly.
819# The default value is: YES.
820
821WARN_IF_DOC_ERROR = YES
822
823# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
824# are documented, but have no documentation for their parameters or return
825# value. If set to NO, doxygen will only warn about wrong or incomplete
826# parameter documentation, but not about the absence of documentation. If
827# EXTRACT_ALL is set to YES then this flag will automatically be disabled.
828# The default value is: NO.
829
830WARN_NO_PARAMDOC = NO
831
832# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
833# a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS
834# then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but
835# at the end of the doxygen process doxygen will return with a non-zero status.
836# Possible values are: NO, YES and FAIL_ON_WARNINGS.
837# The default value is: NO.
838
839WARN_AS_ERROR = NO
840
841# The WARN_FORMAT tag determines the format of the warning messages that doxygen
842# can produce. The string should contain the $file, $line, and $text tags, which
843# will be replaced by the file and line number from which the warning originated
844# and the warning text. Optionally the format may contain $version, which will
845# be replaced by the version of the file (if it could be obtained via
846# FILE_VERSION_FILTER)
847# The default value is: $file:$line: $text.
848
849WARN_FORMAT = "$file:$line: $text"
850
851# The WARN_LOGFILE tag can be used to specify a file to which warning and error
852# messages should be written. If left blank the output is written to standard
853# error (stderr).
854
855WARN_LOGFILE =
856
857#---------------------------------------------------------------------------
858# Configuration options related to the input files
859#---------------------------------------------------------------------------
860
861# The INPUT tag is used to specify the files and/or directories that contain
862# documented source files. You may enter file names like myfile.cpp or
863# directories like /usr/src/myproject. Separate the files or directories with
864# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
865# Note: If this tag is empty the current directory is searched.
866
867INPUT = src \
868 include
869
870# This tag can be used to specify the character encoding of the source files
871# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
872# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
873# documentation (see:
874# https://www.gnu.org/software/libiconv/) for the list of possible encodings.
875# The default value is: UTF-8.
876
877INPUT_ENCODING = UTF-8
878
879# If the value of the INPUT tag contains directories, you can use the
880# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
881# *.h) to filter out the source-files in the directories.
882#
883# Note that for custom extensions or not directly supported extensions you also
884# need to set EXTENSION_MAPPING for the extension otherwise the files are not
885# read by doxygen.
886#
887# Note the list of default checked file patterns might differ from the list of
888# default file extension mappings.
889#
890# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,
891# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,
892# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc,
893# *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C comment),
894# *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd, *.vhdl,
895# *.ucf, *.qsf and *.ice.
896
897FILE_PATTERNS = *.c \
898 *.cc \
899 *.cxx \
900 *.cpp \
901 *.c++ \
902 *.java \
903 *.ii \
904 *.ixx \
905 *.ipp \
906 *.i++ \
907 *.inl \
908 *.idl \
909 *.ddl \
910 *.odl \
911 *.h \
912 *.hh \
913 *.hxx \
914 *.hpp \
915 *.h++ \
916 *.cs \
917 *.d \
918 *.php \
919 *.php4 \
920 *.php5 \
921 *.phtml \
922 *.inc \
923 *.m \
924 *.markdown \
925 *.md \
926 *.mm \
927 *.dox \
928 *.py \
929 *.pyw \
930 *.f90 \
931 *.f95 \
932 *.f03 \
933 *.f08 \
934 *.f18 \
935 *.f \
936 *.for \
937 *.vhd \
938 *.vhdl \
939 *.ucf \
940 *.qsf \
941 *.ice
942
943# The RECURSIVE tag can be used to specify whether or not subdirectories should
944# be searched for input files as well.
945# The default value is: NO.
946
947RECURSIVE = NO
948
949# The EXCLUDE tag can be used to specify files and/or directories that should be
950# excluded from the INPUT source files. This way you can easily exclude a
951# subdirectory from a directory tree whose root is specified with the INPUT tag.
952#
953# Note that relative paths are relative to the directory from which doxygen is
954# run.
955
956EXCLUDE =
957
958# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
959# directories that are symbolic links (a Unix file system feature) are excluded
960# from the input.
961# The default value is: NO.
962
963EXCLUDE_SYMLINKS = NO
964
965# If the value of the INPUT tag contains directories, you can use the
966# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
967# certain files from those directories.
968#
969# Note that the wildcards are matched against the file with absolute path, so to
970# exclude all test directories for example use the pattern */test/*
971
972EXCLUDE_PATTERNS =
973
974# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
975# (namespaces, classes, functions, etc.) that should be excluded from the
976# output. The symbol name can be a fully qualified name, a word, or if the
977# wildcard * is used, a substring. Examples: ANamespace, AClass,
978# AClass::ANamespace, ANamespace::*Test
979#
980# Note that the wildcards are matched against the file with absolute path, so to
981# exclude all test directories use the pattern */test/*
982
983EXCLUDE_SYMBOLS =
984
985# The EXAMPLE_PATH tag can be used to specify one or more files or directories
986# that contain example code fragments that are included (see the \include
987# command).
988
989EXAMPLE_PATH =
990
991# If the value of the EXAMPLE_PATH tag contains directories, you can use the
992# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
993# *.h) to filter out the source-files in the directories. If left blank all
994# files are included.
995
996EXAMPLE_PATTERNS = *
997
998# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
999# searched for input files to be used with the \include or \dontinclude commands
1000# irrespective of the value of the RECURSIVE tag.
1001# The default value is: NO.
1002
1003EXAMPLE_RECURSIVE = NO
1004
1005# The IMAGE_PATH tag can be used to specify one or more files or directories
1006# that contain images that are to be included in the documentation (see the
1007# \image command).
1008
1009IMAGE_PATH =
1010
1011# The INPUT_FILTER tag can be used to specify a program that doxygen should
1012# invoke to filter for each input file. Doxygen will invoke the filter program
1013# by executing (via popen()) the command:
1014#
1015# <filter> <input-file>
1016#
1017# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
1018# name of an input file. Doxygen will then use the output that the filter
1019# program writes to standard output. If FILTER_PATTERNS is specified, this tag
1020# will be ignored.
1021#
1022# Note that the filter must not add or remove lines; it is applied before the
1023# code is scanned, but not when the output code is generated. If lines are added
1024# or removed, the anchors will not be placed correctly.
1025#
1026# Note that for custom extensions or not directly supported extensions you also
1027# need to set EXTENSION_MAPPING for the extension otherwise the files are not
1028# properly processed by doxygen.
1029
1030INPUT_FILTER =
1031
1032# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
1033# basis. Doxygen will compare the file name with each pattern and apply the
1034# filter if there is a match. The filters are a list of the form: pattern=filter
1035# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
1036# filters are used. If the FILTER_PATTERNS tag is empty or if none of the
1037# patterns match the file name, INPUT_FILTER is applied.
1038#
1039# Note that for custom extensions or not directly supported extensions you also
1040# need to set EXTENSION_MAPPING for the extension otherwise the files are not
1041# properly processed by doxygen.
1042
1043FILTER_PATTERNS =
1044
1045# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
1046# INPUT_FILTER) will also be used to filter the input files that are used for
1047# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
1048# The default value is: NO.
1049
1050FILTER_SOURCE_FILES = NO
1051
1052# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
1053# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
1054# it is also possible to disable source filtering for a specific pattern using
1055# *.ext= (so without naming a filter).
1056# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
1057
1058FILTER_SOURCE_PATTERNS =
1059
1060# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
1061# is part of the input, its contents will be placed on the main page
1062# (index.html). This can be useful if you have a project on for instance GitHub
1063# and want to reuse the introduction page also for the doxygen output.
1064
1065USE_MDFILE_AS_MAINPAGE =
1066
1067#---------------------------------------------------------------------------
1068# Configuration options related to source browsing
1069#---------------------------------------------------------------------------
1070
1071# If the SOURCE_BROWSER tag is set to YES then a list of source files will be
1072# generated. Documented entities will be cross-referenced with these sources.
1073#
1074# Note: To get rid of all source code in the generated output, make sure that
1075# also VERBATIM_HEADERS is set to NO.
1076# The default value is: NO.
1077
1078SOURCE_BROWSER = NO
1079
1080# Setting the INLINE_SOURCES tag to YES will include the body of functions,
1081# classes and enums directly into the documentation.
1082# The default value is: NO.
1083
1084INLINE_SOURCES = NO
1085
1086# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
1087# special comment blocks from generated source code fragments. Normal C, C++ and
1088# Fortran comments will always remain visible.
1089# The default value is: YES.
1090
1091STRIP_CODE_COMMENTS = YES
1092
1093# If the REFERENCED_BY_RELATION tag is set to YES then for each documented
1094# entity all documented functions referencing it will be listed.
1095# The default value is: NO.
1096
1097REFERENCED_BY_RELATION = NO
1098
1099# If the REFERENCES_RELATION tag is set to YES then for each documented function
1100# all documented entities called/used by that function will be listed.
1101# The default value is: NO.
1102
1103REFERENCES_RELATION = NO
1104
1105# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
1106# to YES then the hyperlinks from functions in REFERENCES_RELATION and
1107# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
1108# link to the documentation.
1109# The default value is: YES.
1110
1111REFERENCES_LINK_SOURCE = YES
1112
1113# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
1114# source code will show a tooltip with additional information such as prototype,
1115# brief description and links to the definition and documentation. Since this
1116# will make the HTML file larger and loading of large files a bit slower, you
1117# can opt to disable this feature.
1118# The default value is: YES.
1119# This tag requires that the tag SOURCE_BROWSER is set to YES.
1120
1121SOURCE_TOOLTIPS = YES
1122
1123# If the USE_HTAGS tag is set to YES then the references to source code will
1124# point to the HTML generated by the htags(1) tool instead of doxygen built-in
1125# source browser. The htags tool is part of GNU's global source tagging system
1126# (see https://www.gnu.org/software/global/global.html). You will need version
1127# 4.8.6 or higher.
1128#
1129# To use it do the following:
1130# - Install the latest version of global
1131# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file
1132# - Make sure the INPUT points to the root of the source tree
1133# - Run doxygen as normal
1134#
1135# Doxygen will invoke htags (and that will in turn invoke gtags), so these
1136# tools must be available from the command line (i.e. in the search path).
1137#
1138# The result: instead of the source browser generated by doxygen, the links to
1139# source code will now point to the output of htags.
1140# The default value is: NO.
1141# This tag requires that the tag SOURCE_BROWSER is set to YES.
1142
1143USE_HTAGS = NO
1144
1145# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
1146# verbatim copy of the header file for each class for which an include is
1147# specified. Set to NO to disable this.
1148# See also: Section \class.
1149# The default value is: YES.
1150
1151VERBATIM_HEADERS = YES
1152
1153#---------------------------------------------------------------------------
1154# Configuration options related to the alphabetical class index
1155#---------------------------------------------------------------------------
1156
1157# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
1158# compounds will be generated. Enable this if the project contains a lot of
1159# classes, structs, unions or interfaces.
1160# The default value is: YES.
1161
1162ALPHABETICAL_INDEX = YES
1163
1164# In case all classes in a project start with a common prefix, all classes will
1165# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
1166# can be used to specify a prefix (or a list of prefixes) that should be ignored
1167# while generating the index headers.
1168# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1169
1170IGNORE_PREFIX =
1171
1172#---------------------------------------------------------------------------
1173# Configuration options related to the HTML output
1174#---------------------------------------------------------------------------
1175
1176# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
1177# The default value is: YES.
1178
1179GENERATE_HTML = YES
1180
1181# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
1182# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1183# it.
1184# The default directory is: html.
1185# This tag requires that the tag GENERATE_HTML is set to YES.
1186
1187HTML_OUTPUT = html
1188
1189# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
1190# generated HTML page (for example: .htm, .php, .asp).
1191# The default value is: .html.
1192# This tag requires that the tag GENERATE_HTML is set to YES.
1193
1194HTML_FILE_EXTENSION = .html
1195
1196# The HTML_HEADER tag can be used to specify a user-defined HTML header file for
1197# each generated HTML page. If the tag is left blank doxygen will generate a
1198# standard header.
1199#
1200# To get valid HTML the header file that includes any scripts and style sheets
1201# that doxygen needs, which is dependent on the configuration options used (e.g.
1202# the setting GENERATE_TREEVIEW). It is highly recommended to start with a
1203# default header using
1204# doxygen -w html new_header.html new_footer.html new_stylesheet.css
1205# YourConfigFile
1206# and then modify the file new_header.html. See also section "Doxygen usage"
1207# for information on how to generate the default header that doxygen normally
1208# uses.
1209# Note: The header is subject to change so you typically have to regenerate the
1210# default header when upgrading to a newer version of doxygen. For a description
1211# of the possible markers and block names see the documentation.
1212# This tag requires that the tag GENERATE_HTML is set to YES.
1213
1214HTML_HEADER =
1215
1216# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
1217# generated HTML page. If the tag is left blank doxygen will generate a standard
1218# footer. See HTML_HEADER for more information on how to generate a default
1219# footer and what special commands can be used inside the footer. See also
1220# section "Doxygen usage" for information on how to generate the default footer
1221# that doxygen normally uses.
1222# This tag requires that the tag GENERATE_HTML is set to YES.
1223
1224HTML_FOOTER =
1225
1226# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
1227# sheet that is used by each HTML page. It can be used to fine-tune the look of
1228# the HTML output. If left blank doxygen will generate a default style sheet.
1229# See also section "Doxygen usage" for information on how to generate the style
1230# sheet that doxygen normally uses.
1231# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
1232# it is more robust and this tag (HTML_STYLESHEET) will in the future become
1233# obsolete.
1234# This tag requires that the tag GENERATE_HTML is set to YES.
1235
1236HTML_STYLESHEET =
1237
1238# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1239# cascading style sheets that are included after the standard style sheets
1240# created by doxygen. Using this option one can overrule certain style aspects.
1241# This is preferred over using HTML_STYLESHEET since it does not replace the
1242# standard style sheet and is therefore more robust against future updates.
1243# Doxygen will copy the style sheet files to the output directory.
1244# Note: The order of the extra style sheet files is of importance (e.g. the last
1245# style sheet in the list overrules the setting of the previous ones in the
1246# list). For an example see the documentation.
1247# This tag requires that the tag GENERATE_HTML is set to YES.
1248
1249HTML_EXTRA_STYLESHEET =
1250
1251# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
1252# other source files which should be copied to the HTML output directory. Note
1253# that these files will be copied to the base HTML output directory. Use the
1254# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
1255# files. In the HTML_STYLESHEET file, use the file name only. Also note that the
1256# files will be copied as-is; there are no commands or markers available.
1257# This tag requires that the tag GENERATE_HTML is set to YES.
1258
1259HTML_EXTRA_FILES =
1260
1261# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
1262# will adjust the colors in the style sheet and background images according to
1263# this color. Hue is specified as an angle on a colorwheel, see
1264# https://en.wikipedia.org/wiki/Hue for more information. For instance the value
1265# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
1266# purple, and 360 is red again.
1267# Minimum value: 0, maximum value: 359, default value: 220.
1268# This tag requires that the tag GENERATE_HTML is set to YES.
1269
1270HTML_COLORSTYLE_HUE = 220
1271
1272# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
1273# in the HTML output. For a value of 0 the output will use grayscales only. A
1274# value of 255 will produce the most vivid colors.
1275# Minimum value: 0, maximum value: 255, default value: 100.
1276# This tag requires that the tag GENERATE_HTML is set to YES.
1277
1278HTML_COLORSTYLE_SAT = 100
1279
1280# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
1281# luminance component of the colors in the HTML output. Values below 100
1282# gradually make the output lighter, whereas values above 100 make the output
1283# darker. The value divided by 100 is the actual gamma applied, so 80 represents
1284# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
1285# change the gamma.
1286# Minimum value: 40, maximum value: 240, default value: 80.
1287# This tag requires that the tag GENERATE_HTML is set to YES.
1288
1289HTML_COLORSTYLE_GAMMA = 80
1290
1291# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
1292# page will contain the date and time when the page was generated. Setting this
1293# to YES can help to show when doxygen was last run and thus if the
1294# documentation is up to date.
1295# The default value is: NO.
1296# This tag requires that the tag GENERATE_HTML is set to YES.
1297
1298HTML_TIMESTAMP = NO
1299
1300# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML
1301# documentation will contain a main index with vertical navigation menus that
1302# are dynamically created via JavaScript. If disabled, the navigation index will
1303# consists of multiple levels of tabs that are statically embedded in every HTML
1304# page. Disable this option to support browsers that do not have JavaScript,
1305# like the Qt help browser.
1306# The default value is: YES.
1307# This tag requires that the tag GENERATE_HTML is set to YES.
1308
1309HTML_DYNAMIC_MENUS = YES
1310
1311# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
1312# documentation will contain sections that can be hidden and shown after the
1313# page has loaded.
1314# The default value is: NO.
1315# This tag requires that the tag GENERATE_HTML is set to YES.
1316
1317HTML_DYNAMIC_SECTIONS = NO
1318
1319# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
1320# shown in the various tree structured indices initially; the user can expand
1321# and collapse entries dynamically later on. Doxygen will expand the tree to
1322# such a level that at most the specified number of entries are visible (unless
1323# a fully collapsed tree already exceeds this amount). So setting the number of
1324# entries 1 will produce a full collapsed tree by default. 0 is a special value
1325# representing an infinite number of entries and will result in a full expanded
1326# tree by default.
1327# Minimum value: 0, maximum value: 9999, default value: 100.
1328# This tag requires that the tag GENERATE_HTML is set to YES.
1329
1330HTML_INDEX_NUM_ENTRIES = 100
1331
1332# If the GENERATE_DOCSET tag is set to YES, additional index files will be
1333# generated that can be used as input for Apple's Xcode 3 integrated development
1334# environment (see:
1335# https://developer.apple.com/xcode/), introduced with OSX 10.5 (Leopard). To
1336# create a documentation set, doxygen will generate a Makefile in the HTML
1337# output directory. Running make will produce the docset in that directory and
1338# running make install will install the docset in
1339# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
1340# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy
1341# genXcode/_index.html for more information.
1342# The default value is: NO.
1343# This tag requires that the tag GENERATE_HTML is set to YES.
1344
1345GENERATE_DOCSET = NO
1346
1347# This tag determines the name of the docset feed. A documentation feed provides
1348# an umbrella under which multiple documentation sets from a single provider
1349# (such as a company or product suite) can be grouped.
1350# The default value is: Doxygen generated docs.
1351# This tag requires that the tag GENERATE_DOCSET is set to YES.
1352
1353DOCSET_FEEDNAME = "Doxygen generated docs"
1354
1355# This tag specifies a string that should uniquely identify the documentation
1356# set bundle. This should be a reverse domain-name style string, e.g.
1357# com.mycompany.MyDocSet. Doxygen will append .docset to the name.
1358# The default value is: org.doxygen.Project.
1359# This tag requires that the tag GENERATE_DOCSET is set to YES.
1360
1361DOCSET_BUNDLE_ID = org.doxygen.Project
1362
1363# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
1364# the documentation publisher. This should be a reverse domain-name style
1365# string, e.g. com.mycompany.MyDocSet.documentation.
1366# The default value is: org.doxygen.Publisher.
1367# This tag requires that the tag GENERATE_DOCSET is set to YES.
1368
1369DOCSET_PUBLISHER_ID = org.doxygen.Publisher
1370
1371# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
1372# The default value is: Publisher.
1373# This tag requires that the tag GENERATE_DOCSET is set to YES.
1374
1375DOCSET_PUBLISHER_NAME = Publisher
1376
1377# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
1378# additional HTML index files: index.hhp, index.hhc, and index.hhk. The
1379# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
1380# (see:
1381# https://www.microsoft.com/en-us/download/details.aspx?id=21138) on Windows.
1382#
1383# The HTML Help Workshop contains a compiler that can convert all HTML output
1384# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
1385# files are now used as the Windows 98 help format, and will replace the old
1386# Windows help format (.hlp) on all Windows platforms in the future. Compressed
1387# HTML files also contain an index, a table of contents, and you can search for
1388# words in the documentation. The HTML workshop also contains a viewer for
1389# compressed HTML files.
1390# The default value is: NO.
1391# This tag requires that the tag GENERATE_HTML is set to YES.
1392
1393GENERATE_HTMLHELP = NO
1394
1395# The CHM_FILE tag can be used to specify the file name of the resulting .chm
1396# file. You can add a path in front of the file if the result should not be
1397# written to the html output directory.
1398# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1399
1400CHM_FILE =
1401
1402# The HHC_LOCATION tag can be used to specify the location (absolute path
1403# including file name) of the HTML help compiler (hhc.exe). If non-empty,
1404# doxygen will try to run the HTML help compiler on the generated index.hhp.
1405# The file has to be specified with full path.
1406# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1407
1408HHC_LOCATION =
1409
1410# The GENERATE_CHI flag controls if a separate .chi index file is generated
1411# (YES) or that it should be included in the main .chm file (NO).
1412# The default value is: NO.
1413# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1414
1415GENERATE_CHI = NO
1416
1417# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
1418# and project file content.
1419# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1420
1421CHM_INDEX_ENCODING =
1422
1423# The BINARY_TOC flag controls whether a binary table of contents is generated
1424# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
1425# enables the Previous and Next buttons.
1426# The default value is: NO.
1427# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1428
1429BINARY_TOC = NO
1430
1431# The TOC_EXPAND flag can be set to YES to add extra items for group members to
1432# the table of contents of the HTML help documentation and to the tree view.
1433# The default value is: NO.
1434# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
1435
1436TOC_EXPAND = NO
1437
1438# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
1439# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
1440# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
1441# (.qch) of the generated HTML documentation.
1442# The default value is: NO.
1443# This tag requires that the tag GENERATE_HTML is set to YES.
1444
1445GENERATE_QHP = NO
1446
1447# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
1448# the file name of the resulting .qch file. The path specified is relative to
1449# the HTML output folder.
1450# This tag requires that the tag GENERATE_QHP is set to YES.
1451
1452QCH_FILE =
1453
1454# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
1455# Project output. For more information please see Qt Help Project / Namespace
1456# (see:
1457# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace).
1458# The default value is: org.doxygen.Project.
1459# This tag requires that the tag GENERATE_QHP is set to YES.
1460
1461QHP_NAMESPACE = org.doxygen.Project
1462
1463# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
1464# Help Project output. For more information please see Qt Help Project / Virtual
1465# Folders (see:
1466# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders).
1467# The default value is: doc.
1468# This tag requires that the tag GENERATE_QHP is set to YES.
1469
1470QHP_VIRTUAL_FOLDER = doc
1471
1472# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
1473# filter to add. For more information please see Qt Help Project / Custom
1474# Filters (see:
1475# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters).
1476# This tag requires that the tag GENERATE_QHP is set to YES.
1477
1478QHP_CUST_FILTER_NAME =
1479
1480# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
1481# custom filter to add. For more information please see Qt Help Project / Custom
1482# Filters (see:
1483# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters).
1484# This tag requires that the tag GENERATE_QHP is set to YES.
1485
1486QHP_CUST_FILTER_ATTRS =
1487
1488# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
1489# project's filter section matches. Qt Help Project / Filter Attributes (see:
1490# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes).
1491# This tag requires that the tag GENERATE_QHP is set to YES.
1492
1493QHP_SECT_FILTER_ATTRS =
1494
1495# The QHG_LOCATION tag can be used to specify the location (absolute path
1496# including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to
1497# run qhelpgenerator on the generated .qhp file.
1498# This tag requires that the tag GENERATE_QHP is set to YES.
1499
1500QHG_LOCATION =
1501
1502# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
1503# generated, together with the HTML files, they form an Eclipse help plugin. To
1504# install this plugin and make it available under the help contents menu in
1505# Eclipse, the contents of the directory containing the HTML and XML files needs
1506# to be copied into the plugins directory of eclipse. The name of the directory
1507# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
1508# After copying Eclipse needs to be restarted before the help appears.
1509# The default value is: NO.
1510# This tag requires that the tag GENERATE_HTML is set to YES.
1511
1512GENERATE_ECLIPSEHELP = NO
1513
1514# A unique identifier for the Eclipse help plugin. When installing the plugin
1515# the directory name containing the HTML and XML files should also have this
1516# name. Each documentation set should have its own identifier.
1517# The default value is: org.doxygen.Project.
1518# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
1519
1520ECLIPSE_DOC_ID = org.doxygen.Project
1521
1522# If you want full control over the layout of the generated HTML pages it might
1523# be necessary to disable the index and replace it with your own. The
1524# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
1525# of each HTML page. A value of NO enables the index and the value YES disables
1526# it. Since the tabs in the index contain the same information as the navigation
1527# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
1528# The default value is: NO.
1529# This tag requires that the tag GENERATE_HTML is set to YES.
1530
1531DISABLE_INDEX = NO
1532
1533# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
1534# structure should be generated to display hierarchical information. If the tag
1535# value is set to YES, a side panel will be generated containing a tree-like
1536# index structure (just like the one that is generated for HTML Help). For this
1537# to work a browser that supports JavaScript, DHTML, CSS and frames is required
1538# (i.e. any modern browser). Windows users are probably better off using the
1539# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
1540# further fine-tune the look of the index. As an example, the default style
1541# sheet generated by doxygen has an example that shows how to put an image at
1542# the root of the tree instead of the PROJECT_NAME. Since the tree basically has
1543# the same information as the tab index, you could consider setting
1544# DISABLE_INDEX to YES when enabling this option.
1545# The default value is: NO.
1546# This tag requires that the tag GENERATE_HTML is set to YES.
1547
1548GENERATE_TREEVIEW = NO
1549
1550# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
1551# doxygen will group on one line in the generated HTML documentation.
1552#
1553# Note that a value of 0 will completely suppress the enum values from appearing
1554# in the overview section.
1555# Minimum value: 0, maximum value: 20, default value: 4.
1556# This tag requires that the tag GENERATE_HTML is set to YES.
1557
1558ENUM_VALUES_PER_LINE = 4
1559
1560# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
1561# to set the initial width (in pixels) of the frame in which the tree is shown.
1562# Minimum value: 0, maximum value: 1500, default value: 250.
1563# This tag requires that the tag GENERATE_HTML is set to YES.
1564
1565TREEVIEW_WIDTH = 250
1566
1567# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
1568# external symbols imported via tag files in a separate window.
1569# The default value is: NO.
1570# This tag requires that the tag GENERATE_HTML is set to YES.
1571
1572EXT_LINKS_IN_WINDOW = NO
1573
1574# If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg
1575# tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see
1576# https://inkscape.org) to generate formulas as SVG images instead of PNGs for
1577# the HTML output. These images will generally look nicer at scaled resolutions.
1578# Possible values are: png (the default) and svg (looks nicer but requires the
1579# pdf2svg or inkscape tool).
1580# The default value is: png.
1581# This tag requires that the tag GENERATE_HTML is set to YES.
1582
1583HTML_FORMULA_FORMAT = png
1584
1585# Use this tag to change the font size of LaTeX formulas included as images in
1586# the HTML documentation. When you change the font size after a successful
1587# doxygen run you need to manually remove any form_*.png images from the HTML
1588# output directory to force them to be regenerated.
1589# Minimum value: 8, maximum value: 50, default value: 10.
1590# This tag requires that the tag GENERATE_HTML is set to YES.
1591
1592FORMULA_FONTSIZE = 10
1593
1594# Use the FORMULA_TRANSPARENT tag to determine whether or not the images
1595# generated for formulas are transparent PNGs. Transparent PNGs are not
1596# supported properly for IE 6.0, but are supported on all modern browsers.
1597#
1598# Note that when changing this option you need to delete any form_*.png files in
1599# the HTML output directory before the changes have effect.
1600# The default value is: YES.
1601# This tag requires that the tag GENERATE_HTML is set to YES.
1602
1603FORMULA_TRANSPARENT = YES
1604
1605# The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands
1606# to create new LaTeX commands to be used in formulas as building blocks. See
1607# the section "Including formulas" for details.
1608
1609FORMULA_MACROFILE =
1610
1611# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
1612# https://www.mathjax.org) which uses client side JavaScript for the rendering
1613# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
1614# installed or if you want to formulas look prettier in the HTML output. When
1615# enabled you may also need to install MathJax separately and configure the path
1616# to it using the MATHJAX_RELPATH option.
1617# The default value is: NO.
1618# This tag requires that the tag GENERATE_HTML is set to YES.
1619
1620USE_MATHJAX = NO
1621
1622# When MathJax is enabled you can set the default output format to be used for
1623# the MathJax output. See the MathJax site (see:
1624# http://docs.mathjax.org/en/v2.7-latest/output.html) for more details.
1625# Possible values are: HTML-CSS (which is slower, but has the best
1626# compatibility), NativeMML (i.e. MathML) and SVG.
1627# The default value is: HTML-CSS.
1628# This tag requires that the tag USE_MATHJAX is set to YES.
1629
1630MATHJAX_FORMAT = HTML-CSS
1631
1632# When MathJax is enabled you need to specify the location relative to the HTML
1633# output directory using the MATHJAX_RELPATH option. The destination directory
1634# should contain the MathJax.js script. For instance, if the mathjax directory
1635# is located at the same level as the HTML output directory, then
1636# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
1637# Content Delivery Network so you can quickly see the result without installing
1638# MathJax. However, it is strongly recommended to install a local copy of
1639# MathJax from https://www.mathjax.org before deployment.
1640# The default value is: https://cdn.jsdelivr.net/npm/mathjax@2.
1641# This tag requires that the tag USE_MATHJAX is set to YES.
1642
1643MATHJAX_RELPATH = https://cdn.jsdelivr.net/npm/mathjax@2
1644
1645# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
1646# extension names that should be enabled during MathJax rendering. For example
1647# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
1648# This tag requires that the tag USE_MATHJAX is set to YES.
1649
1650MATHJAX_EXTENSIONS =
1651
1652# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
1653# of code that will be used on startup of the MathJax code. See the MathJax site
1654# (see:
1655# http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an
1656# example see the documentation.
1657# This tag requires that the tag USE_MATHJAX is set to YES.
1658
1659MATHJAX_CODEFILE =
1660
1661# When the SEARCHENGINE tag is enabled doxygen will generate a search box for
1662# the HTML output. The underlying search engine uses javascript and DHTML and
1663# should work on any modern browser. Note that when using HTML help
1664# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
1665# there is already a search function so this one should typically be disabled.
1666# For large projects the javascript based search engine can be slow, then
1667# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
1668# search using the keyboard; to jump to the search box use <access key> + S
1669# (what the <access key> is depends on the OS and browser, but it is typically
1670# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
1671# key> to jump into the search results window, the results can be navigated
1672# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
1673# the search. The filter options can be selected when the cursor is inside the
1674# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
1675# to select a filter and <Enter> or <escape> to activate or cancel the filter
1676# option.
1677# The default value is: YES.
1678# This tag requires that the tag GENERATE_HTML is set to YES.
1679
1680SEARCHENGINE = YES
1681
1682# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
1683# implemented using a web server instead of a web client using JavaScript. There
1684# are two flavors of web server based searching depending on the EXTERNAL_SEARCH
1685# setting. When disabled, doxygen will generate a PHP script for searching and
1686# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
1687# and searching needs to be provided by external tools. See the section
1688# "External Indexing and Searching" for details.
1689# The default value is: NO.
1690# This tag requires that the tag SEARCHENGINE is set to YES.
1691
1692SERVER_BASED_SEARCH = NO
1693
1694# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
1695# script for searching. Instead the search results are written to an XML file
1696# which needs to be processed by an external indexer. Doxygen will invoke an
1697# external search engine pointed to by the SEARCHENGINE_URL option to obtain the
1698# search results.
1699#
1700# Doxygen ships with an example indexer (doxyindexer) and search engine
1701# (doxysearch.cgi) which are based on the open source search engine library
1702# Xapian (see:
1703# https://xapian.org/).
1704#
1705# See the section "External Indexing and Searching" for details.
1706# The default value is: NO.
1707# This tag requires that the tag SEARCHENGINE is set to YES.
1708
1709EXTERNAL_SEARCH = NO
1710
1711# The SEARCHENGINE_URL should point to a search engine hosted by a web server
1712# which will return the search results when EXTERNAL_SEARCH is enabled.
1713#
1714# Doxygen ships with an example indexer (doxyindexer) and search engine
1715# (doxysearch.cgi) which are based on the open source search engine library
1716# Xapian (see:
1717# https://xapian.org/). See the section "External Indexing and Searching" for
1718# details.
1719# This tag requires that the tag SEARCHENGINE is set to YES.
1720
1721SEARCHENGINE_URL =
1722
1723# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
1724# search data is written to a file for indexing by an external tool. With the
1725# SEARCHDATA_FILE tag the name of this file can be specified.
1726# The default file is: searchdata.xml.
1727# This tag requires that the tag SEARCHENGINE is set to YES.
1728
1729SEARCHDATA_FILE = searchdata.xml
1730
1731# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
1732# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
1733# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
1734# projects and redirect the results back to the right project.
1735# This tag requires that the tag SEARCHENGINE is set to YES.
1736
1737EXTERNAL_SEARCH_ID =
1738
1739# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
1740# projects other than the one defined by this configuration file, but that are
1741# all added to the same external search index. Each project needs to have a
1742# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
1743# to a relative location where the documentation can be found. The format is:
1744# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
1745# This tag requires that the tag SEARCHENGINE is set to YES.
1746
1747EXTRA_SEARCH_MAPPINGS =
1748
1749#---------------------------------------------------------------------------
1750# Configuration options related to the LaTeX output
1751#---------------------------------------------------------------------------
1752
1753# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
1754# The default value is: YES.
1755
1756GENERATE_LATEX = YES
1757
1758# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
1759# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1760# it.
1761# The default directory is: latex.
1762# This tag requires that the tag GENERATE_LATEX is set to YES.
1763
1764LATEX_OUTPUT = latex
1765
1766# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1767# invoked.
1768#
1769# Note that when not enabling USE_PDFLATEX the default is latex when enabling
1770# USE_PDFLATEX the default is pdflatex and when in the later case latex is
1771# chosen this is overwritten by pdflatex. For specific output languages the
1772# default can have been set differently, this depends on the implementation of
1773# the output language.
1774# This tag requires that the tag GENERATE_LATEX is set to YES.
1775
1776LATEX_CMD_NAME =
1777
1778# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
1779# index for LaTeX.
1780# Note: This tag is used in the Makefile / make.bat.
1781# See also: LATEX_MAKEINDEX_CMD for the part in the generated output file
1782# (.tex).
1783# The default file is: makeindex.
1784# This tag requires that the tag GENERATE_LATEX is set to YES.
1785
1786MAKEINDEX_CMD_NAME = makeindex
1787
1788# The LATEX_MAKEINDEX_CMD tag can be used to specify the command name to
1789# generate index for LaTeX. In case there is no backslash (\) as first character
1790# it will be automatically added in the LaTeX code.
1791# Note: This tag is used in the generated output file (.tex).
1792# See also: MAKEINDEX_CMD_NAME for the part in the Makefile / make.bat.
1793# The default value is: makeindex.
1794# This tag requires that the tag GENERATE_LATEX is set to YES.
1795
1796LATEX_MAKEINDEX_CMD = makeindex
1797
1798# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
1799# documents. This may be useful for small projects and may help to save some
1800# trees in general.
1801# The default value is: NO.
1802# This tag requires that the tag GENERATE_LATEX is set to YES.
1803
1804COMPACT_LATEX = NO
1805
1806# The PAPER_TYPE tag can be used to set the paper type that is used by the
1807# printer.
1808# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
1809# 14 inches) and executive (7.25 x 10.5 inches).
1810# The default value is: a4.
1811# This tag requires that the tag GENERATE_LATEX is set to YES.
1812
1813PAPER_TYPE = a4
1814
1815# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
1816# that should be included in the LaTeX output. The package can be specified just
1817# by its name or with the correct syntax as to be used with the LaTeX
1818# \usepackage command. To get the times font for instance you can specify :
1819# EXTRA_PACKAGES=times or EXTRA_PACKAGES={times}
1820# To use the option intlimits with the amsmath package you can specify:
1821# EXTRA_PACKAGES=[intlimits]{amsmath}
1822# If left blank no extra packages will be included.
1823# This tag requires that the tag GENERATE_LATEX is set to YES.
1824
1825EXTRA_PACKAGES =
1826
1827# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
1828# generated LaTeX document. The header should contain everything until the first
1829# chapter. If it is left blank doxygen will generate a standard header. See
1830# section "Doxygen usage" for information on how to let doxygen write the
1831# default header to a separate file.
1832#
1833# Note: Only use a user-defined header if you know what you are doing! The
1834# following commands have a special meaning inside the header: $title,
1835# $datetime, $date, $doxygenversion, $projectname, $projectnumber,
1836# $projectbrief, $projectlogo. Doxygen will replace $title with the empty
1837# string, for the replacement values of the other commands the user is referred
1838# to HTML_HEADER.
1839# This tag requires that the tag GENERATE_LATEX is set to YES.
1840
1841LATEX_HEADER =
1842
1843# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
1844# generated LaTeX document. The footer should contain everything after the last
1845# chapter. If it is left blank doxygen will generate a standard footer. See
1846# LATEX_HEADER for more information on how to generate a default footer and what
1847# special commands can be used inside the footer.
1848#
1849# Note: Only use a user-defined footer if you know what you are doing!
1850# This tag requires that the tag GENERATE_LATEX is set to YES.
1851
1852LATEX_FOOTER =
1853
1854# The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
1855# LaTeX style sheets that are included after the standard style sheets created
1856# by doxygen. Using this option one can overrule certain style aspects. Doxygen
1857# will copy the style sheet files to the output directory.
1858# Note: The order of the extra style sheet files is of importance (e.g. the last
1859# style sheet in the list overrules the setting of the previous ones in the
1860# list).
1861# This tag requires that the tag GENERATE_LATEX is set to YES.
1862
1863LATEX_EXTRA_STYLESHEET =
1864
1865# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
1866# other source files which should be copied to the LATEX_OUTPUT output
1867# directory. Note that the files will be copied as-is; there are no commands or
1868# markers available.
1869# This tag requires that the tag GENERATE_LATEX is set to YES.
1870
1871LATEX_EXTRA_FILES =
1872
1873# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
1874# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
1875# contain links (just like the HTML output) instead of page references. This
1876# makes the output suitable for online browsing using a PDF viewer.
1877# The default value is: YES.
1878# This tag requires that the tag GENERATE_LATEX is set to YES.
1879
1880PDF_HYPERLINKS = YES
1881
1882# If the USE_PDFLATEX tag is set to YES, doxygen will use the engine as
1883# specified with LATEX_CMD_NAME to generate the PDF file directly from the LaTeX
1884# files. Set this option to YES, to get a higher quality PDF documentation.
1885#
1886# See also section LATEX_CMD_NAME for selecting the engine.
1887# The default value is: YES.
1888# This tag requires that the tag GENERATE_LATEX is set to YES.
1889
1890USE_PDFLATEX = YES
1891
1892# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
1893# command to the generated LaTeX files. This will instruct LaTeX to keep running
1894# if errors occur, instead of asking the user for help. This option is also used
1895# when generating formulas in HTML.
1896# The default value is: NO.
1897# This tag requires that the tag GENERATE_LATEX is set to YES.
1898
1899LATEX_BATCHMODE = NO
1900
1901# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
1902# index chapters (such as File Index, Compound Index, etc.) in the output.
1903# The default value is: NO.
1904# This tag requires that the tag GENERATE_LATEX is set to YES.
1905
1906LATEX_HIDE_INDICES = NO
1907
1908# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
1909# code with syntax highlighting in the LaTeX output.
1910#
1911# Note that which sources are shown also depends on other settings such as
1912# SOURCE_BROWSER.
1913# The default value is: NO.
1914# This tag requires that the tag GENERATE_LATEX is set to YES.
1915
1916LATEX_SOURCE_CODE = NO
1917
1918# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
1919# bibliography, e.g. plainnat, or ieeetr. See
1920# https://en.wikipedia.org/wiki/BibTeX and \cite for more info.
1921# The default value is: plain.
1922# This tag requires that the tag GENERATE_LATEX is set to YES.
1923
1924LATEX_BIB_STYLE = plain
1925
1926# If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated
1927# page will contain the date and time when the page was generated. Setting this
1928# to NO can help when comparing the output of multiple runs.
1929# The default value is: NO.
1930# This tag requires that the tag GENERATE_LATEX is set to YES.
1931
1932LATEX_TIMESTAMP = NO
1933
1934# The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute)
1935# path from which the emoji images will be read. If a relative path is entered,
1936# it will be relative to the LATEX_OUTPUT directory. If left blank the
1937# LATEX_OUTPUT directory will be used.
1938# This tag requires that the tag GENERATE_LATEX is set to YES.
1939
1940LATEX_EMOJI_DIRECTORY =
1941
1942#---------------------------------------------------------------------------
1943# Configuration options related to the RTF output
1944#---------------------------------------------------------------------------
1945
1946# If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
1947# RTF output is optimized for Word 97 and may not look too pretty with other RTF
1948# readers/editors.
1949# The default value is: NO.
1950
1951GENERATE_RTF = NO
1952
1953# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
1954# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
1955# it.
1956# The default directory is: rtf.
1957# This tag requires that the tag GENERATE_RTF is set to YES.
1958
1959RTF_OUTPUT = rtf
1960
1961# If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
1962# documents. This may be useful for small projects and may help to save some
1963# trees in general.
1964# The default value is: NO.
1965# This tag requires that the tag GENERATE_RTF is set to YES.
1966
1967COMPACT_RTF = NO
1968
1969# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
1970# contain hyperlink fields. The RTF file will contain links (just like the HTML
1971# output) instead of page references. This makes the output suitable for online
1972# browsing using Word or some other Word compatible readers that support those
1973# fields.
1974#
1975# Note: WordPad (write) and others do not support links.
1976# The default value is: NO.
1977# This tag requires that the tag GENERATE_RTF is set to YES.
1978
1979RTF_HYPERLINKS = NO
1980
1981# Load stylesheet definitions from file. Syntax is similar to doxygen's
1982# configuration file, i.e. a series of assignments. You only have to provide
1983# replacements, missing definitions are set to their default value.
1984#
1985# See also section "Doxygen usage" for information on how to generate the
1986# default style sheet that doxygen normally uses.
1987# This tag requires that the tag GENERATE_RTF is set to YES.
1988
1989RTF_STYLESHEET_FILE =
1990
1991# Set optional variables used in the generation of an RTF document. Syntax is
1992# similar to doxygen's configuration file. A template extensions file can be
1993# generated using doxygen -e rtf extensionFile.
1994# This tag requires that the tag GENERATE_RTF is set to YES.
1995
1996RTF_EXTENSIONS_FILE =
1997
1998# If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
1999# with syntax highlighting in the RTF output.
2000#
2001# Note that which sources are shown also depends on other settings such as
2002# SOURCE_BROWSER.
2003# The default value is: NO.
2004# This tag requires that the tag GENERATE_RTF is set to YES.
2005
2006RTF_SOURCE_CODE = NO
2007
2008#---------------------------------------------------------------------------
2009# Configuration options related to the man page output
2010#---------------------------------------------------------------------------
2011
2012# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
2013# classes and files.
2014# The default value is: NO.
2015
2016GENERATE_MAN = NO
2017
2018# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
2019# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2020# it. A directory man3 will be created inside the directory specified by
2021# MAN_OUTPUT.
2022# The default directory is: man.
2023# This tag requires that the tag GENERATE_MAN is set to YES.
2024
2025MAN_OUTPUT = man
2026
2027# The MAN_EXTENSION tag determines the extension that is added to the generated
2028# man pages. In case the manual section does not start with a number, the number
2029# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
2030# optional.
2031# The default value is: .3.
2032# This tag requires that the tag GENERATE_MAN is set to YES.
2033
2034MAN_EXTENSION = .3
2035
2036# The MAN_SUBDIR tag determines the name of the directory created within
2037# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
2038# MAN_EXTENSION with the initial . removed.
2039# This tag requires that the tag GENERATE_MAN is set to YES.
2040
2041MAN_SUBDIR =
2042
2043# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
2044# will generate one additional man file for each entity documented in the real
2045# man page(s). These additional files only source the real man page, but without
2046# them the man command would be unable to find the correct page.
2047# The default value is: NO.
2048# This tag requires that the tag GENERATE_MAN is set to YES.
2049
2050MAN_LINKS = NO
2051
2052#---------------------------------------------------------------------------
2053# Configuration options related to the XML output
2054#---------------------------------------------------------------------------
2055
2056# If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
2057# captures the structure of the code including all documentation.
2058# The default value is: NO.
2059
2060GENERATE_XML = NO
2061
2062# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
2063# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
2064# it.
2065# The default directory is: xml.
2066# This tag requires that the tag GENERATE_XML is set to YES.
2067
2068XML_OUTPUT = xml
2069
2070# If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
2071# listings (including syntax highlighting and cross-referencing information) to
2072# the XML output. Note that enabling this will significantly increase the size
2073# of the XML output.
2074# The default value is: YES.
2075# This tag requires that the tag GENERATE_XML is set to YES.
2076
2077XML_PROGRAMLISTING = YES
2078
2079# If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, doxygen will include
2080# namespace members in file scope as well, matching the HTML output.
2081# The default value is: NO.
2082# This tag requires that the tag GENERATE_XML is set to YES.
2083
2084XML_NS_MEMB_FILE_SCOPE = NO
2085
2086#---------------------------------------------------------------------------
2087# Configuration options related to the DOCBOOK output
2088#---------------------------------------------------------------------------
2089
2090# If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
2091# that can be used to generate PDF.
2092# The default value is: NO.
2093
2094GENERATE_DOCBOOK = NO
2095
2096# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
2097# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
2098# front of it.
2099# The default directory is: docbook.
2100# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
2101
2102DOCBOOK_OUTPUT = docbook
2103
2104# If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
2105# program listings (including syntax highlighting and cross-referencing
2106# information) to the DOCBOOK output. Note that enabling this will significantly
2107# increase the size of the DOCBOOK output.
2108# The default value is: NO.
2109# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
2110
2111DOCBOOK_PROGRAMLISTING = NO
2112
2113#---------------------------------------------------------------------------
2114# Configuration options for the AutoGen Definitions output
2115#---------------------------------------------------------------------------
2116
2117# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
2118# AutoGen Definitions (see http://autogen.sourceforge.net/) file that captures
2119# the structure of the code including all documentation. Note that this feature
2120# is still experimental and incomplete at the moment.
2121# The default value is: NO.
2122
2123GENERATE_AUTOGEN_DEF = NO
2124
2125#---------------------------------------------------------------------------
2126# Configuration options related to Sqlite3 output
2127#---------------------------------------------------------------------------
2128
2129#---------------------------------------------------------------------------
2130# Configuration options related to the Perl module output
2131#---------------------------------------------------------------------------
2132
2133# If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
2134# file that captures the structure of the code including all documentation.
2135#
2136# Note that this feature is still experimental and incomplete at the moment.
2137# The default value is: NO.
2138
2139GENERATE_PERLMOD = NO
2140
2141# If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
2142# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
2143# output from the Perl module output.
2144# The default value is: NO.
2145# This tag requires that the tag GENERATE_PERLMOD is set to YES.
2146
2147PERLMOD_LATEX = NO
2148
2149# If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
2150# formatted so it can be parsed by a human reader. This is useful if you want to
2151# understand what is going on. On the other hand, if this tag is set to NO, the
2152# size of the Perl module output will be much smaller and Perl will parse it
2153# just the same.
2154# The default value is: YES.
2155# This tag requires that the tag GENERATE_PERLMOD is set to YES.
2156
2157PERLMOD_PRETTY = YES
2158
2159# The names of the make variables in the generated doxyrules.make file are
2160# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
2161# so different doxyrules.make files included by the same Makefile don't
2162# overwrite each other's variables.
2163# This tag requires that the tag GENERATE_PERLMOD is set to YES.
2164
2165PERLMOD_MAKEVAR_PREFIX =
2166
2167#---------------------------------------------------------------------------
2168# Configuration options related to the preprocessor
2169#---------------------------------------------------------------------------
2170
2171# If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
2172# C-preprocessor directives found in the sources and include files.
2173# The default value is: YES.
2174
2175ENABLE_PREPROCESSING = YES
2176
2177# If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
2178# in the source code. If set to NO, only conditional compilation will be
2179# performed. Macro expansion can be done in a controlled way by setting
2180# EXPAND_ONLY_PREDEF to YES.
2181# The default value is: NO.
2182# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2183
2184MACRO_EXPANSION = NO
2185
2186# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
2187# the macro expansion is limited to the macros specified with the PREDEFINED and
2188# EXPAND_AS_DEFINED tags.
2189# The default value is: NO.
2190# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2191
2192EXPAND_ONLY_PREDEF = NO
2193
2194# If the SEARCH_INCLUDES tag is set to YES, the include files in the
2195# INCLUDE_PATH will be searched if a #include is found.
2196# The default value is: YES.
2197# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2198
2199SEARCH_INCLUDES = YES
2200
2201# The INCLUDE_PATH tag can be used to specify one or more directories that
2202# contain include files that are not input files but should be processed by the
2203# preprocessor.
2204# This tag requires that the tag SEARCH_INCLUDES is set to YES.
2205
2206INCLUDE_PATH =
2207
2208# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
2209# patterns (like *.h and *.hpp) to filter out the header-files in the
2210# directories. If left blank, the patterns specified with FILE_PATTERNS will be
2211# used.
2212# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2213
2214INCLUDE_FILE_PATTERNS =
2215
2216# The PREDEFINED tag can be used to specify one or more macro names that are
2217# defined before the preprocessor is started (similar to the -D option of e.g.
2218# gcc). The argument of the tag is a list of macros of the form: name or
2219# name=definition (no spaces). If the definition and the "=" are omitted, "=1"
2220# is assumed. To prevent a macro definition from being undefined via #undef or
2221# recursively expanded use the := operator instead of the = operator.
2222# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2223
2224PREDEFINED =
2225
2226# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
2227# tag can be used to specify a list of macro names that should be expanded. The
2228# macro definition that is found in the sources will be used. Use the PREDEFINED
2229# tag if you want to use a different macro definition that overrules the
2230# definition found in the source code.
2231# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2232
2233EXPAND_AS_DEFINED =
2234
2235# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
2236# remove all references to function-like macros that are alone on a line, have
2237# an all uppercase name, and do not end with a semicolon. Such function macros
2238# are typically used for boiler-plate code, and will confuse the parser if not
2239# removed.
2240# The default value is: YES.
2241# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
2242
2243SKIP_FUNCTION_MACROS = YES
2244
2245#---------------------------------------------------------------------------
2246# Configuration options related to external references
2247#---------------------------------------------------------------------------
2248
2249# The TAGFILES tag can be used to specify one or more tag files. For each tag
2250# file the location of the external documentation should be added. The format of
2251# a tag file without this location is as follows:
2252# TAGFILES = file1 file2 ...
2253# Adding location for the tag files is done as follows:
2254# TAGFILES = file1=loc1 "file2 = loc2" ...
2255# where loc1 and loc2 can be relative or absolute paths or URLs. See the
2256# section "Linking to external documentation" for more information about the use
2257# of tag files.
2258# Note: Each tag file must have a unique name (where the name does NOT include
2259# the path). If a tag file is not located in the directory in which doxygen is
2260# run, you must also specify the path to the tagfile here.
2261
2262TAGFILES =
2263
2264# When a file name is specified after GENERATE_TAGFILE, doxygen will create a
2265# tag file that is based on the input files it reads. See section "Linking to
2266# external documentation" for more information about the usage of tag files.
2267
2268GENERATE_TAGFILE =
2269
2270# If the ALLEXTERNALS tag is set to YES, all external class will be listed in
2271# the class index. If set to NO, only the inherited external classes will be
2272# listed.
2273# The default value is: NO.
2274
2275ALLEXTERNALS = NO
2276
2277# If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
2278# in the modules index. If set to NO, only the current project's groups will be
2279# listed.
2280# The default value is: YES.
2281
2282EXTERNAL_GROUPS = YES
2283
2284# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
2285# the related pages index. If set to NO, only the current project's pages will
2286# be listed.
2287# The default value is: YES.
2288
2289EXTERNAL_PAGES = YES
2290
2291#---------------------------------------------------------------------------
2292# Configuration options related to the dot tool
2293#---------------------------------------------------------------------------
2294
2295# If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
2296# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
2297# NO turns the diagrams off. Note that this option also works with HAVE_DOT
2298# disabled, but it is recommended to install and use dot, since it yields more
2299# powerful graphs.
2300# The default value is: YES.
2301
2302CLASS_DIAGRAMS = YES
2303
2304# You can include diagrams made with dia in doxygen documentation. Doxygen will
2305# then run dia to produce the diagram and insert it in the documentation. The
2306# DIA_PATH tag allows you to specify the directory where the dia binary resides.
2307# If left empty dia is assumed to be found in the default search path.
2308
2309DIA_PATH =
2310
2311# If set to YES the inheritance and collaboration graphs will hide inheritance
2312# and usage relations if the target is undocumented or is not a class.
2313# The default value is: YES.
2314
2315HIDE_UNDOC_RELATIONS = YES
2316
2317# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
2318# available from the path. This tool is part of Graphviz (see:
2319# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
2320# Bell Labs. The other options in this section have no effect if this option is
2321# set to NO
2322# The default value is: NO.
2323
2324HAVE_DOT = NO
2325
2326# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
2327# to run in parallel. When set to 0 doxygen will base this on the number of
2328# processors available in the system. You can set it explicitly to a value
2329# larger than 0 to get control over the balance between CPU load and processing
2330# speed.
2331# Minimum value: 0, maximum value: 32, default value: 0.
2332# This tag requires that the tag HAVE_DOT is set to YES.
2333
2334DOT_NUM_THREADS = 0
2335
2336# When you want a differently looking font in the dot files that doxygen
2337# generates you can specify the font name using DOT_FONTNAME. You need to make
2338# sure dot is able to find the font, which can be done by putting it in a
2339# standard location or by setting the DOTFONTPATH environment variable or by
2340# setting DOT_FONTPATH to the directory containing the font.
2341# The default value is: Helvetica.
2342# This tag requires that the tag HAVE_DOT is set to YES.
2343
2344DOT_FONTNAME = Helvetica
2345
2346# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
2347# dot graphs.
2348# Minimum value: 4, maximum value: 24, default value: 10.
2349# This tag requires that the tag HAVE_DOT is set to YES.
2350
2351DOT_FONTSIZE = 10
2352
2353# By default doxygen will tell dot to use the default font as specified with
2354# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
2355# the path where dot can find it using this tag.
2356# This tag requires that the tag HAVE_DOT is set to YES.
2357
2358DOT_FONTPATH =
2359
2360# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
2361# each documented class showing the direct and indirect inheritance relations.
2362# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
2363# The default value is: YES.
2364# This tag requires that the tag HAVE_DOT is set to YES.
2365
2366CLASS_GRAPH = YES
2367
2368# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
2369# graph for each documented class showing the direct and indirect implementation
2370# dependencies (inheritance, containment, and class references variables) of the
2371# class with other documented classes.
2372# The default value is: YES.
2373# This tag requires that the tag HAVE_DOT is set to YES.
2374
2375COLLABORATION_GRAPH = YES
2376
2377# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
2378# groups, showing the direct groups dependencies.
2379# The default value is: YES.
2380# This tag requires that the tag HAVE_DOT is set to YES.
2381
2382GROUP_GRAPHS = YES
2383
2384# If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
2385# collaboration diagrams in a style similar to the OMG's Unified Modeling
2386# Language.
2387# The default value is: NO.
2388# This tag requires that the tag HAVE_DOT is set to YES.
2389
2390UML_LOOK = NO
2391
2392# If the UML_LOOK tag is enabled, the fields and methods are shown inside the
2393# class node. If there are many fields or methods and many nodes the graph may
2394# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
2395# number of items for each type to make the size more manageable. Set this to 0
2396# for no limit. Note that the threshold may be exceeded by 50% before the limit
2397# is enforced. So when you set the threshold to 10, up to 15 fields may appear,
2398# but if the number exceeds 15, the total amount of fields shown is limited to
2399# 10.
2400# Minimum value: 0, maximum value: 100, default value: 10.
2401# This tag requires that the tag UML_LOOK is set to YES.
2402
2403UML_LIMIT_NUM_FIELDS = 10
2404
2405# If the DOT_UML_DETAILS tag is set to NO, doxygen will show attributes and
2406# methods without types and arguments in the UML graphs. If the DOT_UML_DETAILS
2407# tag is set to YES, doxygen will add type and arguments for attributes and
2408# methods in the UML graphs. If the DOT_UML_DETAILS tag is set to NONE, doxygen
2409# will not generate fields with class member information in the UML graphs. The
2410# class diagrams will look similar to the default class diagrams but using UML
2411# notation for the relationships.
2412# Possible values are: NO, YES and NONE.
2413# The default value is: NO.
2414# This tag requires that the tag UML_LOOK is set to YES.
2415
2416DOT_UML_DETAILS = NO
2417
2418# The DOT_WRAP_THRESHOLD tag can be used to set the maximum number of characters
2419# to display on a single line. If the actual line length exceeds this threshold
2420# significantly it will wrapped across multiple lines. Some heuristics are apply
2421# to avoid ugly line breaks.
2422# Minimum value: 0, maximum value: 1000, default value: 17.
2423# This tag requires that the tag HAVE_DOT is set to YES.
2424
2425DOT_WRAP_THRESHOLD = 17
2426
2427# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
2428# collaboration graphs will show the relations between templates and their
2429# instances.
2430# The default value is: NO.
2431# This tag requires that the tag HAVE_DOT is set to YES.
2432
2433TEMPLATE_RELATIONS = NO
2434
2435# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
2436# YES then doxygen will generate a graph for each documented file showing the
2437# direct and indirect include dependencies of the file with other documented
2438# files.
2439# The default value is: YES.
2440# This tag requires that the tag HAVE_DOT is set to YES.
2441
2442INCLUDE_GRAPH = YES
2443
2444# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
2445# set to YES then doxygen will generate a graph for each documented file showing
2446# the direct and indirect include dependencies of the file with other documented
2447# files.
2448# The default value is: YES.
2449# This tag requires that the tag HAVE_DOT is set to YES.
2450
2451INCLUDED_BY_GRAPH = YES
2452
2453# If the CALL_GRAPH tag is set to YES then doxygen will generate a call
2454# dependency graph for every global function or class method.
2455#
2456# Note that enabling this option will significantly increase the time of a run.
2457# So in most cases it will be better to enable call graphs for selected
2458# functions only using the \callgraph command. Disabling a call graph can be
2459# accomplished by means of the command \hidecallgraph.
2460# The default value is: NO.
2461# This tag requires that the tag HAVE_DOT is set to YES.
2462
2463CALL_GRAPH = NO
2464
2465# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
2466# dependency graph for every global function or class method.
2467#
2468# Note that enabling this option will significantly increase the time of a run.
2469# So in most cases it will be better to enable caller graphs for selected
2470# functions only using the \callergraph command. Disabling a caller graph can be
2471# accomplished by means of the command \hidecallergraph.
2472# The default value is: NO.
2473# This tag requires that the tag HAVE_DOT is set to YES.
2474
2475CALLER_GRAPH = NO
2476
2477# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
2478# hierarchy of all classes instead of a textual one.
2479# The default value is: YES.
2480# This tag requires that the tag HAVE_DOT is set to YES.
2481
2482GRAPHICAL_HIERARCHY = YES
2483
2484# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
2485# dependencies a directory has on other directories in a graphical way. The
2486# dependency relations are determined by the #include relations between the
2487# files in the directories.
2488# The default value is: YES.
2489# This tag requires that the tag HAVE_DOT is set to YES.
2490
2491DIRECTORY_GRAPH = YES
2492
2493# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
2494# generated by dot. For an explanation of the image formats see the section
2495# output formats in the documentation of the dot tool (Graphviz (see:
2496# http://www.graphviz.org/)).
2497# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
2498# to make the SVG files visible in IE 9+ (other browsers do not have this
2499# requirement).
2500# Possible values are: png, jpg, gif, svg, png:gd, png:gd:gd, png:cairo,
2501# png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and
2502# png:gdiplus:gdiplus.
2503# The default value is: png.
2504# This tag requires that the tag HAVE_DOT is set to YES.
2505
2506DOT_IMAGE_FORMAT = png
2507
2508# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
2509# enable generation of interactive SVG images that allow zooming and panning.
2510#
2511# Note that this requires a modern browser other than Internet Explorer. Tested
2512# and working are Firefox, Chrome, Safari, and Opera.
2513# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
2514# the SVG files visible. Older versions of IE do not have SVG support.
2515# The default value is: NO.
2516# This tag requires that the tag HAVE_DOT is set to YES.
2517
2518INTERACTIVE_SVG = NO
2519
2520# The DOT_PATH tag can be used to specify the path where the dot tool can be
2521# found. If left blank, it is assumed the dot tool can be found in the path.
2522# This tag requires that the tag HAVE_DOT is set to YES.
2523
2524DOT_PATH =
2525
2526# The DOTFILE_DIRS tag can be used to specify one or more directories that
2527# contain dot files that are included in the documentation (see the \dotfile
2528# command).
2529# This tag requires that the tag HAVE_DOT is set to YES.
2530
2531DOTFILE_DIRS =
2532
2533# The MSCFILE_DIRS tag can be used to specify one or more directories that
2534# contain msc files that are included in the documentation (see the \mscfile
2535# command).
2536
2537MSCFILE_DIRS =
2538
2539# The DIAFILE_DIRS tag can be used to specify one or more directories that
2540# contain dia files that are included in the documentation (see the \diafile
2541# command).
2542
2543DIAFILE_DIRS =
2544
2545# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
2546# path where java can find the plantuml.jar file. If left blank, it is assumed
2547# PlantUML is not used or called during a preprocessing step. Doxygen will
2548# generate a warning when it encounters a \startuml command in this case and
2549# will not generate output for the diagram.
2550
2551PLANTUML_JAR_PATH =
2552
2553# When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a
2554# configuration file for plantuml.
2555
2556PLANTUML_CFG_FILE =
2557
2558# When using plantuml, the specified paths are searched for files specified by
2559# the !include statement in a plantuml block.
2560
2561PLANTUML_INCLUDE_PATH =
2562
2563# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
2564# that will be shown in the graph. If the number of nodes in a graph becomes
2565# larger than this value, doxygen will truncate the graph, which is visualized
2566# by representing a node as a red box. Note that doxygen if the number of direct
2567# children of the root node in a graph is already larger than
2568# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
2569# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
2570# Minimum value: 0, maximum value: 10000, default value: 50.
2571# This tag requires that the tag HAVE_DOT is set to YES.
2572
2573DOT_GRAPH_MAX_NODES = 50
2574
2575# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
2576# generated by dot. A depth value of 3 means that only nodes reachable from the
2577# root by following a path via at most 3 edges will be shown. Nodes that lay
2578# further from the root node will be omitted. Note that setting this option to 1
2579# or 2 may greatly reduce the computation time needed for large code bases. Also
2580# note that the size of a graph can be further restricted by
2581# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
2582# Minimum value: 0, maximum value: 1000, default value: 0.
2583# This tag requires that the tag HAVE_DOT is set to YES.
2584
2585MAX_DOT_GRAPH_DEPTH = 0
2586
2587# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
2588# background. This is disabled by default, because dot on Windows does not seem
2589# to support this out of the box.
2590#
2591# Warning: Depending on the platform used, enabling this option may lead to
2592# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
2593# read).
2594# The default value is: NO.
2595# This tag requires that the tag HAVE_DOT is set to YES.
2596
2597DOT_TRANSPARENT = NO
2598
2599# Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
2600# files in one run (i.e. multiple -o and -T options on the command line). This
2601# makes dot run faster, but since only newer versions of dot (>1.8.10) support
2602# this, this feature is disabled by default.
2603# The default value is: NO.
2604# This tag requires that the tag HAVE_DOT is set to YES.
2605
2606DOT_MULTI_TARGETS = NO
2607
2608# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
2609# explaining the meaning of the various boxes and arrows in the dot generated
2610# graphs.
2611# The default value is: YES.
2612# This tag requires that the tag HAVE_DOT is set to YES.
2613
2614GENERATE_LEGEND = YES
2615
2616# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate
2617# files that are used to generate the various graphs.
2618#
2619# Note: This setting is not only used for dot files but also for msc and
2620# plantuml temporary files.
2621# The default value is: YES.
2622
2623DOT_CLEANUP = YES
diff --git a/doc/.gitignore b/doc/.gitignore
new file mode 100644
index 0000000..218e19e
--- /dev/null
+++ b/doc/.gitignore
@@ -0,0 +1,3 @@
1# Doxygen generated files:
2html/
3latex/
diff --git a/include/gnunet_chat_lib.h b/include/gnunet_chat_lib.h
index e061429..d5de43a 100644
--- a/include/gnunet_chat_lib.h
+++ b/include/gnunet_chat_lib.h
@@ -119,9 +119,9 @@ struct GNUNET_CHAT_Invitation;
119 * Method called whenever an issue occurs regarding a certain chat context 119 * Method called whenever an issue occurs regarding a certain chat context
120 * of a specific chat handle. 120 * of a specific chat handle.
121 * 121 *
122 * @param[in/out] cls Closure from #GNUNET_CHAT_start 122 * @param[in,out] cls Closure from #GNUNET_CHAT_start
123 * @param[in/out] handle Chat handle 123 * @param[in,out] handle Chat handle
124 * @param[in/out] context Chat context 124 * @param[in,out] context Chat context
125 * @param[in] reason Reason indicating the issue 125 * @param[in] reason Reason indicating the issue
126 */ 126 */
127typedef void 127typedef void
@@ -131,9 +131,9 @@ typedef void
131/** 131/**
132 * Iterator over chat contacts of a specific chat handle. 132 * Iterator over chat contacts of a specific chat handle.
133 * 133 *
134 * @param[in/out] cls Closure from #GNUNET_CHAT_iterate_contacts 134 * @param[in,out] cls Closure from #GNUNET_CHAT_iterate_contacts
135 * @param[in/out] handle Chat handle 135 * @param[in,out] handle Chat handle
136 * @param[in/out] contact Chat contact 136 * @param[in,out] contact Chat contact
137 * @return #GNUNET_YES if we should continue to iterate, #GNUNET_NO otherwise. 137 * @return #GNUNET_YES if we should continue to iterate, #GNUNET_NO otherwise.
138 */ 138 */
139typedef int 139typedef int
@@ -143,9 +143,9 @@ typedef int
143/** 143/**
144 * Iterator over chat groups of a specific chat handle. 144 * Iterator over chat groups of a specific chat handle.
145 * 145 *
146 * @param[in/out] cls Closure from #GNUNET_CHAT_iterate_groups 146 * @param[in,out] cls Closure from #GNUNET_CHAT_iterate_groups
147 * @param[in/out] handle Chat handle 147 * @param[in,out] handle Chat handle
148 * @param[in/out] group Chat group 148 * @param[in,out] group Chat group
149 * @return #GNUNET_YES if we should continue to iterate, #GNUNET_NO otherwise. 149 * @return #GNUNET_YES if we should continue to iterate, #GNUNET_NO otherwise.
150 */ 150 */
151typedef int 151typedef int
@@ -155,9 +155,9 @@ typedef int
155/** 155/**
156 * Iterator over chat contacts in a specific chat group. 156 * Iterator over chat contacts in a specific chat group.
157 * 157 *
158 * @param[in/out] cls Closure from #GNUNET_CHAT_group_iterate_contacts 158 * @param[in,out] cls Closure from #GNUNET_CHAT_group_iterate_contacts
159 * @param[in/out] group Chat group 159 * @param[in,out] group Chat group
160 * @param[in/out] contact Chat contact 160 * @param[in,out] contact Chat contact
161 * @return #GNUNET_YES if we should continue to iterate, #GNUNET_NO otherwise. 161 * @return #GNUNET_YES if we should continue to iterate, #GNUNET_NO otherwise.
162 */ 162 */
163typedef int 163typedef int
@@ -167,8 +167,8 @@ typedef int
167/** 167/**
168 * Iterator over chat messages in a specific chat context. 168 * Iterator over chat messages in a specific chat context.
169 * 169 *
170 * @param[in/out] cls Closure from #GNUNET_CHAT_context_iterate_messages 170 * @param[in,out] cls Closure from #GNUNET_CHAT_context_iterate_messages
171 * @param[in/out] context Chat context 171 * @param[in,out] context Chat context
172 * @param[in] message Chat message 172 * @param[in] message Chat message
173 * @return #GNUNET_YES if we should continue to iterate, #GNUNET_NO otherwise. 173 * @return #GNUNET_YES if we should continue to iterate, #GNUNET_NO otherwise.
174 */ 174 */
@@ -179,9 +179,9 @@ typedef int
179/** 179/**
180 * Iterator over chat files in a specific chat context. 180 * Iterator over chat files in a specific chat context.
181 * 181 *
182 * @param[in/out] cls Closure from #GNUNET_CHAT_context_iterate_files 182 * @param[in,out] cls Closure from #GNUNET_CHAT_context_iterate_files
183 * @param[in/out] context Chat context 183 * @param[in,out] context Chat context
184 * @param[in/out] file Chat file 184 * @param[in,out] file Chat file
185 * @return #GNUNET_YES if we should continue to iterate, #GNUNET_NO otherwise. 185 * @return #GNUNET_YES if we should continue to iterate, #GNUNET_NO otherwise.
186 */ 186 */
187typedef int 187typedef int
@@ -192,7 +192,7 @@ typedef int
192 * Iterator over chat contacts in a chat to check whether they received a 192 * Iterator over chat contacts in a chat to check whether they received a
193 * specific message or not. 193 * specific message or not.
194 * 194 *
195 * @param[in/out] cls Closure from #GNUNET_CHAT_message_get_read_receipt 195 * @param[in,out] cls Closure from #GNUNET_CHAT_message_get_read_receipt
196 * @param[in] message Chat message 196 * @param[in] message Chat message
197 * @param[in] contact Chat contact 197 * @param[in] contact Chat contact
198 * @param[in] read_receipt #GNUNET_YES if the message was received by the contact, 198 * @param[in] read_receipt #GNUNET_YES if the message was received by the contact,
@@ -207,7 +207,7 @@ typedef int
207/** 207/**
208 * Method called during an upload of a specific file in a chat to share it. 208 * Method called during an upload of a specific file in a chat to share it.
209 * 209 *
210 * @param[in/out] cls Closure from #GNUNET_CHAT_context_send_file 210 * @param[in,out] cls Closure from #GNUNET_CHAT_context_send_file
211 * @param[in] file Chat file 211 * @param[in] file Chat file
212 * @param[in] completed Amount of the file being uploaded (in bytes) 212 * @param[in] completed Amount of the file being uploaded (in bytes)
213 * @param[in] size Full size of the uploading file (in bytes) 213 * @param[in] size Full size of the uploading file (in bytes)
@@ -219,7 +219,7 @@ typedef void
219/** 219/**
220 * Method called during a download of a specific file in a chat which was shared. 220 * Method called during a download of a specific file in a chat which was shared.
221 * 221 *
222 * @param[in/out] cls Closure from #GNUNET_CHAT_file_start_download 222 * @param[in,out] cls Closure from #GNUNET_CHAT_file_start_download
223 * @param[in] file Chat file 223 * @param[in] file Chat file
224 * @param[in] completed Amount of the file being downloaded (in bytes) 224 * @param[in] completed Amount of the file being downloaded (in bytes)
225 * @param[in] size Full size of the downloading file (in bytes) 225 * @param[in] size Full size of the downloading file (in bytes)
@@ -232,8 +232,8 @@ typedef void
232 * Method called during an unindexing of a specific file in a chat which was 232 * Method called during an unindexing of a specific file in a chat which was
233 * uploaded before. 233 * uploaded before.
234 * 234 *
235 * @param[in/out] cls Closure from #GNUNET_CHAT_file_unindex 235 * @param[in,out] cls Closure from #GNUNET_CHAT_file_unindex
236 * @param[in/out] file Chat file 236 * @param[in,out] file Chat file
237 * @param[in] completed Amount of the file being unindexed (in bytes) 237 * @param[in] completed Amount of the file being unindexed (in bytes)
238 * @param[in] size Full size of the unindexing file (in bytes) 238 * @param[in] size Full size of the unindexing file (in bytes)
239 */ 239 */
@@ -252,9 +252,9 @@ typedef void
252 * @param[in] directory Application directory path (optional) 252 * @param[in] directory Application directory path (optional)
253 * @param[in] name User name (optional) 253 * @param[in] name User name (optional)
254 * @param[in] warn_cb Callback for warnings (optional) 254 * @param[in] warn_cb Callback for warnings (optional)
255 * @param[in/out] warn_cls Closure for warnings (optional) 255 * @param[in,out] warn_cls Closure for warnings (optional)
256 * @param[in] msg_cb Callback for message events (optional) 256 * @param[in] msg_cb Callback for message events (optional)
257 * @param[in/out] msg_cls Closure for message events (optional) 257 * @param[in,out] msg_cls Closure for message events (optional)
258 * @return Chat handle 258 * @return Chat handle
259 */ 259 */
260struct GNUNET_CHAT_Handle* 260struct GNUNET_CHAT_Handle*
@@ -268,7 +268,7 @@ GNUNET_CHAT_start (const struct GNUNET_CONFIGURATION_Handle *cfg,
268 * Stops a chat handle closing all its remaining resources and frees the 268 * Stops a chat handle closing all its remaining resources and frees the
269 * regarding memory. 269 * regarding memory.
270 * 270 *
271 * @param[in/out] handle Chat handle 271 * @param[in,out] handle Chat handle
272 */ 272 */
273void 273void
274GNUNET_CHAT_stop (struct GNUNET_CHAT_Handle *handle); 274GNUNET_CHAT_stop (struct GNUNET_CHAT_Handle *handle);
@@ -280,7 +280,7 @@ GNUNET_CHAT_stop (struct GNUNET_CHAT_Handle *handle);
280 * Updating the chat handle should only be used if necessary because the usage 280 * Updating the chat handle should only be used if necessary because the usage
281 * can require renewed exchanging of GNS entries. 281 * can require renewed exchanging of GNS entries.
282 * 282 *
283 * @param[in/out] handle Chat handle 283 * @param[in,out] handle Chat handle
284 * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure 284 * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure
285 */ 285 */
286int 286int
@@ -289,7 +289,7 @@ GNUNET_CHAT_update (struct GNUNET_CHAT_Handle *handle);
289/** 289/**
290 * Updates the name of a chat handle for related communication. 290 * Updates the name of a chat handle for related communication.
291 * 291 *
292 * @param[in/out] handle Chat handle 292 * @param[in,out] handle Chat handle
293 * @param[in] name New name or NULL 293 * @param[in] name New name or NULL
294 * @return #GNUNET_YES on success, #GNUNET_NO on failure and #GNUNET_SYSERR if <i>handle</i> is NULL 294 * @return #GNUNET_YES on success, #GNUNET_NO on failure and #GNUNET_SYSERR if <i>handle</i> is NULL
295 */ 295 */
@@ -320,9 +320,9 @@ GNUNET_CHAT_get_key (const struct GNUNET_CHAT_Handle *handle);
320 * Iterates through the contacts of a given chat <i>handle</i> with a selected 320 * Iterates through the contacts of a given chat <i>handle</i> with a selected
321 * callback and custom closure. 321 * callback and custom closure.
322 * 322 *
323 * @param[in/out] handle Chat handle 323 * @param[in,out] handle Chat handle
324 * @param[in] callback Callback for contact iteration (optional) 324 * @param[in] callback Callback for contact iteration (optional)
325 * @param[in/out] cls Closure for contact iteration (optional) 325 * @param[in,out] cls Closure for contact iteration (optional)
326 * @return Amount of contacts iterated or #GNUNET_SYSERR on failure 326 * @return Amount of contacts iterated or #GNUNET_SYSERR on failure
327 */ 327 */
328int 328int
@@ -339,7 +339,7 @@ GNUNET_CHAT_iterate_contacts (struct GNUNET_CHAT_Handle *handle,
339 * group will be private using a randomly generated key and others can only 339 * group will be private using a randomly generated key and others can only
340 * join the chat via a private invitation. 340 * join the chat via a private invitation.
341 * 341 *
342 * @param[in/out] handle Chat handle 342 * @param[in,out] handle Chat handle
343 * @return New group chat 343 * @return New group chat
344 */ 344 */
345struct GNUNET_CHAT_Group * 345struct GNUNET_CHAT_Group *
@@ -350,9 +350,9 @@ GNUNET_CHAT_group_create (struct GNUNET_CHAT_Handle *handle,
350 * Iterates through the groups of a given chat <i>handle</i> with a selected 350 * Iterates through the groups of a given chat <i>handle</i> with a selected
351 * callback and custom closure. 351 * callback and custom closure.
352 * 352 *
353 * @param[in/out] handle Chat handle 353 * @param[in,out] handle Chat handle
354 * @param[in] callback Callback for group iteration (optional) 354 * @param[in] callback Callback for group iteration (optional)
355 * @param[in/out] cls Closure for group iteration (optional) 355 * @param[in,out] cls Closure for group iteration (optional)
356 * @return Amount of groups iterated or #GNUNET_SYSERR on failure 356 * @return Amount of groups iterated or #GNUNET_SYSERR on failure
357 */ 357 */
358int 358int
@@ -364,7 +364,7 @@ GNUNET_CHAT_iterate_groups (struct GNUNET_CHAT_Handle *handle,
364 * Leaves the private chat with a specific <i>contact</i> and frees the 364 * Leaves the private chat with a specific <i>contact</i> and frees the
365 * regarding memory of the contact if there remains no common chat with it. 365 * regarding memory of the contact if there remains no common chat with it.
366 * 366 *
367 * @param[in/out] contact Cntact 367 * @param[in,out] contact Cntact
368 * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure 368 * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure
369 */ 369 */
370int 370int
@@ -374,7 +374,7 @@ GNUNET_CHAT_contact_delete (struct GNUNET_CHAT_Contact *contact);
374 * Overrides the name of a given <i>contact</i> with a custom nick <i>name</i> 374 * Overrides the name of a given <i>contact</i> with a custom nick <i>name</i>
375 * which will be only used locally. 375 * which will be only used locally.
376 * 376 *
377 * @param[in/out] contact Contact 377 * @param[in,out] contact Contact
378 * @param[in] name Custom nick name 378 * @param[in] name Custom nick name
379 */ 379 */
380void 380void
@@ -404,7 +404,7 @@ GNUNET_CHAT_contact_get_key (const struct GNUNET_CHAT_Contact *contact);
404/** 404/**
405 * Returns the chat context for a private chat with a given <i>contact</i>. 405 * Returns the chat context for a private chat with a given <i>contact</i>.
406 * 406 *
407 * @param[in/out] contact Contact 407 * @param[in,out] contact Contact
408 * @return Chat context 408 * @return Chat context
409 */ 409 */
410struct GNUNET_CHAT_Context* 410struct GNUNET_CHAT_Context*
@@ -414,7 +414,7 @@ GNUNET_CHAT_contact_get_context (struct GNUNET_CHAT_Contact *contact);
414 * Sets a custom <i>user pointer</i> to a given <i>contact</i> so it can be 414 * Sets a custom <i>user pointer</i> to a given <i>contact</i> so it can be
415 * accessed in contact related callbacks. 415 * accessed in contact related callbacks.
416 * 416 *
417 * @param[in/out] contact Contact 417 * @param[in,out] contact Contact
418 * @param[in] user_pointer Custom user pointer 418 * @param[in] user_pointer Custom user pointer
419 */ 419 */
420void 420void
@@ -435,7 +435,7 @@ GNUNET_CHAT_contact_get_user_pointer (const struct GNUNET_CHAT_Contact *contact)
435 * Leaves a specific <i>group</i> chat and frees its memory if it is not shared 435 * Leaves a specific <i>group</i> chat and frees its memory if it is not shared
436 * with other groups or contacts. 436 * with other groups or contacts.
437 * 437 *
438 * @param[in/out] group Group 438 * @param[in,out] group Group
439 * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure 439 * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure
440 */ 440 */
441int 441int
@@ -445,7 +445,7 @@ GNUNET_CHAT_group_leave (struct GNUNET_CHAT_Group *group);
445 * Sets the name of a given <i>group</i> to a custom nick <i>name</i> 445 * Sets the name of a given <i>group</i> to a custom nick <i>name</i>
446 * which will be only used locally. 446 * which will be only used locally.
447 * 447 *
448 * @param[in/out] group Group 448 * @param[in,out] group Group
449 * @param[in] name Custom nick name 449 * @param[in] name Custom nick name
450 */ 450 */
451void 451void
@@ -465,7 +465,7 @@ GNUNET_CHAT_group_get_name (const struct GNUNET_CHAT_Group *group);
465 * Sets a custom <i>user pointer</i> to a given <i>group</i> so it can be 465 * Sets a custom <i>user pointer</i> to a given <i>group</i> so it can be
466 * accessed in group related callbacks. 466 * accessed in group related callbacks.
467 * 467 *
468 * @param[in/out] group Group 468 * @param[in,out] group Group
469 * @param[in] user_pointer Custom user pointer 469 * @param[in] user_pointer Custom user pointer
470 */ 470 */
471void 471void
@@ -486,8 +486,8 @@ GNUNET_CHAT_group_get_user_pointer (const struct GNUNET_CHAT_Group *group);
486 * Invites a specific <i>contact</i> to a given <i>group</i> via a privately 486 * Invites a specific <i>contact</i> to a given <i>group</i> via a privately
487 * sent invitation. 487 * sent invitation.
488 * 488 *
489 * @param[in/out] group Group 489 * @param[in,out] group Group
490 * @param[in/out] contact Contact 490 * @param[in,out] contact Contact
491 */ 491 */
492void 492void
493GNUNET_CHAT_group_invite_contact (struct GNUNET_CHAT_Group *group, 493GNUNET_CHAT_group_invite_contact (struct GNUNET_CHAT_Group *group,
@@ -497,9 +497,9 @@ GNUNET_CHAT_group_invite_contact (struct GNUNET_CHAT_Group *group,
497 * Iterates through the contacts of a given <i>group</i> with a selected 497 * Iterates through the contacts of a given <i>group</i> with a selected
498 * callback and custom closure. 498 * callback and custom closure.
499 * 499 *
500 * @param[in/out] group Group 500 * @param[in,out] group Group
501 * @param[in] callback Callback for contact iteration (optional) 501 * @param[in] callback Callback for contact iteration (optional)
502 * @param[in/out] cls Closure for contact iteration (optional) 502 * @param[in,out] cls Closure for contact iteration (optional)
503 * @return Amount of contacts iterated or #GNUNET_SYSERR on failure 503 * @return Amount of contacts iterated or #GNUNET_SYSERR on failure
504 */ 504 */
505int 505int
@@ -510,7 +510,7 @@ GNUNET_CHAT_group_iterate_contacts (struct GNUNET_CHAT_Group *group,
510/** 510/**
511 * Returns the chat context for a chat with a given <i>group</i>. 511 * Returns the chat context for a chat with a given <i>group</i>.
512 * 512 *
513 * @param[in/out] group Group 513 * @param[in,out] group Group
514 * @return Chat context 514 * @return Chat context
515 */ 515 */
516struct GNUNET_CHAT_Context* 516struct GNUNET_CHAT_Context*
@@ -520,7 +520,7 @@ GNUNET_CHAT_group_get_context (struct GNUNET_CHAT_Group *group);
520 * Sets a custom <i>user pointer</i> to a given chat <i>context</i> so it can 520 * Sets a custom <i>user pointer</i> to a given chat <i>context</i> so it can
521 * be accessed in chat context related callbacks. 521 * be accessed in chat context related callbacks.
522 * 522 *
523 * @param[in/out] context Chat context 523 * @param[in,out] context Chat context
524 * @param[in] user_pointer Custom user pointer 524 * @param[in] user_pointer Custom user pointer
525 */ 525 */
526void 526void
@@ -540,7 +540,7 @@ GNUNET_CHAT_context_get_user_pointer (const struct GNUNET_CHAT_Context *context)
540/** 540/**
541 * Sends a selected <i>text</i> into a given chat <i>context</i>. 541 * Sends a selected <i>text</i> into a given chat <i>context</i>.
542 * 542 *
543 * @param[in/out] context Chat context 543 * @param[in,out] context Chat context
544 * @param[in] text Text 544 * @param[in] text Text
545 * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure 545 * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure
546 */ 546 */
@@ -553,10 +553,10 @@ GNUNET_CHAT_context_send_text (struct GNUNET_CHAT_Context *context,
553 * and shares the regarding information to download and decrypt it in a given 553 * and shares the regarding information to download and decrypt it in a given
554 * chat <i>context</i>. 554 * chat <i>context</i>.
555 * 555 *
556 * @param[in/out] context Chat context 556 * @param[in,out] context Chat context
557 * @param[in] path Local file path 557 * @param[in] path Local file path
558 * @param[in] callback Callback for file uploading (optional) 558 * @param[in] callback Callback for file uploading (optional)
559 * @param[in/out] cls Closure for file uploading (optional) 559 * @param[in,out] cls Closure for file uploading (optional)
560 * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure 560 * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure
561 */ 561 */
562int 562int
@@ -569,7 +569,7 @@ GNUNET_CHAT_context_send_file (struct GNUNET_CHAT_Context *context,
569 * Shares the information to download and decrypt a specific <i>file</i> from 569 * Shares the information to download and decrypt a specific <i>file</i> from
570 * another chat in a given chat <i>context</i>. 570 * another chat in a given chat <i>context</i>.
571 * 571 *
572 * @param[in/out] context Chat context 572 * @param[in,out] context Chat context
573 * @param[in] file File handle 573 * @param[in] file File handle
574 * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure 574 * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure
575 */ 575 */
@@ -581,9 +581,9 @@ GNUNET_CHAT_context_share_file (struct GNUNET_CHAT_Context *context,
581 * Iterates through the contacts of a given chat <i>context</i> with a selected 581 * Iterates through the contacts of a given chat <i>context</i> with a selected
582 * callback and custom closure. 582 * callback and custom closure.
583 * 583 *
584 * @param[in/out] context Chat context 584 * @param[in,out] context Chat context
585 * @param[in] callback Callback for contact iteration (optional) 585 * @param[in] callback Callback for contact iteration (optional)
586 * @param[in/out] cls Closure for contact iteration (optional) 586 * @param[in,out] cls Closure for contact iteration (optional)
587 * @return Amount of contacts iterated or #GNUNET_SYSERR on failure 587 * @return Amount of contacts iterated or #GNUNET_SYSERR on failure
588 */ 588 */
589int 589int
@@ -595,9 +595,9 @@ GNUNET_CHAT_context_iterate_messages (struct GNUNET_CHAT_Context *context,
595 * Iterates through the files of a given chat <i>context</i> with a selected 595 * Iterates through the files of a given chat <i>context</i> with a selected
596 * callback and custom closure. 596 * callback and custom closure.
597 * 597 *
598 * @param[in/out] context Chat context 598 * @param[in,out] context Chat context
599 * @param[in] callback Callback for file iteration (optional) 599 * @param[in] callback Callback for file iteration (optional)
600 * @param[in/out] cls Closure for file iteration (optional) 600 * @param[in,out] cls Closure for file iteration (optional)
601 * @return Amount of files iterated or #GNUNET_SYSERR on failure 601 * @return Amount of files iterated or #GNUNET_SYSERR on failure
602 */ 602 */
603int 603int
@@ -660,7 +660,7 @@ GNUNET_CHAT_message_is_private (const struct GNUNET_CHAT_Message *message);
660 * 660 *
661 * @param[in] message Message 661 * @param[in] message Message
662 * @param[in] callback Callback for contact iteration (optional) 662 * @param[in] callback Callback for contact iteration (optional)
663 * @param[in/out] cls Closure for contact iteration (optional) 663 * @param[in,out] cls Closure for contact iteration (optional)
664 * @return Amount of contacts iterated or #GNUNET_SYSERR on failure 664 * @return Amount of contacts iterated or #GNUNET_SYSERR on failure
665 */ 665 */
666int 666int
@@ -742,7 +742,7 @@ GNUNET_CHAT_file_is_local (const struct GNUNET_CHAT_File *file);
742 * Sets a custom <i>user pointer</i> to a given <i>file</i> handle so it can 742 * Sets a custom <i>user pointer</i> to a given <i>file</i> handle so it can
743 * be accessed in file related callbacks. 743 * be accessed in file related callbacks.
744 * 744 *
745 * @param[in/out] file File handle 745 * @param[in,out] file File handle
746 * @param[in] user_pointer Custom user pointer 746 * @param[in] user_pointer Custom user pointer
747 */ 747 */
748void 748void
@@ -763,9 +763,9 @@ GNUNET_CHAT_file_get_user_pointer (const struct GNUNET_CHAT_File *file);
763 * Starts downloading a file from a given <i>file</i> handle and sets up a 763 * Starts downloading a file from a given <i>file</i> handle and sets up a
764 * selected callback and custom closure for its progress. 764 * selected callback and custom closure for its progress.
765 * 765 *
766 * @param[in/out] file File handle 766 * @param[in,out] file File handle
767 * @param[in] callback Callback for file downloading (optional) 767 * @param[in] callback Callback for file downloading (optional)
768 * @param[in/out] cls Closure for file downloading (optional) 768 * @param[in,out] cls Closure for file downloading (optional)
769 * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure 769 * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure
770 */ 770 */
771int 771int
@@ -776,7 +776,7 @@ GNUNET_CHAT_file_start_download (struct GNUNET_CHAT_File *file,
776/** 776/**
777 * Pause downloading a file from a given <i>file</i> handle. 777 * Pause downloading a file from a given <i>file</i> handle.
778 * 778 *
779 * @param[in/out] file File handle 779 * @param[in,out] file File handle
780 * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure 780 * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure
781 */ 781 */
782int 782int
@@ -785,7 +785,7 @@ GNUNET_CHAT_file_pause_download (struct GNUNET_CHAT_File *file);
785/** 785/**
786 * Resume downloading a file from a given <i>file</i> handle. 786 * Resume downloading a file from a given <i>file</i> handle.
787 * 787 *
788 * @param[in/out] file File handle 788 * @param[in,out] file File handle
789 * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure 789 * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure
790 */ 790 */
791int 791int
@@ -794,7 +794,7 @@ GNUNET_CHAT_file_resume_download (struct GNUNET_CHAT_File *file);
794/** 794/**
795 * Stops downloading a file from a given <i>file</i> handle. 795 * Stops downloading a file from a given <i>file</i> handle.
796 * 796 *
797 * @param[in/out] file File handle 797 * @param[in,out] file File handle
798 * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure 798 * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure
799 */ 799 */
800int 800int
@@ -804,9 +804,9 @@ GNUNET_CHAT_file_stop_download (struct GNUNET_CHAT_File *file);
804 * Unindexes an uploaded file from a given <i>file</i> handle with a selected 804 * Unindexes an uploaded file from a given <i>file</i> handle with a selected
805 * callback and a custom closure. 805 * callback and a custom closure.
806 * 806 *
807 * @param[in/out] file File handle 807 * @param[in,out] file File handle
808 * @param[in] callback Callback for file unindexing (optional) 808 * @param[in] callback Callback for file unindexing (optional)
809 * @param[in/out] cls Closure for file unindexing (optional) 809 * @param[in,out] cls Closure for file unindexing (optional)
810 * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure 810 * @return #GNUNET_OK on success, #GNUNET_SYSERR on failure
811 */ 811 */
812int 812int
@@ -817,7 +817,7 @@ GNUNET_CHAT_file_unindex (struct GNUNET_CHAT_File *file,
817/** 817/**
818 * Accepts a given chat <i>invitation</i> to enter another chat. 818 * Accepts a given chat <i>invitation</i> to enter another chat.
819 * 819 *
820 * @param[in/out] invitation Chat invitation 820 * @param[in,out] invitation Chat invitation
821 */ 821 */
822void 822void
823GNUNET_CHAT_invitation_accept (struct GNUNET_CHAT_Invitation *invitation); 823GNUNET_CHAT_invitation_accept (struct GNUNET_CHAT_Invitation *invitation);