History

added tSlide, atodb, and dbtoa

spiricom committed 6 years ago

Commit c1f26962 parents 982eb8e bec88f112 files · +2716 −16Browse files

Unified · Split

12 files
  1. .DS_Store +0 −0
  2. .gitignore +1 −0
  3. Doxyfile +2567 −0
  4. Examples/basic-oscillators.c +36 −0
  5. Examples/basic-oscillators.h +22 −0
  6. LEAF/.DS_Store +0 −0
  7. LEAF/Src/leaf-oscillators.c +1 −1
  8. LEAF/leaf.h +73 −12
  9. LEAF_JUCEPlugin/.DS_Store +0 −0
  10. LEAF_JUCEPlugin/LEAF.jucer +6 −0
  11. LEAF_JUCEPlugin/Source/MyTest.cpp +12 −5
  12. README.md +1 −1
.DS_Store+0−0

Binary file not shown.

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

Binary file not shown.

LEAF/Src/leaf-oscillators.c+1−1
@@ -227,7 +227,7 @@ float tSquare_tick(tSquare* const cy) · 226 unmodified lines
227 float out = 0.0f;227 float out = 0.0f;
228 228
229 int idx = (int)(c->phase * SQR_TABLE_SIZE);229 int idx = (int)(c->phase * SQR_TABLE_SIZE);
230 230
231 // Wavetable synthesis231 // Wavetable synthesis
232 out = __leaf_table_squarewave[c->oct+1][idx] +232 out = __leaf_table_squarewave[c->oct+1][idx] +
233 (__leaf_table_squarewave[c->oct][idx] - __leaf_table_squarewave[c->oct+1][idx]) * c->w;233 (__leaf_table_squarewave[c->oct][idx] - __leaf_table_squarewave[c->oct+1][idx]) * c->w;
LEAF/leaf.h+73−12
@@ -1,12 +1,12 @@
1/*1/*
2 ==============================================================================2 ==============================================================================
3 3
4 leaf.h4 leaf.h
5 Created: 20 Jan 2017 12:07:26pm5 Created: 20 Jan 2017 12:07:26pm
6 Author: Michael R Mulshine6 Author: Michael R Mulshine
7 7
8 ==============================================================================8 ==============================================================================
9*/9 */
10 10
11#ifndef LEAF_H_INCLUDED11#ifndef LEAF_H_INCLUDED
12#define LEAF_H_INCLUDED12#define LEAF_H_INCLUDED
@@ -61,16 +61,77 @@ · 48 unmodified lines
61 61
62#endif62#endif
63 63
64/*! \mainpage LEAF
65 *
66 * \section intro_sec Introduction
67 *
68 * This is the introduction.
69 *
70 * \section install_sec Installation
71 *
72 * \subsection step1 Step 1: Opening the box
73 *
74 * etc...
75 */
76
77/*!
78 * @defgroup leaf LEAF
79 * @defgroup oscillators Oscillators
80 * @defgroup filters Filters
81 * @defgroup delay Delay
82 * @defgroup reverb Reverb
83 * @defgroup distortion Distortion
84 * @defgroup effects Effects
85 * @defgroup envelopes Envelopes
86 * @defgroup dynamics Dynamics
87 * @defgroup analysis Analysis
88 * @defgroup instruments Instruments
89 * @defgroup midi MIDI
90 * @defgroup sampling Sampling
91 * @defgroup physical Physical Models
92 * @defgroup electrical Electrical Models
93 * @defgroup mempool Mempool
94 * @defgroup math Math
95 */
96
64#ifdef __cplusplus97#ifdef __cplusplus
65extern "C" {98extern "C" {
66#endif99#endif
67 100
68void LEAF_init (float sampleRate, int blocksize, char* memory, size_t memorysize, float(*randomNumberFunction)(void));101 /*!
69void LEAF_setSampleRate (float sampleRate);102 * @ingroup leaf
70float LEAF_getSampleRate (void);103 * @{
71 104 */
105
106 //! Initialize the LEAF instance.
107 /*!
108 @param sampleRate The audio sample rate.
109 @param blockSize The audio block size.
110 @param memory A pointer to the memory that will make up the default LEAF mempool.
111 @param memorySize The size of the memory that will make up the default LEAF mempool.
112 @param random A pointer to a random number function. Should return a float >= 0 and < 1.
113 */
114 void LEAF_init (float sampleRate, int blockSize, char* memory, size_t memorySize, float(*random)(void));
115
116 //! Set the sample rate of LEAF.
117 /*!
118 @param sampleRate The new audio sample rate.
119 */
120 void LEAF_setSampleRate (float sampleRate);
121
122 //! Get the sample rate of LEAF.
123 /*!
124 @return The current sample rate as a float.
125 */
126 float LEAF_getSampleRate (void);
127
128 /*!
129 * @}
130 */
131
72#ifdef __cplusplus132#ifdef __cplusplus
73}133}
74#endif134#endif
75 135
76#endif // LEAF_H_INCLUDED136#endif // LEAF_H_INCLUDED
137
LEAF_JUCEPlugin/.DS_Store+0−0

Binary file not shown.

