From 155759586a70f4e89bbd3e5e7a3679cba8d19da3 Mon Sep 17 00:00:00 2001 From: Vladimir Marchenko Date: Fri, 22 Jul 2022 16:20:26 +0200 Subject: [PATCH] Updated Documentation to Doxygen 1.9.2 and new layout. --- .github/workflows/build.yaml | 22 +- Doxygen/dsp.dxy.in | 928 ++++++++++++------ Doxygen/gen_doc.sh | 6 +- Doxygen/templates/CMSIS_Logo_Final.png | Bin 5823 -> 0 bytes ...nLayout_forUser.xml => Layout_forUser.xml} | 70 +- Doxygen/templates/cmsis_logo_white_small.png | Bin 0 -> 6816 bytes .../{cmsis.css => extra_stylesheet.css} | 624 +++++++----- Doxygen/templates/header.html | 71 +- Doxygen/templates/navtree.css | 90 +- Doxygen/templates/navtree.js | 551 +++++++++++ Doxygen/templates/printComponentTabs.js | 26 +- Doxygen/templates/search.css | 12 +- Doxygen/templates/tab_b.png | Bin 0 -> 128 bytes Doxygen/templates/tab_topnav.png | Bin 232 -> 0 bytes Doxygen/templates/tabs.css | 106 +- Include/arm_math.h | 133 ++- Include/dsp/controller_functions.h | 40 +- Include/dsp/fast_math_functions.h | 28 +- Include/dsp/interpolation_functions.h | 46 +- Source/ControllerFunctions/arm_sin_cos_f32.c | 29 - Source/SupportFunctions/arm_barycenter_f32.c | 1 + Source/TransformFunctions/arm_cfft_f64.c | 4 - 22 files changed, 1925 insertions(+), 862 deletions(-) delete mode 100644 Doxygen/templates/CMSIS_Logo_Final.png rename Doxygen/templates/{DoxygenLayout_forUser.xml => Layout_forUser.xml} (69%) create mode 100644 Doxygen/templates/cmsis_logo_white_small.png rename Doxygen/templates/{cmsis.css => extra_stylesheet.css} (62%) create mode 100644 Doxygen/templates/navtree.js create mode 100644 Doxygen/templates/tab_b.png delete mode 100644 Doxygen/templates/tab_topnav.png diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml index c65e48e1..4de0e404 100644 --- a/.github/workflows/build.yaml +++ b/.github/workflows/build.yaml @@ -29,21 +29,21 @@ jobs: sudo apt-get install --no-install-recommends -y libclang1-9 libclang-cpp1-9 p7zip libxml2-utils sudo pip install LinkChecker - - name: Install Doxygen 1.8.6 - run: | - wget http://archive.ubuntu.com/ubuntu/pool/main/d/doxygen/doxygen_1.8.6-2_amd64.deb - sudo dpkg -i doxygen_1.8.6-2_amd64.deb - which doxygen - doxygen --version - -# - name: Install doxygen 1.9.2 +# - name: Install Doxygen 1.8.6 # run: | -# wget https://doxygen.nl/files/doxygen-1.9.2.linux.bin.tar.gz -# sudo tar -C /opt -xf doxygen-1.9.2.linux.bin.tar.gz -# sudo ln -s /opt/doxygen-1.9.2/bin/doxygen /usr/local/bin/ +# wget http://archive.ubuntu.com/ubuntu/pool/main/d/doxygen/doxygen_1.8.6-2_amd64.deb +# sudo dpkg -i doxygen_1.8.6-2_amd64.deb # which doxygen # doxygen --version + - name: Install doxygen 1.9.2 + run: | + wget https://doxygen.nl/files/doxygen-1.9.2.linux.bin.tar.gz + sudo tar -C /opt -xf doxygen-1.9.2.linux.bin.tar.gz + sudo ln -s /opt/doxygen-1.9.2/bin/doxygen /usr/local/bin/ + which doxygen + doxygen --version + - name: Install PackChk 1.3.95 run: | wget https://github.com/Open-CMSIS-Pack/devtools/releases/download/tools%2Fpackchk%2F1.3.95/packchk-1.3.95-linux64.zip diff --git a/Doxygen/dsp.dxy.in b/Doxygen/dsp.dxy.in index 560f9192..fd398f5a 100644 --- a/Doxygen/dsp.dxy.in +++ b/Doxygen/dsp.dxy.in @@ -1,4 +1,4 @@ -# Doxyfile 1.8.6 +# Doxyfile 1.9.2 # This file describes the settings to be used by the documentation system # doxygen (www.doxygen.org) for a project. @@ -17,11 +17,11 @@ # Project related configuration options #--------------------------------------------------------------------------- -# This tag specifies the encoding used for all characters in the config file -# that follow. The default is UTF-8 which is also the encoding used for all text -# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv -# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv -# for the list of possible encodings. +# This tag specifies the encoding used for all characters in the configuration +# file that follow. The default is UTF-8 which is also the encoding used for all +# text before the first occurrence of this tag. Doxygen uses libiconv (or the +# iconv built into libc) for the transcoding. See +# https://www.gnu.org/software/libiconv/ for the list of possible encodings. # The default value is: UTF-8. DOXYFILE_ENCODING = UTF-8 @@ -51,8 +51,7 @@ PROJECT_BRIEF = "CMSIS DSP Software Library" # and the maximum width should not exceed 200 pixels. Doxygen will copy the logo # to the output directory. -PROJECT_LOGO = templates/CMSIS_Logo_Final.png - +PROJECT_LOGO = templates/cmsis_logo_white_small.png # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path # into which the generated documentation will be written. If a relative path is # entered, it will be relative to the location where doxygen was started. If @@ -60,7 +59,7 @@ PROJECT_LOGO = templates/CMSIS_Logo_Final.png OUTPUT_DIRECTORY = ../Documentation -# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub- +# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- # directories (in 2 levels) under the output directory of each output format and # will distribute the generated files over these directories. Enabling this # option can be useful when feeding doxygen a huge amount of source files, where @@ -70,6 +69,14 @@ OUTPUT_DIRECTORY = ../Documentation CREATE_SUBDIRS = NO +# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII +# characters to appear in the names of generated files. If set to NO, non-ASCII +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode +# U+3044. +# The default value is: NO. + +ALLOW_UNICODE_NAMES = NO + # The OUTPUT_LANGUAGE tag is used to specify the language in which all # documentation generated by doxygen is written. Doxygen will use this # information to generate all constant output in the proper language. @@ -85,14 +92,14 @@ CREATE_SUBDIRS = NO OUTPUT_LANGUAGE = English -# If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member +# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member # descriptions after the members that are listed in the file and class # documentation (similar to Javadoc). Set to NO to disable this. # The default value is: YES. BRIEF_MEMBER_DESC = YES -# If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief +# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief # description of a member or function before the detailed description # # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the @@ -137,7 +144,7 @@ ALWAYS_DETAILED_SEC = NO INLINE_INHERITED_MEMB = NO -# If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path +# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path # before files name in the file list and in the header files. If set to NO the # shortest path that makes the file name unique will be used # The default value is: YES. @@ -181,6 +188,16 @@ SHORT_NAMES = NO JAVADOC_AUTOBRIEF = NO +# If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line +# such as +# /*************** +# as being the beginning of a Javadoc-style comment "banner". If set to NO, the +# Javadoc-style will behave just like regular comments and it will not be +# interpreted by doxygen. +# The default value is: NO. + +JAVADOC_BANNER = NO + # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first # line (until the first dot) of a Qt-style comment as the brief description. If # set to NO, the Qt-style will behave just like regular Qt-style comments (thus @@ -201,15 +218,23 @@ QT_AUTOBRIEF = NO MULTILINE_CPP_IS_BRIEF = YES +# By default Python docstrings are displayed as preformatted text and doxygen's +# special commands cannot be used. By setting PYTHON_DOCSTRING to NO the +# doxygen's special commands can be used and the contents of the docstring +# documentation blocks is shown as doxygen documentation. +# The default value is: YES. + +PYTHON_DOCSTRING = NO + # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the # documentation from any documented member that it re-implements. # The default value is: YES. INHERIT_DOCS = NO -# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a -# new page for each member. If set to NO, the documentation of a member will be -# part of the file/class/namespace that contains it. +# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new +# page for each member. If set to NO, the documentation of a member will be part +# of the file/class/namespace that contains it. # The default value is: NO. SEPARATE_MEMBER_PAGES = NO @@ -218,25 +243,26 @@ SEPARATE_MEMBER_PAGES = NO # uses this value to replace tabs by spaces in code fragments. # Minimum value: 1, maximum value: 16, default value: 4. -TAB_SIZE = 8 +TAB_SIZE = 2 # This tag can be used to specify a number of aliases that act as commands in # the documentation. An alias has the form: # name=value # For example adding -# "sideeffect=@par Side Effects:\n" +# "sideeffect=@par Side Effects:^^" # will allow you to put the command \sideeffect (or @sideeffect) in the # documentation, which will result in a user-defined paragraph with heading -# "Side Effects:". You can put \n's in the value part of an alias to insert -# newlines. +# "Side Effects:". Note that you cannot put \n's in the value part of an alias +# to insert newlines (in the resulting output). You can put ^^ in the value part +# of an alias to insert a newline as if a physical newline was in the original +# file. When you need a literal { or } or , in the value part of an alias you +# have to escape them by means of a backslash (\), this can lead to conflicts +# with the commands \{ and \} for these it is advised to use the version @{ and +# @} or use a double escape (\\{ and \\}) ALIASES = -# This tag can be used to specify a number of word-keyword mappings (TCL only). -# A mapping has the form "name=value". For example adding "class=itcl::class" -# will allow you to use the command class in the itcl::class meaning. -TCL_SUBST = # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources # only. Doxygen will then generate output that is more tailored for C. For @@ -266,25 +292,40 @@ OPTIMIZE_FOR_FORTRAN = NO OPTIMIZE_OUTPUT_VHDL = NO +# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice +# sources only. Doxygen will then generate output that is more tailored for that +# language. For instance, namespaces will be presented as modules, types will be +# separated into more groups, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_SLICE = NO + # Doxygen selects the parser to use depending on the extension of the files it # parses. With this tag you can assign which parser to use for a given # extension. Doxygen has a built-in mapping, but you can override or extend it # using this tag. The format is ext=language, where ext is a file extension, and # language is one of the parsers supported by doxygen: IDL, Java, Javascript, -# C#, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL. For instance to make -# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C -# (default is Fortran), use: inc=Fortran f=C. +# Csharp (C#), C, C++, Lex, D, PHP, md (Markdown), Objective-C, Python, Slice, +# VHDL, Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: +# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser +# tries to guess whether the code is fixed or free formatted code, this is the +# default for Fortran type files). For instance to make doxygen treat .inc files +# as Fortran files (default is PHP), and .f files as C (default is Fortran), +# use: inc=Fortran f=C. # -# Note For files without extension you can use no_extension as a placeholder. +# Note: For files without extension you can use no_extension as a placeholder. # # Note that for custom extensions you also need to set FILE_PATTERNS otherwise -# the files are not read by doxygen. +# the files are not read by doxygen. When specifying no_extension you should add +# * to the FILE_PATTERNS. +# +# Note see also the list of default file extension mappings. EXTENSION_MAPPING = # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments # according to the Markdown format, which allows for more readable -# documentation. See http://daringfireball.net/projects/markdown/ for details. +# documentation. See https://daringfireball.net/projects/markdown/ for details. # The output of markdown processing is further processed by doxygen, so you can # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in # case of backward compatibilities issues. @@ -292,10 +333,19 @@ EXTENSION_MAPPING = MARKDOWN_SUPPORT = YES +# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up +# to that level are automatically included in the table of contents, even if +# they do not have an id attribute. +# Note: This feature currently applies only to Markdown headings. +# Minimum value: 0, maximum value: 99, default value: 5. +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. + +TOC_INCLUDE_HEADINGS = 5 + # When enabled doxygen tries to link words that correspond to documented # classes, or namespaces to their corresponding documentation. Such a link can -# be prevented in individual cases by by putting a % sign in front of the word -# or globally by setting AUTOLINK_SUPPORT to NO. +# be prevented in individual cases by putting a % sign in front of the word or +# globally by setting AUTOLINK_SUPPORT to NO. # The default value is: YES. AUTOLINK_SUPPORT = YES @@ -317,7 +367,7 @@ BUILTIN_STL_SUPPORT = NO CPP_CLI_SUPPORT = NO # Set the SIP_SUPPORT tag to YES if your project consists of sip (see: -# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen +# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen # will parse them like normal C++ but will assume all classes use public instead # of private inheritance when no explicit protection keyword is present. # The default value is: NO. @@ -335,13 +385,20 @@ SIP_SUPPORT = NO IDL_PROPERTY_SUPPORT = YES # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC -# tag is set to YES, then doxygen will reuse the documentation of the first +# tag is set to YES then doxygen will reuse the documentation of the first # member in the group (if any) for the other members of the group. By default # all members of a group must be documented explicitly. # The default value is: NO. DISTRIBUTE_GROUP_DOC = NO +# If one adds a struct or class to a group and this option is enabled, then also +# any nested class or struct is added to the same group. By default this option +# is disabled and one has to add nested compounds explicitly via \ingroup. +# The default value is: NO. + +GROUP_NESTED_COMPOUNDS = YES + # Set the SUBGROUPING tag to YES to allow class member groups of the same type # (for instance a group of public functions) to be put as a subgroup of that # type (e.g. under the Public Functions section). Set it to NO to prevent @@ -396,11 +453,24 @@ TYPEDEF_HIDES_STRUCT = YES LOOKUP_CACHE_SIZE = 0 +# The NUM_PROC_THREADS specifies the number threads doxygen is allowed to use +# during processing. When set to 0 doxygen will based this on the number of +# cores available in the system. You can set it explicitly to a value larger +# than 0 to get more control over the balance between CPU load and processing +# speed. At this moment only the input processing can be done using multiple +# threads. Since this is still an experimental feature the default is set to 1, +# which effectively disables parallel processing. Please report any issues you +# encounter. Generating dot graphs in parallel is controlled by the +# DOT_NUM_THREADS setting. +# Minimum value: 0, maximum value: 32, default value: 1. + +NUM_PROC_THREADS = 1 + #--------------------------------------------------------------------------- # Build related configuration options #--------------------------------------------------------------------------- -# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in +# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in # documentation are documented, even if no documentation was available. Private # class members and static file members will be hidden unless the # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. @@ -410,35 +480,41 @@ LOOKUP_CACHE_SIZE = 0 EXTRACT_ALL = YES -# If the EXTRACT_PRIVATE tag is set to YES all private members of a class will +# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will # be included in the documentation. # The default value is: NO. EXTRACT_PRIVATE = NO -# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal +# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual +# methods of a class will be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIV_VIRTUAL = NO + +# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal # scope will be included in the documentation. # The default value is: NO. EXTRACT_PACKAGE = NO -# If the EXTRACT_STATIC tag is set to YES all static members of a file will be +# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be # included in the documentation. # The default value is: NO. EXTRACT_STATIC = NO -# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined -# locally in source files will be included in the documentation. If set to NO +# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO, # only classes defined in header files are included. Does not have any effect # for Java sources. # The default value is: YES. EXTRACT_LOCAL_CLASSES = NO -# This flag is only useful for Objective-C code. When set to YES local methods, +# This flag is only useful for Objective-C code. If set to YES, local methods, # which are defined in the implementation section but not in the interface are -# included in the documentation. If set to NO only methods in the interface are +# included in the documentation. If set to NO, only methods in the interface are # included. # The default value is: NO. @@ -453,6 +529,13 @@ EXTRACT_LOCAL_METHODS = NO EXTRACT_ANON_NSPACES = NO +# If this flag is set to YES, the name of an unnamed parameter in a declaration +# will be determined by the corresponding definition. By default unnamed +# parameters remain unnamed in the output. +# The default value is: YES. + +RESOLVE_UNNAMED_PARAMS = YES + # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all # undocumented members inside documented classes or files. If set to NO these # members will be included in the various overviews, but no documentation @@ -463,21 +546,21 @@ HIDE_UNDOC_MEMBERS = NO # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all # undocumented classes that are normally visible in the class hierarchy. If set -# to NO these classes will be included in the various overviews. This option has -# no effect if EXTRACT_ALL is enabled. +# to NO, these classes will be included in the various overviews. This option +# has no effect if EXTRACT_ALL is enabled. # The default value is: NO. HIDE_UNDOC_CLASSES = NO # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend -# (class|struct|union) declarations. If set to NO these declarations will be -# included in the documentation. +# declarations. If set to NO, these declarations will be included in the +# documentation. # The default value is: NO. HIDE_FRIEND_COMPOUNDS = NO # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any -# documentation blocks found inside the body of a function. If set to NO these +# documentation blocks found inside the body of a function. If set to NO, these # blocks will be appended to the function's detailed documentation block. # The default value is: NO. @@ -490,28 +573,52 @@ HIDE_IN_BODY_DOCS = NO INTERNAL_DOCS = NO -# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file -# names in lower-case letters. If set to YES upper-case letters are also -# allowed. This is useful if you have classes or files whose names only differ -# in case and if your file system supports case sensitive file names. Windows -# and Mac users are advised to set this option to NO. +# With the correct setting of option CASE_SENSE_NAMES doxygen will better be +# able to match the capabilities of the underlying filesystem. In case the +# filesystem is case sensitive (i.e. it supports files in the same directory +# whose names only differ in casing), the option must be set to YES to properly +# deal with such files in case they appear in the input. For filesystems that +# are not case sensitive the option should be be set to NO to properly deal with +# output files written for symbols that only differ in casing, such as for two +# classes, one named CLASS and the other named Class, and to also support +# references to files without having to specify the exact matching casing. On +# Windows (including Cygwin) and MacOS, users should typically set this option +# to NO, whereas on Linux or other Unix flavors it should typically be set to +# YES. # The default value is: system dependent. CASE_SENSE_NAMES = YES # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with -# their full class and namespace scopes in the documentation. If set to YES the +# their full class and namespace scopes in the documentation. If set to YES, the # scope will be hidden. # The default value is: NO. HIDE_SCOPE_NAMES = YES +# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will +# append additional text to a page's title, such as Class Reference. If set to +# YES the compound reference will be hidden. +# The default value is: NO. + +HIDE_COMPOUND_REFERENCE= NO + +# If the SHOW_HEADERFILE tag is set to YES then the documentation for a class +# will show which file needs to be included to use the class. +# The default value is: YES. + +SHOW_HEADERFILE = NO + # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of # the files that are included by a file in the documentation of that file. # The default value is: YES. SHOW_INCLUDE_FILES = NO +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each +# grouped member an include statement to the documentation, telling the reader +# which file to include in order to use the member. +# The default value is: NO. SHOW_GROUPED_MEMB_INC = NO @@ -529,14 +636,14 @@ INLINE_INFO = YES # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the # (detailed) documentation of file and class members alphabetically by member -# name. If set to NO the members will appear in declaration order. +# name. If set to NO, the members will appear in declaration order. # The default value is: YES. SORT_MEMBER_DOCS = YES # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief # descriptions of file, namespace and class members alphabetically by member -# name. If set to NO the members will appear in declaration order. Note that +# name. If set to NO, the members will appear in declaration order. Note that # this will also influence the order of the classes in the class list. # The default value is: NO. @@ -581,27 +688,25 @@ SORT_BY_SCOPE_NAME = NO STRICT_PROTO_MATCHING = NO -# The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the -# todo list. This list is created by putting \todo commands in the -# documentation. +# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo +# list. This list is created by putting \todo commands in the documentation. # The default value is: YES. GENERATE_TODOLIST = YES -# The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the -# test list. This list is created by putting \test commands in the -# documentation. +# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test +# list. This list is created by putting \test commands in the documentation. # The default value is: YES. GENERATE_TESTLIST = YES -# The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug +# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug # list. This list is created by putting \bug commands in the documentation. # The default value is: YES. GENERATE_BUGLIST = YES -# The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO) +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) # the deprecated list. This list is created by putting \deprecated commands in # the documentation. # The default value is: YES. @@ -623,11 +728,11 @@ ENABLED_SECTIONS = # documentation regardless of this setting. # Minimum value: 0, maximum value: 10000, default value: 30. -MAX_INITIALIZER_LINES = 0 +MAX_INITIALIZER_LINES = 30 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at -# the bottom of the documentation of classes and structs. If set to YES the list -# will mention the files that were used to generate the documentation. +# the bottom of the documentation of classes and structs. If set to YES, the +# list will mention the files that were used to generate the documentation. # The default value is: YES. SHOW_USED_FILES = NO @@ -661,22 +766,22 @@ FILE_VERSION_FILTER = # output files in an output format independent way. To create the layout file # that represents doxygen's defaults, run doxygen with the -l option. You can # optionally specify a file name after the option, if omitted DoxygenLayout.xml -# will be used as the name of the layout file. +# will be used as the name of the layout file. See also section "Changing the +# layout of pages" for information. # # Note that if you run doxygen from a directory containing a file called # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE # tag is left empty. -LAYOUT_FILE = templates/DoxygenLayout_forUser.xml +LAYOUT_FILE = templates/Layout_forUser.xml # The CITE_BIB_FILES tag can be used to specify one or more bib files containing # the reference definitions. This must be a list of .bib files. The .bib # extension is automatically appended if omitted. This requires the bibtex tool -# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. +# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info. # For LaTeX the style of the bibliography can be controlled using # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the -# search path. Do not use file names with spaces, bibtex cannot handle them. See -# also \cite for info how to create references. +# search path. See also \cite for info how to create references. CITE_BIB_FILES = @@ -692,7 +797,7 @@ CITE_BIB_FILES = QUIET = YES # The WARNINGS tag can be used to turn on/off the warning messages that are -# generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES +# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES # this implies that the warnings are on. # # Tip: Turn warnings on while writing the documentation. @@ -700,7 +805,7 @@ QUIET = YES WARNINGS = YES -# If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate +# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag # will automatically be disabled. # The default value is: YES. @@ -708,20 +813,38 @@ WARNINGS = YES WARN_IF_UNDOCUMENTED = YES # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for -# potential errors in the documentation, such as not documenting some parameters -# in a documented function, or documenting parameters that don't exist or using -# markup commands wrongly. +# potential errors in the documentation, such as documenting some parameters in +# a documented function twice, or documenting parameters that don't exist or +# using markup commands wrongly. # The default value is: YES. WARN_IF_DOC_ERROR = YES +# If WARN_IF_INCOMPLETE_DOC is set to YES, doxygen will warn about incomplete +# function parameter documentation. If set to NO, doxygen will accept that some +# parameters have no documentation without warning. +# The default value is: YES. + +WARN_IF_INCOMPLETE_DOC = YES + # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that # are documented, but have no documentation for their parameters or return -# value. If set to NO doxygen will only warn about wrong or incomplete parameter -# documentation, but not about the absence of documentation. +# value. If set to NO, doxygen will only warn about wrong parameter +# documentation, but not about the absence of documentation. If EXTRACT_ALL is +# set to YES then this flag will automatically be disabled. See also +# WARN_IF_INCOMPLETE_DOC +# The default value is: NO. + +WARN_NO_PARAMDOC = NO + +# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when +# a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS +# then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but +# at the end of the doxygen process doxygen will return with a non-zero status. +# Possible values are: NO, YES and FAIL_ON_WARNINGS. # The default value is: NO. -WARN_NO_PARAMDOC = YES +WARN_AS_ERROR = NO # The WARN_FORMAT tag determines the format of the warning messages that doxygen # can produce. The string should contain the $file, $line, and $text tags, which @@ -746,65 +869,88 @@ WARN_LOGFILE = # The INPUT tag is used to specify the files and/or directories that contain # documented source files. You may enter file names like myfile.cpp or # directories like /usr/src/myproject. Separate the files or directories with -# spaces. +# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # Note: If this tag is empty the current directory is searched. INPUT = history.txt \ - ../Examples/ARM \ ../Include/ \ - ../Source/ + ../Source/ \ + ../Examples/ARM \ + # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses # libiconv (or the iconv built into libc) for the transcoding. See the libiconv -# documentation (see: http://www.gnu.org/software/libiconv) for the list of -# possible encodings. +# documentation (see: +# https://www.gnu.org/software/libiconv/) for the list of possible encodings. # The default value is: UTF-8. INPUT_ENCODING = UTF-8 # If the value of the INPUT tag contains directories, you can use the # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and -# *.h) to filter out the source-files in the directories. If left blank the -# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii, -# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, -# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, -# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, -# *.qsf, *.as and *.js. +# *.h) to filter out the source-files in the directories. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# read by doxygen. +# +# Note the list of default checked file patterns might differ from the list of +# default file extension mappings. +# +# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, +# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, +# *.hh, *.hxx, *.hpp, *.h++, *.l, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, +# *.inc, *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C +# comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd, +# *.vhdl, *.ucf, *.qsf and *.ice. FILE_PATTERNS = *.c \ *.cc \ *.cxx \ *.cpp \ *.c++ \ - *.d \ *.java \ *.ii \ *.ixx \ *.ipp \ *.i++ \ *.inl \ + *.idl \ + *.ddl \ + *.odl \ *.h \ *.hh \ *.hxx \ *.hpp \ *.h++ \ - *.idl \ - *.odl \ + *.l \ *.cs \ + *.d \ *.php \ - *.php3 \ + *.php4 \ + *.php5 \ + *.phtml \ *.inc \ *.m \ + *.markdown \ + *.md \ *.mm \ *.dox \ *.py \ + *.pyw \ *.f90 \ + *.f95 \ + *.f03 \ + *.f08 \ + *.f18 \ *.f \ *.for \ *.vhd \ *.vhdl \ - *.txt + *.ucf \ + *.qsf \ + *.ice # The RECURSIVE tag can be used to specify whether or not subdirectories should # be searched for input files as well. @@ -819,7 +965,7 @@ RECURSIVE = YES # Note that relative paths are relative to the directory from which doxygen is # run. -EXCLUDE = math_helper.* \ +EXCLUDE = \ ../Source/DistanceFunctions/arm_boolean_distance_template.h \ ../Source/DistanceFunctions/arm_boolean_distance.c @@ -837,7 +983,9 @@ EXCLUDE_SYMLINKS = NO # Note that the wildcards are matched against the file with absolute path, so to # exclude all test directories for example use the pattern */test/* -EXCLUDE_PATTERNS = */RTE/* +EXCLUDE_PATTERNS = */RTE/* \ + math_helper.* \ + *.py \ # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names # (namespaces, classes, functions, etc.) that should be excluded from the @@ -890,6 +1038,10 @@ IMAGE_PATH = images # Note that the filter must not add or remove lines; it is applied before the # code is scanned, but not when the output code is generated. If lines are added # or removed, the anchors will not be placed correctly. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. INPUT_FILTER = @@ -899,11 +1051,15 @@ INPUT_FILTER = # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how # filters are used. If the FILTER_PATTERNS tag is empty or if none of the # patterns match the file name, INPUT_FILTER is applied. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. FILTER_PATTERNS = # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using -# INPUT_FILTER ) will also be used to filter the input files that are used for +# INPUT_FILTER) will also be used to filter the input files that are used for # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). # The default value is: NO. @@ -951,7 +1107,7 @@ INLINE_SOURCES = NO STRIP_CODE_COMMENTS = YES # If the REFERENCED_BY_RELATION tag is set to YES then for each documented -# function all documented functions referencing it will be listed. +# entity all documented functions referencing it will be listed. # The default value is: NO. REFERENCED_BY_RELATION = NO @@ -963,7 +1119,7 @@ REFERENCED_BY_RELATION = NO REFERENCES_RELATION = NO # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set -# to YES, then the hyperlinks from functions in REFERENCES_RELATION and +# to YES then the hyperlinks from functions in REFERENCES_RELATION and # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will # link to the documentation. # The default value is: YES. @@ -983,12 +1139,12 @@ SOURCE_TOOLTIPS = YES # If the USE_HTAGS tag is set to YES then the references to source code will # point to the HTML generated by the htags(1) tool instead of doxygen built-in # source browser. The htags tool is part of GNU's global source tagging system -# (see http://www.gnu.org/software/global/global.html). You will need version +# (see https://www.gnu.org/software/global/global.html). You will need version # 4.8.6 or higher. # # To use it do the following: # - Install the latest version of global -# - Enable SOURCE_BROWSER and USE_HTAGS in the config file +# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file # - Make sure the INPUT points to the root of the source tree # - Run doxygen as normal # @@ -1010,6 +1166,46 @@ USE_HTAGS = NO VERBATIM_HEADERS = NO +# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the +# clang parser (see: +# http://clang.llvm.org/) for more accurate parsing at the cost of reduced +# performance. This can be particularly helpful with template rich C++ code for +# which doxygen's built-in parser lacks the necessary type information. +# Note: The availability of this option depends on whether or not doxygen was +# generated with the -Duse_libclang=ON option for CMake. +# The default value is: NO. + +CLANG_ASSISTED_PARSING = NO + +# If the CLANG_ASSISTED_PARSING tag is set to YES and the CLANG_ADD_INC_PATHS +# tag is set to YES then doxygen will add the directory of each input to the +# include path. +# The default value is: YES. +# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. + +CLANG_ADD_INC_PATHS = YES + +# If clang assisted parsing is enabled you can provide the compiler with command +# line options that you would normally use when invoking the compiler. Note that +# the include paths will already be set by doxygen for the files and directories +# specified with INPUT and INCLUDE_PATH. +# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. + +CLANG_OPTIONS = + +# If clang assisted parsing is enabled you can provide the clang parser with the +# path to the directory containing a file called compile_commands.json. This +# file is the compilation database (see: +# http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) containing the +# options used when the source files were built. This is equivalent to +# specifying the -p option to a clang tool, such as clang-check. These options +# will then be passed to the parser. Any options specified with CLANG_OPTIONS +# will be added as well. +# Note: The availability of this option depends on whether or not doxygen was +# generated with the -Duse_libclang=ON option for CMake. + +CLANG_DATABASE_PATH = + #--------------------------------------------------------------------------- # Configuration options related to the alphabetical class index #--------------------------------------------------------------------------- @@ -1021,13 +1217,6 @@ VERBATIM_HEADERS = NO ALPHABETICAL_INDEX = NO -# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in -# which the alphabetical index list will be split. -# Minimum value: 1, maximum value: 20, default value: 5. -# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. - -COLS_IN_ALPHA_INDEX = 5 - # In case all classes in a project start with a common prefix, all classes will # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag # can be used to specify a prefix (or a list of prefixes) that should be ignored @@ -1040,7 +1229,7 @@ IGNORE_PREFIX = arm_ # Configuration options related to the HTML output #--------------------------------------------------------------------------- -# If the GENERATE_HTML tag is set to YES doxygen will generate HTML output +# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output # The default value is: YES. GENERATE_HTML = YES @@ -1102,16 +1291,19 @@ HTML_FOOTER = templates/footer.html HTML_STYLESHEET = -# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user- -# defined cascading style sheet that is included after the standard style sheets +# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined +# cascading style sheets that are included after the standard style sheets # created by doxygen. Using this option one can overrule certain style aspects. # This is preferred over using HTML_STYLESHEET since it does not replace the -# standard style sheet and is therefor more robust against future updates. -# Doxygen will copy the style sheet file to the output directory. For an example -# see the documentation. +# standard style sheet and is therefore more robust against future updates. +# Doxygen will copy the style sheet files to the output directory. +# Note: The order of the extra style sheet files is of importance (e.g. the last +# style sheet in the list overrules the setting of the previous ones in the +# list). For an example see the documentation. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_EXTRA_STYLESHEET = templates/cmsis.css + +HTML_EXTRA_STYLESHEET = templates/extra_stylesheet.css # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or # other source files which should be copied to the HTML output directory. Note @@ -1122,13 +1314,17 @@ HTML_EXTRA_STYLESHEET = templates/cmsis.css # This tag requires that the tag GENERATE_HTML is set to YES. HTML_EXTRA_FILES = templates/tabs.css \ - templates/tab_topnav.png \ - templates/printComponentTabs.js + templates/search.css \ + templates/navtree.css \ + templates/tab_b.png \ + templates/printComponentTabs.js \ + templates/navtree.js \ + ../LICENSE.txt # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen -# will adjust the colors in the stylesheet and background images according to -# this color. Hue is specified as an angle on a colorwheel, see -# http://en.wikipedia.org/wiki/Hue for more information. For instance the value +# will adjust the colors in the style sheet and background images according to +# this color. Hue is specified as an angle on a color-wheel, see +# https://en.wikipedia.org/wiki/Hue for more information. For instance the value # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 # purple, and 360 is red again. # Minimum value: 0, maximum value: 359, default value: 220. @@ -1137,7 +1333,7 @@ HTML_EXTRA_FILES = templates/tabs.css \ HTML_COLORSTYLE_HUE = 220 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors -# in the HTML output. For a value of 0 the output will use grayscales only. A +# in the HTML output. For a value of 0 the output will use gray-scales only. A # value of 255 will produce the most vivid colors. # Minimum value: 0, maximum value: 255, default value: 100. # This tag requires that the tag GENERATE_HTML is set to YES. @@ -1157,12 +1353,24 @@ HTML_COLORSTYLE_GAMMA = 80 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML # page will contain the date and time when the page was generated. Setting this -# to NO can help when comparing the output of multiple runs. -# The default value is: YES. +# to YES can help to show when doxygen was last run and thus if the +# documentation is up to date. +# The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_TIMESTAMP = YES +# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML +# documentation will contain a main index with vertical navigation menus that +# are dynamically created via JavaScript. If disabled, the navigation index will +# consists of multiple levels of tabs that are statically embedded in every HTML +# page. Disable this option to support browsers that do not have JavaScript, +# like the Qt help browser. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_MENUS = NO + # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML # documentation will contain sections that can be hidden and shown after the # page has loaded. @@ -1186,13 +1394,14 @@ HTML_INDEX_NUM_ENTRIES = 100 # If the GENERATE_DOCSET tag is set to YES, additional index files will be # generated that can be used as input for Apple's Xcode 3 integrated development -# environment (see: http://developer.apple.com/tools/xcode/), introduced with -# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a -# Makefile in the HTML output directory. Running make will produce the docset in -# that directory and running make install will install the docset in +# environment (see: +# https://developer.apple.com/xcode/), introduced with OSX 10.5 (Leopard). To +# create a documentation set, doxygen will generate a Makefile in the HTML +# output directory. Running make will produce the docset in that directory and +# running make install will install the docset in # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at -# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html -# for more information. +# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy +# genXcode/_index.html for more information. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. @@ -1231,8 +1440,12 @@ DOCSET_PUBLISHER_NAME = Publisher # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three # additional HTML index files: index.hhp, index.hhc, and index.hhk. The # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop -# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on -# Windows. +# on Windows. In the beginning of 2021 Microsoft took the original page, with +# a.o. the download links, offline the HTML help workshop was already many years +# in maintenance mode). You can download the HTML help workshop from the web +# archives at Installation executable (see: +# http://web.archive.org/web/20160201063255/http://download.microsoft.com/downlo +# ad/0/A/9/0A939EF6-E31C-430F-A3DF-DFAE7960D564/htmlhelp.exe). # # The HTML Help Workshop contains a compiler that can convert all HTML output # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML @@ -1254,28 +1467,29 @@ GENERATE_HTMLHELP = NO CHM_FILE = # The HHC_LOCATION tag can be used to specify the location (absolute path -# including file name) of the HTML help compiler ( hhc.exe). If non-empty +# including file name) of the HTML help compiler (hhc.exe). If non-empty, # doxygen will try to run the HTML help compiler on the generated index.hhp. # The file has to be specified with full path. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. HHC_LOCATION = -# The GENERATE_CHI flag controls if a separate .chi index file is generated ( -# YES) or that it should be included in the master .chm file ( NO). +# The GENERATE_CHI flag controls if a separate .chi index file is generated +# (YES) or that it should be included in the main .chm file (NO). # The default value is: NO. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. GENERATE_CHI = NO -# The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc) +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) # and project file content. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. CHM_INDEX_ENCODING = -# The BINARY_TOC flag controls whether a binary table of contents is generated ( -# YES) or a normal table of contents ( NO) in the .chm file. +# The BINARY_TOC flag controls whether a binary table of contents is generated +# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it +# enables the Previous and Next buttons. # The default value is: NO. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. @@ -1306,7 +1520,8 @@ QCH_FILE = # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help # Project output. For more information please see Qt Help Project / Namespace -# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). +# (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace). # The default value is: org.doxygen.Project. # This tag requires that the tag GENERATE_QHP is set to YES. @@ -1314,8 +1529,8 @@ QHP_NAMESPACE = org.doxygen.Project # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt # Help Project output. For more information please see Qt Help Project / Virtual -# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- -# folders). +# Folders (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders). # The default value is: doc. # This tag requires that the tag GENERATE_QHP is set to YES. @@ -1323,30 +1538,30 @@ QHP_VIRTUAL_FOLDER = doc # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom # filter to add. For more information please see Qt Help Project / Custom -# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- -# filters). +# Filters (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). # This tag requires that the tag GENERATE_QHP is set to YES. QHP_CUST_FILTER_NAME = # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the # custom filter to add. For more information please see Qt Help Project / Custom -# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- -# filters). +# Filters (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). # This tag requires that the tag GENERATE_QHP is set to YES. QHP_CUST_FILTER_ATTRS = # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this # project's filter section matches. Qt Help Project / Filter Attributes (see: -# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes). # This tag requires that the tag GENERATE_QHP is set to YES. QHP_SECT_FILTER_ATTRS = -# The QHG_LOCATION tag can be used to specify the location of Qt's -# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the -# generated .qhp file. +# The QHG_LOCATION tag can be used to specify the location (absolute path +# including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to +# run qhelpgenerator on the generated .qhp file. # This tag requires that the tag GENERATE_QHP is set to YES. QHG_LOCATION = @@ -1388,17 +1603,29 @@ DISABLE_INDEX = NO # index structure (just like the one that is generated for HTML Help). For this # to work a browser that supports JavaScript, DHTML, CSS and frames is required # (i.e. any modern browser). Windows users are probably better off using the -# HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can -# further fine-tune the look of the index. As an example, the default style -# sheet generated by doxygen has an example that shows how to put an image at -# the root of the tree instead of the PROJECT_NAME. Since the tree basically has -# the same information as the tab index, you could consider setting -# DISABLE_INDEX to YES when enabling this option. +# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can +# further fine tune the look of the index (see "Fine-tuning the output"). As an +# example, the default style sheet generated by doxygen has an example that +# shows how to put an image at the root of the tree instead of the PROJECT_NAME. +# Since the tree basically has the same information as the tab index, you could +# consider setting DISABLE_INDEX to YES when enabling this option. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_TREEVIEW = YES +# When both GENERATE_TREEVIEW and DISABLE_INDEX are set to YES, then the +# FULL_SIDEBAR option determines if the side bar is limited to only the treeview +# area (value NO) or if it should extend to the full height of the window (value +# YES). Setting this to YES gives a layout similar to +# https://docs.readthedocs.io with more room for contents, but less room for the +# project logo, title, and description. If either GENERATOR_TREEVIEW or +# DISABLE_INDEX is set to NO, this option has no effect. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FULL_SIDEBAR = NO + # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that # doxygen will group on one line in the generated HTML documentation. # @@ -1407,7 +1634,7 @@ GENERATE_TREEVIEW = YES # Minimum value: 0, maximum value: 20, default value: 4. # This tag requires that the tag GENERATE_HTML is set to YES. -ENUM_VALUES_PER_LINE = 0 +ENUM_VALUES_PER_LINE = 1 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used # to set the initial width (in pixels) of the frame in which the tree is shown. @@ -1416,13 +1643,24 @@ ENUM_VALUES_PER_LINE = 0 TREEVIEW_WIDTH = 250 -# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to +# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to # external symbols imported via tag files in a separate window. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. EXT_LINKS_IN_WINDOW = NO +# If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg +# tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see +# https://inkscape.org) to generate formulas as SVG images instead of PNGs for +# the HTML output. These images will generally look nicer at scaled resolutions. +# Possible values are: png (the default) and svg (looks nicer but requires the +# pdf2svg or inkscape tool). +# The default value is: png. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FORMULA_FORMAT = png + # Use this tag to change the font size of LaTeX formulas included as images in # the HTML documentation. When you change the font size after a successful # doxygen run you need to manually remove any form_*.png images from the HTML @@ -1432,7 +1670,7 @@ EXT_LINKS_IN_WINDOW = NO FORMULA_FONTSIZE = 10 -# Use the FORMULA_TRANPARENT tag to determine whether or not the images +# Use the FORMULA_TRANSPARENT tag to determine whether or not the images # generated for formulas are transparent PNGs. Transparent PNGs are not # supported properly for IE 6.0, but are supported on all modern browsers. # @@ -1443,9 +1681,15 @@ FORMULA_FONTSIZE = 10 FORMULA_TRANSPARENT = YES +# The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands +# to create new LaTeX commands to be used in formulas as building blocks. See +# the section "Including formulas" for details. + +FORMULA_MACROFILE = + # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see -# http://www.mathjax.org) which uses client side Javascript for the rendering -# instead of using prerendered bitmaps. Use this if you do not have LaTeX +# https://www.mathjax.org) which uses client side JavaScript for the rendering +# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX # installed or if you want to formulas look prettier in the HTML output. When # enabled you may also need to install MathJax separately and configure the path # to it using the MATHJAX_RELPATH option. @@ -1454,11 +1698,29 @@ FORMULA_TRANSPARENT = YES USE_MATHJAX = NO +# With MATHJAX_VERSION it is possible to specify the MathJax version to be used. +# Note that the different versions of MathJax have different requirements with +# regards to the different settings, so it is possible that also other MathJax +# settings have to be changed when switching between the different MathJax +# versions. +# Possible values are: MathJax_2 and MathJax_3. +# The default value is: MathJax_2. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_VERSION = MathJax_2 + # When MathJax is enabled you can set the default output format to be used for -# the MathJax output. See the MathJax site (see: -# http://docs.mathjax.org/en/latest/output.html) for more details. +# the MathJax output. For more details about the output format see MathJax +# version 2 (see: +# http://docs.mathjax.org/en/v2.7-latest/output.html) and MathJax version 3 +# (see: +# http://docs.mathjax.org/en/latest/web/components/output.html). # Possible values are: HTML-CSS (which is slower, but has the best -# compatibility), NativeMML (i.e. MathML) and SVG. +# compatibility. This is the name for Mathjax version 2, for MathJax version 3 +# this will be translated into chtml), NativeMML (i.e. MathML. Only supported +# for NathJax 2. For MathJax version 3 chtml will be used instead.), chtml (This +# is the name for Mathjax version 3, for MathJax version 2 this will be +# translated into HTML-CSS) and SVG. # The default value is: HTML-CSS. # This tag requires that the tag USE_MATHJAX is set to YES. @@ -1471,22 +1733,29 @@ MATHJAX_FORMAT = HTML-CSS # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax # Content Delivery Network so you can quickly see the result without installing # MathJax. However, it is strongly recommended to install a local copy of -# MathJax from http://www.mathjax.org before deployment. -# The default value is: http://cdn.mathjax.org/mathjax/latest. +# MathJax from https://www.mathjax.org before deployment. The default value is: +# - in case of MathJax version 2: https://cdn.jsdelivr.net/npm/mathjax@2 +# - in case of MathJax version 3: https://cdn.jsdelivr.net/npm/mathjax@3 # This tag requires that the tag USE_MATHJAX is set to YES. -MATHJAX_RELPATH = http://www.mathjax.org/mathjax +MATHJAX_RELPATH = # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax # extension names that should be enabled during MathJax rendering. For example +# for MathJax version 2 (see +# https://docs.mathjax.org/en/v2.7-latest/tex.html#tex-and-latex-extensions): # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# For example for MathJax version 3 (see +# http://docs.mathjax.org/en/latest/input/tex/extensions/index.html): +# MATHJAX_EXTENSIONS = ams # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_EXTENSIONS = # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces # of code that will be used on startup of the MathJax code. See the MathJax site -# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an +# (see: +# http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an # example see the documentation. # This tag requires that the tag USE_MATHJAX is set to YES. @@ -1515,11 +1784,11 @@ SEARCHENGINE = YES # When the SERVER_BASED_SEARCH tag is enabled the search engine will be # implemented using a web server instead of a web client using Javascript. There -# are two flavours of web server based searching depending on the -# EXTERNAL_SEARCH setting. When disabled, doxygen will generate a PHP script for -# searching and an index file used by the script. When EXTERNAL_SEARCH is -# enabled the indexing and searching needs to be provided by external tools. See -# the section "External Indexing and Searching" for details. +# are two flavors of web server based searching depending on the EXTERNAL_SEARCH +# setting. When disabled, doxygen will generate a PHP script for searching and +# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing +# and searching needs to be provided by external tools. See the section +# "External Indexing and Searching" for details. # The default value is: NO. # This tag requires that the tag SEARCHENGINE is set to YES. @@ -1531,9 +1800,10 @@ SERVER_BASED_SEARCH = NO # external search engine pointed to by the SEARCHENGINE_URL option to obtain the # search results. # -# Doxygen ships with an example indexer ( doxyindexer) and search engine +# Doxygen ships with an example indexer (doxyindexer) and search engine # (doxysearch.cgi) which are based on the open source search engine library -# Xapian (see: http://xapian.org/). +# Xapian (see: +# https://xapian.org/). # # See the section "External Indexing and Searching" for details. # The default value is: NO. @@ -1544,10 +1814,11 @@ EXTERNAL_SEARCH = NO # The SEARCHENGINE_URL should point to a search engine hosted by a web server # which will return the search results when EXTERNAL_SEARCH is enabled. # -# Doxygen ships with an example indexer ( doxyindexer) and search engine +# Doxygen ships with an example indexer (doxyindexer) and search engine # (doxysearch.cgi) which are based on the open source search engine library -# Xapian (see: http://xapian.org/). See the section "External Indexing and -# Searching" for details. +# Xapian (see: +# https://xapian.org/). See the section "External Indexing and Searching" for +# details. # This tag requires that the tag SEARCHENGINE is set to YES. SEARCHENGINE_URL = @@ -1582,7 +1853,7 @@ EXTRA_SEARCH_MAPPINGS = # Configuration options related to the LaTeX output #--------------------------------------------------------------------------- -# If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output. +# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output. # The default value is: YES. GENERATE_LATEX = NO @@ -1598,22 +1869,36 @@ LATEX_OUTPUT = latex # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be # invoked. # -# Note that when enabling USE_PDFLATEX this option is only used for generating -# bitmaps for formulas in the HTML output, but not in the Makefile that is -# written to the output directory. -# The default file is: latex. +# Note that when not enabling USE_PDFLATEX the default is latex when enabling +# USE_PDFLATEX the default is pdflatex and when in the later case latex is +# chosen this is overwritten by pdflatex. For specific output languages the +# default can have been set differently, this depends on the implementation of +# the output language. # This tag requires that the tag GENERATE_LATEX is set to YES. -LATEX_CMD_NAME = latex +LATEX_CMD_NAME = # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate # index for LaTeX. +# Note: This tag is used in the Makefile / make.bat. +# See also: LATEX_MAKEINDEX_CMD for the part in the generated output file +# (.tex). # The default file is: makeindex. # This tag requires that the tag GENERATE_LATEX is set to YES. MAKEINDEX_CMD_NAME = makeindex -# If the COMPACT_LATEX tag is set to YES doxygen generates more compact LaTeX +# The LATEX_MAKEINDEX_CMD tag can be used to specify the command name to +# generate index for LaTeX. In case there is no backslash (\) as first character +# it will be automatically added in the LaTeX code. +# Note: This tag is used in the generated output file (.tex). +# See also: MAKEINDEX_CMD_NAME for the part in the Makefile / make.bat. +# The default value is: makeindex. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_MAKEINDEX_CMD = makeindex + +# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX # documents. This may be useful for small projects and may help to save some # trees in general. # The default value is: NO. @@ -1631,39 +1916,57 @@ COMPACT_LATEX = NO PAPER_TYPE = a4 # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names -# that should be included in the LaTeX output. To get the times font for -# instance you can specify -# EXTRA_PACKAGES=times +# that should be included in the LaTeX output. The package can be specified just +# by its name or with the correct syntax as to be used with the LaTeX +# \usepackage command. To get the times font for instance you can specify : +# EXTRA_PACKAGES=times or EXTRA_PACKAGES={times} +# To use the option intlimits with the amsmath package you can specify: +# EXTRA_PACKAGES=[intlimits]{amsmath} # If left blank no extra packages will be included. # This tag requires that the tag GENERATE_LATEX is set to YES. EXTRA_PACKAGES = -# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the -# generated LaTeX document. The header should contain everything until the first -# chapter. If it is left blank doxygen will generate a standard header. See -# section "Doxygen usage" for information on how to let doxygen write the -# default header to a separate file. +# The LATEX_HEADER tag can be used to specify a user-defined LaTeX header for +# the generated LaTeX document. The header should contain everything until the +# first chapter. If it is left blank doxygen will generate a standard header. It +# is highly recommended to start with a default header using +# doxygen -w latex new_header.tex new_footer.tex new_stylesheet.sty +# and then modify the file new_header.tex. See also section "Doxygen usage" for +# information on how to generate the default header that doxygen normally uses. # -# Note: Only use a user-defined header if you know what you are doing! The -# following commands have a special meaning inside the header: $title, -# $datetime, $date, $doxygenversion, $projectname, $projectnumber. Doxygen will -# replace them by respectively the title of the page, the current date and time, -# only the current date, the version number of doxygen, the project name (see -# PROJECT_NAME), or the project number (see PROJECT_NUMBER). +# Note: Only use a user-defined header if you know what you are doing! +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. The following +# commands have a special meaning inside the header (and footer): For a +# description of the possible markers and block names see the documentation. # This tag requires that the tag GENERATE_LATEX is set to YES. LATEX_HEADER = -# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the -# generated LaTeX document. The footer should contain everything after the last -# chapter. If it is left blank doxygen will generate a standard footer. -# -# Note: Only use a user-defined footer if you know what you are doing! +# The LATEX_FOOTER tag can be used to specify a user-defined LaTeX footer for +# the generated LaTeX document. The footer should contain everything after the +# last chapter. If it is left blank doxygen will generate a standard footer. See +# LATEX_HEADER for more information on how to generate a default footer and what +# special commands can be used inside the footer. See also section "Doxygen +# usage" for information on how to generate the default footer that doxygen +# normally uses. Note: Only use a user-defined footer if you know what you are +# doing! # This tag requires that the tag GENERATE_LATEX is set to YES. LATEX_FOOTER = +# The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined +# LaTeX style sheets that are included after the standard style sheets created +# by doxygen. Using this option one can overrule certain style aspects. Doxygen +# will copy the style sheet files to the output directory. +# Note: The order of the extra style sheet files is of importance (e.g. the last +# style sheet in the list overrules the setting of the previous ones in the +# list). +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_EXTRA_STYLESHEET = + # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or # other source files which should be copied to the LATEX_OUTPUT output # directory. Note that the files will be copied as-is; there are no commands or @@ -1681,9 +1984,11 @@ LATEX_EXTRA_FILES = PDF_HYPERLINKS = YES -# If the LATEX_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate -# the PDF file directly from the LaTeX files. Set this option to YES to get a -# higher quality PDF documentation. +# If the USE_PDFLATEX tag is set to YES, doxygen will use the engine as +# specified with LATEX_CMD_NAME to generate the PDF file directly from the LaTeX +# files. Set this option to YES, to get a higher quality PDF documentation. +# +# See also section LATEX_CMD_NAME for selecting the engine. # The default value is: YES. # This tag requires that the tag GENERATE_LATEX is set to YES. @@ -1691,8 +1996,7 @@ USE_PDFLATEX = YES # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode # command to the generated LaTeX files. This will instruct LaTeX to keep running -# if errors occur, instead of asking the user for help. This option is also used -# when generating formulas in HTML. +# if errors occur, instead of asking the user for help. # The default value is: NO. # This tag requires that the tag GENERATE_LATEX is set to YES. @@ -1705,29 +2009,35 @@ LATEX_BATCHMODE = NO LATEX_HIDE_INDICES = NO -# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source -# code with syntax highlighting in the LaTeX output. -# -# Note that which sources are shown also depends on other settings such as -# SOURCE_BROWSER. -# The default value is: NO. -# This tag requires that the tag GENERATE_LATEX is set to YES. - -LATEX_SOURCE_CODE = NO - # The LATEX_BIB_STYLE tag can be used to specify the style to use for the # bibliography, e.g. plainnat, or ieeetr. See -# http://en.wikipedia.org/wiki/BibTeX and \cite for more info. +# https://en.wikipedia.org/wiki/BibTeX and \cite for more info. # The default value is: plain. # This tag requires that the tag GENERATE_LATEX is set to YES. LATEX_BIB_STYLE = plain +# If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated +# page will contain the date and time when the page was generated. Setting this +# to NO can help when comparing the output of multiple runs. +# The default value is: NO. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_TIMESTAMP = NO + +# The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute) +# path from which the emoji images will be read. If a relative path is entered, +# it will be relative to the LATEX_OUTPUT directory. If left blank the +# LATEX_OUTPUT directory will be used. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_EMOJI_DIRECTORY = + #--------------------------------------------------------------------------- # Configuration options related to the RTF output #--------------------------------------------------------------------------- -# If the GENERATE_RTF tag is set to YES doxygen will generate RTF output. The +# If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The # RTF output is optimized for Word 97 and may not look too pretty with other RTF # readers/editors. # The default value is: NO. @@ -1742,7 +2052,7 @@ GENERATE_RTF = NO RTF_OUTPUT = rtf -# If the COMPACT_RTF tag is set to YES doxygen generates more compact RTF +# If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF # documents. This may be useful for small projects and may help to save some # trees in general. # The default value is: NO. @@ -1762,9 +2072,9 @@ COMPACT_RTF = NO RTF_HYPERLINKS = NO -# Load stylesheet definitions from file. Syntax is similar to doxygen's config -# file, i.e. a series of assignments. You only have to provide replacements, -# missing definitions are set to their default value. +# Load stylesheet definitions from file. Syntax is similar to doxygen's +# configuration file, i.e. a series of assignments. You only have to provide +# replacements, missing definitions are set to their default value. # # See also section "Doxygen usage" for information on how to generate the # default style sheet that doxygen normally uses. @@ -1773,8 +2083,8 @@ RTF_HYPERLINKS = NO RTF_STYLESHEET_FILE = # Set optional variables used in the generation of an RTF document. Syntax is -# similar to doxygen's config file. A template extensions file can be generated -# using doxygen -e rtf extensionFile. +# similar to doxygen's configuration file. A template extensions file can be +# generated using doxygen -e rtf extensionFile. # This tag requires that the tag GENERATE_RTF is set to YES. RTF_EXTENSIONS_FILE = @@ -1783,7 +2093,7 @@ RTF_EXTENSIONS_FILE = # Configuration options related to the man page output #--------------------------------------------------------------------------- -# If the GENERATE_MAN tag is set to YES doxygen will generate man pages for +# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for # classes and files. # The default value is: NO. @@ -1807,6 +2117,13 @@ MAN_OUTPUT = man MAN_EXTENSION = .3 +# The MAN_SUBDIR tag determines the name of the directory created within +# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by +# MAN_EXTENSION with the initial . removed. +# This tag requires that the tag GENERATE_MAN is set to YES. + +MAN_SUBDIR = + # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it # will generate one additional man file for each entity documented in the real # man page(s). These additional files only source the real man page, but without @@ -1820,7 +2137,7 @@ MAN_LINKS = NO # Configuration options related to the XML output #--------------------------------------------------------------------------- -# If the GENERATE_XML tag is set to YES doxygen will generate an XML file that +# If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that # captures the structure of the code including all documentation. # The default value is: NO. @@ -1834,19 +2151,7 @@ GENERATE_XML = NO XML_OUTPUT = xml -# The XML_SCHEMA tag can be used to specify a XML schema, which can be used by a -# validating XML parser to check the syntax of the XML files. -# This tag requires that the tag GENERATE_XML is set to YES. - -#XML_SCHEMA = - -# The XML_DTD tag can be used to specify a XML DTD, which can be used by a -# validating XML parser to check the syntax of the XML files. -# This tag requires that the tag GENERATE_XML is set to YES. - -#XML_DTD = - -# If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program +# If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program # listings (including syntax highlighting and cross-referencing information) to # the XML output. Note that enabling this will significantly increase the size # of the XML output. @@ -1855,11 +2160,18 @@ XML_OUTPUT = xml XML_PROGRAMLISTING = YES +# If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, doxygen will include +# namespace members in file scope as well, matching the HTML output. +# The default value is: NO. +# This tag requires that the tag GENERATE_XML is set to YES. + +XML_NS_MEMB_FILE_SCOPE = NO + #--------------------------------------------------------------------------- # Configuration options related to the DOCBOOK output #--------------------------------------------------------------------------- -# If the GENERATE_DOCBOOK tag is set to YES doxygen will generate Docbook files +# If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files # that can be used to generate PDF. # The default value is: NO. @@ -1877,10 +2189,10 @@ DOCBOOK_OUTPUT = docbook # Configuration options for the AutoGen Definitions output #--------------------------------------------------------------------------- -# If the GENERATE_AUTOGEN_DEF tag is set to YES doxygen will generate an AutoGen -# Definitions (see http://autogen.sf.net) file that captures the structure of -# the code including all documentation. Note that this feature is still -# experimental and incomplete at the moment. +# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an +# AutoGen Definitions (see http://autogen.sourceforge.net/) file that captures +# the structure of the code including all documentation. Note that this feature +# is still experimental and incomplete at the moment. # The default value is: NO. GENERATE_AUTOGEN_DEF = NO @@ -1889,7 +2201,7 @@ GENERATE_AUTOGEN_DEF = NO # Configuration options related to the Perl module output #--------------------------------------------------------------------------- -# If the GENERATE_PERLMOD tag is set to YES doxygen will generate a Perl module +# If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module # file that captures the structure of the code including all documentation. # # Note that this feature is still experimental and incomplete at the moment. @@ -1897,7 +2209,7 @@ GENERATE_AUTOGEN_DEF = NO GENERATE_PERLMOD = NO -# If the PERLMOD_LATEX tag is set to YES doxygen will generate the necessary +# If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary # Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI # output from the Perl module output. # The default value is: NO. @@ -1905,9 +2217,9 @@ GENERATE_PERLMOD = NO PERLMOD_LATEX = NO -# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be nicely +# If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely # formatted so it can be parsed by a human reader. This is useful if you want to -# understand what is going on. On the other hand, if this tag is set to NO the +# understand what is going on. On the other hand, if this tag is set to NO, the # size of the Perl module output will be much smaller and Perl will parse it # just the same. # The default value is: YES. @@ -1927,14 +2239,14 @@ PERLMOD_MAKEVAR_PREFIX = # Configuration options related to the preprocessor #--------------------------------------------------------------------------- -# If the ENABLE_PREPROCESSING tag is set to YES doxygen will evaluate all +# If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all # C-preprocessor directives found in the sources and include files. # The default value is: YES. ENABLE_PREPROCESSING = YES -# If the MACRO_EXPANSION tag is set to YES doxygen will expand all macro names -# in the source code. If set to NO only conditional compilation will be +# If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names +# in the source code. If set to NO, only conditional compilation will be # performed. Macro expansion can be done in a controlled way by setting # EXPAND_ONLY_PREDEF to YES. # The default value is: NO. @@ -1948,9 +2260,9 @@ MACRO_EXPANSION = YES # The default value is: NO. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. -EXPAND_ONLY_PREDEF = YES +EXPAND_ONLY_PREDEF = NO -# If the SEARCH_INCLUDES tag is set to YES the includes files in the +# If the SEARCH_INCLUDES tag is set to YES, the include files in the # INCLUDE_PATH will be searched if a #include is found. # The default value is: YES. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. @@ -1980,7 +2292,7 @@ INCLUDE_FILE_PATTERNS = # recursively expanded use the := operator instead of the = operator. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. -PREDEFINED = ARM_MATH_NEON=1 ARM_FLOAT16_SUPPORTED=1 __ALIGNED(x)= +PREDEFINED = ARM_MATH_NEON=1 ARM_FLOAT16_SUPPORTED=1 __STATIC_FORCEINLINE= __ALIGNED(x)= # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this # tag can be used to specify a list of macro names that should be expanded. The @@ -1992,9 +2304,9 @@ PREDEFINED = ARM_MATH_NEON=1 ARM_FLOAT16_SUPPORTED=1 __ALIGNED(x)= EXPAND_AS_DEFINED = # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will -# remove all refrences to function-like macros that are alone on a line, have an -# all uppercase name, and do not end with a semicolon. Such function macros are -# typically used for boiler-plate code, and will confuse the parser if not +# remove all references to function-like macros that are alone on a line, have +# an all uppercase name, and do not end with a semicolon. Such function macros +# are typically used for boiler-plate code, and will confuse the parser if not # removed. # The default value is: YES. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. @@ -2014,7 +2326,7 @@ SKIP_FUNCTION_MACROS = NO # where loc1 and loc2 can be relative or absolute paths or URLs. See the # section "Linking to external documentation" for more information about the use # of tag files. -# Note: Each tag file must have an unique name (where the name does NOT include +# Note: Each tag file must have a unique name (where the name does NOT include # the path). If a tag file is not located in the directory in which doxygen is # run, you must also specify the path to the tagfile here. @@ -2026,37 +2338,32 @@ TAGFILES = GENERATE_TAGFILE = -# If the ALLEXTERNALS tag is set to YES all external class will be listed in the -# class index. If set to NO only the inherited external classes will be listed. +# If the ALLEXTERNALS tag is set to YES, all external class will be listed in +# the class index. If set to NO, only the inherited external classes will be +# listed. # The default value is: NO. ALLEXTERNALS = NO -# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed in -# the modules index. If set to NO, only the current project's groups will be +# If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed +# in the modules index. If set to NO, only the current project's groups will be # listed. # The default value is: YES. EXTERNAL_GROUPS = YES -# If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in +# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in # the related pages index. If set to NO, only the current project's pages will # be listed. # The default value is: YES. EXTERNAL_PAGES = YES -# The PERL_PATH should be the absolute path and name of the perl script -# interpreter (i.e. the result of 'which perl'). -# The default file (with absolute path) is: /usr/bin/perl. - -PERL_PATH = /usr/bin/perl - #--------------------------------------------------------------------------- # Configuration options related to the dot tool #--------------------------------------------------------------------------- -# If the CLASS_DIAGRAMS tag is set to YES doxygen will generate a class diagram +# If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram # (in HTML and LaTeX) for classes with base or super classes. Setting the tag to # NO turns the diagrams off. Note that this option also works with HAVE_DOT # disabled, but it is recommended to install and use dot, since it yields more @@ -2065,15 +2372,6 @@ PERL_PATH = /usr/bin/perl CLASS_DIAGRAMS = YES -# You can define message sequence charts within doxygen comments using the \msc -# command. Doxygen will then run the mscgen tool (see: -# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the -# documentation. The MSCGEN_PATH tag allows you to specify the directory where -# the mscgen tool resides. If left empty the tool is assumed to be found in the -# default search path. - -MSCGEN_PATH = - # You can include diagrams made with dia in doxygen documentation. Doxygen will # then run dia to produce the diagram and insert it in the documentation. The # DIA_PATH tag allows you to specify the directory where the dia binary resides. @@ -2081,7 +2379,7 @@ MSCGEN_PATH = DIA_PATH = -# If set to YES, the inheritance and collaboration graphs will hide inheritance +# If set to YES the inheritance and collaboration graphs will hide inheritance # and usage relations if the target is undocumented or is not a class. # The default value is: YES. @@ -2106,7 +2404,7 @@ HAVE_DOT = NO DOT_NUM_THREADS = 0 -# When you want a differently looking font n the dot files that doxygen +# When you want a differently looking font in the dot files that doxygen # generates you can specify the font name using DOT_FONTNAME. You need to make # sure dot is able to find the font, which can be done by putting it in a # standard location or by setting the DOTFONTPATH environment variable or by @@ -2154,7 +2452,7 @@ COLLABORATION_GRAPH = YES GROUP_GRAPHS = YES -# If the UML_LOOK tag is set to YES doxygen will generate inheritance and +# If the UML_LOOK tag is set to YES, doxygen will generate inheritance and # collaboration diagrams in a style similar to the OMG's Unified Modeling # Language. # The default value is: NO. @@ -2171,10 +2469,32 @@ UML_LOOK = NO # but if the number exceeds 15, the total amount of fields shown is limited to # 10. # Minimum value: 0, maximum value: 100, default value: 10. -# This tag requires that the tag HAVE_DOT is set to YES. +# This tag requires that the tag UML_LOOK is set to YES. UML_LIMIT_NUM_FIELDS = 10 +# If the DOT_UML_DETAILS tag is set to NO, doxygen will show attributes and +# methods without types and arguments in the UML graphs. If the DOT_UML_DETAILS +# tag is set to YES, doxygen will add type and arguments for attributes and +# methods in the UML graphs. If the DOT_UML_DETAILS tag is set to NONE, doxygen +# will not generate fields with class member information in the UML graphs. The +# class diagrams will look similar to the default class diagrams but using UML +# notation for the relationships. +# Possible values are: NO, YES and NONE. +# The default value is: NO. +# This tag requires that the tag UML_LOOK is set to YES. + +DOT_UML_DETAILS = NO + +# The DOT_WRAP_THRESHOLD tag can be used to set the maximum number of characters +# to display on a single line. If the actual line length exceeds this threshold +# significantly it will wrapped across multiple lines. Some heuristics are apply +# to avoid ugly line breaks. +# Minimum value: 0, maximum value: 1000, default value: 17. +# This tag requires that the tag HAVE_DOT is set to YES. + +DOT_WRAP_THRESHOLD = 17 + # If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and # collaboration graphs will show the relations between templates and their # instances. @@ -2206,7 +2526,8 @@ INCLUDED_BY_GRAPH = YES # # Note that enabling this option will significantly increase the time of a run. # So in most cases it will be better to enable call graphs for selected -# functions only using the \callgraph command. +# functions only using the \callgraph command. Disabling a call graph can be +# accomplished by means of the command \hidecallgraph. # The default value is: NO. # This tag requires that the tag HAVE_DOT is set to YES. @@ -2217,7 +2538,8 @@ CALL_GRAPH = NO # # Note that enabling this option will significantly increase the time of a run. # So in most cases it will be better to enable caller graphs for selected -# functions only using the \callergraph command. +# functions only using the \callergraph command. Disabling a caller graph can be +# accomplished by means of the command \hidecallergraph. # The default value is: NO. # This tag requires that the tag HAVE_DOT is set to YES. @@ -2240,11 +2562,15 @@ GRAPHICAL_HIERARCHY = YES DIRECTORY_GRAPH = YES # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images -# generated by dot. +# generated by dot. For an explanation of the image formats see the section +# output formats in the documentation of the dot tool (Graphviz (see: +# http://www.graphviz.org/)). # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order # to make the SVG files visible in IE 9+ (other browsers do not have this # requirement). -# Possible values are: png, jpg, gif and svg. +# Possible values are: png, jpg, gif, svg, png:gd, png:gd:gd, png:cairo, +# png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and +# png:gdiplus:gdiplus. # The default value is: png. # This tag requires that the tag HAVE_DOT is set to YES. @@ -2287,6 +2613,24 @@ MSCFILE_DIRS = DIAFILE_DIRS = +# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the +# path where java can find the plantuml.jar file. If left blank, it is assumed +# PlantUML is not used or called during a preprocessing step. Doxygen will +# generate a warning when it encounters a \startuml command in this case and +# will not generate output for the diagram. + +PLANTUML_JAR_PATH = + +# When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a +# configuration file for plantuml. + +PLANTUML_CFG_FILE = + +# When using plantuml, the specified paths are searched for files specified by +# the !include statement in a plantuml block. + +PLANTUML_INCLUDE_PATH = + # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes # that will be shown in the graph. If the number of nodes in a graph becomes # larger than this value, doxygen will truncate the graph, which is visualized @@ -2323,7 +2667,7 @@ MAX_DOT_GRAPH_DEPTH = 0 DOT_TRANSPARENT = NO -# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output +# Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output # files in one run (i.e. multiple -o and -T options on the command line). This # makes dot run faster, but since only newer versions of dot (>1.8.10) support # this, this feature is disabled by default. @@ -2340,9 +2684,11 @@ DOT_MULTI_TARGETS = NO GENERATE_LEGEND = YES -# If the DOT_CLEANUP tag is set to YES doxygen will remove the intermediate dot +# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate # files that are used to generate the various graphs. +# +# Note: This setting is not only used for dot files but also for msc temporary +# files. # The default value is: YES. -# This tag requires that the tag HAVE_DOT is set to YES. DOT_CLEANUP = YES diff --git a/Doxygen/gen_doc.sh b/Doxygen/gen_doc.sh index e83e3621..cd54912c 100644 --- a/Doxygen/gen_doc.sh +++ b/Doxygen/gen_doc.sh @@ -5,7 +5,7 @@ # # Pre-requisites: # - bash shell (for Windows: install git for Windows) -# - doxygen 1.8.6 +# - doxygen 1.9.2 set -o pipefail @@ -22,8 +22,8 @@ if [[ ! -f "${DOXYGEN}" ]]; then else version=$("${DOXYGEN}" --version) echo "DOXYGEN is ${DOXYGEN} at version ${version}" - if [[ "${version}" != "1.8.6" ]]; then - echo " >> Version is different from 1.8.6 !" >&2 + if [[ "${version}" != "1.9.2" ]]; then + echo " >> Version is different from 1.9.2 !" >&2 fi fi diff --git a/Doxygen/templates/CMSIS_Logo_Final.png b/Doxygen/templates/CMSIS_Logo_Final.png deleted file mode 100644 index ec557ff8cb86d8c428290e82171aac4b7a421000..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 5823 zcmV;w7C`BVP)p6AlSBZHrs~000(VNkld6ZSvo$o(;pXm-& z6q5*uB!+}R5Gkq<2Z|C<3q;e zkx4;|LK6*Cfg+MPU^GgrAXQY|;Y@qKKTZ`EP{X}dC20D7)^aU5XYb$M`_}jFbN27| z+xtR+0tE^bC{Un4fdT~z6ev)jK!E~ZVirGZbIZ!!N4pyZIz}Ar4z%Wx-6T?td`)Wx zqZpt=8~|a`WWesM%XKF2)CUF)j=_ zTZNpd6k~;8pdG`M28ia~X$_$do=cOE?2wW*VaSv7NAh}y#v>svr>JBuT0p^xG2idzZRHi`Ut^*co8va zLN*0qbA8i+;(qYiN8EAsXs$zRSn|T-Z3?lt4>Z+3jTDz~^_0|+7<+--F~8^r?%u(< zhRv;sVn$^eq4Bfmx{we{M(>5$6uUExyeI@OXrHZt$F4y(4Hu5V2e^MT@vxYI*)(NB za6W?B$vzaP>Z2L5X&-LfWFu%;THW@H*doMZKb_0GdFs%97C8ERVKd{6+pz|j+-k?U z2BO&v9X)#E#o%W_E7qxihs`9bFB{6fPD~zP>01o5;HQZazME;plRh&p9mxikyttfX zuL}!8{A%)ri1D`V3`@p%G}(*On)ZPTqLyMs(K^D<@>>nRxM~EOy3@|RZ*jdD@W;zW zv9ch=6EtYIv2?yM=`$PWur&DoztieT#1jnBBSV4$?9rTzO?|h9}@gz@3iRq@J zg-NnEcp2VzUH->{6M4R;+5$Ru-xP%Sm83_+xcGI>izitDm|i9lVsT%{?C0goe!g>U zIUn>yI|s-`h}TTLphw#*@P#A0Yv8W!Oh_bnOo&!O><6g^e*33goPETFm}+>6Yo=cC z=(`MGx}9W?w%rYeR8%-!tvhng9BbsrIaW{h=gUa9{EWBnV4!XBv|*7b>MbAOIN&Vs2XS( z#yvua*_P!XqyPHS2!YR$as3QOAyzWipxTf!o_EGxpS}gRPiz zuN3mzmhB)!i~RtjWMExc#W|O6saf}je8$(BEO7(~C&HVmr?NvmIx27=(T{n|URZPA$u(n;y!h z(;Ix>+hbaGUpp4R!WPEnag)#bW?Qz(r%mgN5JQyK3-axU^2{IF@kAeBP)FrXJMH`; zDOh9K&TIfTllomYo%&TKlUnKdUdpnZlTB%^E3Y``v^EXs=x-)ax~s)x$%|LC+0iG7P>SuE`E*iPJ$a#`vDD30^BrvG9DNFXcA3b z?M$2GvRL_K%G?+BQL^JBo{1Hca8psZQK+tcDaKb+og)q78OyTczUyWX+@_^^sIGe5 zJFUx|d`4A&&-Z3YU;N04#lPvMn+5=HA8Jqg)=(iNhLjV_Ce1i~%cj*Y=hBagic6d{ zAJ5lXBM{%}sH|%R3mhkYvhQYHrSuPLYt}AnxmQ+s&Ir%VK9wjc9-VI7zYsWlb`&VB zH3-qB7!BXL){4i+_@0|liXYV0tbL;8Ug_j>NBVB|=|oZSs8r+rtAJN>8Q-DgKQn5O zlDq8~M&LzhT~dOZ;_t5;%dP|EZhYM0o|=U$UTk-zV?gfio12Ax<3qll=uL^$oH$`c zt>*p3D4S9>TpIET)3oBA?|uM!^5*K*|L0I40&II}?Vj4|)emL^F~Re^$I-IwMTTOS zGz^54AoO*)_N7UGdXZ_{UsquO(B`b$g3xM~5CWycf2*xov#j;KE!FG(s8x7LHl6+# z(^FUG+Wx^q;M)RFDtxeZciWYNyuW53-r2pL@z!*cJQGg_&{5n_SYXAE!3$ zi~K^#5@^`NJqyRN@<5?Qiv<0TSw^1$bJ#Psf<<~RH@E$bYnMFzh*q3k*)$g_pJ9g0 z38BY;j7#20v^wBkJLdHAU3Xs)>Z)xot$DMvI@@1*wjP)_=IpZ*Z59xEq!5BI@Ii=g zmz`cUe9Oyg|J0$;*|VkClfF(X9evQ6VeJ(iT2*E1j2NhtLJC>kR+-vO>uQ18&c@Of z6DM8}3rG!AN?{;2v{k10U9rpWi;$-nZ+)MbY~&}tOZ0e7LQ_3|7Vvp);36#;@WOJ6 zO6KtChfvh}0tUSJIE(a!ISaB24(-c_u^)JXZcsj{YMQjHsY-=_zCITrwr2Zt&!yYE zAs7*53kxjEv^?!D1m<_xm%Ztk(y~v|Dg-S6J#4H9si z3PXg@U0Mycg_Dv)q!h<06}U9*{vAR;5Z#eijI69|+YhR_!Ll5b*8fqraqaH~G#G{j zhWJK%?QCAZ{xaz_DfH%DrJ2oaMXO zl~M{EC;qoWu)eHv#-{ShbHCqR`;dni64xDv zZ1fuRhjEjtx;0a7efjy_o2yr!?+3woo||2#(Kt^04AV3pHF^#DL+PaH-I^(L5@U0W zx5{mPJ+~Z?nupqTZm-BukS%mWh_~-xpk?yvprLHN?=7yo{~eBBv?%`s5NU)8qVZ@Y zyB)J{K}a#eFiZsceTY`xO6iA$kf8OovuDpfsI4#zuXmid5rlsA=9*Q_{y_0AfIxTX z-f5xs#kH$8SFfHS!l1%+Gs}a($Fl8lmT5j;S~26o?vAOpdiArLt5;QN9ag&8^pimt zVA=LK)0FGRO`6{21eKgVbP1=#k_-&IXwONi0ndP^I;_;0Ad|i3aOe6*S-k!ck|kY! zG&`Ehi~3MxT8v4Sa9iN9^|*^Wj#jjV3d21b-DnsF!sPgT>vzBiAp|Xg0x&R_cy7kE zZ0E%HKh2)sa(&#CbB9VPz7qsK2>pwe>sshtS}Qc|Kc?H_)s1U6ZK+=U9i_tx-*w+M zOcN>e17oM2JGdtXw)w?18@Fs+GnYVBdanD9VOoYE#V^O5epcR}KjbJzB{{>2MT=uQ z1}bFh6(`a8zT=Jr*;Ehl#P^9ME~cse;Cnd=@t&<5BMq*}HiFv(fe%_y_u+7M=Q6I= zYe1Eq=1prhDy3%!ftR)%r^K+V zF0Hn65~F}J6-NJWMv;x0oLlHfklA$fUu*JMtb_(XP4uR(??xNFQ~-wLXEzJFv=SDY zHE4|x;(`eirWbd`Mr%q-FEfD?lnN1wgCaOuiranH#WL;5<14C4OG`^lA;k~1QV8U2 z@cC-q5b}d&m(YNuYj3R9FMT)b zTDEg+7}r1Vyhg{!qCXE5njv8jpmgwF>w9(8tG9$<@Vsf;2*ee#XyE0x6YuL~Gw&ry zEpJ`cbN!FPFl;nT%kWfqn0u$J;+zSmOg-<$(#ch)cGw{yT?7b`U(9~|ndhD|Vam*# z$|}y8(4l#vEhSNqJAXPAuP|;ol9~p*$ArB7=YQ%l9c=Dfx*6qffCr-Q| zrnMfUl|rLC4n-b}APgUfCyIWe5$*a$o843=X{A8u{PjT&ViXp|T9edaln~*2cxd)^ zrLlGe*#$r1f)n}d%8}gYyG#lLw)q+EyLt@Uy40^$r1uoxXcVbpC^S`qlEl=>+1^jEyFZHu)F@F#9?vr%^O#*34Cv>Vc9XmG>bjg-Q$Jw z-wrLeV#NxD79WcC+&hAYe9uKn^TM)8XP@3yAAP&&Cd+mPd7c|$@N8$FLn|~wKJ0rg z(lEZ;-t3!Dv7eZ>Gr)7Rp(5452npy1o0BfuK<@(3ZKRUv zUe<$dL-r~s78~iidgb`ZRW}(*uJM)MByIb6snn&?FfWtRKr3%)ZFMI}8i$Y;>H9@i zUv9@@!|}4umQ9*|lSHgNU|;LYq%%xO_Gf|bH(9ax*BmGQzoj&*WvJdV zef2hit+r*~@5B<5RT$!Cvk&{i+}YZW5R{vy1zNOwreu=Ta^Lqq3Iku6LM&~soPZAu z!vq-1A->7Fl`As{G1vFpKijcbAKQ-KrKJ9oG>x|n#4C0zewj23JU9FANmAFh-GVMM zO$#{uZ@aU)I;AvoeBb-Pa^iihn6u=7eIZ`4o%p5FF!0^XvLvZ4zbbV)GiC)T2eLwv z2m`PjY~Q0l&o(6Jav(pnwk)}v3%0ZU-_PU zvDUf@tw#z(Um-y$mGZspJ81Eu*5R*f+e)|B@*Usvq?CG12kp4yE2g}Z!Ri}E{?Ege?9xzl2nNTWh^xSMMhzGZ9T>a~I z2dt^~eeYx1NDhW*wLJFJsiy)zM(dft*QAgM6@-nh%5KqG|7-2WHUHkO{T%2tQn7qF z^3ySFcM^>9GLR^NbOV>nKaoef({MiAwT($m5$goFP4%30qy%{=6DOY2M_ERHw6e4* z_vW$@D<`{C&l`{p{rI-(wSVpjdsS6c_TIoePGp0)bo@Q9Y}oKgPuOj3{}V4h#Pl*T zBcVS1{d3Rt$lxqus zy_1vfdy6ORI4h*Vu*SX7S>KiuEt(oX6s@{{E`bT|4;m?wyoN!IeVty;u?_-4M-&h)9HfhP3Z;-Tcwq-xd1>zB=S3#s{|3 zC$M-mR>U_`&2fTw5%?}4g8Rde`#Sw?7GUXihM6&@qL>Fvix)+Ula^!*D;AyWm}%nW zY!mYrj$>=yBP;NgBkzppJGU}AUc~cGf`O@hQO1m6M(1>=8wi!+RS7R6`J+~RqN9zL zG2nP%GEyr_ficMv92J6_`uwLi3=0y)kZxkH4!LFBR_^HWGkXerY3b7WjCZ}p2q(_+ zLYHaY5oLkfv1oy#RFrN8(Mq_*H5B*|H2?Te3sx*TA|=~MlZIc0S#F(w5`XFD z*b02b=<;EqH@-k}@DP431Xsn2urke=)(54vik8C=4!$l#Bv?BhWskdQJ^+@vS^jll zE*azn{wnGA$+h>q!8kL<P@q780tE^bC{Un4fdT~z6!>q({|AB8L{zOp@@oJ9002ov JPDHLkV1h|lb^ibW diff --git a/Doxygen/templates/DoxygenLayout_forUser.xml b/Doxygen/templates/Layout_forUser.xml similarity index 69% rename from Doxygen/templates/DoxygenLayout_forUser.xml rename to Doxygen/templates/Layout_forUser.xml index 39642eef..222d4718 100644 --- a/Doxygen/templates/DoxygenLayout_forUser.xml +++ b/Doxygen/templates/Layout_forUser.xml @@ -1,36 +1,54 @@ + - + - - + + + + + + + + + - + + + + + + + + + + - + - + - + + @@ -65,6 +83,8 @@ + + @@ -72,6 +92,7 @@ + @@ -81,17 +102,26 @@ + + + + + + + - + + + @@ -99,6 +129,14 @@ + + + + + + + + @@ -107,20 +145,29 @@ + + + + + + + - + + + @@ -137,9 +184,12 @@ + + + @@ -159,6 +209,8 @@ + + diff --git a/Doxygen/templates/cmsis_logo_white_small.png b/Doxygen/templates/cmsis_logo_white_small.png new file mode 100644 index 0000000000000000000000000000000000000000..0f3d64fe1afb1fe91759f36cd4cfc69b4fc3d8d5 GIT binary patch literal 6816 zcmV;R8eip!P)Px#1ZP1_K>z@;j|==^1poj532;bRa{vGr5dZ)e5dq33^FIIp8Z}8oK~#8N?VSm@ zTt$_~A#6!xHxSlN?nkEn-&f!5d+Tgf_nfY}b*t(w z7f>5M`sky<_A?+Lpb=QKXwm2;OP2g(>C&aU+NFSiWeYg>hNL}66G-32;V=8}!w;vD zZY2F1L2x72u3Wr$@wrCxx%T$9fpv$J!3ockaJ z6psB6PCj$t!i955y>j*>h=%kYe6PTNJIC?e-Q63T=&I4x)wMG+UN-R#oWF#9pEZ(z zfKLu^+@Z8iV+oEaYCZV9*!;R~C{U4m1p!!9O9cIA`vzGNTz?Upw>8p$fc_0RD^7b6 z>6xCMp4@^f3cbC(vkACM(Yc|ikA+$+Y*IHd7UZjC3(sr;{TDdsF0?e);rxFyzik=_ zkmu2TfSFPOwR{R9BToc@`*X^&y0HcX^bgP_+!`nUAesT@zl zx%c4maMF6DH3{B990%)nM@Pp{f^0at_Tl>3@I2hz-MxUkSU~eAv?FDsf(#vhu&hL2 z$6N3n)_1aCjdIkM^k~rcPS`Ili}C9v(-#oRY24V1jKIWzaE)$3erCY z*MEWRjYP|FYxGUCtVAH|9q7k6B>@4ghFTw-_qXPssoRPTIxT8xGVC#zxm#a@>L- zd#+$jGW2H{vQt8@~#&_wprGej384> zcDVRBu1y-l<&~YFWdxLG4N}=8>byXG4I+KoP6O%%j(aXnxm3;>1%hxEX+I-x8E8>Q zU~8uNm6T@=HXkWIIShXk_rUuCzgKa>nh4ApNE(I>yP{uH(011m8@HW5fBstJ)x1)G zG9H4gv+XojP+t>BC)sJuQ2DTNC~1_+twdey%yDfa$qdONtw35)N4s1VBt!FPOYPxW zP4;94!Vlwyx1%T$k#GW=_EV@U^VM#rX>l?t7Yz9T8rSt|B`COFH#}ixC4x%Rnz&++4W@i9$OL}R zQkk951_3oIW9xWs*dx^6qJrjZP#H-Ru`zS23;jiu8J4A|+NE4TT^%5sD92qKs-8xN zJ*&fe6?M=lIZ2Sya~Nx^iJ-j46u6v!&gZbRWhDZ8K8-y;z?ZVv^BO6i=Xw-tYSjZK zy8;w~GA+*a=G6jB8IB#9S~6^&N4drspIWl(3poYQUHKdN4cik0*;`Sk_e2F4!LWqu z9oX=elKqobbk|ky$hd=_nOZ1h-6lTj=<&I8=jJwX8@cyNF1BbzL{+OTU>gkIt>P~Q zPEL^*zD;UVIqk9o=L@)BN0^9Mh^ELZS=g4kq0;Qxv*qh|Iz=VGo)2{|kT(ZeW%h8s zfI4-5*mVIRXPL}MP@wM_Y0E$*ZbAk9+Du9Wl{KF-9V0$YSM3{Q0+l)&ncFzwIRkwM zlKyO}Jh16i%5WWe$Dv=(Xd|(8B*)K@j!_;oW&4v!O>`_E9SrX;#e-ukge{kU zVeI@ovfOHU4zne!J8dzzT)A>(9ZL0lzJ_+K0vGLn@Q=pV)n z^UGk8Kv^_||5anv%{bDs%AksaF83A(d= zH!Ld>$gV2Tv@Ib#uQ}lWeOg5yJLZ7ANyzOs@{c$_&9bV4ZUp@QSrAhRRT4Ct7RGT%Ps?D(=*x#Bg+NclHzc6C|=^U_5p_XV0h%L z_Q{hc>!0poXf!%=fnClW=-(LmkD5t|z?KEjmj#)?wQrEuM)Lnmg8t3O%Wd+r_5FWg z;vLX&_kslrYJT^Gh=JI6F2^t0rC8t$2bVgLz_pt#yCzVcOH7mp_u~}HP6g#Z-`G?a z+V5pE%Zi2W2`SSbV6}mU4d*#y0K5w3R6QLX9qXc__CI8lXfvJIr6g4Hl^iPG>2PfT z248@3_mEHJ^&;mS%gznhw-IuGB^_y?lGTzOXRKu)dkC_2BOO6H9oow&n>PKqmb~0v zSfl?mWcvXP&YwWvP|L0hh)cB-ePva?5LA_mSB&mS^Qe#tn zJc-O)UwBs=XxK2>83XwJG>68&-a%1hmr5Y-WsF|eNXtOp`4p~f;V0({xt`mLQbg*R zEK^Gc=40ywW6cD3^rCYmJFOeYS`T~u(j0F39Bdk8*-Zff@B>p{2K`|gNmao9b4)}T zkf#y5Ohf$m#YF`!*Mhu;%v>j)*AQqII%9zB;h8P+u_!lS&^jo6)pV9YK}4P#7B2-^ z%d6=nKeDT-0)t6LUNgG7x;Ery{*Q@G1Ufs>`88v08L;8F($)<8t7SC>dZA36-7m%1 zv4rIR2yv*H^g4zcX(qrngfjVo75Eq7l&*YSe`3ar8JPxIpgk5_ih;0%^IT`G)DUR0 z$CX2Nf!upyWguYGg^COql>aw}vVVKdbtCnb+!ZPgUZxW|5nX!5FZaOh7$j(arV*oH&j zqCYjA^ZRvuq{K)Q!Ts3~S^f_l8G7xaS4p|_CaMiI^3@&ouU*WZGx?cY@5aM!O5_|t z6ze7G7mU<{ECreZFck!wnzplyH8ZFLJ(Fc^$=abm-dI}->{uVWUoq3vwbJX5{BK+W z&^KHGA^jZZV$&$>@Y_yc-ygV^>G=rqHK6y)qx2^N?=Hx7TME*$sjHrO9~fkvSPTY1 zzg0&#{DGX-G(WM3Y6DHco|B<1wPz9b+z+oNndi586viEjqR8n$D7>9Rq%sWAo+0-Y zD3gJF;5n={Xj@vB+}09oSJ83-@3z& zssjzu0i^H37ikZ^RkJ-F$XfwnksIuws6#i*NFzZ(v|(!ORIO52%XX%*#sbpykojJ9OViVhwF1b}EQp^Qc_Oe|FK+8zrja+W|5P(k zHfmN%Mc2F0;C@_YCdf(DGjOkEIG*Az0`7$(ByqPd@-+>~&CKA)>C%&Rol`wJ_#Owp zuXYSo0+}OaD-K@q+Caeem+_Y~(3@$+em#LEKref)K+Y^@Kp)5+Qf7NRVDc4T3XEMu zUgUeIDA;DDnOZhvYZS90*f3sQ(VrPvBB;b}WVoB21;}29%G3O{uj#j4ZU~U?=kj5v zo{#phtfql_^pj-yeZ5^S)`Nferw;Y}82cOouV&{vK>I5EZcP@anxLR%C=LXJ)BbA(QTb2Xor7wH62~us-kxGC} z^=Q6Ds`xGfWzq}o#JQom&v^t|5weGRkUbR>Ik@(_OcSbQG=@d4HzQ!KF|w+F%yr?- z6fjhX1~HBo568s)NQ$8HG@Nc%0yUUY^=xU%azIo$1@iP=>Rdmtfvz2SXm;>R{vPTZ6 zcNuP#Y+t~54~M!Z*IKY;8m3PI6{aAI9jQzLe8<4=-yM~LyqD{lNgoG9uSmIXC}=6% zaME^`-EdH@@0ewl4H04d_mZiK~98(|gZ?5G^eo-p& zs-BdP1&G$G1pj?;>h=N4sz8$hZFTfyvPZ^i?%Fd2(sEE?We?Bw0HZWOQgh3uAVEe= zK?a`|KE`%S$*W0j7H}gp383^}`1_XCaNuZu9~AWdlzRA-Wt9ON_bdHpraoMtaMTne z2g;xsH=lP5eV`dd$S<8SlKHtF^2{TYqD8i!7=e9SdK5W`RcoL@Ue$;x_V_Uc?9pWR z=s`7%*ao9220~;c*YnwU#6V#;!mvzJsY-#38p1!r#8d^?b#tyRNU8*KpT(|*4fCU7 zO_JZsgtF*;TEj;lQKj9fd@q7JxQRog6L4MKYJXqg`wcd#+v}&}ksmv3&vgwl`BstN z_h~Y-WtV|$Z2`9>vd2O9BL%r-r9!;$_}4zvrGGEj7g+<1?3Kvd%Ivw8-?6K_qX19o zJH%LfrNL}=N|QB-8biUec}4WE3B z?xWD-r?zpfftR|sDno{5c|@)>CQl1v{qh`sUuap8fd0s$V{+6Qz6Y^c+wr-IY z(W9NY9N>-YT021aB@C*V->3p1s3BXf5p0@?U$){n3RIBh)8#T!$8*GRblxbLCSDGq zu5811Bu0n+iQO(#MVK>Iy^TQ;@M^aC4ICr451^bo(DnC2;+!Y`p&&;S%KfygQs`ch zAKC3J0$skFiCwd(@5nzA$3bAE9|IxUt+%cb$0T%jcMqe&-Ofx=z%KoZ=KfHP-0@WAU$_Z+ z50|);Ql3yt4Fv4HMql6%fWmnI?XW?2;|4FZ94b!!txW2wLOq4OiSsM3bLBQ3iEr8=NZ zd`2@`9|ZWNX1XNWqq&ZXkphReC%$2V;AEpM140`5>>?n4V+vKVxehid$m(7w8V6)= zi<+^dsvdmn1?Ae7dUX?Ui%_so2lsNb59Ks=Mg@7=e{x^aE%>qP>LV|97c6M}JWHJZ zO=wdG1CX@=@_koGkRNbJ+z3a2cW-pKcXk4Nez&o{m@{Y2YUKMrS?Yi)Sn@+;M6PAy zx|a5o{VAjC3d@d!1y80xgJf0Y`&Iizd-xf-XC^(e-H>1QT|nrs;1IvGhXO~=apd|l z7}xL*7obA}B)*VTin@zsQ+$>sw70i!NqH*#6WuIAcr zp_ymo4%C&VphXU>z@vR#9N>Kkx=g(j_%1d!2Y6FgSqRA2Zq~DmO?>BCRwN+#BKG^8 zxdixMLjUE+I*xQSNoBtYI=x8uK(?klC6=d}Koj^g`a)lO(4%eGFXuR(Q}sMfLGEo4 z_B^G>Arlo1m?j#18DO4Oisc6Mgk2^qfCxre3i zl&-U^SiqwJn9`T!4(MMRS9WwfM_y{{Y=Kr>JNFK{QhAWA?F_25M-5W?vo;1DS~RE> zT>mrIbKTo82^gyn1|Em%nkV-nV>S4j+8wM11k0|}^YtWsR3j6hok6;W8^4o@sQ_de zN%Jea(eodcl?ur9I>c>^ij0fwaw^1!P5xaPyn3aP`s_(r_D5ghM=b?>aSn7-=n`j| zDUbeRja9r0XmK*F{Kkj&hd1^64an5zm$kEWwwe17j;4YtHuRSuZcx((3+e^s*p3Q% zoYd6$gn0nl^})pBaHMNVkMR3NZsK1_uk-t5uKkMiBkt2UZcXY49W<*Va{@_S(9^k( zRn0v_?|vlB5UH4Ml?3q>b&`(8j!e_dpw&0&wC(w=l=m6r=+C5B_J_&4kTO)Ya~M3E zlTIUPtG%z2GOs`pt=*5?IX;Um(@X4m2$>gDYmW@l4!VBQXb}XOb|$LW@v1+9GU$6~ zZfF|2d-&b3fs{srBCJf(OYUJB*`jP~XWdyUFGxRn_vSd*E;R+{)A!LnMcROtYg5kk zO}M7+u~G_j56I0PglGnU+a)OiP2C!;7GVGO*k86rh)U7MB>%|In!BL^0l7lXh*RF} zJhTsRV9kMC%Sihj)Kwu>?Cl`Xvh~u;Ul}!65D?H35Kw2+|F3v!Eoa4%#~4|^0xj8i zY<9aZ#eqMNx1ek22L%HHG6QGag`lb!))a774HNg9E*Q3~MN4%VLDuCAi~;#?Q>K=G zv_2rf1HW96RxNTm6wcaBtCqM!QnSDx!cN$kI!6+Fwbga%=ZpdZnhu=!1oP7h;JDMY zX^xRL9oVKRJKv;rE!(Fd3edd@T~jx~2?)pxoLQrf{>^@0&|TB!HBB9676|gu=+3lY z6#E~i%h-@l;syld1|0Py^VtdzWD2&cn)ObHfY}j!Q{$c;`vTg#u(4&WZa_e0;HazP zu!)N@$-e`-hI~5;@hc)*0d@@mHm9I575eJO`Ee_H0|NRbaCChgq-+**U#N=--Ld*) ztg+PvWNFvj!w`Kty8Tj%G?*P>&?DfJ2^{$No}Qk_ugVlbK*WL{_o zba!`eOpqK(fL(=*=V`(G<}hhMcMrO!!r$1hG6n=R8aThc;OSSv#sR0-CO)s@`1j!W zXY>2;-rnBbxxNkOTa)zl{++o#hTq3S_b;Re#iM{RF`0o~nslnx?-MgiKOi6$a%2MJ zJX*HMoqdx4PX|HNX6aqdKOm(BZ4wBs=>(bPFE;)o-T?v427xk>fP16h?#&0fXA@*v zbsM`sL_okY0i1j%x_dt(=n|jX@&bC)9sLt6*krn|VXk7p{~r)+gK+$bq{wev=K%uj zZ36lMbew>`rfj1S5YR6{JPaWqv>Ntqj)|`U(tr$g4d38+Kf!gT22Hr!w2wdp1oV5* z;;cfqZUn~(1j-Zw<(G8#W)ghwklrV?li#HyX|Ar5ujSxRL9eezp2zuD;MXeRT;9h8 z1T6C)a8@8-HY9D&?>z~kgE{I$d + + - -$title + + $projectname: $title $title - - - - - + + + + + + + + + + + $treeview $search $mathjax - - + +$extrastylesheet + + +
+ +
- + - + + - - - - - + + + + + + + +
-
$projectname -   - + +  $projectnumber
$projectbrief
 -
