Krolyxon
Commit 3120783

Branches

Tags

Refs →

orion-rf.piolibdepsesp32-s3-n16r8RF24docsDoxyfile

393 lines · 16.6 KB

Raw Blame History Download
1# This file describes the settings to be used by the documentation system
2# doxygen (www.doxygen.org) for a project.
3#
4# All text after a double hash (##) is considered a comment and is placed in
5# front of the TAG it is preceding.
6#
7# All text after a single hash (#) is considered a comment and will be ignored.
8# The format is:
9# TAG = value [value, ...]
10# For lists, items can also be appended using:
11# TAG += value [value, ...]
12# Values that contain spaces should be placed between quotes (\" \").
13
14#---------------------------------------------------------------------------
15# Project related configuration options
16#---------------------------------------------------------------------------
17
18PROJECT_ICON = images/favicon.ico
19
20# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
21# double-quotes, unless you are using Doxywizard) that should identify the
22# project for which the documentation is generated. This name is used in the
23# title of most generated pages and in a few other places.
24# The default value is: My Project.
25
26PROJECT_NAME = "Optimized high speed nRF24L01+ driver class documentation"
27
28# Using the PROJECT_BRIEF tag one can provide an optional one line description
29# for a project that appears at the top of each page and should give viewer a
30# quick idea about the purpose of the project. Keep the description short.
31
32PROJECT_BRIEF = "TMRh20 2020 - Optimized fork of the nRF24L01+ driver"
33
34# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
35# into which the generated documentation will be written. If a relative path is
36# entered, it will be relative to the location where doxygen was started. If
37# left blank the current directory will be used.
38
39OUTPUT_DIRECTORY = ./
40
41# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
42# Stripping is only done if one of the specified strings matches the left-hand part
43# of the path. The tag can be used to show relative paths in the file list.
44# If left blank the directory from which doxygen is run is used as the path to strip.
45# Note that you can specify absolute paths here, but also relative paths, which will
46# be relative from the directory where doxygen is started.
47#
48# This tag requires that the tag FULL_PATH_NAMES is set to YES.
49STRIP_FROM_PATH = ../
50
51# Doxygen selects the parser to use depending on the extension of the files it
52# parses. With this tag you can assign which parser to use for a given
53# extension. Doxygen has a built-in mapping, but you can override or extend it
54# using this tag. The format is ext=language, where ext is a file extension, and
55# language is one of the parsers supported by doxygen: IDL, Java, JavaScript,
56# Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice, VHDL,
57# Fortran (fixed format Fortran: FortranFixed, free formatted Fortran:
58# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser
59# tries to guess whether the code is fixed or free formatted code, this is the
60# default for Fortran type files). For instance to make doxygen treat .inc files
61# as Fortran files (default is PHP), and .f files as C (default is Fortran),
62# use: inc=Fortran f=C.
63#
64# Note: For files without extension you can use no_extension as a placeholder.
65#
66# Note that for custom extensions you also need to set FILE_PATTERNS otherwise
67# the files are not read by doxygen.
68
69EXTENSION_MAPPING = ino=c \
70 pde=c
71
72#---------------------------------------------------------------------------
73# Build related configuration options
74#---------------------------------------------------------------------------
75
76# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
77# documentation are documented, even if no documentation was available. Private
78# class members and static file members will be hidden unless the
79# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
80# Note: This will also disable the warnings about undocumented members that are
81# normally produced when WARNINGS is set to YES.
82# The default value is: NO.
83
84EXTRACT_ALL = YES
85
86# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
87# included in the documentation.
88# The default value is: NO.
89
90EXTRACT_STATIC = YES
91
92# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
93# names in lower-case letters. If set to YES, upper-case letters are also
94# allowed. This is useful if you have classes or files whose names only differ
95# in case and if your file system supports case sensitive file names. Windows
96# (including Cygwin) ands Mac users are advised to set this option to NO.
97# The default value is: system dependent.
98
99CASE_SENSE_NAMES = YES
100
101# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
102# (detailed) documentation of file and class members alphabetically by member
103# name. If set to NO, the members will appear in declaration order.
104# The default value is: YES.
105
106SORT_MEMBER_DOCS = NO
107
108# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
109# fully-qualified names, including namespaces. If set to NO, the class list will
110# be sorted only by class name, not including the namespace part.
111# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
112# Note: This option applies only to the class list, not to the alphabetical
113# list.
114# The default value is: NO.
115
116SORT_BY_SCOPE_NAME = YES
117
118# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
119# list. This list is created by putting \todo commands in the documentation.
120# The default value is: YES.
121
122GENERATE_TODOLIST = NO
123
124# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
125# will remove the Files entry from the Quick Index and from the Folder Tree View
126# (if specified).
127# The default value is: YES.
128
129SHOW_FILES = YES
130
131# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
132# page. This will remove the Namespaces entry from the Quick Index and from the
133# Folder Tree View (if specified).
134# The default value is: YES.
135
136SHOW_NAMESPACES = NO
137
138# Don't display the ugly/complicated "tree view" side menu.
139# And, restore the top (simpler) navigation bar.
140# As of doxygen v1.13.0, these default values changed from NO to YES
141GENERATE_TREEVIEW = NO
142DISABLE_INDEX = NO
143
144#---------------------------------------------------------------------------
145# Configuration options related to warning and progress messages
146#---------------------------------------------------------------------------
147
148# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
149# a warning is encountered.
150# The default value is: NO.
151
152WARN_AS_ERROR = YES
153
154#---------------------------------------------------------------------------
155# Configuration options related to the input files
156#---------------------------------------------------------------------------
157
158# The INPUT tag is used to specify the files and/or directories that contain
159# documented source files. You may enter file names like myfile.cpp or
160# directories like /usr/src/myproject. Separate the files or directories with
161# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
162# Note: If this tag is empty the current directory is searched.
163
164INPUT = ../ \
165 ../utility/Template \
166 ./
167
168# If the value of the INPUT tag contains directories, you can use the
169# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
170# *.h) to filter out the source-files in the directories.
171#
172# Note that for custom extensions or not directly supported extensions you also
173# need to set EXTENSION_MAPPING for the extension otherwise the files are not
174# read by doxygen.
175#
176# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,
177# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,
178# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc,
179# *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C comment),
180# *.doc (to be provided as doxygen C comment), *.txt (to be provided as doxygen
181# C comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd,
182# *.vhdl, *.ucf, *.qsf and *.ice.
183
184FILE_PATTERNS = *.c \
185 *.cc \
186 *.cxx \
187 *.cpp \
188 *.c++ \
189 *.java \
190 *.ii \
191 *.ixx \
192 *.ipp \
193 *.i++ \
194 *.inl \
195 *.idl \
196 *.ddl \
197 *.odl \
198 *.h \
199 *.hh \
200 *.hxx \
201 *.hpp \
202 *.h++ \
203 *.cs \
204 *.d \
205 *.php \
206 *.php4 \
207 *.php5 \
208 *.phtml \
209 *.inc \
210 *.m \
211 *.markdown \
212 *.md \
213 *.mm \
214 *.dox \
215 *.py \
216 *.f90 \
217 *.f \
218 *.for \
219 *.tcl \
220 *.vhd \
221 *.vhdl \
222 *.ucf \
223 *.qsf \
224 *.as \
225 *.js
226
227# The EXCLUDE tag can be used to specify files and/or directories that should be
228# excluded from the INPUT source files. This way you can easily exclude a
229# subdirectory from a directory tree whose root is specified with the INPUT tag.
230#
231# Note that relative paths are relative to the directory from which doxygen is
232# run.
233
234EXCLUDE = Makefile \
235 configure
236
237# If the value of the INPUT tag contains directories, you can use the
238# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
239# certain files from those directories.
240#
241# Note that the wildcards are matched against the file with absolute path, so to
242# exclude all test directories for example use the pattern */test/*
243
244EXCLUDE_PATTERNS = bcm2835* \
245 readme* \
246 runtest* \
247 tests* \
248 README*
249
250# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
251# (namespaces, classes, functions, etc.) that should be excluded from the
252# output. The symbol name can be a fully qualified name, a word, or if the
253# wildcard * is used, a substring. Examples: ANamespace, AClass,
254# AClass::ANamespace, ANamespace::*Test
255#
256# Note that the wildcards are matched against the file with absolute path, so to
257# exclude all test directories use the pattern */test/*
258
259EXCLUDE_SYMBOLS = _
260
261# The EXAMPLE_PATH tag can be used to specify one or more files or directories
262# that contain example code fragments that are included (see the \include
263# command).
264
265EXAMPLE_PATH = ../examples \
266 ../examples_linux
267
268# If the value of the EXAMPLE_PATH tag contains directories, you can use the
269# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
270# *.h) to filter out the source-files in the directories. If left blank all
271# files are included.
272
273EXAMPLE_PATTERNS =
274
275# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
276# searched for input files to be used with the \include or \dontinclude commands
277# irrespective of the value of the RECURSIVE tag.
278# The default value is: NO.
279
280EXAMPLE_RECURSIVE = YES
281
282# The IMAGE_PATH tag can be used to specify one or more files or directories
283# that contain images that are to be included in the documentation (see the
284# \image command).
285
286IMAGE_PATH = ../images
287
288# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
289# is part of the input, its contents will be placed on the main page
290# (index.html). This can be useful if you have a project on for instance GitHub
291# and want to reuse the introduction page also for the doxygen output.
292
293USE_MDFILE_AS_MAINPAGE = main_page.md
294
295#---------------------------------------------------------------------------
296# Configuration options related to source browsing
297#---------------------------------------------------------------------------
298
299# If the SOURCE_BROWSER tag is set to YES then a list of source files will be
300# generated. Documented entities will be cross-referenced with these sources.
301#
302# Note: To get rid of all source code in the generated output, make sure that
303# also VERBATIM_HEADERS is set to NO.
304# The default value is: NO.
305
306SOURCE_BROWSER = YES
307
308#---------------------------------------------------------------------------
309# Configuration options related to the HTML output
310#---------------------------------------------------------------------------
311
312# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
313# cascading style sheets that are included after the standard style sheets
314# created by doxygen. Using this option one can overrule certain style aspects.
315# This is preferred over using HTML_STYLESHEET since it does not replace the
316# standard style sheet and is therefore more robust against future updates.
317# Doxygen will copy the style sheet files to the output directory.
318# Note: The order of the extra style sheet files is of importance (e.g. the last
319# style sheet in the list overrules the setting of the previous ones in the
320# list). For an example see the documentation.
321# This tag requires that the tag GENERATE_HTML is set to YES.
322
323HTML_EXTRA_STYLESHEET = doxygen-custom.css
324
325# The HTML_COLORSTYLE tag can be used to specify if the generated HTML output should be rendered
326# with a dark or light theme.
327#
328# Possible values are:
329# - LIGHT always generate light mode output
330# - DARK always generate dark mode output
331# - AUTO_LIGHT automatically set the mode according to the user preference,
332# use light mode if no preference is set (the default)
333# - AUTO_DARK automatically set the mode according to the user preference,
334# use dark mode if no preference is set
335# - TOGGLE allow to user to switch between light and dark mode via a button.
336#
337# The default value is: AUTO_LIGHT.
338#
339# This tag requires that the tag GENERATE_HTML is set to YES.
340
341HTML_COLORSTYLE = TOGGLE
342
343# If the TIMESTAMP tag is set different from NO then each generated page will contain
344# the date or date and time when the page was generated. Setting this to NO can help
345# when comparing the output of multiple runs.
346#
347# Possible values are: YES, NO, DATETIME and DATE.
348#
349# The default value is: NO.
350
351TIMESTAMP = DATE
352
353# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML
354# documentation will contain a main index with vertical navigation menus that
355# are dynamically created via JavaScript. If disabled, the navigation index will
356# consists of multiple levels of tabs that are statically embedded in every HTML
357# page. Disable this option to support browsers that do not have JavaScript,
358# like the Qt help browser.
359# The default value is: YES.
360# This tag requires that the tag GENERATE_HTML is set to YES.
361
362HTML_DYNAMIC_MENUS = NO
363
364# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
365# documentation will contain sections that can be hidden and shown after the
366# page has loaded.
367# The default value is: NO.
368# This tag requires that the tag GENERATE_HTML is set to YES.
369
370HTML_DYNAMIC_SECTIONS = YES
371
372#---------------------------------------------------------------------------
373# Configuration options related to the LaTeX output
374#---------------------------------------------------------------------------
375
376# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
377# The default value is: YES.
378
379GENERATE_LATEX = NO
380
381#---------------------------------------------------------------------------
382# Configuration options related to the preprocessor
383#---------------------------------------------------------------------------
384
385# The PREDEFINED tag can be used to specify one or more macro names that are
386# defined before the preprocessor is started (similar to the -D option of e.g.
387# gcc). The argument of the tag is a list of macros of the form: name or
388# name=definition (no spaces). If the definition and the "=" are omitted, "=1"
389# is assumed. To prevent a macro definition from being undefined via #undef or
390# recursively expanded use the := operator instead of the = operator.
391# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
392
393PREDEFINED = DOXYGEN_FORCED