LEAF_JUCEPlugin/LEAF.jucer+6−0
@@ -13,6 +13,12 @@ · 12 unmodified lines
13 buildStandalone="1" enableIAA="0" cppLanguageStandard="11" companyCopyright="Princeton University"13 buildStandalone="1" enableIAA="0" cppLanguageStandard="11" companyCopyright="Princeton University"
14 pluginFormats="buildAU,buildStandalone" pluginCharacteristicsValue="pluginWantsMidiIn">14 pluginFormats="buildAU,buildStandalone" pluginCharacteristicsValue="pluginWantsMidiIn">
15 <MAINGROUP id="F7Bywq" name="LEAF">15 <MAINGROUP id="F7Bywq" name="LEAF">
16 <GROUP id="{F7096CF4-1A84-4CC8-A236-06FAE894451E}" name="Examples">
17 <FILE id="hMMOsl" name="basic-oscillators.c" compile="0" resource="0"
18 file="../Examples/basic-oscillators.c"/>
19 <FILE id="mVSe2h" name="basic-oscillators.h" compile="0" resource="0"
20 file="../Examples/basic-oscillators.h"/>
21 </GROUP>
16 <GROUP id="{14C5E2CD-5D51-3FD3-5677-28BECA29E95E}" name="Source">22 <GROUP id="{14C5E2CD-5D51-3FD3-5677-28BECA29E95E}" name="Source">
17 <GROUP id="{C9F79DF0-2C57-F2B0-7B1B-78A14937E038}" name="LEAF">23 <GROUP id="{C9F79DF0-2C57-F2B0-7B1B-78A14937E038}" name="LEAF">
18 <GROUP id="{B591B686-9726-94F1-28CD-B08349461C76}" name="Externals">24 <GROUP id="{B591B686-9726-94F1-28CD-B08349461C76}" name="Externals">
LEAF_JUCEPlugin/Source/MyTest.cpp+12−5
@@ -27,6 +27,8 @@ tEnvelope env; · 26 unmodified lines
27 27
28tAutotune at;28tAutotune at;
29 29
30tTriangle tri;
31
30float gain;32float gain;
31float freq;33float freq;
32float dtime;34float dtime;
@@ -43,9 +45,11 @@ void LEAFTest_init (float sampleRate, int blockSize) · 10 unmodified lines
43{45{
44 LEAF_init(sampleRate, blockSize, memory, MSIZE, &getRandomFloat);46 LEAF_init(sampleRate, blockSize, memory, MSIZE, &getRandomFloat);
45 47
46 tNoise_init(&noise, WhiteNoise);48 tTriangle_init(&tri);
47 49
48 tAutotune_init(&at, 1, 1024, 512);50// tNoise_init(&noise, WhiteNoise);
51//
52// tAutotune_init(&at, 1, 1024, 512);
49 53
50// tSVF_init(&bp1, SVFTypeBandpass, 100, 4.0f);54// tSVF_init(&bp1, SVFTypeBandpass, 100, 4.0f);
51// tSVF_init(&bp2, SVFTypeBandpass, 1000, 4.0f);55// tSVF_init(&bp2, SVFTypeBandpass, 1000, 4.0f);
@@ -75,9 +79,12 @@ float LEAFTest_tick (float input) · 23 unmodified lines
75 79
76// return tSampler_tick(&samp);80// return tSampler_tick(&samp);
77 81
78 tAutotune_setFreq(&at, 440.0f, 0);82// tAutotune_setFreq(&at, 440.0f, 0);
83
84// return tAutotune_tick(&at, input)[0];
79 85
80 return tAutotune_tick(&at, input)[0];86 tTriangle_setFreq(&tri, x);
87 return tTriangle_tick(&tri);
81}88}
82 89
83int firstFrame = 1;90int firstFrame = 1;
@@ -93,7 +100,7 @@ void LEAFTest_block (void) · 9 unmodified lines
93 100
94 float val = getSliderValue("mod freq");101 float val = getSliderValue("mod freq");
95 102
96 x = val * 3.5f + 0.5f;103 x = val * -40000.0f + 20000;
97 104
98// a = val * tBuffer_getBufferLength(&buff);105// a = val * tBuffer_getBufferLength(&buff);
99 106
README.md+1−1
@@ -43,7 +43,7 @@ Internally, LEAF objects that the user defines globally (by writing something li · 42 unmodified lines
43 43
44All LEAF objects must have an init() function and a free() function -- these will create the objects inside the default mempool, as well as an initToPool() and freeFromPool() function -- these will create the objects inside a user-defined specific mempool that is not the default. 44All LEAF objects must have an init() function and a free() function -- these will create the objects inside the default mempool, as well as an initToPool() and freeFromPool() function -- these will create the objects inside a user-defined specific mempool that is not the default.
45 45
46LEAF objects assume that they will be "ticked" once per sample, and generally take single sample input and produce single sample output. The alternative would be to have the user pass in an array and have the objects operate on the full array, which could have performance advantages if SIMD instructions are available on the processor, but would have disadvantages in flexibility of use. If an audio object requires some kind of buffer to operate on (such as a pitch detector) it will collect samples in it's sample-by-sample tick function and store them in its own internal buffer. 46LEAF objects assume that they will be "ticked" once per sample, and generally take single sample input and produce single sample output. The alternative would be to have the user pass in an array and have the objects operate on the full array, which could have performance advantages if SIMD instructions are available on the processor, but would have disadvantages in flexibility of use. If an audio object requires some kind of buffer to operate on (such as a pitch detector) it will collect samples in its sample-by-sample tick function and store them in its own internal buffer.
47 47
48 48
49////49////

Keyboard shortcuts

General

Show keyboard shortcuts
?
Focus the current search
/

Issues and pull requests

Open filters
f

Issues, pull requests and Inbox

Select next item
j↓
Select previous item
k↑
Open selected item
Enter
Dismiss filters or clear selection
Esc

Repository code

Go to file
t