$projectbrief
- 		$searchbox
$searchbox
+
+
    + +
+
diff --git a/Doxygen/templates/navtree.css b/Doxygen/templates/navtree.css index e46ffcd6..3a8b901c 100644 --- a/Doxygen/templates/navtree.css +++ b/Doxygen/templates/navtree.css @@ -1,6 +1,15 @@ -#nav-tree .children_ul { - margin:0; - padding:4px; +:root { + --arm_light_blue: #00C1DE; + --arm_blue: #11809F; + --arm_blue1: #0091BD; + --arm_dark_blue: #002B49; + --arm_light_gray: #E5ECEB; + --arm_light_gray1: #EFF5F4; + --arm_light_gray2: #EBEBEB; + --arm_light_gray3: #F7F7F7; + --arm_dark_gray: #7D868C; + --arm_black: #333E48; + --arm_orange: #FF6B00; } #nav-tree ul { @@ -20,10 +29,9 @@ } #nav-tree .selected { - background-image: url('tab_a.png'); - background-repeat:repeat-x; - color: #fff; - text-shadow: 0px 1px 1px rgba(0, 0, 0, 1.0); + border: 1.5px solid var(--arm_blue); + border-left-width: 5px; + margin-left:-10px; /*correction to place selection border on the edge screen edge */ } #nav-tree img { @@ -36,6 +44,7 @@ #nav-tree a { text-decoration:none; padding:0px; + padding-left:0px; margin:0px; outline:none; } @@ -43,33 +52,37 @@ #nav-tree .label { margin:0px; padding:0px; + font: 15px Lato, Calibri, sans-serif; +} + +#nav-tree .label:hover { + color: var(--arm_orange); } #nav-tree .label a { - padding:2px; + padding-left:6px; + line-height: 30px; + color: var(--arm_black); } #nav-tree .selected a { - text-decoration:none; - padding:2px; - margin:0px; - color:#fff; + font-weight: bold; } -#nav-tree .children_ul { - margin:0px; - padding:0px; +/*correction for the larger box border on the left (10px-5px) */ +#nav-tree .selected .arrow { + margin-left:5px; } -#nav-tree .item { +#nav-tree .children_ul { margin:0px; padding:0px; } #nav-tree { padding: 0px 0px; - background-color: #FAFAFF; - font-size:14px; + padding-left: 10px; /*correction to add space before the first arrow in nav-tree */ + background-color: #FAFAFF; overflow:auto; } @@ -78,15 +91,16 @@ display:block; padding:0px; margin:0px; + -webkit-overflow-scrolling : touch; /* iOS 5+ */ } #side-nav { - padding:0 6px 0 0; + padding:0 2px 0 0; margin: 0px; display:block; position: absolute; left: 0px; - width: 300px; + width: 340px; } .ui-resizable .ui-resizable-handle { @@ -94,12 +108,14 @@ } .ui-resizable-e { - background:url("ftv2splitbar.png") repeat scroll right center transparent; - cursor:e-resize; + background-color: var(--arm_light_gray); + background-repeat:repeat-y; + background-attachment: scroll; + cursor:ew-resize; height:100%; right:0; top:0; - width:6px; + width:2px; } .ui-resizable-handle { @@ -114,10 +130,32 @@ } #nav-tree { - background-image:url('nav_h.png'); - background-repeat:repeat-x; - background-color: #F9FAFC; + background-color: white; + -webkit-overflow-scrolling : touch; /* iOS 5+ */ } +#nav-sync { + position:absolute; + top:5px; + right:24px; + z-index:0; +} +#nav-sync img { + opacity:0.0; +} + +#nav-sync img:hover { + opacity:0.0; +} + +#nav-tree a:hover { + color: var(--arm_orange); +} + +@media print +{ + #nav-tree { display: none; } + div.ui-resizable-handle { display: none; position: relative; } +} diff --git a/Doxygen/templates/navtree.js b/Doxygen/templates/navtree.js new file mode 100644 index 00000000..c7a300dd --- /dev/null +++ b/Doxygen/templates/navtree.js @@ -0,0 +1,551 @@ +/* + @licstart The following is the entire license notice for the JavaScript code in this file. + + The MIT License (MIT) + + Copyright (C) 1997-2020 by Dimitri van Heesch + + Permission is hereby granted, free of charge, to any person obtaining a copy of this software + and associated documentation files (the "Software"), to deal in the Software without restriction, + including without limitation the rights to use, copy, modify, merge, publish, distribute, + sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is + furnished to do so, subject to the following conditions: + + The above copyright notice and this permission notice shall be included in all copies or + substantial portions of the Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING + BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, + DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + + @licend The above is the entire license notice for the JavaScript code in this file + */ +var navTreeSubIndices = new Array(); +var arrowDown = '▼'; +var arrowRight = '►'; + +function getData(varName) +{ + var i = varName.lastIndexOf('/'); + var n = i>=0 ? varName.substring(i+1) : varName; + return eval(n.replace(/\-/g,'_')); +} + +function stripPath(uri) +{ + return uri.substring(uri.lastIndexOf('/')+1); +} + +function stripPath2(uri) +{ + var i = uri.lastIndexOf('/'); + var s = uri.substring(i+1); + var m = uri.substring(0,i+1).match(/\/d\w\/d\w\w\/$/); + return m ? uri.substring(i-6) : s; +} + +function hashValue() +{ + return $(location).attr('hash').substring(1).replace(/[^\w\-]/g,''); +} + +function hashUrl() +{ + return '#'+hashValue(); +} + +function pathName() +{ + return $(location).attr('pathname').replace(/[^-A-Za-z0-9+&@#/%?=~_|!:,.;\(\)]/g, ''); +} + +function localStorageSupported() +{ + try { + return 'localStorage' in window && window['localStorage'] !== null && window.localStorage.getItem; + } + catch(e) { + return false; + } +} + +function storeLink(link) +{ + if (!$("#nav-sync").hasClass('sync') && localStorageSupported()) { + window.localStorage.setItem('navpath',link); + } +} + +function deleteLink() +{ + if (localStorageSupported()) { + window.localStorage.setItem('navpath',''); + } +} + +function cachedLink() +{ + if (localStorageSupported()) { + return window.localStorage.getItem('navpath'); + } else { + return ''; + } +} + +function getScript(scriptName,func,show) +{ + var head = document.getElementsByTagName("head")[0]; + var script = document.createElement('script'); + script.id = scriptName; + script.type = 'text/javascript'; + script.onload = func; + script.src = scriptName+'.js'; + head.appendChild(script); +} + +function createIndent(o,domNode,node,level) +{ + var level=-1; + var n = node; + while (n.parentNode) { level++; n=n.parentNode; } + if (node.childrenData) { + var imgNode = document.createElement("span"); + imgNode.className = 'arrow'; + imgNode.style.paddingLeft=(16*level).toString()+'px'; + imgNode.innerHTML=arrowRight; + node.plus_img = imgNode; + node.expandToggle = document.createElement("a"); + node.expandToggle.href = "javascript:void(0)"; + node.expandToggle.onclick = function() { + if (node.expanded) { + $(node.getChildrenUL()).slideUp("fast"); + node.plus_img.innerHTML=arrowRight; + node.expanded = false; + } else { + expandNode(o, node, false, false); + } + } + node.expandToggle.appendChild(imgNode); + domNode.appendChild(node.expandToggle); + } else { + var span = document.createElement("span"); + span.className = 'arrow'; + span.style.width = 16*(level+1)+'px'; + span.innerHTML = ' '; + domNode.appendChild(span); + } +} + +var animationInProgress = false; + +function gotoAnchor(anchor,aname,updateLocation) +{ + var pos, docContent = $('#doc-content'); + var ancParent = $(anchor.parent()); + if (ancParent.hasClass('memItemLeft') || + ancParent.hasClass('memtitle') || + ancParent.hasClass('fieldname') || + ancParent.hasClass('fieldtype') || + ancParent.is(':header')) + { + pos = ancParent.position().top; + } else if (anchor.position()) { + pos = anchor.position().top; + } + if (pos) { + var dist = Math.abs(Math.min( + pos-docContent.offset().top, + docContent[0].scrollHeight- + docContent.height()-docContent.scrollTop())); + animationInProgress=true; + docContent.animate({ + scrollTop: pos + docContent.scrollTop() - docContent.offset().top + },Math.max(50,Math.min(500,dist)),function(){ + if (updateLocation) window.location.href=aname; + animationInProgress=false; + }); + } +} + +function newNode(o, po, text, link, childrenData, lastNode) +{ + var node = new Object(); + node.children = Array(); + node.childrenData = childrenData; + node.depth = po.depth + 1; + node.relpath = po.relpath; + node.isLast = lastNode; + + node.li = document.createElement("li"); + po.getChildrenUL().appendChild(node.li); + node.parentNode = po; + + node.itemDiv = document.createElement("div"); + node.itemDiv.className = "item"; + + node.labelSpan = document.createElement("span"); + node.labelSpan.className = "label"; + + createIndent(o,node.itemDiv,node,0); + node.itemDiv.appendChild(node.labelSpan); + node.li.appendChild(node.itemDiv); + + var a = document.createElement("a"); + node.labelSpan.appendChild(a); + node.label = document.createTextNode(text); + node.expanded = false; + a.appendChild(node.label); + if (link) { + var url; + if (link.substring(0,1)=='^') { + url = link.substring(1); + link = url; + } else { + url = node.relpath+link; + } + a.className = stripPath(link.replace('#',':')); + if (link.indexOf('#')!=-1) { + var aname = '#'+link.split('#')[1]; + var srcPage = stripPath(pathName()); + var targetPage = stripPath(link.split('#')[0]); + a.href = srcPage!=targetPage ? url : "javascript:void(0)"; + a.onclick = function(){ + storeLink(link); + if (!$(a).parent().parent().hasClass('selected')) + { + $('.item').removeClass('selected'); + $('.item').removeAttr('id'); + $(a).parent().parent().addClass('selected'); + $(a).parent().parent().attr('id','selected'); + } + var anchor = $(aname); + gotoAnchor(anchor,aname,true); + }; + } else { + a.href = url; + a.onclick = function() { storeLink(link); } + } + } else { + if (childrenData != null) + { + a.className = "nolink"; + a.href = "javascript:void(0)"; + a.onclick = node.expandToggle.onclick; + } + } + + node.childrenUL = null; + node.getChildrenUL = function() { + if (!node.childrenUL) { + node.childrenUL = document.createElement("ul"); + node.childrenUL.className = "children_ul"; + node.childrenUL.style.display = "none"; + node.li.appendChild(node.childrenUL); + } + return node.childrenUL; + }; + + return node; +} + +function showRoot() +{ + var headerHeight = $("#top").height(); + var footerHeight = $("#nav-path").height(); + var windowHeight = $(window).height() - headerHeight - footerHeight; + (function (){ // retry until we can scroll to the selected item + try { + var navtree=$('#nav-tree'); + navtree.scrollTo('#selected',100,{offset:-windowHeight/2}); + } catch (err) { + setTimeout(arguments.callee, 0); + } + })(); +} + +function expandNode(o, node, imm, showRoot) +{ + if (node.childrenData && !node.expanded) { + if (typeof(node.childrenData)==='string') { + var varName = node.childrenData; + getScript(node.relpath+varName,function(){ + node.childrenData = getData(varName); + expandNode(o, node, imm, showRoot); + }, showRoot); + } else { + if (!node.childrenVisited) { + getNode(o, node); + } + $(node.getChildrenUL()).slideDown("fast"); + node.plus_img.innerHTML = arrowDown; + node.expanded = true; + } + } +} + +function glowEffect(n,duration) +{ + n.addClass('glow').delay(duration).queue(function(next){ + $(this).removeClass('glow');next(); + }); +} + +function highlightAnchor() +{ + var aname = hashUrl(); + var anchor = $(aname); + if (anchor.parent().attr('class')=='memItemLeft'){ + var rows = $('.memberdecls tr[class$="'+hashValue()+'"]'); + glowEffect(rows.children(),300); // member without details + } else if (anchor.parent().attr('class')=='fieldname'){ + glowEffect(anchor.parent().parent(),1000); // enum value + } else if (anchor.parent().attr('class')=='fieldtype'){ + glowEffect(anchor.parent().parent(),1000); // struct field + } else if (anchor.parent().is(":header")) { + glowEffect(anchor.parent(),1000); // section header + } else { + glowEffect(anchor.next(),1000); // normal member + } +} + +function selectAndHighlight(hash,n) +{ + var a; + if (hash) { + var link=stripPath(pathName())+':'+hash.substring(1); + a=$('.item a[class$="'+link+'"]'); + } + if (a && a.length) { + a.parent().parent().addClass('selected'); + a.parent().parent().attr('id','selected'); + highlightAnchor(); + } else if (n) { + $(n.itemDiv).addClass('selected'); + $(n.itemDiv).attr('id','selected'); + } + var topOffset=5; + if (typeof page_layout!=='undefined' && page_layout==1) { + topOffset+=$('#top').outerHeight(); + } + if ($('#nav-tree-contents .item:first').hasClass('selected')) { + topOffset+=25; + } + $('#nav-sync').css('top',topOffset+'px'); + showRoot(); +} + +function showNode(o, node, index, hash) +{ + if (node && node.childrenData) { + if (typeof(node.childrenData)==='string') { + var varName = node.childrenData; + getScript(node.relpath+varName,function(){ + node.childrenData = getData(varName); + showNode(o,node,index,hash); + },true); + } else { + if (!node.childrenVisited) { + getNode(o, node); + } + $(node.getChildrenUL()).css({'display':'block'}); + node.plus_img.innerHTML = arrowDown; + node.expanded = true; + var n = node.children[o.breadcrumbs[index]]; + if (index+11) hash = '#'+parts[1].replace(/[^\w\-]/g,''); + else hash=''; + } + if (hash.match(/^#l\d+$/)) { + var anchor=$('a[name='+hash.substring(1)+']'); + glowEffect(anchor.parent(),1000); // line number + hash=''; // strip line number anchors + } + var url=root+hash; + var i=-1; + while (NAVTREEINDEX[i+1]<=url) i++; + if (i==-1) { i=0; root=NAVTREE[0][1]; } // fallback: show index + if (navTreeSubIndices[i]) { + gotoNode(o,i,root,hash,relpath) + } else { + getScript(relpath+'navtreeindex'+i,function(){ + navTreeSubIndices[i] = eval('NAVTREEINDEX'+i); + if (navTreeSubIndices[i]) { + gotoNode(o,i,root,hash,relpath); + } + },true); + } +} + +function showSyncOff(n,relpath) +{ + n.html(''); +} + +function showSyncOn(n,relpath) +{ + n.html(''); +} + +function toggleSyncButton(relpath) +{ + var navSync = $('#nav-sync'); + if (navSync.hasClass('sync')) { + navSync.removeClass('sync'); + showSyncOff(navSync,relpath); + storeLink(stripPath2(pathName())+hashUrl()); + } else { + navSync.addClass('sync'); + showSyncOn(navSync,relpath); + deleteLink(); + } +} + +var loadTriggered = false; +var readyTriggered = false; +var loadObject,loadToRoot,loadUrl,loadRelPath; + +$(window).on('load',function(){ + if (readyTriggered) { // ready first + navTo(loadObject,loadToRoot,loadUrl,loadRelPath); + showRoot(); + } + loadTriggered=true; +}); + +function initNavTree(toroot,relpath) +{ + var o = new Object(); + o.toroot = toroot; + o.node = new Object(); + o.node.li = document.getElementById("nav-tree-contents"); + o.node.childrenData = NAVTREE; + o.node.children = new Array(); + o.node.childrenUL = document.createElement("ul"); + o.node.getChildrenUL = function() { return o.node.childrenUL; }; + o.node.li.appendChild(o.node.childrenUL); + o.node.depth = 0; + o.node.relpath = relpath; + o.node.expanded = false; + o.node.isLast = true; + o.node.plus_img = document.createElement("span"); + o.node.plus_img.className = 'arrow'; + o.node.plus_img.innerHTML = arrowRight; + + if (localStorageSupported()) { + var navSync = $('#nav-sync'); + if (cachedLink()) { + showSyncOff(navSync,relpath); + navSync.removeClass('sync'); + } else { + showSyncOn(navSync,relpath); + } + navSync.click(function(){ toggleSyncButton(relpath); }); + } + + if (loadTriggered) { // load before ready + navTo(o,toroot,hashUrl(),relpath); + showRoot(); + } else { // ready before load + loadObject = o; + loadToRoot = toroot; + loadUrl = hashUrl(); + loadRelPath = relpath; + readyTriggered=true; + } + + $(window).bind('hashchange', function(){ + if (window.location.hash && window.location.hash.length>1){ + var a; + if ($(location).attr('hash')){ + var clslink=stripPath(pathName())+':'+hashValue(); + a=$('.item a[class$="'+clslink.replace(/ ' + this.tabTxt + ''; this.listItem = '
  • ' + this.tabTxt + '
    • '; @@ -13,28 +13,16 @@ function tabElement(id, folderName, tabTxt ) { var arr = []; // fill array - arr.push( new tabElement( "GEN", "/General/html/", "General") ); - arr.push( new tabElement( "CORE_A", "/Core_A/html/", "Core(A)") ); - arr.push( new tabElement( "CORE_M", "/Core/html/", "Core(M)") ); - arr.push( new tabElement( "DRV", "/Driver/html/", "Driver") ); - arr.push( new tabElement( "DSP&ML", "/DSP/html/", "DSP") ); - arr.push( new tabElement( "NN", "/NN/html/", "NN") ); - arr.push( new tabElement( "RTOSv1", "/RTOS/html/", "RTOS v1") ); - arr.push( new tabElement( "RTOSv2", "/RTOS2/html/", "RTOS v2") ); - arr.push( new tabElement( "PACK", "/Pack/html/", "Pack") ); - arr.push( new tabElement( "Build", "/Build/html/", "Build") ); - arr.push( new tabElement( "SVD", "/SVD/html/", "SVD") ); - arr.push( new tabElement( "DAP", "/DAP/html/", "DAP") ); - arr.push( new tabElement( "ZONE", "/Zone/html/", "Zone") ); - +// arr.push( new tabElement( "GEN", "/General/html/", "General")); + // write tabs // called from the header file. function writeComponentTabs() { for ( var i=0; i < arr.length; i++ ) { if (strgURL.search(arr[i].folderName) > 0) { // if this is the current folder - document.write(arr[i].currentListItem); // then print and hightlight the tab - } else { + document.write(arr[i].currentListItem); // then print and highlight the tab + } else { document.write(arr[i].listItem); // else, print the tab - } + } } }; diff --git a/Doxygen/templates/search.css b/Doxygen/templates/search.css index 1746d13f..da3b5099 100644 --- a/Doxygen/templates/search.css +++ b/Doxygen/templates/search.css @@ -136,7 +136,7 @@ span.SelectionMark { a.SelectItem { display: block; outline-style: none; - color: #000000; + color: #000000; text-decoration: none; padding-left: 6px; padding-right: 12px; @@ -144,7 +144,7 @@ a.SelectItem { a.SelectItem:focus, a.SelectItem:active { - color: #000000; + color: #000000; outline-style: none; text-decoration: none; } @@ -177,7 +177,7 @@ iframe#MSearchResults { #SRIndex { - clear:both; + clear:both; padding-bottom: 15px; } @@ -196,7 +196,7 @@ body.SRPage { } .SRChildren { - padding-left: 3ex; padding-bottom: .5em + padding-left: 3ex; padding-bottom: .5em } .SRPage .SRChildren { @@ -204,7 +204,7 @@ body.SRPage { } .SRSymbol { - font-weight: bold; + font-weight: bold; color: #425E97; font-family: Arial, Verdana, sans-serif; text-decoration: none; @@ -213,7 +213,7 @@ body.SRPage { a.SRScope { display: block; - color: #425E97; + color: #425E97; font-family: Arial, Verdana, sans-serif; text-decoration: none; outline: none; diff --git a/Doxygen/templates/tab_b.png b/Doxygen/templates/tab_b.png new file mode 100644 index 0000000000000000000000000000000000000000..6aaf98e9d20ca9cde306dbfdc108d75d5d9ded17 GIT binary patch literal 128 zcmeAS@N?(olHy`uVBq!ia0vp^j6kfy!3HEfN&we@P7LeL$-D$|SkfJR9T^xl z_H+M9WCij$3p^r=85sDEfH31!Z9ZwBps1&dV~9j}a>cJ_U+dM_6eP4*n3);Y7qBoL SwfqmVi^0>?&t;ucLK6Ts>>P#w literal 0 HcmV?d00001 diff --git a/Doxygen/templates/tab_topnav.png b/Doxygen/templates/tab_topnav.png deleted file mode 100644 index b257b7780f30c0e030ee0cc9fe812dccddbe6851..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 232 zcmeAS@N?(olHy`uVBq!ia0vp^EI_Qr!2~38zONMlQk(@Ik;M!Qe1}1p@p%4<6p*TP zM_)$m$n4Fmh;vZIjzaOYW($mE;L?bwP&!1v`W*G*{f+Gf}ZW`Y?#K7?7bfqP8fBG+= OA_h-aKbLh*2~7acPeJzp diff --git a/Doxygen/templates/tabs.css b/Doxygen/templates/tabs.css index ffbab509..2229e0a1 100644 --- a/Doxygen/templates/tabs.css +++ b/Doxygen/templates/tabs.css @@ -1,71 +1,103 @@ -.tabs, .tabs1, .tabs2, .tabs3 { - background-image: url('tab_b.png'); +:root { + --arm_light_blue: #00C1DE; + --arm_blue: #11809F; + --arm_blue1: #0091BD; + --arm_dark_blue: #002B49; + --arm_light_gray: #E5ECEB; + --arm_light_gray1: #EFF5F4; + --arm_light_gray2: #EBEBEB; + --arm_light_gray3: #F7F7F7; + --arm_dark_gray: #7D868C; + --arm_black: #333E48; + --arm_orange: #FF6B00; + --arm_yellow: #FFC700; +} + +/* in Doxygen 1.9.2 'tabs' is assigned to second navigation row (navrow1) with + 'Main Page', 'Namespaces', etc */ + +.tabs, .tabs1, .tabs2, .tabs3, .main-nav { + background-color: var(--arm_light_gray); + color: var(--arm_black); width: 100%; z-index: 101; - font-size: 10px; + font-family: 'Futura PT W01 Medium', 'Lato Light', Lato, Calibri, sans-serif; + font-size: 14px; + font-weight: 800; } .tabs1 { - background-image: url('tab_topnav.png'); - font-size: 12px; + background-color: var(--arm_black); + font-size: 16px; } -.tabs2 { - font-size: 10px; -} -.tabs3 { - font-size: 9px; +.tabs { + background-color: var(--arm_light_gray); } -.tablist { +.tablist, .main-menu { margin: 0; padding: 0; display: table; - line-height: 24px; + line-height: 28px; } .tablist li { float: left; display: table-cell; - background-image: url('tab_b.png'); + background-color: var(--arm_light_gray); + border-right-style:solid; + border-right-width:1px; + border-right-color:var(--arm_dark_gray); list-style: none; + margin:0px; +} + +.tablist .MSearchBoxInactive { + opacity:0.75; } +.tablist .MSearchBoxInactive:hover { + opacity:1.0; +} + + .tabs1 .tablist li { - float: left; - display: table-cell; - background-image: url('tab_topnav.png'); - list-style: none; + background-color: var(--arm_black); + font-weight: 1000; } .tablist a { display: block; - padding: 0 20px; - font-weight: bold; - background-image:url('tab_s.png'); - background-repeat:no-repeat; - background-position:right; - color: #283A5D; - text-shadow: 0px 1px 1px rgba(255, 255, 255, 0.9); - text-decoration: none; + padding: 0 10px; + color: var(--arm_dark_gray); + font-weight: 600; outline: none; } -.tabs3 .tablist a { - padding: 0 10px; +.tabs1 .tablist a { + padding: 3px 20px; + color: white; + background-color:var(--arm_black); +} + +.tablist li.current a { + background-color: var(--arm_dark_gray); + color: white; +} + +.tabs1 .tablist li.current a { + background-color: var(--arm_blue); } .tablist a:hover { - background-image: url('tab_h.png'); - background-repeat:repeat-x; - color: #fff; - text-shadow: 0px 1px 1px rgba(0, 0, 0, 1.0); - text-decoration: none; + color: var(--arm_orange); } -.tablist li.current a { - background-image: url('tab_a.png'); - background-repeat:repeat-x; - color: #fff; - text-shadow: 0px 1px 1px rgba(0, 0, 0, 1.0); +.tabs1 a:hover { + color: var(--arm_yellow); +} + +.tablist li.current :hover { + color: white; } diff --git a/Include/arm_math.h b/Include/arm_math.h index 13d114c8..b32c4d14 100644 --- a/Include/arm_math.h +++ b/Include/arm_math.h @@ -33,20 +33,20 @@ * based devices. * * The library is divided into a number of functions each covering a specific category: - * - Basic math functions - * - Fast math functions - * - Complex math functions - * - Filtering functions - * - Matrix functions - * - Transform functions - * - Motor control functions - * - Statistical functions - * - Support functions - * - Interpolation functions - * - Support Vector Machine functions (SVM) - * - Bayes classifier functions - * - Distance functions - * - Quaternion functions + * - \ref groupMath "Basic math functions" + * - \ref groupFastMath "Fast math functions" + * - \ref groupCmplxMath "Complex math functions" + * - \ref groupFilters "Filtering functions" + * - \ref groupMatrix "Matrix functions" + * - \ref groupTransforms "Transform functions" + * - \ref groupController "Motor control functions" + * - \ref groupStats "Statistical functions" + * - \ref groupSupport "Support functions" + * - \ref groupInterpolation "Interpolation functions" + * - \ref groupSVM "Support Vector Machine functions (SVM)" + * - \ref groupBayes "Bayes classifier functions" + * - \ref groupDistance "Distance functions" + * - \ref groupQuaternionMath "Quaternion functions" * * The library has generally separate functions for operating on 8-bit integers, 16-bit integers, * 32-bit integer and 32-bit floating-point values. @@ -64,13 +64,13 @@ * The library is released in source form. It is strongly advised to compile the library using -Ofast to * have the best performances. * - * The library functions are declared in the public file arm_math.h which is placed in the Include folder. + * The library functions are declared in the public file `arm_math.h` which is placed in the `Include` folder. * Simply include this file. If you don't want to include everything, you can also rely - * on headers in Include/dsp folder and use only what you need. + * on headers in `Include/dsp` folder and use only what you need. * * \section example Examples * - * The library ships with a number of examples which demonstrate how to use the library functions. + * The library ships with a number of examples which demonstrate how to use the library functions. Please refer to \ref groupExamples. * * \section toolchain Toolchain Support * @@ -80,72 +80,58 @@ * * \section preprocessor Preprocessor Macros * - * Each library project have different preprocessor macros. - * - * - ARM_MATH_BIG_ENDIAN: - * - * Define macro ARM_MATH_BIG_ENDIAN to build the library for big endian targets. By default library builds for little endian targets. - * - * - ARM_MATH_MATRIX_CHECK: - * - * Define macro ARM_MATH_MATRIX_CHECK for checking on the input and output sizes of matrices - * - * - ARM_MATH_ROUNDING: - * - * Define macro ARM_MATH_ROUNDING for rounding on support functions - * - * - ARM_MATH_LOOPUNROLL: - * - * Define macro ARM_MATH_LOOPUNROLL to enable manual loop unrolling in DSP functions - * - * - ARM_MATH_NEON: - * - * Define macro ARM_MATH_NEON to enable Neon versions of the DSP functions. + * Each library project has different preprocessor macros. + * + * - `ARM_MATH_BIG_ENDIAN`: + * - Define macro ARM_MATH_BIG_ENDIAN to build the library for big endian targets. By default library builds for little endian targets. + * . + * - `ARM_MATH_MATRIX_CHECK`: + * - Define macro ARM_MATH_MATRIX_CHECK for checking on the input and output sizes of matrices + * . + * - `ARM_MATH_ROUNDING`: + * - Define macro ARM_MATH_ROUNDING for rounding on support functions + * . + * - `ARM_MATH_LOOPUNROLL`: + * - Define macro ARM_MATH_LOOPUNROLL to enable manual loop unrolling in DSP functions + * . + * - `ARM_MATH_NEON`: + * - Define macro ARM_MATH_NEON to enable Neon versions of the DSP functions. * It is not enabled by default when Neon is available because performances are * dependent on the compiler and target architecture. - * - * - ARM_MATH_NEON_EXPERIMENTAL: - * - * Define macro ARM_MATH_NEON_EXPERIMENTAL to enable experimental Neon versions of + * . + * - `ARM_MATH_NEON_EXPERIMENTAL`: + * - Define macro ARM_MATH_NEON_EXPERIMENTAL to enable experimental Neon versions of * of some DSP functions. Experimental Neon versions currently do not have better * performances than the scalar versions. - * - * - ARM_MATH_HELIUM: - * - * It implies the flags ARM_MATH_MVEF and ARM_MATH_MVEI and ARM_MATH_MVE_FLOAT16. - * - * - ARM_MATH_HELIUM_EXPERIMENTAL: - * - * Only taken into account when ARM_MATH_MVEF, ARM_MATH_MVEI or ARM_MATH_MVE_FLOAT16 are defined. + * . + * - `ARM_MATH_HELIUM`: + * - It implies the flags ARM_MATH_MVEF and ARM_MATH_MVEI and ARM_MATH_MVE_FLOAT16. + * . + * - `ARM_MATH_HELIUM_EXPERIMENTAL`: + * - Only taken into account when ARM_MATH_MVEF, ARM_MATH_MVEI or ARM_MATH_MVE_FLOAT16 are defined. * Enable some vector versions which may have worse performance than scalar * depending on the core / compiler configuration. - * - * - ARM_MATH_MVEF: - * - * Select Helium versions of the f32 algorithms. + * . + * - `ARM_MATH_MVEF`: + * - Select Helium versions of the f32 algorithms. * It implies ARM_MATH_FLOAT16 and ARM_MATH_MVEI. - * - * - ARM_MATH_MVEI: - * - * Select Helium versions of the int and fixed point algorithms. - * - * - ARM_MATH_MVE_FLOAT16: - * - * MVE Float16 implementations of some algorithms (Requires MVE extension). - * - * - DISABLEFLOAT16: - * - * Disable float16 algorithms when __fp16 is not supported for a + * . + * - `ARM_MATH_MVEI`: + * - Select Helium versions of the int and fixed point algorithms. + * . + * - `ARM_MATH_MVE_FLOAT16`: + * - MVE Float16 implementations of some algorithms (Requires MVE extension). + * . + * - `DISABLEFLOAT16`: + * - Disable float16 algorithms when __fp16 is not supported for a * specific compiler / core configuration. * This is only valid for scalar. When vector architecture is * supporting f16 then it can't be disabled. - * - * - ARM_MATH_AUTOVECTORIZE: - * - * With Helium or Neon, disable the use of vectorized code with C intrinsics + * . + * - `ARM_MATH_AUTOVECTORIZE`: + * - With Helium or Neon, disable the use of vectorized code with C intrinsics * and use pure C instead. The vectorization is then done by the compiler. * - *
    * \section pack CMSIS-DSP in ARM::CMSIS Pack * * The following files relevant to CMSIS-DSP are present in the ARM::CMSIS Pack directories: @@ -158,9 +144,12 @@ * |\b CMSIS\\DSP\\PrivateInclude | private include files for building the lib | * |\b CMSIS\\DSP\\Source | source files | * - *
    * \section rev Revision History of CMSIS-DSP * Please refer to \ref ChangeLog_pg. + * + * \section license License + * + * The CMSIS-DSP is provided free of charge under the Apache 2.0 License. */ diff --git a/Include/dsp/controller_functions.h b/Include/dsp/controller_functions.h index 7c08c243..cb1d26c4 100755 --- a/Include/dsp/controller_functions.h +++ b/Include/dsp/controller_functions.h @@ -52,15 +52,35 @@ extern "C" */ - /** - * @ingroup groupController - */ - - /** - * @addtogroup SinCos - * @{ - */ +/** + @ingroup groupController + */ +/** + @defgroup SinCos Sine Cosine + + Computes the trigonometric sine and cosine values using a combination of table lookup + and linear interpolation. + There are separate functions for Q31 and floating-point data types. + The input to the floating-point version is in degrees while the + fixed-point Q31 have a scaled input with the range + [-1 0.9999] mapping to [-180 +180] degrees. + + The floating point function also allows values that are out of the usual range. When this happens, the function will + take extra time to adjust the input value to the range of [-180 180]. + + The result is accurate to 5 digits after the decimal point. + + The implementation is based on table lookup using 360 values together with linear interpolation. + The steps used are: + -# Calculation of the nearest integer table index. + -# Compute the fractional portion (fract) of the input. + -# Fetch the value corresponding to \c index from sine table to \c y0 and also value from \c index+1 to \c y1. + -# Sine value is computed as *psinVal = y0 + (fract * (y1 - y0)). + -# Fetch the value corresponding to \c index from cosine table to \c y0 and also value from \c index+1 to \c y1. + -# Cosine value is computed as *pcosVal = y0 + (fract * (y1 - y0)). + */ + /** * @brief Floating-point sin_cos function. * @param[in] theta input value in degrees @@ -84,10 +104,6 @@ extern "C" q31_t * pSinVal, q31_t * pCosVal); - /** - * @} end of SinCos group - */ - /** * @ingroup groupController */ diff --git a/Include/dsp/fast_math_functions.h b/Include/dsp/fast_math_functions.h index 489f2140..596c0bfe 100755 --- a/Include/dsp/fast_math_functions.h +++ b/Include/dsp/fast_math_functions.h @@ -63,17 +63,8 @@ extern "C" * */ - /** - * @ingroup groupFastMath - */ - - -/** - @addtogroup sin - @{ - */ -/** + /** * @brief Fast approximation to the trigonometric sine function for floating-point data. * @param[in] x input value in radians. * @return sin(x). @@ -90,7 +81,6 @@ extern "C" q31_t arm_sin_q31( q31_t x); - /** * @brief Fast approximation to the trigonometric sine function for Q15 data. * @param[in] x Scaled input value in radians. @@ -99,14 +89,6 @@ extern "C" q15_t arm_sin_q15( q15_t x); -/** - @} end of sin group - */ - -/** - @addtogroup cos - @{ - */ /** * @brief Fast approximation to the trigonometric cosine function for floating-point data. @@ -134,10 +116,6 @@ extern "C" q15_t arm_cos_q15( q15_t x); -/** - @} end of cos group - */ - /** @brief Floating-point vector of log values. @@ -162,8 +140,8 @@ extern "C" */ void arm_vlog_f64( const float64_t * pSrc, - float64_t * pDst, - uint32_t blockSize); + float64_t * pDst, + uint32_t blockSize); diff --git a/Include/dsp/interpolation_functions.h b/Include/dsp/interpolation_functions.h index 6e51f7c8..f578e2ed 100755 --- a/Include/dsp/interpolation_functions.h +++ b/Include/dsp/interpolation_functions.h @@ -121,18 +121,6 @@ extern "C" } arm_spline_instance_f32; - - - /** - * @ingroup groupInterpolation - */ - - /** - * @addtogroup SplineInterpolate - * @{ - */ - - /** * @brief Processing function for the floating-point cubic spline interpolation. * @param[in] S points to an instance of the floating-point spline structure. @@ -166,18 +154,7 @@ extern "C" float32_t * tempBuffer); - /** - * @} end of SplineInterpolate group - */ - - - - /** - * @addtogroup LinearInterpolate - * @{ - */ - - /** + /** * @brief Process function for the floating-point Linear Interpolation Function. * @param[in,out] S is an instance of the floating-point Linear Interpolation structure * @param[in] x input sample to process @@ -241,23 +218,6 @@ q7_t arm_linear_interp_q7( q31_t x, uint32_t nValues); - /** - * @} end of LinearInterpolate group - */ - - - - - /** - * @ingroup groupInterpolation - */ - - - /** - * @addtogroup BilinearInterpolate - * @{ - */ - /** * @brief Floating-point bilinear interpolation. * @param[in,out] S points to an instance of the interpolation structure. @@ -306,10 +266,6 @@ q7_t arm_linear_interp_q7( arm_bilinear_interp_instance_q7 * S, q31_t X, q31_t Y); - /** - * @} end of BilinearInterpolate group - */ - #ifdef __cplusplus diff --git a/Source/ControllerFunctions/arm_sin_cos_f32.c b/Source/ControllerFunctions/arm_sin_cos_f32.c index e6d9d90f..d6874d90 100644 --- a/Source/ControllerFunctions/arm_sin_cos_f32.c +++ b/Source/ControllerFunctions/arm_sin_cos_f32.c @@ -29,35 +29,6 @@ #include "dsp/controller_functions.h" #include "arm_common_tables.h" -/** - @ingroup groupController - */ - -/** - @defgroup SinCos Sine Cosine - - Computes the trigonometric sine and cosine values using a combination of table lookup - and linear interpolation. - There are separate functions for Q31 and floating-point data types. - The input to the floating-point version is in degrees while the - fixed-point Q31 have a scaled input with the range - [-1 0.9999] mapping to [-180 +180] degrees. - - The floating point function also allows values that are out of the usual range. When this happens, the function will - take extra time to adjust the input value to the range of [-180 180]. - - The result is accurate to 5 digits after the decimal point. - - The implementation is based on table lookup using 360 values together with linear interpolation. - The steps used are: - -# Calculation of the nearest integer table index. - -# Compute the fractional portion (fract) of the input. - -# Fetch the value corresponding to \c index from sine table to \c y0 and also value from \c index+1 to \c y1. - -# Sine value is computed as *psinVal = y0 + (fract * (y1 - y0)). - -# Fetch the value corresponding to \c index from cosine table to \c y0 and also value from \c index+1 to \c y1. - -# Cosine value is computed as *pcosVal = y0 + (fract * (y1 - y0)). - */ - /** @addtogroup SinCos @{ diff --git a/Source/SupportFunctions/arm_barycenter_f32.c b/Source/SupportFunctions/arm_barycenter_f32.c index 817bb588..586fb397 100755 --- a/Source/SupportFunctions/arm_barycenter_f32.c +++ b/Source/SupportFunctions/arm_barycenter_f32.c @@ -33,6 +33,7 @@ /** @ingroup barycenter + @{ */ diff --git a/Source/TransformFunctions/arm_cfft_f64.c b/Source/TransformFunctions/arm_cfft_f64.c index d686eb8c..e8c0a6b8 100644 --- a/Source/TransformFunctions/arm_cfft_f64.c +++ b/Source/TransformFunctions/arm_cfft_f64.c @@ -41,10 +41,6 @@ extern void arm_bitreversal_64( const uint16_t bitRevLen, const uint16_t * pBitRevTable); -/** -* @} end of ComplexFFT group -*/ - /* ---------------------------------------------------------------------- * Internal helper function used by the FFTs * ---------------------------------------------------------------------- */