diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 572b93c92..000000000 --- a/.gitattributes +++ /dev/null @@ -1 +0,0 @@ -ARM.CMSIS-DSP.pdsc filter=git-version diff --git a/.gitconfig b/.gitconfig deleted file mode 100644 index da069398c..000000000 --- a/.gitconfig +++ /dev/null @@ -1,3 +0,0 @@ -[filter "git-version"] - clean = ./Scripts/git/git-version.clean - smudge = ./Scripts/git/git-version.smudge diff --git a/.github/dependabot.yaml b/.github/dependabot.yaml new file mode 100644 index 000000000..0cb7b3485 --- /dev/null +++ b/.github/dependabot.yaml @@ -0,0 +1,8 @@ +version: 2 +updates: + - package-ecosystem: github-actions + directory: "/" + schedule: + interval: "weekly" + open-pull-requests-limit: 10 + rebase-strategy: disabled diff --git a/.github/doxygen.json b/.github/doxygen.json deleted file mode 100644 index e1d8cc804..000000000 --- a/.github/doxygen.json +++ /dev/null @@ -1,16 +0,0 @@ -{ - "problemMatcher": [ - { - "owner": "doxygen", - "severity": "warning", - "pattern": [ - { - "regexp": "^(.*):(\\d+): warning: (.*)$", - "file": 1, - "line": 2, - "message": 3 - } - ] - } - ] -} diff --git a/.github/linkchecker.json b/.github/linkchecker.json deleted file mode 100644 index 23f7fca69..000000000 --- a/.github/linkchecker.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "problemMatcher": [ - { - "owner": "linkchecker", - "severity": "warning", - "pattern": [ - { - "regexp": "^(.*):(\\d+):(\\d+);(.*);(.*);(.*)$", - "file": 1, - "line": 2, - "column": 3, - "code": 5, - "message": 6 - } - ] - } - ] -} diff --git a/.github/packchk.json b/.github/packchk.json deleted file mode 100644 index 7b193f5c4..000000000 --- a/.github/packchk.json +++ /dev/null @@ -1,20 +0,0 @@ -{ - "problemMatcher": [ - { - "owner": "packchk", - "severity": "warning", - "pattern": [ - { - "regexp": "^\\*\\*\\* (INFO|WARNING) M(\\d+): (.*) \\(Line (\\d+)\\)$", - "file": 3, - "line": 4, - "code": 2 - }, - { - "regexp": "^ (.*)$", - "message": 1 - } - ] - } - ] -} diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml deleted file mode 100644 index 1b4448682..000000000 --- a/.github/workflows/build.yaml +++ /dev/null @@ -1,147 +0,0 @@ -name: Build documentation and pack -on: - workflow_dispatch: - push: - branches: - - main - pull_request: - branches: - - main - release: - types: [published] -jobs: - pack: - name: Generate pack - runs-on: ubuntu-20.04 - steps: - - uses: actions/checkout@v3 - with: - fetch-depth: 0 - - - name: Fetch tags - if: ${{ github.event_name == 'release' }} - run: | - git fetch --tags --force - - - name: Install packages - run: | - sudo apt-get update - 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 - run: | - wget -O doxygen.tgz https://sourceforge.net/projects/doxygen/files/rel-1.9.2/doxygen-1.9.2.linux.bin.tar.gz/download - sudo tar -C /opt -xf doxygen.tgz - 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 - unzip packchk-1.3.95-linux64.zip - sudo mv packchk /usr/local/bin - which packchk - packchk --version - - - name: Generate doxygen - run: | - echo "::add-matcher::.github/doxygen.json" - /bin/bash gen_doc.sh - echo "::remove-matcher owner=doxygen::" - working-directory: ./Doxygen - - - name: Run linkchecker - run: | - echo "::add-matcher::.github/linkchecker.json" - /bin/bash ../Scripts/git/check_links.sh ./html/index.html ./ - echo "::remove-matcher owner=linkchecker::" - working-directory: ./Documentation - - - name: Archive documentation - if: ${{ github.event_name == 'pull_request' }} - uses: actions/upload-artifact@v3 - with: - name: documentation - path: Documentation/html/ - retention-days: 1 - if-no-files-found: error - - - name: Archive documentation - if: ${{ github.event_name == 'release' || github.event_name == 'push' || github.event_name == 'workflow_dispatch' }} - run: | - cd Documentation/html - tar -cvjf /tmp/doc.tbz2 . - - - name: Generate pack - id: pack - run: | - mkdir -p ~/.arm/Packs/.Web - wget -O ~/.arm/Packs/.Web/ARM.CMSIS.pdsc https://www.keil.com/pack/ARM.CMSIS.pdsc - echo "::add-matcher::.github/packchk.json" - /bin/bash ./Scripts/git/gen_pack.sh - echo "::remove-matcher owner=packchk::" - - - name: Archive pack - if: ${{ github.event_name != 'release' }} - uses: actions/upload-artifact@v3 - with: - path: output/*.pack - retention-days: 1 - if-no-files-found: error - - - name: Attach pack to release assets - if: ${{ github.event_name == 'release' }} - uses: svenstaro/upload-release-action@v2 - with: - repo_token: ${{ secrets.GITHUB_TOKEN }} - file_glob: true - file: output/*.pack - tag: ${{ github.ref }} - overwrite: true - - - uses: actions/checkout@v3 - if: ${{ github.event_name == 'release' || github.event_name == 'push' || github.event_name == 'workflow_dispatch' }} - with: - ref: gh-pages - - - name: Publish documentation - if: ${{ github.event_name == 'push' || github.event_name == 'workflow_dispatch' }} - run: | - rm -rf main - mkdir main - pushd main - tar -xvjf /tmp/doc.tbz2 - popd - ./update_versions.sh - git config user.name github-actions - git config user.email github-actions@github.com - git add . - git commit -m "Update main documentation" - git push - - - name: Publish documentation - if: ${{ github.event_name == 'release' }} - run: | - RELEASE=$(echo $GITHUB_REF | sed 's/refs\/tags\///') - rm -rf ${RELEASE} - mkdir -p ${RELEASE} - rm -f latest - ln -s ${RELEASE} latest - pushd ${RELEASE} - tar -xvjf /tmp/doc.tbz2 - popd - ./update_versions.sh - git config user.name github-actions - git config user.email github-actions@github.com - git add . latest - git commit -m "Update documentation for release ${RELEASE}" - git push diff --git a/.github/workflows/gh-pages.yml b/.github/workflows/gh-pages.yml index 3ed929a1d..c32b39fc5 100644 --- a/.github/workflows/gh-pages.yml +++ b/.github/workflows/gh-pages.yml @@ -1,10 +1,10 @@ # Simple workflow for deploying static content to GitHub Pages -name: Deploy static content to Pages +name: Deploy static content to GitHub Pages on: # Runs on pushes targeting the default branch push: - branches: ["gh-pages"] + branches: [gh-pages] # Allows you to run this workflow manually from the Actions tab workflow_dispatch: @@ -30,14 +30,17 @@ jobs: runs-on: ubuntu-latest steps: - name: Checkout - uses: actions/checkout@v3 + uses: actions/checkout@v4 + - name: Setup Pages uses: actions/configure-pages@v3 + - name: Upload artifact - uses: actions/upload-pages-artifact@v1 + uses: actions/upload-pages-artifact@v2 with: # Upload entire repository path: '.' + - name: Deploy to GitHub Pages id: deployment - uses: actions/deploy-pages@v1 + uses: actions/deploy-pages@v2 diff --git a/.github/workflows/pack.yml b/.github/workflows/pack.yml new file mode 100644 index 000000000..5ad888be8 --- /dev/null +++ b/.github/workflows/pack.yml @@ -0,0 +1,35 @@ +name: Build documentation and pack +on: + workflow_dispatch: + pull_request: + push: + branches: [main] + release: + types: [published] + +concurrency: + group: ${{ github.workflow }}-${{ github.ref }} + cancel-in-progress: true + +jobs: + pack: + name: Generate pack + runs-on: ubuntu-22.04 + steps: + - uses: actions/checkout@v4 + with: + fetch-depth: 0 + + - name: Fetch tags + run: | + git fetch --tags --force + + - uses: Open-CMSIS-Pack/gen-pack-action@main + with: + doxygen-version: 1.9.6 + packchk-version: 1.4.1 + gen-doc-script: ./Documentation/Doxygen/gen_doc.sh + doc-path: ./Documentation/html + gen-pack-script: ./gen_pack.sh --no-preprocess + gen-pack-output: ./output + gh-pages-branch: gh-pages diff --git a/.gitignore b/.gitignore index 9e67b5d73..f2db07035 100644 --- a/.gitignore +++ b/.gitignore @@ -1,10 +1,15 @@ +*.bak +Documentation/html/ +Documentation/Doxygen/dsp.dxy +Documentation/Doxygen/history.txt DSP_Lib_TestSuite/build/ PythonWrapper/cmsisdsp.cp36-win_amd64.pyd PythonWrapper/internal.cp36-win_amd64.pyd PythonWrapper/*.so PythonWrapper/rec_2.dat *.pickle -build_*/ +build +output Examples/ARM/arm_fft_bin_example/RTE/ Examples/ARM/arm_fft_bin_example/RTE/ Examples/ARM/arm_fft_bin_example/RTE/ @@ -17,17 +22,23 @@ Examples/ARM/*/RTE/ Examples/ARM/*/MTICoverageOut.cov CMSISDSP.egg-info/ dist/ -Output/ -Documentation/html/ PACK.xsd *.uvguix.* -Documentation/html/* -Doxygen/history.txt -Doxygen/dsp.dxy __pycache__/ *.pyd .DS_Store .swiftpm/ -build/ Examples/cmsis_build/RTE/_Release* -Testing/cmsis_build/RTE/_Release* \ No newline at end of file +Testing/cmsis_build/RTE/_Release* + +PythonWrapper/build_linux/CMakeCache.txt +PythonWrapper/build_linux/CMakeFiles/ +PythonWrapper/build_linux/Makefile +PythonWrapper/build_linux/bin_dsp/ +PythonWrapper/build_linux/build.sh +PythonWrapper/build_linux/cmake_install.cmake + + + +# Output of the linkchecker tool +linkchecker-out.csv \ No newline at end of file diff --git a/Doxygen/dsp.dxy.in b/Documentation/Doxygen/dsp.dxy.in similarity index 91% rename from Doxygen/dsp.dxy.in rename to Documentation/Doxygen/dsp.dxy.in index 8cf5d3e19..965077c39 100644 --- a/Doxygen/dsp.dxy.in +++ b/Documentation/Doxygen/dsp.dxy.in @@ -1,4 +1,4 @@ -# Doxyfile 1.9.2 +# Doxyfile 1.9.6 # This file describes the settings to be used by the documentation system # doxygen (www.doxygen.org) for a project. @@ -12,6 +12,15 @@ # For lists, items can also be appended using: # TAG += value [value, ...] # Values that contain spaces should be placed between quotes (\" \"). +# Note: +# +# Use doxygen to compare the used configuration file with the template +# configuration file: +# doxygen -x [configFile] +# Use doxygen to compare the used configuration file with the template +# configuration file without replacing the environment variables or CMake type +# replacement variables: +# doxygen -x_noenv [configFile] #--------------------------------------------------------------------------- # Project related configuration options @@ -51,24 +60,37 @@ PROJECT_BRIEF = "CMSIS DSP Software Library" # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy # the logo to the output directory. -PROJECT_LOGO = templates/cmsis_logo_white_small.png +PROJECT_LOGO = ./style_template/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 # left blank the current directory will be used. -OUTPUT_DIRECTORY = ../Documentation +OUTPUT_DIRECTORY = ../ -# 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 +# If the CREATE_SUBDIRS tag is set to YES then doxygen will create up to 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 # putting all generated files in the same directory would otherwise causes -# performance problems for the file system. +# performance problems for the file system. Adapt CREATE_SUBDIRS_LEVEL to +# control the number of sub-directories. # The default value is: NO. CREATE_SUBDIRS = NO +# Controls the number of sub-directories that will be created when +# CREATE_SUBDIRS tag is set to YES. Level 0 represents 16 directories, and every +# level increment doubles the number of directories, resulting in 4096 +# directories at level 8 which is the default and also the maximum value. The +# sub-directories are organized in 2 levels, the first level always has a fixed +# number of 16 directories. +# Minimum value: 0, maximum value: 8, default value: 8. +# This tag requires that the tag CREATE_SUBDIRS is set to YES. + +CREATE_SUBDIRS_LEVEL = 8 + # 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 @@ -80,14 +102,14 @@ 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. -# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, -# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), -# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, -# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), -# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, -# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, -# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, -# Ukrainian and Vietnamese. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Bulgarian, +# Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, English +# (United States), Esperanto, Farsi (Persian), Finnish, French, German, Greek, +# Hindi, Hungarian, Indonesian, Italian, Japanese, Japanese-en (Japanese with +# English messages), Korean, Korean-en (Korean with English messages), Latvian, +# Lithuanian, Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, +# Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, +# Swedish, Turkish, Ukrainian and Vietnamese. # The default value is: English. OUTPUT_LANGUAGE = English @@ -106,7 +128,7 @@ BRIEF_MEMBER_DESC = YES # brief descriptions will be completely suppressed. # The default value is: YES. -REPEAT_BRIEF = NO +REPEAT_BRIEF = YES # This tag implements a quasi-intelligent brief description abbreviator that is # used to form the text in various listings. Each string in this list, if found @@ -417,7 +439,7 @@ SUBGROUPING = YES # SEPARATE_MEMBER_PAGES. # The default value is: NO. -INLINE_GROUPED_CLASSES = NO +INLINE_GROUPED_CLASSES = YES # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions # with only public data fields or simple typedef fields will be shown inline in @@ -427,7 +449,7 @@ INLINE_GROUPED_CLASSES = NO # Man pages) or section (for LaTeX and RTF). # The default value is: NO. -INLINE_SIMPLE_STRUCTS = NO +INLINE_SIMPLE_STRUCTS = YES # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or # enum is documented as struct, union, or enum with the name of the typedef. So @@ -453,7 +475,7 @@ TYPEDEF_HIDES_STRUCT = YES LOOKUP_CACHE_SIZE = 0 -# The NUM_PROC_THREADS specifies the number threads doxygen is allowed to use +# The NUM_PROC_THREADS specifies the number of 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 @@ -547,7 +569,8 @@ 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. +# will also hide undocumented C++ concepts if enabled. This option has no effect +# if EXTRACT_ALL is enabled. # The default value is: NO. HIDE_UNDOC_CLASSES = NO @@ -578,14 +601,15 @@ INTERNAL_DOCS = NO # 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 +# are not case sensitive the option should 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. +# Possible values are: SYSTEM, NO and YES. +# The default value is: SYSTEM. CASE_SENSE_NAMES = YES @@ -613,7 +637,7 @@ SHOW_HEADERFILE = NO # the files that are included by a file in the documentation of that file. # The default value is: YES. -SHOW_INCLUDE_FILES = NO +SHOW_INCLUDE_FILES = YES # 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 @@ -686,7 +710,7 @@ SORT_BY_SCOPE_NAME = NO # accept a match between prototype and implementation in such cases. # The default value is: NO. -STRICT_PROTO_MATCHING = NO +STRICT_PROTO_MATCHING = YES # 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. @@ -773,7 +797,7 @@ FILE_VERSION_FILTER = # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE # tag is left empty. -LAYOUT_FILE = templates/Layout_forUser.xml +LAYOUT_FILE = ./style_template/layout.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 @@ -835,7 +859,15 @@ WARN_IF_INCOMPLETE_DOC = YES # WARN_IF_INCOMPLETE_DOC # The default value is: NO. -WARN_NO_PARAMDOC = NO +WARN_NO_PARAMDOC = YES + +# If WARN_IF_UNDOC_ENUM_VAL option is set to YES, doxygen will warn about +# undocumented enumeration values. If set to NO, doxygen will accept +# undocumented enumeration values. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: NO. + +WARN_IF_UNDOC_ENUM_VAL = 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 @@ -852,13 +884,27 @@ WARN_AS_ERROR = NO # and the warning text. Optionally the format may contain $version, which will # be replaced by the version of the file (if it could be obtained via # FILE_VERSION_FILTER) +# See also: WARN_LINE_FORMAT # The default value is: $file:$line: $text. WARN_FORMAT = "$file:$line: $text" +# In the $text part of the WARN_FORMAT command it is possible that a reference +# to a more specific place is given. To make it easier to jump to this place +# (outside of doxygen) the user can define a custom "cut" / "paste" string. +# Example: +# WARN_LINE_FORMAT = "'vi $file +$line'" +# See also: WARN_FORMAT +# The default value is: at line $line of file $file. + +WARN_LINE_FORMAT = "at line $line of file $file" + # The WARN_LOGFILE tag can be used to specify a file to which warning and error # messages should be written. If left blank the output is written to standard -# error (stderr). +# error (stderr). In case the file specified cannot be opened for writing the +# warning and error messages are written to standard error. When as file - is +# specified the warning and error messages are written to standard output +# (stdout). WARN_LOGFILE = @@ -872,21 +918,33 @@ WARN_LOGFILE = # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # Note: If this tag is empty the current directory is searched. -INPUT = history.txt \ - ../Include/ \ - ../Source/ \ - ../Examples/ARM \ - +INPUT = ./src/mainpage.md \ + ./src/history.md \ + ./src/history.txt \ + ../../Examples/ARM \ + ../../Include/ \ + ../../Source/ \ # 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: # https://www.gnu.org/software/libiconv/) for the list of possible encodings. +# See also: INPUT_FILE_ENCODING # The default value is: UTF-8. INPUT_ENCODING = UTF-8 +# This tag can be used to specify the character encoding of the source files +# that doxygen parses The INPUT_FILE_ENCODING tag can be used to specify +# character encoding on a per file pattern basis. Doxygen will compare the file +# name with each pattern and apply the encoding instead of the default +# INPUT_ENCODING) if there is a match. The character encodings are a list of the +# form: pattern=encoding (like *.php=ISO-8859-1). See cfg_input_encoding +# "INPUT_ENCODING" for further information on supported encodings. + +INPUT_FILE_ENCODING = + # 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. @@ -966,15 +1024,15 @@ RECURSIVE = YES # run. EXCLUDE = \ - ../Source/DistanceFunctions/arm_boolean_distance_template.h \ - ../Source/DistanceFunctions/arm_boolean_distance.c + ../../Source/DistanceFunctions/arm_boolean_distance_template.h \ + ../../Source/DistanceFunctions/arm_boolean_distance.c # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or # directories that are symbolic links (a Unix file system feature) are excluded # from the input. # The default value is: NO. -EXCLUDE_SYMLINKS = NO +EXCLUDE_SYMLINKS = YES # If the value of the INPUT tag contains directories, you can use the # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude @@ -991,7 +1049,7 @@ EXCLUDE_PATTERNS = */RTE/* \ # (namespaces, classes, functions, etc.) that should be excluded from the # output. The symbol name can be a fully qualified name, a word, or if the # wildcard * is used, a substring. Examples: ANamespace, AClass, -# AClass::ANamespace, ANamespace::*Test +# ANamespace::AClass, ANamespace::*Test # # Note that the wildcards are matched against the file with absolute path, so to # exclude all test directories use the pattern */test/* @@ -1029,7 +1087,7 @@ EXCLUDE_SYMBOLS = S \ # that contain example code fragments that are included (see the \include # command). -EXAMPLE_PATH = ../Examples/ARM +EXAMPLE_PATH = ../../Examples/ARM # If the value of the EXAMPLE_PATH tag contains directories, you can use the # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and @@ -1049,7 +1107,7 @@ EXAMPLE_RECURSIVE = NO # that contain images that are to be included in the documentation (see the # \image command). -IMAGE_PATH = images +IMAGE_PATH = ./src/images # The INPUT_FILTER tag can be used to specify a program that doxygen should # invoke to filter for each input file. Doxygen will invoke the filter program @@ -1066,6 +1124,11 @@ IMAGE_PATH = images # 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 doxygen will use the data processed and written to standard output +# for further processing, therefore nothing else, like debug statements or used +# commands (so in case of a Windows batch file always use @echo OFF), should be +# written to standard output. +# # 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. @@ -1107,6 +1170,15 @@ FILTER_SOURCE_PATTERNS = USE_MDFILE_AS_MAINPAGE = +# The Fortran standard specifies that for fixed formatted Fortran code all +# characters from position 72 are to be considered as comment. A common +# extension is to allow longer lines before the automatic comment starts. The +# setting FORTRAN_COMMENT_AFTER will also make it possible that longer lines can +# be processed before the automatic comment starts. +# Minimum value: 7, maximum value: 10000, default value: 72. + +FORTRAN_COMMENT_AFTER = 72 + #--------------------------------------------------------------------------- # Configuration options related to source browsing #--------------------------------------------------------------------------- @@ -1244,10 +1316,11 @@ CLANG_DATABASE_PATH = ALPHABETICAL_INDEX = NO -# 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 -# while generating the index headers. +# The IGNORE_PREFIX tag can be used to specify a prefix (or a list of prefixes) +# that should be ignored while generating the index headers. The IGNORE_PREFIX +# tag works for classes, function and member names. The entity will be placed in +# the alphabetical list under the first letter of the entity name that remains +# after removing the prefix. # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. IGNORE_PREFIX = arm_ @@ -1294,7 +1367,7 @@ HTML_FILE_EXTENSION = .html # of the possible markers and block names see the documentation. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_HEADER = templates/header.html +HTML_HEADER = ./style_template/header.html # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each # generated HTML page. If the tag is left blank doxygen will generate a standard @@ -1304,7 +1377,7 @@ HTML_HEADER = templates/header.html # that doxygen normally uses. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_FOOTER = templates/footer.html +HTML_FOOTER = ./style_template/footer.html # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style # sheet that is used by each HTML page. It can be used to fine-tune the look of @@ -1326,11 +1399,19 @@ HTML_STYLESHEET = # 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. +# list). +# Note: Since the styling of scrollbars can currently not be overruled in +# Webkit/Chromium, the styling will be left out of the default doxygen.css if +# one or more extra stylesheets have been specified. So if scrollbar +# customization is desired it has to be added explicitly. For an example see the +# documentation. # This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_EXTRA_STYLESHEET = templates/extra_stylesheet.css +HTML_EXTRA_STYLESHEET = ./style_template/extra_stylesheet.css \ + ./style_template/extra_navtree.css \ + ./style_template/extra_search.css \ + ./style_template/extra_tabs.css \ + ./style_template/version.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 @@ -1340,14 +1421,24 @@ HTML_EXTRA_STYLESHEET = templates/extra_stylesheet.css # files will be copied as-is; there are no commands or markers available. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_EXTRA_FILES = templates/tabs.css \ - templates/search.css \ - templates/navtree.css \ - templates/tab_b.png \ - templates/navtree.js \ - templates/version.css \ - templates/dropdown.png \ - ../LICENSE +HTML_EXTRA_FILES = ./style_template/tab_b.png \ + ./style_template/tabs.js \ + ./style_template/darkmode_toggle.js \ + ./style_template/navtree.js \ + ./style_template/dropdown.png + +# The HTML_COLORSTYLE tag can be used to specify if the generated HTML output +# should be rendered with a dark or light theme. +# Possible values are: LIGHT always generate light mode output, DARK always +# generate dark mode output, AUTO_LIGHT automatically set the mode according to +# the user preference, use light mode if no preference is set (the default), +# AUTO_DARK automatically set the mode according to the user preference, use +# dark mode if no preference is set and TOGGLE allow to user to switch between +# light and dark mode via a button. +# The default value is: AUTO_LIGHT. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE = TOGGLE # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen # will adjust the colors in the style sheet and background images according to @@ -1443,6 +1534,13 @@ GENERATE_DOCSET = NO DOCSET_FEEDNAME = "Doxygen generated docs" +# This tag determines the URL of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDURL = + # This tag specifies a string that should uniquely identify the documentation # set bundle. This should be a reverse domain-name style string, e.g. # com.mycompany.MyDocSet. Doxygen will append .docset to the name. @@ -1623,7 +1721,7 @@ ECLIPSE_DOC_ID = org.doxygen.Project # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. -DISABLE_INDEX = NO +DISABLE_INDEX = YES # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index # structure should be generated to display hierarchical information. If the tag @@ -1647,7 +1745,7 @@ GENERATE_TREEVIEW = YES # 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 +# project logo, title, and description. If either GENERATE_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. @@ -1669,7 +1767,7 @@ ENUM_VALUES_PER_LINE = 1 # Minimum value: 0, maximum value: 1500, default value: 250. # This tag requires that the tag GENERATE_HTML is set to YES. -TREEVIEW_WIDTH = 250 +TREEVIEW_WIDTH = 330 # 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. @@ -1678,6 +1776,13 @@ TREEVIEW_WIDTH = 250 EXT_LINKS_IN_WINDOW = NO +# If the OBFUSCATE_EMAILS tag is set to YES, doxygen will obfuscate email +# addresses. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +OBFUSCATE_EMAILS = YES + # 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 @@ -1698,17 +1803,6 @@ HTML_FORMULA_FORMAT = png FORMULA_FONTSIZE = 10 -# 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. -# -# Note that when changing this option you need to delete any form_*.png files in -# the HTML output directory before the changes have effect. -# The default value is: YES. -# This tag requires that the tag GENERATE_HTML is set to YES. - -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. @@ -2299,7 +2393,8 @@ SEARCH_INCLUDES = YES # The INCLUDE_PATH tag can be used to specify one or more directories that # contain include files that are not input files but should be processed by the -# preprocessor. +# preprocessor. Note that the INCLUDE_PATH is not recursive, so the setting of +# RECURSIVE has no effect here. # This tag requires that the tag SEARCH_INCLUDES is set to YES. INCLUDE_PATH = @@ -2391,15 +2486,6 @@ EXTERNAL_PAGES = YES # Configuration options related to the dot tool #--------------------------------------------------------------------------- -# 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 -# powerful graphs. -# The default value is: YES. - -CLASS_DIAGRAMS = YES - # 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. @@ -2432,35 +2518,50 @@ HAVE_DOT = NO DOT_NUM_THREADS = 0 -# 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 -# setting DOT_FONTPATH to the directory containing the font. -# The default value is: Helvetica. +# DOT_COMMON_ATTR is common attributes for nodes, edges and labels of +# subgraphs. When you want a differently looking font in the dot files that +# doxygen generates you can specify fontname, fontcolor and fontsize attributes. +# For details please see Node, +# Edge and Graph Attributes specification 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 setting DOT_FONTPATH to the +# directory containing the font. Default graphviz fontsize is 14. +# The default value is: fontname=Helvetica,fontsize=10. +# This tag requires that the tag HAVE_DOT is set to YES. + +DOT_COMMON_ATTR = "fontname=Helvetica,fontsize=10" + +# DOT_EDGE_ATTR is concatenated with DOT_COMMON_ATTR. For elegant style you can +# add 'arrowhead=open, arrowtail=open, arrowsize=0.5'. Complete documentation about +# arrows shapes. +# The default value is: labelfontname=Helvetica,labelfontsize=10. # This tag requires that the tag HAVE_DOT is set to YES. -DOT_FONTNAME = Helvetica +DOT_EDGE_ATTR = "labelfontname=Helvetica,labelfontsize=10" -# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of -# dot graphs. -# Minimum value: 4, maximum value: 24, default value: 10. +# DOT_NODE_ATTR is concatenated with DOT_COMMON_ATTR. For view without boxes +# around nodes set 'shape=plain' or 'shape=plaintext' Shapes specification +# The default value is: shape=box,height=0.2,width=0.4. # This tag requires that the tag HAVE_DOT is set to YES. -DOT_FONTSIZE = 10 +DOT_NODE_ATTR = "shape=box,height=0.2,width=0.4" -# By default doxygen will tell dot to use the default font as specified with -# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set -# the path where dot can find it using this tag. +# You can set the path where dot can find font specified with fontname in +# DOT_COMMON_ATTR and others dot attributes. # This tag requires that the tag HAVE_DOT is set to YES. DOT_FONTPATH = -# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for -# each documented class showing the direct and indirect inheritance relations. -# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO. +# If the CLASS_GRAPH tag is set to YES (or GRAPH) then doxygen will generate a +# graph for each documented class showing the direct and indirect inheritance +# relations. In case HAVE_DOT is set as well dot will be used to draw the graph, +# otherwise the built-in generator will be used. If the CLASS_GRAPH tag is set +# to TEXT the direct and indirect inheritance relations will be shown as texts / +# links. +# Possible values are: NO, YES, TEXT and GRAPH. # The default value is: YES. -# This tag requires that the tag HAVE_DOT is set to YES. CLASS_GRAPH = NO @@ -2474,7 +2575,8 @@ CLASS_GRAPH = NO COLLABORATION_GRAPH = NO # If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for -# groups, showing the direct groups dependencies. +# groups, showing the direct groups dependencies. See also the chapter Grouping +# in the manual. # The default value is: YES. # This tag requires that the tag HAVE_DOT is set to YES. @@ -2589,6 +2691,13 @@ GRAPHICAL_HIERARCHY = YES DIRECTORY_GRAPH = YES +# The DIR_GRAPH_MAX_DEPTH tag can be used to limit the maximum number of levels +# of child directories generated in directory dependency graphs by dot. +# Minimum value: 1, maximum value: 25, default value: 1. +# This tag requires that the tag DIRECTORY_GRAPH is set to YES. + +DIR_GRAPH_MAX_DEPTH = 1 + # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images # generated by dot. For an explanation of the image formats see the section # output formats in the documentation of the dot tool (Graphviz (see: @@ -2642,10 +2751,10 @@ 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. +# path where java can find the plantuml.jar file or to the filename of jar file +# to be used. 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 = @@ -2683,18 +2792,6 @@ DOT_GRAPH_MAX_NODES = 50 MAX_DOT_GRAPH_DEPTH = 0 -# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent -# background. This is disabled by default, because dot on Windows does not seem -# to support this out of the box. -# -# Warning: Depending on the platform used, enabling this option may lead to -# badly anti-aliased labels on the edges of a graph (i.e. they become hard to -# read). -# The default value is: NO. -# This tag requires that the tag HAVE_DOT is set to YES. - -DOT_TRANSPARENT = NO - # 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 @@ -2707,6 +2804,8 @@ DOT_MULTI_TARGETS = NO # If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page # explaining the meaning of the various boxes and arrows in the dot generated # graphs. +# Note: This tag requires that UML_LOOK isn't set, i.e. the doxygen internal +# graphical representation for inheritance and collaboration diagrams is used. # The default value is: YES. # This tag requires that the tag HAVE_DOT is set to YES. diff --git a/Documentation/Doxygen/gen_doc.sh b/Documentation/Doxygen/gen_doc.sh new file mode 100644 index 000000000..24d7de0d6 --- /dev/null +++ b/Documentation/Doxygen/gen_doc.sh @@ -0,0 +1,103 @@ +#!/usr/bin/env bash +# Version: 3.0 +# Date: 2023-11-06 +# This bash script generates CMSIS-NN Documentation: +# +# Pre-requisites: +# - bash shell (for Windows: install git for Windows) +# - doxygen 1.9.6 +# - linkchecker (can be skipped with -s) + +set -o pipefail + +# Set version of gen pack library +# For available versions see https://github.com/Open-CMSIS-Pack/gen-pack/tags. +# Use the tag name without the prefix "v", e.g., 0.7.0 +REQUIRED_GEN_PACK_LIB="0.9.1" + +DIRNAME=$(dirname "$(readlink -f "$0")") +GENDIR=../html +REQ_DXY_VERSION="1.9.6" + +RUN_LINKCHECKER=1 + +function usage() { + echo "Usage: $(basename "$0") [-h] [-s] [-c ]" + echo " -h,--help Show usage" + echo " -s,--no-linkcheck Skip linkcheck" + echo " Can be given multiple times. Defaults to all components." +} + +while [[ $# -gt 0 ]]; do + case $1 in + '-h'|'help') + usage + exit 1 + ;; + '-s'|'--no-linkcheck') + RUN_LINKCHECKER=0 + ;; + *) + echo "Invalid command line argument: $1" >&2 + usage + exit 1 + ;; + esac + shift # past argument +done + +############ DO NOT EDIT BELOW ########### + +# Set GEN_PACK_LIB_PATH to use a specific gen-pack library root +# ... instead of bootstrap based on REQUIRED_GEN_PACK_LIB +if [[ -f "${GEN_PACK_LIB_PATH}/gen-pack" ]]; then + . "${GEN_PACK_LIB_PATH}/gen-pack" +else + . <(curl -sL "https://raw.githubusercontent.com/Open-CMSIS-Pack/gen-pack/main/bootstrap") +fi + +find_git +find_doxygen "${REQ_DXY_VERSION}" +[[ ${RUN_LINKCHECKER} != 0 ]] && find_linkchecker + +if [ -z "${VERSION_FULL}" ]; then + VERSION_FULL=$(git_describe "v") +fi + +pushd "${DIRNAME}" > /dev/null || exit 1 + +echo "Generating documentation ..." + +projectName=$(grep -E "PROJECT_NAME\s+=" dsp.dxy.in | sed -r -e 's/[^"]*"([^"]+)".*/\1/') +projectNumberFull="${VERSION_FULL}" +projectNumber="${projectNumberFull%+*}" +datetime=$(date -u +'%a %b %e %Y %H:%M:%S') +year=$(date -u +'%Y') + +sed -e "s/{projectNumber}/${projectNumber}/" dsp.dxy.in \ + | sed -e "s/{cmsisProjectNumber}/${cmsisProjectNumber}/" \ + > dsp.dxy + +git_changelog -f html -p "v" > src/history.txt + +echo_log "\"${UTILITY_DOXYGEN}\" dsp.dxy" +"${UTILITY_DOXYGEN}" dsp.dxy + +mkdir -p "${DIRNAME}/${GENDIR}/search/" +cp -f "${DIRNAME}/style_template/search.css" "${DIRNAME}/${GENDIR}/search/" +cp -f "${DIRNAME}/style_template/navtree.js" "${DIRNAME}/${GENDIR}/" +cp -f "${DIRNAME}/style_template/resize.js" "${DIRNAME}/${GENDIR}/" + +sed -e "s/{datetime}/${datetime}/" "${DIRNAME}/style_template/footer.js.in" \ + | sed -e "s/{year}/${year}/" \ + | sed -e "s/{projectName}/${projectName}/" \ + | sed -e "s/{projectNumber}/${projectNumber}/" \ + | sed -e "s/{projectNumberFull}/${projectNumberFull}/" \ + > "${DIRNAME}/${GENDIR}/footer.js" + +popd > /dev/null || exit 1 + +[[ ${RUN_LINKCHECKER} != 0 ]] && check_links "${DIRNAME}/../html/index.html" "${DIRNAME}" + + +exit 0 diff --git a/Documentation/Doxygen/linkchecker.rc b/Documentation/Doxygen/linkchecker.rc new file mode 100644 index 000000000..3129c0b8d --- /dev/null +++ b/Documentation/Doxygen/linkchecker.rc @@ -0,0 +1,12 @@ +[output] +ignoreerrors= + mag.svg + mag_sel.svg + mag_d.svg + mag_seld.svg + ../tab_a.png + ../tab_ad.png + +[filtering] +ignorewarnings= + http-redirected diff --git a/Documentation/Doxygen/src/history.md b/Documentation/Doxygen/src/history.md new file mode 100644 index 000000000..a5aa2d19c --- /dev/null +++ b/Documentation/Doxygen/src/history.md @@ -0,0 +1,5 @@ +# Revision History {#rev_hist} + +CMSIS-DSP version is offically updated upon releases of the [CMSIS-DSP pack](https://www.keil.arm.com/packs/cmsis-dsp-arm/versions/). + +The table below provides information about the changes delivered with specific versions of CMSIS-DSP. diff --git a/Documentation/Doxygen/src/history.txt b/Documentation/Doxygen/src/history.txt new file mode 100644 index 000000000..e69de29bb diff --git a/Doxygen/images/Biquad Figure.vsd b/Documentation/Doxygen/src/images/Biquad Figure.vsd similarity index 100% rename from Doxygen/images/Biquad Figure.vsd rename to Documentation/Doxygen/src/images/Biquad Figure.vsd diff --git a/Doxygen/images/Biquad.gif b/Documentation/Doxygen/src/images/Biquad.gif similarity index 100% rename from Doxygen/images/Biquad.gif rename to Documentation/Doxygen/src/images/Biquad.gif diff --git a/Doxygen/images/BiquadCascade.gif b/Documentation/Doxygen/src/images/BiquadCascade.gif similarity index 100% rename from Doxygen/images/BiquadCascade.gif rename to Documentation/Doxygen/src/images/BiquadCascade.gif diff --git a/Doxygen/images/BiquadDF2Transposed.gif b/Documentation/Doxygen/src/images/BiquadDF2Transposed.gif similarity index 100% rename from Doxygen/images/BiquadDF2Transposed.gif rename to Documentation/Doxygen/src/images/BiquadDF2Transposed.gif diff --git a/Doxygen/images/BiquadDF2Transposed.vsd b/Documentation/Doxygen/src/images/BiquadDF2Transposed.vsd similarity index 100% rename from Doxygen/images/BiquadDF2Transposed.vsd rename to Documentation/Doxygen/src/images/BiquadDF2Transposed.vsd diff --git a/Doxygen/images/BiquadPostshift.gif b/Documentation/Doxygen/src/images/BiquadPostshift.gif similarity index 100% rename from Doxygen/images/BiquadPostshift.gif rename to Documentation/Doxygen/src/images/BiquadPostshift.gif diff --git a/Doxygen/images/CFFT.gif b/Documentation/Doxygen/src/images/CFFT.gif similarity index 100% rename from Doxygen/images/CFFT.gif rename to Documentation/Doxygen/src/images/CFFT.gif diff --git a/Doxygen/images/CFFT.vsd b/Documentation/Doxygen/src/images/CFFT.vsd similarity index 100% rename from Doxygen/images/CFFT.vsd rename to Documentation/Doxygen/src/images/CFFT.vsd diff --git a/Doxygen/images/CFFTQ15.gif b/Documentation/Doxygen/src/images/CFFTQ15.gif similarity index 100% rename from Doxygen/images/CFFTQ15.gif rename to Documentation/Doxygen/src/images/CFFTQ15.gif diff --git a/Doxygen/images/CFFTQ15.vsd b/Documentation/Doxygen/src/images/CFFTQ15.vsd similarity index 100% rename from Doxygen/images/CFFTQ15.vsd rename to Documentation/Doxygen/src/images/CFFTQ15.vsd diff --git a/Doxygen/images/CFFTQ31.gif b/Documentation/Doxygen/src/images/CFFTQ31.gif similarity index 100% rename from Doxygen/images/CFFTQ31.gif rename to Documentation/Doxygen/src/images/CFFTQ31.gif diff --git a/Doxygen/images/CFFTQ31.vsd b/Documentation/Doxygen/src/images/CFFTQ31.vsd similarity index 100% rename from Doxygen/images/CFFTQ31.vsd rename to Documentation/Doxygen/src/images/CFFTQ31.vsd diff --git a/Doxygen/images/CFFT_Radix2.gif b/Documentation/Doxygen/src/images/CFFT_Radix2.gif similarity index 100% rename from Doxygen/images/CFFT_Radix2.gif rename to Documentation/Doxygen/src/images/CFFT_Radix2.gif diff --git a/Doxygen/images/CIFFTQ15.gif b/Documentation/Doxygen/src/images/CIFFTQ15.gif similarity index 100% rename from Doxygen/images/CIFFTQ15.gif rename to Documentation/Doxygen/src/images/CIFFTQ15.gif diff --git a/Doxygen/images/CIFFTQ15.vsd b/Documentation/Doxygen/src/images/CIFFTQ15.vsd similarity index 100% rename from Doxygen/images/CIFFTQ15.vsd rename to Documentation/Doxygen/src/images/CIFFTQ15.vsd diff --git a/Doxygen/images/CIFFTQ31.gif b/Documentation/Doxygen/src/images/CIFFTQ31.gif similarity index 100% rename from Doxygen/images/CIFFTQ31.gif rename to Documentation/Doxygen/src/images/CIFFTQ31.gif diff --git a/Doxygen/images/CIFFTQ31.vsd b/Documentation/Doxygen/src/images/CIFFTQ31.vsd similarity index 100% rename from Doxygen/images/CIFFTQ31.vsd rename to Documentation/Doxygen/src/images/CIFFTQ31.vsd diff --git a/Doxygen/images/ConvergingSignal.jpg b/Documentation/Doxygen/src/images/ConvergingSignal.jpg similarity index 100% rename from Doxygen/images/ConvergingSignal.jpg rename to Documentation/Doxygen/src/images/ConvergingSignal.jpg diff --git a/Doxygen/images/Convolution.gif b/Documentation/Doxygen/src/images/Convolution.gif similarity index 100% rename from Doxygen/images/Convolution.gif rename to Documentation/Doxygen/src/images/Convolution.gif diff --git a/Doxygen/images/Convolution.vsd b/Documentation/Doxygen/src/images/Convolution.vsd similarity index 100% rename from Doxygen/images/Convolution.vsd rename to Documentation/Doxygen/src/images/Convolution.vsd diff --git a/Doxygen/images/ConvolutionEquation.gif b/Documentation/Doxygen/src/images/ConvolutionEquation.gif similarity index 100% rename from Doxygen/images/ConvolutionEquation.gif rename to Documentation/Doxygen/src/images/ConvolutionEquation.gif diff --git a/Doxygen/images/Convolution_Animation.gif b/Documentation/Doxygen/src/images/Convolution_Animation.gif similarity index 100% rename from Doxygen/images/Convolution_Animation.gif rename to Documentation/Doxygen/src/images/Convolution_Animation.gif diff --git a/Doxygen/images/CorrelateEquation.gif b/Documentation/Doxygen/src/images/CorrelateEquation.gif similarity index 100% rename from Doxygen/images/CorrelateEquation.gif rename to Documentation/Doxygen/src/images/CorrelateEquation.gif diff --git a/Doxygen/images/CorrelateEquation.vsd b/Documentation/Doxygen/src/images/CorrelateEquation.vsd similarity index 100% rename from Doxygen/images/CorrelateEquation.vsd rename to Documentation/Doxygen/src/images/CorrelateEquation.vsd diff --git a/Doxygen/images/CorrelateProperty.gif b/Documentation/Doxygen/src/images/CorrelateProperty.gif similarity index 100% rename from Doxygen/images/CorrelateProperty.gif rename to Documentation/Doxygen/src/images/CorrelateProperty.gif diff --git a/Doxygen/images/Correlation equations.doc b/Documentation/Doxygen/src/images/Correlation equations.doc similarity index 100% rename from Doxygen/images/Correlation equations.doc rename to Documentation/Doxygen/src/images/Correlation equations.doc diff --git a/Doxygen/images/DCT4.gif b/Documentation/Doxygen/src/images/DCT4.gif similarity index 100% rename from Doxygen/images/DCT4.gif rename to Documentation/Doxygen/src/images/DCT4.gif diff --git a/Doxygen/images/DCT4.vsd b/Documentation/Doxygen/src/images/DCT4.vsd similarity index 100% rename from Doxygen/images/DCT4.vsd rename to Documentation/Doxygen/src/images/DCT4.vsd diff --git a/Doxygen/images/DCT4Equation.gif b/Documentation/Doxygen/src/images/DCT4Equation.gif similarity index 100% rename from Doxygen/images/DCT4Equation.gif rename to Documentation/Doxygen/src/images/DCT4Equation.gif diff --git a/Doxygen/images/FFT.doc b/Documentation/Doxygen/src/images/FFT.doc similarity index 100% rename from Doxygen/images/FFT.doc rename to Documentation/Doxygen/src/images/FFT.doc diff --git a/Doxygen/images/FFTBin.gif b/Documentation/Doxygen/src/images/FFTBin.gif similarity index 100% rename from Doxygen/images/FFTBin.gif rename to Documentation/Doxygen/src/images/FFTBin.gif diff --git a/Doxygen/images/FFTBin.vsd b/Documentation/Doxygen/src/images/FFTBin.vsd similarity index 100% rename from Doxygen/images/FFTBin.vsd rename to Documentation/Doxygen/src/images/FFTBin.vsd diff --git a/Doxygen/images/FFTBinInput.gif b/Documentation/Doxygen/src/images/FFTBinInput.gif similarity index 100% rename from Doxygen/images/FFTBinInput.gif rename to Documentation/Doxygen/src/images/FFTBinInput.gif diff --git a/Doxygen/images/FFTBinInput.vsd b/Documentation/Doxygen/src/images/FFTBinInput.vsd similarity index 100% rename from Doxygen/images/FFTBinInput.vsd rename to Documentation/Doxygen/src/images/FFTBinInput.vsd diff --git a/Doxygen/images/FFTBinOutput.gif b/Documentation/Doxygen/src/images/FFTBinOutput.gif similarity index 100% rename from Doxygen/images/FFTBinOutput.gif rename to Documentation/Doxygen/src/images/FFTBinOutput.gif diff --git a/Doxygen/images/FFTBinOutput.vsd b/Documentation/Doxygen/src/images/FFTBinOutput.vsd similarity index 100% rename from Doxygen/images/FFTBinOutput.vsd rename to Documentation/Doxygen/src/images/FFTBinOutput.vsd diff --git a/Doxygen/images/FIR.GIF b/Documentation/Doxygen/src/images/FIR.GIF similarity index 100% rename from Doxygen/images/FIR.GIF rename to Documentation/Doxygen/src/images/FIR.GIF diff --git a/Doxygen/images/FIR.vsd b/Documentation/Doxygen/src/images/FIR.vsd similarity index 100% rename from Doxygen/images/FIR.vsd rename to Documentation/Doxygen/src/images/FIR.vsd diff --git a/Doxygen/images/FIRDecimator.gif b/Documentation/Doxygen/src/images/FIRDecimator.gif similarity index 100% rename from Doxygen/images/FIRDecimator.gif rename to Documentation/Doxygen/src/images/FIRDecimator.gif diff --git a/Doxygen/images/FIRDecimator.vsd b/Documentation/Doxygen/src/images/FIRDecimator.vsd similarity index 100% rename from Doxygen/images/FIRDecimator.vsd rename to Documentation/Doxygen/src/images/FIRDecimator.vsd diff --git a/Doxygen/images/FIRInterpolator.gif b/Documentation/Doxygen/src/images/FIRInterpolator.gif similarity index 100% rename from Doxygen/images/FIRInterpolator.gif rename to Documentation/Doxygen/src/images/FIRInterpolator.gif diff --git a/Doxygen/images/FIRLPF.gif b/Documentation/Doxygen/src/images/FIRLPF.gif similarity index 100% rename from Doxygen/images/FIRLPF.gif rename to Documentation/Doxygen/src/images/FIRLPF.gif diff --git a/Doxygen/images/FIRLPFExample_SignalFlow.vsd b/Documentation/Doxygen/src/images/FIRLPFExample_SignalFlow.vsd similarity index 100% rename from Doxygen/images/FIRLPFExample_SignalFlow.vsd rename to Documentation/Doxygen/src/images/FIRLPFExample_SignalFlow.vsd diff --git a/Doxygen/images/FIRLPF_coeffs.gif b/Documentation/Doxygen/src/images/FIRLPF_coeffs.gif similarity index 100% rename from Doxygen/images/FIRLPF_coeffs.gif rename to Documentation/Doxygen/src/images/FIRLPF_coeffs.gif diff --git a/Doxygen/images/FIRLPF_input.gif b/Documentation/Doxygen/src/images/FIRLPF_input.gif similarity index 100% rename from Doxygen/images/FIRLPF_input.gif rename to Documentation/Doxygen/src/images/FIRLPF_input.gif diff --git a/Doxygen/images/FIRLPF_output.gif b/Documentation/Doxygen/src/images/FIRLPF_output.gif similarity index 100% rename from Doxygen/images/FIRLPF_output.gif rename to Documentation/Doxygen/src/images/FIRLPF_output.gif diff --git a/Doxygen/images/FIRLPF_response.gif b/Documentation/Doxygen/src/images/FIRLPF_response.gif similarity index 100% rename from Doxygen/images/FIRLPF_response.gif rename to Documentation/Doxygen/src/images/FIRLPF_response.gif diff --git a/Doxygen/images/FIRLPF_signalflow.gif b/Documentation/Doxygen/src/images/FIRLPF_signalflow.gif similarity index 100% rename from Doxygen/images/FIRLPF_signalflow.gif rename to Documentation/Doxygen/src/images/FIRLPF_signalflow.gif diff --git a/Doxygen/images/FIRLattice.gif b/Documentation/Doxygen/src/images/FIRLattice.gif similarity index 100% rename from Doxygen/images/FIRLattice.gif rename to Documentation/Doxygen/src/images/FIRLattice.gif diff --git a/Doxygen/images/FIRLattice.vsd b/Documentation/Doxygen/src/images/FIRLattice.vsd similarity index 100% rename from Doxygen/images/FIRLattice.vsd rename to Documentation/Doxygen/src/images/FIRLattice.vsd diff --git a/Doxygen/images/FIRSparse.gif b/Documentation/Doxygen/src/images/FIRSparse.gif similarity index 100% rename from Doxygen/images/FIRSparse.gif rename to Documentation/Doxygen/src/images/FIRSparse.gif diff --git a/Doxygen/images/FIRSparse.vsd b/Documentation/Doxygen/src/images/FIRSparse.vsd similarity index 100% rename from Doxygen/images/FIRSparse.vsd rename to Documentation/Doxygen/src/images/FIRSparse.vsd diff --git a/Doxygen/images/FIRSparse_old.vsd b/Documentation/Doxygen/src/images/FIRSparse_old.vsd similarity index 100% rename from Doxygen/images/FIRSparse_old.vsd rename to Documentation/Doxygen/src/images/FIRSparse_old.vsd diff --git a/Doxygen/images/GEQ_allbandresponse.gif b/Documentation/Doxygen/src/images/GEQ_allbandresponse.gif similarity index 100% rename from Doxygen/images/GEQ_allbandresponse.gif rename to Documentation/Doxygen/src/images/GEQ_allbandresponse.gif diff --git a/Doxygen/images/GEQ_bandresponse.gif b/Documentation/Doxygen/src/images/GEQ_bandresponse.gif similarity index 100% rename from Doxygen/images/GEQ_bandresponse.gif rename to Documentation/Doxygen/src/images/GEQ_bandresponse.gif diff --git a/Doxygen/images/GEQ_inputchirp.gif b/Documentation/Doxygen/src/images/GEQ_inputchirp.gif similarity index 100% rename from Doxygen/images/GEQ_inputchirp.gif rename to Documentation/Doxygen/src/images/GEQ_inputchirp.gif diff --git a/Doxygen/images/GEQ_outputchirp.gif b/Documentation/Doxygen/src/images/GEQ_outputchirp.gif similarity index 100% rename from Doxygen/images/GEQ_outputchirp.gif rename to Documentation/Doxygen/src/images/GEQ_outputchirp.gif diff --git a/Doxygen/images/GEQ_signalflow.gif b/Documentation/Doxygen/src/images/GEQ_signalflow.gif similarity index 100% rename from Doxygen/images/GEQ_signalflow.gif rename to Documentation/Doxygen/src/images/GEQ_signalflow.gif diff --git a/Doxygen/images/GEQ_signalflow.vsd b/Documentation/Doxygen/src/images/GEQ_signalflow.vsd similarity index 100% rename from Doxygen/images/GEQ_signalflow.vsd rename to Documentation/Doxygen/src/images/GEQ_signalflow.vsd diff --git a/Doxygen/images/IDCT4Equation.gif b/Documentation/Doxygen/src/images/IDCT4Equation.gif similarity index 100% rename from Doxygen/images/IDCT4Equation.gif rename to Documentation/Doxygen/src/images/IDCT4Equation.gif diff --git a/Doxygen/images/IIRLattice.gif b/Documentation/Doxygen/src/images/IIRLattice.gif similarity index 100% rename from Doxygen/images/IIRLattice.gif rename to Documentation/Doxygen/src/images/IIRLattice.gif diff --git a/Doxygen/images/IIRLattice.vsd b/Documentation/Doxygen/src/images/IIRLattice.vsd similarity index 100% rename from Doxygen/images/IIRLattice.vsd rename to Documentation/Doxygen/src/images/IIRLattice.vsd diff --git a/Doxygen/images/LMS.gif b/Documentation/Doxygen/src/images/LMS.gif similarity index 100% rename from Doxygen/images/LMS.gif rename to Documentation/Doxygen/src/images/LMS.gif diff --git a/Doxygen/images/LMS.vsd b/Documentation/Doxygen/src/images/LMS.vsd similarity index 100% rename from Doxygen/images/LMS.vsd rename to Documentation/Doxygen/src/images/LMS.vsd diff --git a/Doxygen/images/LinearInterp.gif b/Documentation/Doxygen/src/images/LinearInterp.gif similarity index 100% rename from Doxygen/images/LinearInterp.gif rename to Documentation/Doxygen/src/images/LinearInterp.gif diff --git a/Doxygen/images/LinearInterp.vsd b/Documentation/Doxygen/src/images/LinearInterp.vsd similarity index 100% rename from Doxygen/images/LinearInterp.vsd rename to Documentation/Doxygen/src/images/LinearInterp.vsd diff --git a/Doxygen/images/MatrixAddition.gif b/Documentation/Doxygen/src/images/MatrixAddition.gif similarity index 100% rename from Doxygen/images/MatrixAddition.gif rename to Documentation/Doxygen/src/images/MatrixAddition.gif diff --git a/Doxygen/images/MatrixExample.gif b/Documentation/Doxygen/src/images/MatrixExample.gif similarity index 100% rename from Doxygen/images/MatrixExample.gif rename to Documentation/Doxygen/src/images/MatrixExample.gif diff --git a/Doxygen/images/MatrixExample.vsd b/Documentation/Doxygen/src/images/MatrixExample.vsd similarity index 100% rename from Doxygen/images/MatrixExample.vsd rename to Documentation/Doxygen/src/images/MatrixExample.vsd diff --git a/Doxygen/images/MatrixInverse.gif b/Documentation/Doxygen/src/images/MatrixInverse.gif similarity index 100% rename from Doxygen/images/MatrixInverse.gif rename to Documentation/Doxygen/src/images/MatrixInverse.gif diff --git a/Doxygen/images/MatrixMultiplication.gif b/Documentation/Doxygen/src/images/MatrixMultiplication.gif similarity index 100% rename from Doxygen/images/MatrixMultiplication.gif rename to Documentation/Doxygen/src/images/MatrixMultiplication.gif diff --git a/Doxygen/images/MatrixScale.gif b/Documentation/Doxygen/src/images/MatrixScale.gif similarity index 100% rename from Doxygen/images/MatrixScale.gif rename to Documentation/Doxygen/src/images/MatrixScale.gif diff --git a/Doxygen/images/MatrixSubtraction.gif b/Documentation/Doxygen/src/images/MatrixSubtraction.gif similarity index 100% rename from Doxygen/images/MatrixSubtraction.gif rename to Documentation/Doxygen/src/images/MatrixSubtraction.gif diff --git a/Doxygen/images/MatrixTranspose.gif b/Documentation/Doxygen/src/images/MatrixTranspose.gif similarity index 100% rename from Doxygen/images/MatrixTranspose.gif rename to Documentation/Doxygen/src/images/MatrixTranspose.gif diff --git a/Doxygen/images/PID.gif b/Documentation/Doxygen/src/images/PID.gif similarity index 100% rename from Doxygen/images/PID.gif rename to Documentation/Doxygen/src/images/PID.gif diff --git a/Doxygen/images/PID.vsd b/Documentation/Doxygen/src/images/PID.vsd similarity index 100% rename from Doxygen/images/PID.vsd rename to Documentation/Doxygen/src/images/PID.vsd diff --git a/Doxygen/images/PartialConvolutionEquation.gif b/Documentation/Doxygen/src/images/PartialConvolutionEquation.gif similarity index 100% rename from Doxygen/images/PartialConvolutionEquation.gif rename to Documentation/Doxygen/src/images/PartialConvolutionEquation.gif diff --git a/Doxygen/images/RFFT.gif b/Documentation/Doxygen/src/images/RFFT.gif similarity index 100% rename from Doxygen/images/RFFT.gif rename to Documentation/Doxygen/src/images/RFFT.gif diff --git a/Doxygen/images/RFFT.vsd b/Documentation/Doxygen/src/images/RFFT.vsd similarity index 100% rename from Doxygen/images/RFFT.vsd rename to Documentation/Doxygen/src/images/RFFT.vsd diff --git a/Doxygen/images/RFFTQ15.gif b/Documentation/Doxygen/src/images/RFFTQ15.gif similarity index 100% rename from Doxygen/images/RFFTQ15.gif rename to Documentation/Doxygen/src/images/RFFTQ15.gif diff --git a/Doxygen/images/RFFTQ15.vsd b/Documentation/Doxygen/src/images/RFFTQ15.vsd similarity index 100% rename from Doxygen/images/RFFTQ15.vsd rename to Documentation/Doxygen/src/images/RFFTQ15.vsd diff --git a/Doxygen/images/RFFTQ31.gif b/Documentation/Doxygen/src/images/RFFTQ31.gif similarity index 100% rename from Doxygen/images/RFFTQ31.gif rename to Documentation/Doxygen/src/images/RFFTQ31.gif diff --git a/Doxygen/images/RFFTQ31.vsd b/Documentation/Doxygen/src/images/RFFTQ31.vsd similarity index 100% rename from Doxygen/images/RFFTQ31.vsd rename to Documentation/Doxygen/src/images/RFFTQ31.vsd diff --git a/Doxygen/images/RIFFT.gif b/Documentation/Doxygen/src/images/RIFFT.gif similarity index 100% rename from Doxygen/images/RIFFT.gif rename to Documentation/Doxygen/src/images/RIFFT.gif diff --git a/Doxygen/images/RIFFTQ15.gif b/Documentation/Doxygen/src/images/RIFFTQ15.gif similarity index 100% rename from Doxygen/images/RIFFTQ15.gif rename to Documentation/Doxygen/src/images/RIFFTQ15.gif diff --git a/Doxygen/images/RIFFTQ15.vsd b/Documentation/Doxygen/src/images/RIFFTQ15.vsd similarity index 100% rename from Doxygen/images/RIFFTQ15.vsd rename to Documentation/Doxygen/src/images/RIFFTQ15.vsd diff --git a/Doxygen/images/RIFFTQ31.gif b/Documentation/Doxygen/src/images/RIFFTQ31.gif similarity index 100% rename from Doxygen/images/RIFFTQ31.gif rename to Documentation/Doxygen/src/images/RIFFTQ31.gif diff --git a/Doxygen/images/RIFFTQ31.vsd b/Documentation/Doxygen/src/images/RIFFTQ31.vsd similarity index 100% rename from Doxygen/images/RIFFTQ31.vsd rename to Documentation/Doxygen/src/images/RIFFTQ31.vsd diff --git a/Doxygen/images/SignalFlow.gif b/Documentation/Doxygen/src/images/SignalFlow.gif similarity index 100% rename from Doxygen/images/SignalFlow.gif rename to Documentation/Doxygen/src/images/SignalFlow.gif diff --git a/Doxygen/images/Variance.gif b/Documentation/Doxygen/src/images/Variance.gif similarity index 100% rename from Doxygen/images/Variance.gif rename to Documentation/Doxygen/src/images/Variance.gif diff --git a/Doxygen/images/Variance.vsd b/Documentation/Doxygen/src/images/Variance.vsd similarity index 100% rename from Doxygen/images/Variance.vsd rename to Documentation/Doxygen/src/images/Variance.vsd diff --git a/Doxygen/images/clarke.gif b/Documentation/Doxygen/src/images/clarke.gif similarity index 100% rename from Doxygen/images/clarke.gif rename to Documentation/Doxygen/src/images/clarke.gif diff --git a/Doxygen/images/clarkeFormula.gif b/Documentation/Doxygen/src/images/clarkeFormula.gif similarity index 100% rename from Doxygen/images/clarkeFormula.gif rename to Documentation/Doxygen/src/images/clarkeFormula.gif diff --git a/Doxygen/images/clarkeInvFormula.gif b/Documentation/Doxygen/src/images/clarkeInvFormula.gif similarity index 100% rename from Doxygen/images/clarkeInvFormula.gif rename to Documentation/Doxygen/src/images/clarkeInvFormula.gif diff --git a/Doxygen/images/convolution1.gif b/Documentation/Doxygen/src/images/convolution1.gif similarity index 100% rename from Doxygen/images/convolution1.gif rename to Documentation/Doxygen/src/images/convolution1.gif diff --git a/Doxygen/images/convolution1.vsd b/Documentation/Doxygen/src/images/convolution1.vsd similarity index 100% rename from Doxygen/images/convolution1.vsd rename to Documentation/Doxygen/src/images/convolution1.vsd diff --git a/Doxygen/images/dct4FormatsQ15Table.gif b/Documentation/Doxygen/src/images/dct4FormatsQ15Table.gif similarity index 100% rename from Doxygen/images/dct4FormatsQ15Table.gif rename to Documentation/Doxygen/src/images/dct4FormatsQ15Table.gif diff --git a/Doxygen/images/dct4FormatsQ31Table.gif b/Documentation/Doxygen/src/images/dct4FormatsQ31Table.gif similarity index 100% rename from Doxygen/images/dct4FormatsQ31Table.gif rename to Documentation/Doxygen/src/images/dct4FormatsQ31Table.gif diff --git a/Doxygen/images/dct4NormalizingF32Table.gif b/Documentation/Doxygen/src/images/dct4NormalizingF32Table.gif similarity index 100% rename from Doxygen/images/dct4NormalizingF32Table.gif rename to Documentation/Doxygen/src/images/dct4NormalizingF32Table.gif diff --git a/Doxygen/images/dct4NormalizingQ15Table.gif b/Documentation/Doxygen/src/images/dct4NormalizingQ15Table.gif similarity index 100% rename from Doxygen/images/dct4NormalizingQ15Table.gif rename to Documentation/Doxygen/src/images/dct4NormalizingQ15Table.gif diff --git a/Doxygen/images/dct4NormalizingQ31Table.gif b/Documentation/Doxygen/src/images/dct4NormalizingQ31Table.gif similarity index 100% rename from Doxygen/images/dct4NormalizingQ31Table.gif rename to Documentation/Doxygen/src/images/dct4NormalizingQ31Table.gif diff --git a/Doxygen/images/dct4Tables.ppt b/Documentation/Doxygen/src/images/dct4Tables.ppt similarity index 100% rename from Doxygen/images/dct4Tables.ppt rename to Documentation/Doxygen/src/images/dct4Tables.ppt diff --git a/Doxygen/images/dotProduct.gif b/Documentation/Doxygen/src/images/dotProduct.gif similarity index 100% rename from Doxygen/images/dotProduct.gif rename to Documentation/Doxygen/src/images/dotProduct.gif diff --git a/Doxygen/images/dotProduct.vsd b/Documentation/Doxygen/src/images/dotProduct.vsd similarity index 100% rename from Doxygen/images/dotProduct.vsd rename to Documentation/Doxygen/src/images/dotProduct.vsd diff --git a/Doxygen/images/linearInterpExample.gif b/Documentation/Doxygen/src/images/linearInterpExample.gif similarity index 100% rename from Doxygen/images/linearInterpExample.gif rename to Documentation/Doxygen/src/images/linearInterpExample.gif diff --git a/Doxygen/images/linearInterpExample.vsd b/Documentation/Doxygen/src/images/linearInterpExample.vsd similarity index 100% rename from Doxygen/images/linearInterpExample.vsd rename to Documentation/Doxygen/src/images/linearInterpExample.vsd diff --git a/Doxygen/images/linearInterpExampleMethod1.gif b/Documentation/Doxygen/src/images/linearInterpExampleMethod1.gif similarity index 100% rename from Doxygen/images/linearInterpExampleMethod1.gif rename to Documentation/Doxygen/src/images/linearInterpExampleMethod1.gif diff --git a/Doxygen/images/linearInterpExampleMethod2.gif b/Documentation/Doxygen/src/images/linearInterpExampleMethod2.gif similarity index 100% rename from Doxygen/images/linearInterpExampleMethod2.gif rename to Documentation/Doxygen/src/images/linearInterpExampleMethod2.gif diff --git a/Doxygen/images/linearInterpExampleMethod2.vsd b/Documentation/Doxygen/src/images/linearInterpExampleMethod2.vsd similarity index 100% rename from Doxygen/images/linearInterpExampleMethod2.vsd rename to Documentation/Doxygen/src/images/linearInterpExampleMethod2.vsd diff --git a/Doxygen/images/park.gif b/Documentation/Doxygen/src/images/park.gif similarity index 100% rename from Doxygen/images/park.gif rename to Documentation/Doxygen/src/images/park.gif diff --git a/Doxygen/images/parkFormula.gif b/Documentation/Doxygen/src/images/parkFormula.gif similarity index 100% rename from Doxygen/images/parkFormula.gif rename to Documentation/Doxygen/src/images/parkFormula.gif diff --git a/Doxygen/images/parkFormula.vsd b/Documentation/Doxygen/src/images/parkFormula.vsd similarity index 100% rename from Doxygen/images/parkFormula.vsd rename to Documentation/Doxygen/src/images/parkFormula.vsd diff --git a/Doxygen/images/parkInvFormula.gif b/Documentation/Doxygen/src/images/parkInvFormula.gif similarity index 100% rename from Doxygen/images/parkInvFormula.gif rename to Documentation/Doxygen/src/images/parkInvFormula.gif diff --git a/Doxygen/images/sinCos.gif b/Documentation/Doxygen/src/images/sinCos.gif similarity index 100% rename from Doxygen/images/sinCos.gif rename to Documentation/Doxygen/src/images/sinCos.gif diff --git a/Doxygen/images/sinCos.vsd b/Documentation/Doxygen/src/images/sinCos.vsd similarity index 100% rename from Doxygen/images/sinCos.vsd rename to Documentation/Doxygen/src/images/sinCos.vsd diff --git a/Doxygen/images/varianceFormulae.vsd b/Documentation/Doxygen/src/images/varianceFormulae.vsd similarity index 100% rename from Doxygen/images/varianceFormulae.vsd rename to Documentation/Doxygen/src/images/varianceFormulae.vsd diff --git a/Documentation/Doxygen/src/mainpage.md b/Documentation/Doxygen/src/mainpage.md new file mode 100644 index 000000000..80ef9fcb8 --- /dev/null +++ b/Documentation/Doxygen/src/mainpage.md @@ -0,0 +1,110 @@ +# Overview {#mainpage} + +This user manual describes the CMSIS DSP software library, a suite of common compute processing functions for use on Cortex-M and Cortex-A processor based devices. + +The library is divided into a number of functions each covering a specific category: + + - \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" + - \ref groupWindow "Window 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 and 64-bit floating-point values. + +The library is providing vectorized versions of most algorithms for Helium and of most f32 algorithms for Neon. + +When using a vectorized version, provide a little bit of padding after the end of a buffer (3 words) because the vectorized code may read a little bit after the end of a buffer. You don't have to modify your buffers but just ensure that the end of buffer + padding is not outside of a memory region. + +A Python wrapper is also available with a Python API as close as possible to the C one. It can be used to start developing and testing an algorithm with NumPy and SciPy before writing the C version. Is is available on [PyPI.org](https://pypi.org/project/cmsisdsp/). It can be installed with: `pip install cmsisdsp`. + +## Using the Library {#using} + +The library is released in source form. It is strongly advised to compile the library using `-Ofast` optimization to have the best performances. + +The library functions are declared in the public file `Include/arm_math.h`. Simply include this file to use the CMSIS-DSP library. If you don't want to include everything, you can also rely on individual header files from the `Include/dsp/` folder and include only those that are needed in the project. + +## Examples {#example} + +The library ships with a number of examples which demonstrate how to use the library functions. Please refer to \ref groupExamples. + +## Toolchain Support {#toolchain} + +The library is now tested on Fast Models building with cmake. Core M0, M4, M7, M33, M55, A32 are tested. + +## Access to CMSIS-DSP {#pack} + +CMSIS-DSP is actively maintained in the [**CMSIS-DSP GitHub repository**](https://github.com/ARM-software/CMSIS-RTX) and is released as a standalone [**CMSIS-DSP pack**](https://www.keil.arm.com/packs/cmsis-dsp-arm/versions/) in the [CMSIS-Pack format](https://open-cmsis-pack.github.io/Open-CMSIS-Pack-Spec/main/html/index.html). + +The table below explains the content of **ARM::CMSIS-DSP** pack. + + Directory | Description +:--------------------------------------|:------------------------------------------------------ + 📂 ComputeLibrary | Small Neon kernels when building on Cortex-A + 📂 Documentation | Folder with this CMSIS-DSP documenation + 📂 Example | Example projects demonstrating the usage of the library functions + 📂 Include | Include files for using and building the lib + 📂 PrivateInclude | Private include files for building the lib + 📂 Source | Source files + 📄 ARM.CMSIS-DSP.pdsc | CMSIS-Pack description file + 📄 LICENSE | License Agreement (Apache 2.0) + +See [CMSIS Documentation](https://arm-software.github.io/CMSIS_6/) for an overview of CMSIS software components, tools and specifications. + + +## Preprocessor Macros {#preprocessor} + +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 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. 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. 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 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 and use pure C instead. The vectorization is then done by the compiler. + +## License {#license} + +The CMSIS-DSP is provided free of charge under the [Apache 2.0 License](https://raw.githubusercontent.com/ARM-software/CMSIS-DSP/main/LICENSE). diff --git a/Doxygen/templates/cmsis_logo_white_small.png b/Documentation/Doxygen/style_template/cmsis_logo_white_small.png similarity index 100% rename from Doxygen/templates/cmsis_logo_white_small.png rename to Documentation/Doxygen/style_template/cmsis_logo_white_small.png diff --git a/Documentation/Doxygen/style_template/darkmode_toggle.js b/Documentation/Doxygen/style_template/darkmode_toggle.js new file mode 100644 index 000000000..b2bd94f1c --- /dev/null +++ b/Documentation/Doxygen/style_template/darkmode_toggle.js @@ -0,0 +1,281 @@ +/** + +The code below is based on the Doxygen Awesome project with some minor modifications +https://github.com/jothepro/doxygen-awesome-css + +MIT License + +Copyright (c) 2021 - 2022 jothepro + +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. + +*/ + +class DarkModeToggle extends HTMLElement { + static icon = '' + static icond = '' + static title = "Toggle Light/Dark Mode" + + static prefersLightModeInDarkModeKey = "prefers-light-mode-in-dark-mode" + static prefersDarkModeInLightModeKey = "prefers-dark-mode-in-light-mode" + + static _staticConstructor = function() { + DarkModeToggle.enableDarkMode(DarkModeToggle.userPreference) + // Update the color scheme when the browsers preference changes + // without user interaction on the website. + window.matchMedia('(prefers-color-scheme: dark)').addEventListener('change', event => { + DarkModeToggle.onSystemPreferenceChanged() + }) + // Update the color scheme when the tab is made visible again. + // It is possible that the appearance was changed in another tab + // while this tab was in the background. + document.addEventListener("visibilitychange", visibilityState => { + if (document.visibilityState === 'visible') { + DarkModeToggle.onSystemPreferenceChanged() + } + }); + }() + + static addButton() { + + var tbuttons = document.getElementsByTagName("dark-mode-toggle"); + var toggleButton; + var titleArea = document.getElementById("titlearea"); + var searchBox = document.getElementById("MSearchBox"); + var mainMenu = document.getElementById("main-menu"); + var navRow1 = document.getElementById("navrow1"); + var mainMenuVisible = false; + if (!tbuttons.length){ + toggleButton = document.createElement('dark-mode-toggle') + toggleButton.title = DarkModeToggle.title + } else {toggleButton=tbuttons[0]} + + + if (DarkModeToggle.darkModeEnabled){ + toggleButton.innerHTML=DarkModeToggle.icond + } else { + toggleButton.innerHTML=DarkModeToggle.icon + } + + if (mainMenu) { + var menuStyle = window.getComputedStyle(mainMenu); + mainMenuVisible = menuStyle.display!=='none' + } + var searchBoxPos1 = document.getElementById("searchBoxPos1"); + if (searchBox) { // (1) search box visible + searchBox.parentNode.appendChild(toggleButton) + } else if (navRow1) { // (2) no search box, static menu bar + var li = document.createElement('li'); + li.style = 'float: right;' + li.appendChild(toggleButton); + toggleButton.style = 'width: 24px; height: 25px; padding-top: 11px; float: right;'; + var row = document.querySelector('#navrow1 > ul:first-of-type'); + row.appendChild(li) + } else if (mainMenu && mainMenuVisible) { // (3) no search box + dynamic menu bar expanded + var li = document.createElement('li'); + li.style = 'float: right;' + li.appendChild(toggleButton); + toggleButton.style = 'width: 14px; height: 36px; padding-top: 10px; float: right;'; + mainMenu.appendChild(li) + } else if (searchBoxPos1) { // (4) no search box + dynamic menu bar collapsed + toggleButton.style = 'width: 24px; height: 36px; padding-top: 10px; float: right;'; + searchBoxPos1.style = 'top: 0px;' + searchBoxPos1.appendChild(toggleButton); + } else if (titleArea) { // (5) no search box and no navigation tabs + toggleButton.style = 'width: 24px; height: 24px; position: absolute; right: 0px; top: 34px;'; + titleArea.append(toggleButton); + } + } + + static init() { + $(function() { + $(document).ready(function() { + + $(document).ready(function(){ + DarkModeToggle.addButton(); + }) + $(window).resize(function(){ + DarkModeToggle.addButton(); + }) + DarkModeToggle.setDarkModeVisibility(DarkModeToggle.darkModeEnabled) + }) + }) + } + + constructor() { + super(); + this.onclick=this.toggleDarkMode + } + + + static createCookie(name, value, days) { + if (days) { + var date = new Date(); + date.setTime(date.getTime() + (days * 24 * 60 * 60 * 1000)); + var expires = "; expires=" + date.toGMTString(); + } + else var expires = ""; + + document.cookie = name + "=" + value + expires + "; path=/"; + } + + static readCookie(name) { + var nameEQ = name + "="; + var ca = document.cookie.split(';'); + for (var i = 0; i < ca.length; i++) { + var c = ca[i]; + while (c.charAt(0) == ' ') c = c.substring(1, c.length); + if (c.indexOf(nameEQ) == 0) return c.substring(nameEQ.length, c.length); + } + return null; + } + + static eraseCookie(name) { + DarkModeToggle.createCookie(name, "", -1); + } + + /** + * @returns `true` for dark-mode, `false` for light-mode system preference + */ + static get systemPreference() { + return window.matchMedia('(prefers-color-scheme: dark)').matches + } + + static get prefersDarkModeInLightMode() { + if (window.chrome) { // Chrome supports localStorage in combination with file:// but not cookies + return localStorage.getItem(DarkModeToggle.prefersDarkModeInLightModeKey) + } else { // Other browsers support cookies in combination with file:// but not localStorage + return DarkModeToggle.readCookie('doxygen_prefers_dark')=='1' + } + } + + static set prefersDarkModeInLightMode(preference) { + if (window.chrome) { + if (preference) { + localStorage.setItem(DarkModeToggle.prefersDarkModeInLightModeKey, true) + } else { + localStorage.removeItem(DarkModeToggle.prefersDarkModeInLightModeKey) + } + } else { + if (preference) { + DarkModeToggle.createCookie('doxygen_prefers_dark','1',365) + } else { + DarkModeToggle.eraseCookie('doxygen_prefers_dark') + } + } + } + + static get prefersLightModeInDarkMode() { + if (window.chrome) { // Chrome supports localStorage in combination with file:// but not cookies + return localStorage.getItem(DarkModeToggle.prefersLightModeInDarkModeKey) + } else { // Other browsers support cookies in combination with file:// but not localStorage + return DarkModeToggle.readCookie('doxygen_prefers_light')=='1' + } + } + + static set prefersLightModeInDarkMode(preference) { + if (window.chrome) { + if (preference) { + localStorage.setItem(DarkModeToggle.prefersLightModeInDarkModeKey, true) + } else { + localStorage.removeItem(DarkModeToggle.prefersLightModeInDarkModeKey) + } + } else { + if (preference) { + DarkModeToggle.createCookie('doxygen_prefers_light','1',365) + } else { + DarkModeToggle.eraseCookie('doxygen_prefers_light') + } + } + } + + + /** + * @returns `true` for dark-mode, `false` for light-mode user preference + */ + static get userPreference() { + return (!DarkModeToggle.systemPreference && DarkModeToggle.prefersDarkModeInLightMode) || + (DarkModeToggle.systemPreference && !DarkModeToggle.prefersLightModeInDarkMode) + } + + static set userPreference(userPreference) { + DarkModeToggle.darkModeEnabled = userPreference + if (!userPreference) { + if (DarkModeToggle.systemPreference) { + DarkModeToggle.prefersLightModeInDarkMode = true + } else { + DarkModeToggle.prefersDarkModeInLightMode = false + } + } else { + if (!DarkModeToggle.systemPreference) { + DarkModeToggle.prefersDarkModeInLightMode = true + } else { + DarkModeToggle.prefersLightModeInDarkMode = false + } + } + DarkModeToggle.onUserPreferenceChanged() + } + + static setDarkModeVisibility(enable) { + var darkModeStyle, lightModeStyle; + if(enable) { + darkModeStyle = 'inline-block'; + lightModeStyle = 'none' + } else { + darkModeStyle = 'none'; + lightModeStyle = 'inline-block' + } + document.querySelectorAll('.dark-mode-visible').forEach(function(el) { + el.style.display = darkModeStyle; + }); + document.querySelectorAll('.light-mode-visible').forEach(function(el) { + el.style.display = lightModeStyle; + }); + } + static enableDarkMode(enable) { + if(enable) { + DarkModeToggle.darkModeEnabled = true + document.documentElement.classList.add("dark-mode") + document.documentElement.classList.remove("light-mode") + } else { + DarkModeToggle.darkModeEnabled = false + document.documentElement.classList.remove("dark-mode") + document.documentElement.classList.add("light-mode") + } + DarkModeToggle.setDarkModeVisibility(enable) + } + + static onSystemPreferenceChanged() { + DarkModeToggle.darkModeEnabled = DarkModeToggle.userPreference + DarkModeToggle.enableDarkMode(DarkModeToggle.darkModeEnabled) + } + + static onUserPreferenceChanged() { + DarkModeToggle.enableDarkMode(DarkModeToggle.darkModeEnabled) + } + + toggleDarkMode() { + DarkModeToggle.userPreference = !DarkModeToggle.userPreference + DarkModeToggle.addButton(); + } +} + +customElements.define("dark-mode-toggle", DarkModeToggle); + +DarkModeToggle.init(); diff --git a/Doxygen/templates/dropdown.png b/Documentation/Doxygen/style_template/dropdown.png similarity index 100% rename from Doxygen/templates/dropdown.png rename to Documentation/Doxygen/style_template/dropdown.png diff --git a/Doxygen/templates/navtree.css b/Documentation/Doxygen/style_template/extra_navtree.css similarity index 91% rename from Doxygen/templates/navtree.css rename to Documentation/Doxygen/style_template/extra_navtree.css index 3a8b901c3..87272cc4b 100644 --- a/Doxygen/templates/navtree.css +++ b/Documentation/Doxygen/style_template/extra_navtree.css @@ -29,6 +29,9 @@ } #nav-tree .selected { + background-image: none; + background-repeat:no-repeat; + text-shadow: none; border: 1.5px solid var(--arm_blue); border-left-width: 5px; margin-left:-10px; /*correction to place selection border on the edge screen edge */ @@ -42,6 +45,7 @@ } #nav-tree a { + color: var(--nav-text-normal-color); text-decoration:none; padding:0px; padding-left:0px; @@ -62,7 +66,6 @@ #nav-tree .label a { padding-left:6px; line-height: 30px; - color: var(--arm_black); } #nav-tree .selected a { @@ -82,7 +85,6 @@ #nav-tree { padding: 0px 0px; padding-left: 10px; /*correction to add space before the first arrow in nav-tree */ - background-color: #FAFAFF; overflow:auto; } @@ -100,7 +102,7 @@ display:block; position: absolute; left: 0px; - width: 340px; + width: 330px; } .ui-resizable .ui-resizable-handle { @@ -108,14 +110,14 @@ } .ui-resizable-e { - background-color: var(--arm_light_gray); + background-color: var(--nav-splitbar-color); background-repeat:repeat-y; background-attachment: scroll; cursor:ew-resize; height:100%; right:0; top:0; - width:2px; + width:1px; } .ui-resizable-handle { @@ -130,7 +132,7 @@ } #nav-tree { - background-color: white; + -webkit-overflow-scrolling : touch; /* iOS 5+ */ } @@ -139,14 +141,15 @@ top:5px; right:24px; z-index:0; + opacity:0; } #nav-sync img { - opacity:0.0; + opacity:0; } #nav-sync img:hover { - opacity:0.0; + opacity:0; } #nav-tree a:hover { diff --git a/Documentation/Doxygen/style_template/extra_search.css b/Documentation/Doxygen/style_template/extra_search.css new file mode 100644 index 000000000..58f12de9b --- /dev/null +++ b/Documentation/Doxygen/style_template/extra_search.css @@ -0,0 +1,49 @@ + +dark-mode-toggle { + position: absolute; + right: 205px; + padding-top: 3px; + color: var(--arm_light_gray); +} + +.tablist .MSearchBox { + pointer-events: none; + display: inline-block; + white-space : nowrap; + background: none; + border-radius: 0.0em; + height: 0em; + width: 0em; + line-height: 0px; +} + +.tablist .MSearchField { + pointer-events: none; + display: inline-block; + vertical-align: middle; + width: 0em; + height: 0px; + margin: 0 0; + padding: 0; + line-height: 0em; + border:none; + outline: none; + -webkit-border-radius: 0px; + border-radius: 0px; + background: none; +} + +.tablist .MSearchBoxInactive { + pointer-events: none; + opacity:0.0; +} + +.tablist .MSearchBoxActive { + pointer-events: none; + opacity:0.0; +} + +.tablist .MSearchBoxInactive:hover { + pointer-events: none; + opacity:0.0; +} \ No newline at end of file diff --git a/Documentation/Doxygen/style_template/extra_stylesheet.css b/Documentation/Doxygen/style_template/extra_stylesheet.css new file mode 100644 index 000000000..b84f7d10f --- /dev/null +++ b/Documentation/Doxygen/style_template/extra_stylesheet.css @@ -0,0 +1,1742 @@ +/* The standard CSS for doxygen 1.9.6*/ +: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_dark_gray1: #6F777C; + --arm_dark_gray2:#383b40; + --arm_black: #333E48; + --arm_black1: #1f2023; + --arm_black2: #2d2f34; + --arm_orange: #FF6B00; + --max_content_width: 1200px; + --max_textblock_width: 950px; + + /* default spacings. Most components reference these values for spacing, to provide uniform spacing on the page. */ + --spacing-small: 5px; + --spacing-medium: 10px; + --spacing-large: 16px; + + --toc-sticky-top: var(--spacing-medium); + --toc-width: 250px; + --toc-max-height: calc(100vh - 2 * var(--spacing-medium) - 85px); + --toc-font-size: 14px; + --toc-header-font-size: 15px; + +} + +html { + /* page base colors */ + --page-background-color: white; + --page-foreground-color: black; + --page-link-color: var(--arm_blue); + --page-visited-link-color: var(--arm_blue); + + /* index */ + --index-odd-item-bg-color: #F7F8FB; + --index-even-item-bg-color: var(--page-background-color); + --index-header-color: black; + --index-separator-color: #A0A0A0; + + /* header */ + --header-background-color: var(--page-background-color); + --header-separator-color: var(--page-background-color); + --header-gradient-image: none; + --group-header-separator-color: var(--arm_light_gray3); + --group-header-color: var(--page-foreground-color); + --inherit-header-color: gray; + + --footer-foreground-color: #2A3D61; + --footer-logo-width: 104px; + --citation-label-color: #334975; + --glow-color: cyan; + + --title-background-color: white; + --title-separator-color: #5373B4; + --directory-separator-color: #9CAFD4; + --separator-color:var(--nav-splitbar-color); + + --blockquote-background-color: #F7F8FB; + --blockquote-border-color: var(--separator-color); + + --scrollbar-thumb-color: #9CAFD4; + --scrollbar-background-color: #F9FAFC; + + --icon-background-color: #728DC1; + --icon-foreground-color: white; + --icon-doc-image: url('doc.png'); + + /* brief member declaration list */ + --memdecl-background-color:#F9FAFC; + --memdecl-separator-color: #DEE4F0; + --memdecl-foreground-color: var(--page-foreground-color); + --memdecl-template-color: #4665A2; + + /* detailed member list */ + --memdef-border-color: var(--arm_dark_gray); + --memdef-title-background-color: var(--arm_light_gray2); + --memdef-title-gradient-image: none; + --memdef-table-header-background-color: var(--arm_light_gray1); + --memdef-proto-background-color: var(--arm_light_gray2); + --memdef-proto-text-color: var(--arm_black); + --memdef-proto-text-shadow: 0px 1px 1px rgba(255, 255, 255, 0.9); + --memdef-doc-background-color: var(--page-background-color); + --memdef-param-name-color: #602020; + --memdef-template-color: #4665A2; + + /* tables */ + --table-cell-border-color: var(--arm_light_gray); + --table-header-background-color: var(--arm_blue); + --table-header-foreground-color: white; + --table-even-cell-color: var(--arm_light_gray3);; + --table-odd-cell-color: #white; + + + /* labels */ + --label-background-color: #728DC1; + --label-left-top-border-color: #5373B4; + --label-right-bottom-border-color: #C4CFE5; + --label-foreground-color: white; + + /** navigation bar/tree/menu */ + --nav-background-color: var(--page-background-color); + --nav-foreground-color: var(--page-foreground-color); + --nav-gradient-image: none; + --nav-gradient-hover-image: none; + --nav-gradient-active-image: none; + --nav-gradient-active-image-parent: none; + --nav-separator-image: none; + --nav-breadcrumb-image: none; + --nav-breadcrumb-border-color: #C2CDE4; + --nav-splitbar-image: none; + --nav-splitbar-color: var(--arm_light_gray); + --nav-font-size-level1: 13px; + --nav-font-size-level2: 10px; + --nav-font-size-level3: 9px; + --nav-text-normal-color:var(--arm_black); + --nav-text-hover-color: var(--arm_orange); + --nav-text-active-color: var(--arm_black); + --nav-text-normal-shadow: 0px 1px 1px rgba(255, 255, 255, 0.9); + --nav-text-hover-shadow: 0px 1px 1px rgba(0, 0, 0, 1.0); + --nav-text-active-shadow: 0px 1px 1px rgba(0, 0, 0, 1.0); + --nav-menu-button-color: #364D7C; + --nav-menu-background-color: white; + --nav-menu-foreground-color: #555555; + --nav-menu-toggle-color: rgba(255, 255, 255, 0.5); + --nav-arrow-color: var(--arm_blue); + --nav-arrow-selected-color: var(--arm_blue); + --nav_tabs-text-color:var(--arm_dark_gray); + --nav_tabs-text-active-color:white; + --nav_tabs-background-color:var(--arm_black2); + --nav_tabs-background-active-color:var(--arm_dark_gray); + --nav_tabs-border-color:var(--arm_dark_gray); + + /* table of contents */ + --toc-background-color: var(--nav-background-color); + --toc-foreground-color: var(--nav-foreground-color); + --toc-active-color: var(--arm_dark_blue); + --toc-border-color: #D8DFEE; + --toc-header-color: #4665A2; + + /** search field */ + --search-background-color: white; + --search-foreground-color: #909090; + --search-magnification-image: url('mag.svg'); + --search-magnification-select-image: url('mag_sel.svg'); + --search-active-color: black; + --search-filter-background-color: #F9FAFC; + --search-filter-foreground-color: black; + --search-filter-border-color: #90A5CE; + --search-filter-highlight-text-color: white; + --search-filter-highlight-bg-color: #3D578C; + --search-results-foreground-color: #425E97; + --search-results-background-color: #EEF1F7; + --search-results-border-color: black; + --search-box-shadow: inset 0.5px 0.5px 3px 0px #555; + + /** code fragments */ + --code-keyword-color: #008000; + --code-type-keyword-color: #604020; + --code-flow-keyword-color: #E08000; + --code-comment-color: #800000; + --code-preprocessor-color: #806020; + --code-string-literal-color: #002080; + --code-char-literal-color: #008080; + --code-vhdl-digit-color: #FF00FF; + --code-vhdl-char-color: #000000; + --code-vhdl-keyword-color: #700070; + --code-vhdl-logic-color: #FF0000; + --code-link-color: var(--arm_blue); + --code-external-link-color: #4665A2; + --fragment-foreground-color: black; + --fragment-background-color: var(--arm_light_gray2); + --fragment-border-color: #C4CFE5; + --fragment-lineno-border-color: #00FF00; + --fragment-lineno-background-color: #E8E8E8; + --fragment-lineno-foreground-color: black; + --fragment-lineno-link-fg-color: #4665A2; + --fragment-lineno-link-bg-color: #D8D8D8; + --fragment-lineno-link-hover-fg-color: #4665A2; + --fragment-lineno-link-hover-bg-color: #C8C8C8; + --tooltip-foreground-color: black; + --tooltip-background-color: white; + --tooltip-border-color: gray; + --tooltip-doc-color: grey; + --tooltip-declaration-color: #006318; + --tooltip-link-color: #4665A2; + --tooltip-shadow: 1px 1px 7px gray; + --tile-background-color: #F9FAFC; + --tile-shadow-color:rgba(0, 0, 0, 0.2); + --tile-hover-border-color: #C8C8C8; + + + /** font-family */ + --font-family-normal: Lato, Calibri, sans-serif; + --font-family-monospace: monospace,fixed; + --font-family-nav: Lato, Calibri, sans-serif; + --font-family-title: Lato, Calibri, sans-serif; + --font-family-toc: Lato, Calibri, sans-serif; + --font-family-search: Lato, Calibri, sans-serif; + --font-family-icon: Arial,Helvetica; + --font-family-tooltip: Lato, Calibri, sans-serif; + + } + +html.dark-mode { + + /* page base colors */ + --page-background-color: var(--arm_black2); + --page-foreground-color: var(--arm_light_gray); + --page-link-color: var(--arm_light_blue); + --page-visited-link-color: var(--arm_light_blue); + + /* index */ + --index-odd-item-bg-color: var(--nav-background-color); + --index-even-item-bg-color: var(--page-background-color); + --index-header-color: #C4CFE5; + --index-separator-color: #334975; + + /* header */ + --header-background-color: var(--page-background-color); + --header-separator-color: var(--page-background-color); + --header-gradient-image: none; + --group-header-separator-color: var(--arm_dark_gray2); + --group-header-color: var(--page-foreground-color); + --inherit-header-color: #A0A0A0; + + --footer-foreground-color: #5B7AB7; + --footer-logo-width: 60px; + --citation-label-color: #90A5CE; + --glow-color: cyan; + + --title-background-color: #090D16; + --title-separator-color: #354C79; + --directory-separator-color: #283A5D; + --separator-color: var(--nav-splitbar-color); + --blockquote-background-color: var(--arm_black); + --blockquote-border-color: var(--separator-color); + + --scrollbar-thumb-color: #283A5D; + --scrollbar-background-color: #070B11; + + --icon-background-color: #334975; + --icon-foreground-color: #C4CFE5; + --icon-doc-image: url('docd.png'); + + /* brief member declaration list */ + --memdecl-background-color:var(--page-background-color); + --memdecl-separator-color: #2C3F65; + --memdecl-foreground-color:var(--page-foreground-color); + --memdecl-template-color: #7C95C6; + + /* detailed member list */ + --memdef-border-color: var(--arm_dark_gray); + --memdef-title-background-color: var(--arm_black); + --memdef-title-gradient-image: none; + --memdef-table-header-background-color: var(--arm_dark_gray2); + --memdef-proto-background-color: var(--memdef-title-background-color); + --memdef-proto-text-color: var(--page-foreground-color); + --memdef-proto-text-shadow: 0px 1px 1px rgba(0, 0, 0, 0.9); + --memdef-doc-background-color: var(--page-background-color); + --memdef-param-name-color: #D28757; + --memdef-template-color: #7C95C6; + + /* tables */ + --table-cell-border-color: var(--arm_dark_gray1); + --table-header-background-color: var(--arm_blue); + --table-header-foreground-color: var(--page-forground-color); + --table-odd-cell-color: var(--arm_dark_gray2); + --table-even-cell-color: var(--page-background-color); + + + /* labels */ + --label-background-color: #354C7B; + --label-left-top-border-color: #4665A2; + --label-right-bottom-border-color: #283A5D; + --label-foreground-color: #CCCCCC; + + /** navigation bar/tree/menu */ + --nav-background-color: var(--arm_dark_gray2); + --nav-foreground-color: var(--page-foreground-color); + --nav-gradient-image: none; + --nav-gradient-hover-image: none; + --nav-gradient-active-image: none; + --nav-gradient-active-image-parent: none; + --nav-separator-image: none; + --nav-breadcrumb-image: none; + --nav-breadcrumb-border-color: #2A3D61; + --nav-splitbar-image: none; + --nav-splitbar-color: var(--arm_dark_gray); + --nav-font-size-level1: 13px; + --nav-font-size-level2: 10px; + --nav-font-size-level3: 9px; + --nav-text-normal-color: var(--page-foreground-color); + --nav-text-hover-color: var(--arm_orange); + --nav-text-active-color:var(--page-foreground-color); + --nav-text-normal-shadow: 0px 1px 1px black; + --nav-text-hover-shadow: 0px 1px 1px rgba(0, 0, 0, 1.0); + --nav-text-active-shadow: 0px 1px 1px rgba(0, 0, 0, 1.0); + --nav-menu-button-color: #B6C4DF; + --nav-menu-background-color: #05070C; + --nav-menu-foreground-color: #BBBBBB; + --nav-menu-toggle-color: rgba(255, 255, 255, 0.2); + --nav-arrow-color: var(--arm_blue); + --nav-arrow-selected-color: var(--arm_blue); + --nav_tabs-text-color:var(--arm_dark_gray); + --nav_tabs-text-active-color:white; + --nav_tabs-background-color:var(--arm_black2); + --nav_tabs-background-active-color:var(--arm_dark_gray); + --nav_tabs-border-color:var(--arm_dark_gray); + + /* table of contents */ + --toc-background-color: var(--nav-background-color); + --toc-active-color: #4665A2; + --toc-foreground-color: var(--nav-foreground-color); + --toc-border-color: #202E4A; + --toc-header-color: #A3B4D7; + + /** search field */ + --search-background-color: black; + --search-foreground-color: #C5C5C5; + --search-magnification-image: url('mag_d.svg'); + --search-magnification-select-image: url('mag_seld.svg'); + --search-active-color: #C5C5C5; + --search-filter-background-color: #101826; + --search-filter-foreground-color: #90A5CE; + --search-filter-border-color: #7C95C6; + --search-filter-highlight-text-color: #BCC9E2; + --search-filter-highlight-bg-color: #283A5D; + --search-results-background-color: #101826; + --search-results-foreground-color: #90A5CE; + --search-results-border-color: #7C95C6; + --search-box-shadow: inset 0.5px 0.5px 3px 0px #2F436C; + + /** code fragments */ + --code-keyword-color: #CC99CD; + --code-type-keyword-color: #AB99CD; + --code-flow-keyword-color: #E08000; + --code-comment-color: #717790; + --code-preprocessor-color: #65CABE; + --code-string-literal-color: #7EC699; + --code-char-literal-color: #00E0F0; + --code-vhdl-digit-color: #FF00FF; + --code-vhdl-char-color: #000000; + --code-vhdl-keyword-color: #700070; + --code-vhdl-logic-color: #FF0000; + --code-link-color: #79C0FF; + --code-external-link-color: #79C0FF; + --fragment-foreground-color: #C9D1D9; + --fragment-background-color: var(--arm_black); + --fragment-border-color: #30363D; + --fragment-lineno-border-color: #30363D; + --fragment-lineno-background-color: black; + --fragment-lineno-foreground-color: #6E7681; + --fragment-lineno-link-fg-color: #6E7681; + --fragment-lineno-link-bg-color: #303030; + --fragment-lineno-link-hover-fg-color: #8E96A1; + --fragment-lineno-link-hover-bg-color: #505050; + --tooltip-foreground-color: #C9D1D9; + --tooltip-background-color: #202020; + --tooltip-border-color: #C9D1D9; + --tooltip-doc-color: #D9E1E9; + --tooltip-declaration-color: #20C348; + --tooltip-link-color: #79C0FF; + --tooltip-shadow: none; + --tile-background-color: var(--arm_dark_gray2); + --tile-shadow-color:rgba(192, 192, 192, 0.2); + --tile-hover-border-color: var(--arm_dark_gray1); + + /** font-family */ + --font-family-normal: Lato, Calibri, sans-serif; + --font-family-monospace: monospace,fixed; + --font-family-nav: Lato, Calibri, sans-serif; + --font-family-title: Lato, Calibri, sans-serif; + --font-family-toc: Lato, Calibri, sans-serif; + --font-family-search: Lato, Calibri, sans-serif; + --font-family-icon: Arial,Helvetica; + --font-family-tooltip: Lato, Calibri, sans-serif; +} + +body, table, div, p, dl { + font-family: var(--font-family-normal); + font-size: 16px; + line-height: 22px; +} + + +.tiles { + width: 1100; + font-size: 0; + margin: 0 auto; +} + +.tile { + width: calc(1000px / 5); + height: 130px; + display: inline-grid; + padding-inline: 5px; + padding-bottom: 10px; + padding-top: 5px; + vertical-align:text-top; + text-align:center; + margin: 2px; + margin-right: 10px; + /* background-color: var(--group-header-separator-color); */ + background-color: var(--tile-background-color); + box-shadow: 0px 4px 6px 0px var(--tile-shadow-color); + transition: 0.0s; + border-radius: 10px; + /* rounded corners */ + flex: 50%; +} + +.tile:hover { + border-color: var(--tile-hover-border-color); + box-shadow: 0 8px 12px 0 var(--tile-shadow-color); + border-style: solid; + border-width: 1px; + height: 130px; + margin:1px; + margin-right: 9px; + cursor: pointer; +} + +.tile h2 { + font-size: 17px; + margin-top:5px; + margin-bottom:0px; + text-align:center; +} + +.tile .tileh { + font-size: 17px; + font-weight:bold; + margin-top:5px; + margin-bottom:0px; + text-align:center; + color:var(--page-link-color); +} + +.tiletxt { + font-size: 15px; + color:var(--page-foreground-color); + margin:0px; + padding:0px; +} + +.tilelinks { + font-size: 14px; + align-self: end; +} + + +/* styles */ + +.style1 { + text-align: center; +} +.style2 { + color: var(--arm_blue); + font-weight: normal; +} +.style3 { + text-align: left; +} +.style4 { + color: #008000; +} +.style5 { + color: #0000FF; +} +.style6 { + color: #000000; + font-style:italic; +} +.mand { + color: #0000FF; +} +.opt { + color: #008000; +} +.cond { + color: var(--arm_orange); +} + +.choice +{ + background-color:#F7F9D0; +} +.seq +{ + background-color:#C9DECB; +} +.group1 +{ + background-color:#F8F1F1; +} +.group2 +{ + background-color:#DCEDEA; +} + +.arrow { + color: var(--nav-arrow-color); + -webkit-user-select: none; + -khtml-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + user-select: none; + cursor: pointer; + font-size: 100%; + width: 16px; + height: 22px; + display: inline-block; +} + +.main-menu { + margin: 0; + padding: 0; + display: table; + line-height: 24px; +} + +ul { + list-style-type: disc; + padding-left: 2em; + margin-block-start: 0em; +} + +li { + margin-top: 0.25em; + line-height: 24px; +} + +ul ul { + list-style-type: circle; +} + +ul ul ul { + list-style-type: square; +} + +ul.hierarchy { + color: green; +} + +em { + font-style:italic; +} + +code { + font-family: monospace; + font-size: 85%; + line-height: 1.6; + background-color: var(--fragment-background-color); + border-radius: 6px; + padding: 0.2em 0.4em; +} + +/* Tables */ +table.cmtab1 { + padding: 4px; + border-collapse: collapse; + border: 1px solid var(--arm_dark_gray); + text-align: justify; + width:70%; +} + +th.cmtab1 { + background: var(--arm_light_gray3); + font-weight: bold; + height: 28px; +} + +td.cmtab1 { + padding:1px; + text-align: left; +} + +table.cmtable { + border-collapse:collapse; + margin-top: 4px; + margin-bottom: 4px; +} + +table.cmtable td, table.cmtable th { + border: 1px solid var(--arm_dark_gray); + padding: 3px 7px 2px; +} + +table.cmtable th { + background-color: var(--table-header-background-color); + color: var(--table-header-foreground-color); + font-size: 100%; + padding-bottom: 4px; + padding-top: 5px; + text-align:left; +} + +table.cmtable th a { + color: var(--table-header-foreground-color); + text-decoration: underline; +} + +table.cmtable th a:visited { + color: var(--table-header-foreground-color); + text-decoration: underline; +} + +table.cmtable th a:hover { + color: var(--arm_yellow); + text-decoration: underline; +} + +td.MonoTxt { + font-family:"Arial monospaced for SAP"; +} + +td.XML-Token +{ + azimuth: 180; + font-style:italic; + z-index:20; +} + +span.XML-Token +{ + azimuth: 180; + font-style:italic; + z-index:20; +} + +span.h2 +{ + font-size: 120%; + font-weight: bold; +} + +div.new +{ + background-color:#ccffcc; /* light green */ +} + +div.mod +{ + background-color:#ffe6cc; /* light amber */ +} + +div.del +{ + background-color:#ffcccc; /* light red */ +} + +div.contents { + margin-top: 10px; +/* margin-left: 12px; + margin-right: 8px; +*/ +} + +@media screen and (min-width: 1510px) { + #doc-content > div > div.contents, + .PageDoc > div.contents { + display: block; + flex-direction: row-reverse; + flex-wrap: nowrap; + align-items: flex-start; + } + + div.contents .textblock, div.contents .memberdecls, div.contents .memitem, div.contents .directory{ + min-width: 200px; + max-width: var(--max_textblock_width); + flex-grow: 1; + } + + div.contents p, div.contents ul, div.contents .image, div.contents .markdownTable, div.contents .fragment, div.contents hr, div.contents h1 { + max-width: var(--max_textblock_width); + } + + div.contents hr { + margin-left: 0; + } + + div.content .toc { + overflow-x: overlay; + overflow-wrap: normal; + } + + div.toc { + max-height: var(--toc-max-height); + max-width: var(--toc-width); + border: 0; + border-left: 1px solid var(--nav-splitbar-color); + border-radius: 0; + background-color: transparent; + box-shadow: none; + float: right; + position: sticky; + top: var(--toc-sticky-top); + padding: 0 0 0 var(--spacing-large); + margin: 0 0 0 var(--spacing-large); + } +} + +@media screen and (max-width:1510px) { + #doc-content > div > div.contents, + .PageDoc > div.contents { + display: block; + flex-direction: row-reverse; + flex-wrap: nowrap; + align-items: flex-start; + } + + div.contents .textblock, div.contents .memberdecls, div.contents .memitem, div.contents .directory{ + min-width: 200px; + max-width: var(--max_textblock_width); + flex-grow: 1; + } + + div.contents p, div.contents ul, div.contents .image, div.contents .markdownTable, div.contents .fragment{ + max-width: var(--max_textblock_width); + } + + div.toc { + max-height: 0px; + line-height: 0px; + overflow-y: hidden; + min-width: var(--toc-width); + border: 0; + border-radius: 0; + background-color: transparent; + box-shadow: none; + padding: 0;; + margin: 0; + } +} + + +.memberdecls heading { + font-weight: bold; +} + +div.contents, div.header .headertitle, div.header .summary { + max-width: var(--max_content_width); +} + +div.contents, div.header .headertitle { + margin-left: 3%; + margin-right: auto; +} + +/* @group Heading Levels */ + +h1 { + font-size: 150%; + border-top-color: var(--group-header-separator-color); + border-top-width: 2px; + border-top-style: solid; + padding: 1em 0 0; + margin-top: 0.5em; + margin-bottom: 0.75em; +} +/* +h1:before { + margin-bottom: 1em; + content: ""; + background-color: var(--arm_light_gray3); + height: 2px; + display: block; + width: 100%; +} +*/ +.title { + font-size: 150%; + font-weight: bold; + margin: 10px 0px; +} + +h2, h2.groupheader { + border: 0px; + font-size: 120%; + font-weight: bold; + margin-top: 1.25em; + margin-bottom: 0.25em; +} + +h3 { + font-size: 100%; + margin-top: 1.25em; + margin-bottom: 0.25em; +} + +h4 { + font-size: 100%; + color: #505050; +} + + +div.multicol { + -moz-column-gap: 1em; + -webkit-column-gap: 1em; + -moz-column-count: 3; + -webkit-column-count: 3; +} + +p { + margin-block-start: 1em; + margin-block-end: 0.5em; +} + +p.startli, p.startdd, p.starttd { + margin-top: 2px; +} + + +div.qindex, div.navtab{ + background-color: #EBEFF6; + border: 1px solid #A2B4D8; + text-align: center; +} + +div.qindex, div.navpath { + width: 100%; + line-height: 140%; +} + +div.navtab { + margin-right: 15px; +} + +/* @group Link Styling */ + + +a.qindex { + font-weight: bold; +} + +a.qindexHL { + font-weight: bold; + background-color: #9AAED5; + color: #ffffff; + border: 1px double #849CCC; +} + +.contents a.qindexHL:visited { + color: #ffffff; +} + +pre.fragment { + font-family: monospace; + background-color: var(--fragment-background-color); + border-radius: 6px; + padding: 0.2em 0.4em; + font-size: 85%; + line-height: 1.45; + margin: 0.5em 0px; +} + +div.fragment { + font-family: monospace; + background-color: var(--fragment-background-color); + border-radius: 6px; + padding: 0.2em 0.4em; + font-size: 85%; + line-height: 1.45; +} + +div.line { + font-family: monospace; + font-size: 100%; + line-height: 1.45; + text-wrap: unrestricted; + white-space: -moz-pre-wrap; /* Moz */ + white-space: -pre-wrap; /* Opera 4-6 */ + white-space: -o-pre-wrap; /* Opera 7 */ + white-space: pre-wrap; /* CSS3 */ + word-wrap: break-word; /* IE 5.5+ */ + text-indent: -53px; + padding-left: 53px; + padding-bottom: 0px; + margin: 0px; +} + +span.lineno { + padding-right: 4px; + text-align: right; + border-right: 2px solid #0F0; + background-color: #E8E8E8; + white-space: pre; +} + +span.lineno a { + background-color: #D8D8D8; +} + +span.lineno a:hover { + background-color: #C8C8C8; +} + +div.ah { + background-color: black; + font-weight: bold; + color: #ffffff; + margin-bottom: 3px; + margin-top: 3px; + padding: 0.2em; + border: solid thin #333; + border-radius: 0.5em; + -webkit-border-radius: .5em; + -moz-border-radius: .5em; +} + +body { + color: var(--page-foreground-color); + background-color: var(--page-background-color); + margin: 0; +} + +body a:hover{ + text-decoration: underline; +} + +td.indexkey { + background-color: #EBEFF6; + font-weight: bold; + border: 1px solid #C3CFE6; + margin: 2px 0px 2px 0; + padding: 2px 10px; + white-space: nowrap; + vertical-align: top; +} + +td.indexvalue { + background-color: #EBEFF6; + border: 1px solid #C3CFE6; + padding: 2px 10px; + margin: 2px 0px; +} + +tr.memlist { + background-color: #EDF1F7; +} + +/* +.search { + color: #003399; + font-weight: bold; +} + +form.search { + margin-bottom: 0px; + margin-top: 0px; +} + +input.search { + font-size: 75%; + color: #000080; + font-weight: normal; + background-color: #e8eef2; +} +*/ + +td.tiny { + font-size: 75%; +} + +img.footer { + border: 0px; + vertical-align: middle; +} + +.memSeparator { + line-height: 22px; +} + +.memItemLeft, .memItemRight, .memTemplParams { + border-top: 1px solid var(--arm_light_gray);/*#C3CFE6;*/ +} + +a:-webkit-any-link { + color: var(--page-link-color); + cursor: pointer; + text-decoration: none; +} + +.a:hover { + text-decoration: underline; +} + + +/* @group Member Details */ + +/* Styles for detailed member documentation */ + +.memtitle { + display: inline-block; + padding: 8px; + padding-bottom: 12px; + padding-right: 12px; + border-top: 1px solid var(--memdef-border-color); + border-left: 1px solid var(--memdef-border-color); + border-right: 1px solid var(--memdef-border-color); + border-top-right-radius: 4px; + border-top-left-radius: 4px; + margin-bottom: -1px; + background-color: var(--memdef-title-background-color); + line-height: 1.25; + font-weight: 600; + float: none; +} + +.permalink +{ + color: var(--arm_blue); + font-size: 100%; + display: inline-block; + vertical-align: middle; + padding-bottom:6px; +} + +.memtemplate { + font-size: 80%; + color: #4464A5; + font-weight: normal; + margin-left: 9px; +} + +.memnav { + background-color: #EBEFF6; + border: 1px solid #A2B4D8; + text-align: center; + margin: 2px; + margin-right: 15px; + padding: 2px; +} + +.mempage { + width: 100%; +} + +.memitem { + padding: 0; + margin-bottom: 10px; + margin-right: 5px; + -webkit-transition: box-shadow 0.5s linear; + -moz-transition: box-shadow 0.5s linear; + -ms-transition: box-shadow 0.5s linear; + -o-transition: box-shadow 0.5s linear; + transition: box-shadow 0.5s linear; +} + +.memitem.glow { + /*box-shadow: 0 0 15px cyan; */ +} + +.memname { + font-weight: bold; + margin-left: 6px; +} + +.memname td { + vertical-align: bottom; +} +.memproto, dl.reflist dt { + border-top: 1px solid var(--memdef-border-color); + border-left: 1px solid var(--memdef-border-color); + border-right: 1px solid var(--memdef-border-color); + padding: 6px 0px 6px 0px; + color: var(--memdef-proto-text-color); + font-weight: bold; + background-color: var(--memdef-proto-background-color); + border-top-right-radius: 4px; + border-top-left-radius: 0px; + /* firefox specific markup */ + -moz-border-radius-topright: 4px; + -moz-border-radius-topleft: 0px; + /* webkit specific markup */ + -webkit-border-top-right-radius: 4px; + -webkit-border-top-left-radius: 0px; +} + +.memdoc, dl.reflist dd { + border: 1px solid var(--memdef-border-color); + padding: 6px 10px 2px 10px; +} + +dl.reflist dt { + padding: 5px; +} + +dl.reflist dd { + margin: 0px 0px 10px 0px; + padding: 5px; +} + +.paramkey { + text-align: right; +} + +.paramtype { + white-space: nowrap; +} + +.paramname { + color: var(--memdef-param-name-color); + white-space: nowrap; +} +.paramname em { + font-style: normal; +} + +.params, .retval, .exception, .tparams { + margin-left: 0px; + padding-left: 0px; +} + +.params .paramname, .retval .paramname { + font-weight: bold; + vertical-align: top; +} + +.params .paramtype { + font-style: italic; + vertical-align: top; +} + +.params .paramdir { + font-family: "courier new",courier,monospace; + vertical-align: top; +} + +table.mlabels { + border-spacing: 0px; +} + +td.mlabels-left { + width: 100%; + padding: 0px; +} + +td.mlabels-right { + vertical-align: bottom; + padding: 0px; + white-space: nowrap; +} + +span.mlabels { + margin-left: 8px; +} + +span.mlabel { + background-color: #708CC4; + border-top:1px solid #5072B7; + border-left:1px solid #5072B7; + border-right:1px solid #C3CFE6; + border-bottom:1px solid #C3CFE6; + text-shadow: none; + color: white; + margin-right: 4px; + padding: 2px 3px; + border-radius: 3px; + font-size: 7pt; + white-space: nowrap; +} + + + +/* @end */ + +/* these are for tree view when not used as main index */ + +div.directory { + margin: 10px 0px; + border-top: 1px solid var(--arm_dark_gray); + border-bottom: 1px solid var(--arm_dark_gray); + width: 100%; +} + +.directory table { + border-collapse:collapse; +} + +.directory td { + padding: 0px 10px 10px 0px; + vertical-align: middle; +} + +.directory td.entry { + white-space: nowrap; + padding-right: 6px; + padding-top:10px; +} + +.directory td.entry a { + outline:none; + padding-left: 6px; + padding-top:10px; +} + +.directory td.desc { + width: 100%; + padding-left: 6px; + padding-right: 6px; + padding-top:10px; + border-left: 0px solid rgba(0,0,0,0.05); +} + +.directory img { + vertical-align: -30%; +} + +.directory .levels { + white-space: nowrap; + width: 100%; + text-align: right; + font-size: 9pt; +} + +.directory .levels span { + cursor: pointer; + padding-left: 2px; + padding-right: 2px; + color: #3A568E; +} + +div.dynheader { + margin-top: 8px; + -webkit-touch-callout: none; + -webkit-user-select: none; + -khtml-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + user-select: none; +} + +address { + font-style: normal; + color: #293C63; +} + +blockquote.doxtable { + margin-left:-7px; + margin-bottom: 6px; + padding-left: 8px; + border-left:4px solid; + border-color: #D0C000; + background-color: var(--page-background-color); +} + +table.doxtable { + border-collapse:collapse; + margin-top: 4px; + margin-bottom: 4px; +} + +table.doxtable td, table.doxtable th { + border: 1px solid var(--table-cell-border-color); + padding: 7px 10px 5px; + text-align:left; +} + +table.doxtable th { + background-color: var(--table-header-background-color); + color: var(--table-header-foreground-color); +} + +table.doxtable tr:nth-child(odd) { + background-color: var(--table-odd-cell-color); +} + +table.doxtable tr:nth-child(even) { + background-color: var(--table-even-cell-color); +} + +table.fieldtable { + width: 100%; + margin-bottom: 10px; + border: 1px solid var(--arm_dark_gray); + border-spacing: 0px; + -moz-border-radius: 4px; + -webkit-border-radius: 4px; + border-radius: 4px; +} + +.fieldtable td, .fieldtable th { + padding: 3px 7px 2px; +} + +.fieldtable td.fieldtype, .fieldtable td.fieldname, td.fieldoc{ + white-space: nowrap; + border-right: 1px solid var(--arm_dark_gray); + border-bottom: 1px solid var(--arm_dark_gray); + vertical-align: top; +} + +.fieldtable td.fielddoc { + border-bottom: 1px solid var(--arm_dark_gray); + width: 100%; +} + +.fieldtable td.fielddoc p { + margin-top: 0px; +} + +.fieldtable tr:last-child td { + border-bottom: none; +} + +.fieldtable th { + background-color: var(--memdef-table-header-background-color); + font-size: 100%; + font-weight: bold; +} + + +/* @group Markdown */ + + +table.markdownTable { + border-collapse:collapse; + margin-top: 4px; + margin-bottom: 4px; +} + +table.markdownTable td, table.markdownTable th { + border: 1px solid var(--table-cell-border-color); + padding: 7px 10px 5px; + text-align:left; +} + +table.markdownTable th { + background-color: var(--table-header-background-color); + color: var(--table-header-foreground-color); +} + +table.markdownTable tr:nth-child(odd) { + background-color: var(--table-odd-cell-color); +} + +table.markdownTable tr:nth-child(even) { + background-color: var(--table-even-cell-color); +} + +/* for hyperlinks in table head rows */ +table.markdownTable th a{ + color: var(--table-header-foreground-color); + text-decoration: underline; +} + +table.markdownTable th a:visited{ + color: var(--table-header-foreground-color); +} + +table.markdownTable th a:hover{ + color: var(--arm_yellow); +} + +table.markdownTable th.markdownTableHeadLeft, table.markdownTable td.markdownTableBodyLeft { + text-align: left +} + +table.markdownTable th.markdownTableHeadRight, table.markdownTable td.markdownTableBodyRight { + text-align: right +} + +table.markdownTable th.markdownTableHeadCenter, table.markdownTable td.markdownTableBodyCenter { + text-align: center +} + + +th.markdownTableHeadLeft, th.markdownTableHeadRight, th.markdownTableHeadCenter, th.markdownTableHeadNone { + font-size: 100%; +} + +/* @end */ + + +.tabsearch { + top: 0px; + left: 10px; + height: 36px; + background-image: url('tab_b.png'); + z-index: 101; + overflow: hidden; + font-size: 13px; +} + +.navpath ul +{ + font-size: 11px; + background-color:var(--arm_black); + height:30px; + line-height:30px; + color:white; + border:solid 1px #C1CDE5; + overflow:hidden; + margin:0px; + padding:0px; +} + +.navpath li +{ + list-style-type:none; + float:left; + padding-left:10px; + padding-right:15px; + color:#344D7E; +} + +.navpath li.navelem a +{ + height:32px; + display:block; + text-decoration: none; + outline: none; +} + +.navpath li.navelem a:hover +{ + color:#6583BF; +} + +.navpath li.footer +{ + list-style-type:none; + float:right; + padding-left:10px; + padding-right:15px; + color:var(--arm_white); + font-size: 8pt; +} + +div.summary +{ + float: right; + font-size: 8pt; + padding-right: 5px; + width: 50%; + text-align: right; +} + +div.summary a +{ + white-space: nowrap; +} + +div.ingroups +{ + margin-left: 5px; + font-size: 8pt; + padding-left: 5px; + width: 50%; + text-align: left; +} + +div.ingroups a +{ + white-space: nowrap; +} + +div.header +{ + margin: 0px; +} + +div.headertitle +{ + padding: 5px 5px 5px 0px; + margin-top: 10px; +} + +dl +{ + padding: 0 0 0 10px; +} + +/* dl.note, dl.warning, dl.attention, dl.pre, dl.post, dl.invariant, dl.deprecated, dl.todo, dl.test, dl.bug */ +dl.section +{ + margin-left: 0px; + padding-left: 0px; +} + +dl.note +{ + margin-left:-7px; + padding-left: 8px; + border-left:4px solid; + border-color: #D0C000; +} + +dl.warning, dl.attention +{ + margin-left:-7px; + padding-left: 8px; + border-left:4px solid; + border-color: #FF0000; +} + +dl.pre, dl.post, dl.invariant +{ + margin-left:-7px; + padding-left: 3px; + border-left:4px solid; + border-color: #00D000; +} + +dl.deprecated +{ + margin-left:-7px; + padding-left: 8px; + border-left:4px solid; + border-color: #505050; +} + +dl.todo +{ + margin-left:-7px; + padding-left: 8px; + border-left:4px solid; + border-color: #00C0E0; +} + +dl.test +{ + margin-left:-7px; + padding-left: 8px; + border-left:4px solid; + border-color: #3030E0; +} + +dl.bug +{ + margin-left:-7px; + padding-left: 8px; + border-left:4px solid; + border-color: #C08050; +} + +dl.safety +{ + margin-left:-7px; + padding-left: 8px; + border-left:4px solid; + border-color: #008000; +} + + +dl.section dd { + margin-bottom: 6px; +} + + +#projectlogo +{ + text-align: center; + vertical-align: middle; + border-collapse: separate; +} + +#projectlogo img +{ + border: 0px none; +} + +#projectname +{ + font: 270% 'Lato Lite', Lato, Caibri, sans-serif; + font-weight: 600; + margin: 0px; + color: white; + padding: 2px 0px; +} + +#projectbrief +{ + font: 140% "Lato Lite", Lato, Caibri, sans-serif; + margin: 0px; + color: white; + padding: 4px 0px 4px; +} + +#projectnumber +{ + font: 50% "Lato Lite", Lato, Caibri, sans-serif; + margin: 0px; + color: white; + padding: 0px; +} + +#top +{ + border-bottom: 1px solid var(--arm_dark_gray); +} + +#titlearea +{ + padding: 0px; + margin: 0px; + width: 100%; + border-bottom: 1px solid var(--arm_dark_gray); + background-color: var(--arm_black); +} + +.image +{ + text-align: left; + display: grid; + justify-content: center; + align-items: center; + justify-items: center; +} + +.dotgraph +{ + text-align: center; +} + +.mscgraph +{ + text-align: center; +} + +.caption +{ + font-weight: bold; + font-size: 80%; +} + +div.zoom +{ + border: 1px solid #8EA4D0; +} + +dl.citelist { + margin-bottom:50px; +} + +dl.citelist dt { + color:#314877; + float:left; + font-weight:bold; + margin-right:10px; + padding:5px; +} + +dl.citelist dd { + margin:2px 0; + padding:5px 0; +} + + +div.toc li { + background: none; + font-family: var(--font-family-toc); + font-size: var(--toc-font-size); + margin-top: 5px; + padding-left: 10px; + padding-top: 2px; +} + +div.toc h3 { + color: var(--toc-foreground); + font-size: var(--toc-header-font-size); + font-weight: normal; + margin: var(--spacing-large) 0 var(--spacing-medium) 0; +} + +div.toc li { + padding: 0; + background: none; + line-height: var(--toc-font-size); + margin: var(--toc-font-size) 0 0 0; +} + +div.toc ul { + margin-top: 0 +} + +div.toc li a.active { + font-weight: bold; + color: var(--toc-active-color) !important; +} + +div.toc li a:hover { + color: var(--nav-text-hover-color) !important; +} + +div.toc li a { + font-size: var(--toc-font-size); + color: var(--nav-foreground-color) !important; + text-decoration: none; +} + +.inherit_header { + font-weight: bold; + color: gray; + cursor: pointer; + -webkit-touch-callout: none; + -webkit-user-select: none; + -khtml-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + user-select: none; +} + +.inherit_header td { + padding: 6px 0px 2px 5px; +} + +.inherit { + display: none; +} + +tr.heading h2 { + margin-top: 12px; + margin-bottom: 4px; +} + +@media print +{ + #top { display: none; } + #side-nav { display: none; } + #nav-path { display: none; } + body { overflow:visible; } + h1, h2, h3, h4, h5, h6 { page-break-after: avoid; } + .summary { display: none; } + .memitem { page-break-inside: avoid; } + #doc-content + { + margin-left:0 !important; + height:auto !important; + width:auto !important; + overflow:inherit; + display:inline; + } +} diff --git a/Doxygen/templates/tabs.css b/Documentation/Doxygen/style_template/extra_tabs.css similarity index 68% rename from Doxygen/templates/tabs.css rename to Documentation/Doxygen/style_template/extra_tabs.css index 2229e0a1d..20084463a 100644 --- a/Doxygen/templates/tabs.css +++ b/Documentation/Doxygen/style_template/extra_tabs.css @@ -1,17 +1,3 @@ -: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 */ @@ -31,8 +17,15 @@ font-size: 16px; } +.tabs1 a { + color:while; +} + .tabs { - background-color: var(--arm_light_gray); + background-color: var(--nav_tabs-background-color); + border-top-style:solid; + border-top-width:1px; + border-top-color:var(--nav_tabs-border-color); } .tablist, .main-menu { @@ -45,23 +38,14 @@ .tablist li { float: left; display: table-cell; - background-color: var(--arm_light_gray); + background-color: var(--nav_tabs-background-color); border-right-style:solid; border-right-width:1px; - border-right-color:var(--arm_dark_gray); + border-right-color:var(--nav_tabs-border-color); list-style: none; margin:0px; } -.tablist .MSearchBoxInactive { - opacity:0.75; -} - -.tablist .MSearchBoxInactive:hover { - opacity:1.0; -} - - .tabs1 .tablist li { background-color: var(--arm_black); font-weight: 1000; @@ -90,14 +74,23 @@ background-color: var(--arm_blue); } -.tablist a:hover { - color: var(--arm_orange); +.tabs .tablist a { + background-color: var(--nav_tabs-background-color); + color: var(--nav_tabs-text-color); +} +.tabs .tablist li.current a { + background-color: var(--nav_tabs-background-active-color); + color: var(--nav_tabs-text-active-color); } -.tabs1 a:hover { - color: var(--arm_yellow); +.tabs a:hover { + color: var(--arm_orange); } -.tablist li.current :hover { +.tabs li.current a:hover { color: white; } + +.tabs1 a:hover { + color: var(--arm_yellow); +} diff --git a/Doxygen/templates/footer.html b/Documentation/Doxygen/style_template/footer.html similarity index 100% rename from Doxygen/templates/footer.html rename to Documentation/Doxygen/style_template/footer.html diff --git a/Doxygen/templates/footer.js.in b/Documentation/Doxygen/style_template/footer.js.in similarity index 100% rename from Doxygen/templates/footer.js.in rename to Documentation/Doxygen/style_template/footer.js.in diff --git a/Doxygen/templates/header.html b/Documentation/Doxygen/style_template/header.html similarity index 73% rename from Doxygen/templates/header.html rename to Documentation/Doxygen/style_template/header.html index 3491cbfbd..967e565db 100644 --- a/Doxygen/templates/header.html +++ b/Documentation/Doxygen/style_template/header.html @@ -1,28 +1,28 @@ - + - + $projectname: $title $title - - + + + $treeview $search $mathjax - +$darkmode $extrastylesheet - @@ -38,35 +38,35 @@ - Logo + Logo
$projectname - 
$projectbrief
- + $searchbox - $searchbox + - $searchbox + $searchbox @@ -74,3 +74,10 @@ +
+
    + +
+
diff --git a/Doxygen/templates/Layout_forUser.xml b/Documentation/Doxygen/style_template/layout.xml similarity index 92% rename from Doxygen/templates/Layout_forUser.xml rename to Documentation/Doxygen/style_template/layout.xml index 222d47187..a4895a0e8 100644 --- a/Doxygen/templates/Layout_forUser.xml +++ b/Documentation/Doxygen/style_template/layout.xml @@ -1,10 +1,10 @@ - + - + @@ -16,13 +16,13 @@ - + - - - + + + - + @@ -82,7 +82,7 @@ - + @@ -188,10 +188,11 @@ + - - + + @@ -212,7 +213,8 @@ - + + diff --git a/Doxygen/templates/navtree.js b/Documentation/Doxygen/style_template/navtree.js similarity index 98% rename from Doxygen/templates/navtree.js rename to Documentation/Doxygen/style_template/navtree.js index c7a300dd1..f6b11549d 100644 --- a/Doxygen/templates/navtree.js +++ b/Documentation/Doxygen/style_template/navtree.js @@ -443,6 +443,10 @@ function navTo(o,root,hash,relpath) } else { getScript(relpath+'navtreeindex'+i,function(){ navTreeSubIndices[i] = eval('NAVTREEINDEX'+i); + /* ensures first section is expanded when opening index */ + if ((root=="index.html") && (!navTreeSubIndices[i]["index.html"].length)) { + navTreeSubIndices[i]["index.html"]=[0]; + } if (navTreeSubIndices[i]) { gotoNode(o,i,root,hash,relpath); } diff --git a/Documentation/Doxygen/style_template/resize.js b/Documentation/Doxygen/style_template/resize.js new file mode 100644 index 000000000..34a0c1e1b --- /dev/null +++ b/Documentation/Doxygen/style_template/resize.js @@ -0,0 +1,155 @@ +/* + @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 once=1; +function initResizable() +{ + var cookie_namespace = 'doxygen'; + var sidenav,navtree,content,header,barWidth=6,desktop_vp=768,titleHeight; + + function readSetting(cookie) + { + if (window.chrome) { + var val = localStorage.getItem(cookie_namespace+'_width'); + if (val) return val; + } else { + var myCookie = cookie_namespace+"_"+cookie+"="; + if (document.cookie) { + var index = document.cookie.indexOf(myCookie); + if (index != -1) { + var valStart = index + myCookie.length; + var valEnd = document.cookie.indexOf(";", valStart); + if (valEnd == -1) { + valEnd = document.cookie.length; + } + var val = document.cookie.substring(valStart, valEnd); + return val; + } + } + } + return 0; + } + + function writeSetting(cookie, val) + { + if (window.chrome) { + localStorage.setItem(cookie_namespace+"_width",val); + } else { + var date = new Date(); + date.setTime(date.getTime()+(10*365*24*60*60*1000)); // default expiration is one week + expiration = date.toGMTString(); + document.cookie = cookie_namespace + "_" + cookie + "=" + val + "; SameSite=Lax; expires=" + expiration+"; path=/"; + } + } + + function resizeWidth() + { + var windowWidth = $(window).width() + "px"; + var sidenavWidth = $(sidenav).outerWidth(); + content.css({marginLeft:parseInt(sidenavWidth)+"px"}); + if (typeof page_layout!=='undefined' && page_layout==1) { + footer.css({marginLeft:parseInt(sidenavWidth)+"px"}); + } + writeSetting('width',sidenavWidth-barWidth); + } + + function restoreWidth(navWidth) + { + var windowWidth = $(window).width() + "px"; + content.css({marginLeft:parseInt(navWidth)+barWidth+"px"}); + if (typeof page_layout!=='undefined' && page_layout==1) { + footer.css({marginLeft:parseInt(navWidth)+barWidth+"px"}); + } + sidenav.css({width:navWidth + "px"}); + } + + function resizeHeight() + { + var headerHeight = header.outerHeight(); + var footerHeight = footer.outerHeight(); + var windowHeight = $(window).height(); + var contentHeight,navtreeHeight,sideNavHeight; + if (typeof page_layout==='undefined' || page_layout==0) { /* DISABLE_INDEX=NO */ + contentHeight = windowHeight - headerHeight - footerHeight; + navtreeHeight = contentHeight; + sideNavHeight = contentHeight; + } else if (page_layout==1) { /* DISABLE_INDEX=YES */ + contentHeight = windowHeight - footerHeight; + navtreeHeight = windowHeight - headerHeight; + sideNavHeight = windowHeight; + } + content.css({height:contentHeight + "px"}); + navtree.css({height:navtreeHeight + "px"}); + sidenav.css({height:sideNavHeight + "px"}); + if (location.hash.slice(1)) { + (document.getElementById(location.hash.slice(1))||document.body).scrollIntoView(); + } + } + + function collapseExpand() + { + var newWidth; + if (sidenav.width()>0) { + newWidth=0; + } + else { + var width = readSetting('width'); + newWidth = (width>250 && width<$(window).width()) ? width : 250; + } + restoreWidth(newWidth); + var sidenavWidth = $(sidenav).outerWidth(); + writeSetting('width',sidenavWidth-barWidth); + } + + header = $("#top"); + sidenav = $("#side-nav"); + content = $("#doc-content"); + navtree = $("#nav-tree"); + footer = $("#nav-path"); + $(".side-nav-resizable").resizable({resize: function(e, ui) { resizeWidth(); } }); + $(sidenav).resizable({ minWidth: 0 }); + $(window).resize(function() { resizeHeight(); }); + var device = navigator.userAgent.toLowerCase(); + var touch_device = device.match(/(iphone|ipod|ipad|android)/); + if (touch_device) { /* wider split bar for touch only devices */ + $(sidenav).css({ paddingRight:'20px' }); + $('.ui-resizable-e').css({ width:'20px' }); + $('#nav-sync').css({ right:'34px' }); + barWidth=20; + } + var width = readSetting('width'); + if (width) { restoreWidth(width); } else { resizeWidth(); } + resizeHeight(); + var url = location.href; + var i=url.indexOf("#"); + if (i>=0) window.location.hash=url.substr(i); + var _preventDefault = function(evt) { evt.preventDefault(); }; + $("#splitbar").bind("dragstart", _preventDefault).bind("selectstart", _preventDefault); + if (once) { + $(".ui-resizable-handle").dblclick(collapseExpand); + once=0 + } + $(window).on('load',resizeHeight); +} +/* @license-end */ diff --git a/Documentation/Doxygen/style_template/search.css b/Documentation/Doxygen/style_template/search.css new file mode 100644 index 000000000..9ca12c5c4 --- /dev/null +++ b/Documentation/Doxygen/style_template/search.css @@ -0,0 +1,297 @@ +/*---------------- Search Box */ + +.titlearea table { + width: 100%; +} + +dark-mode-toggle { + position: absolute; + right: 5px; + padding-top: 3px; +} + +#MSearchBox { + position: absolute; + right: 34px; +} + +/*---------------- Search box styling */ + +.SRPage * { + font-weight: normal; + line-height: normal; +} + +dark-mode-toggle { + margin-left: 5px; + display: flex; + float: right; +} + +#MSearchBox { + display: inline-block; + white-space : nowrap; + background: var(--search-background-color); + border-radius: 0.65em; + box-shadow: var(--search-box-shadow); + z-index: 102; +} + +#MSearchBox .left { + display: inline-block; + vertical-align: middle; + height: 1.4em; +} + +#MSearchSelect { + display: inline-block; + vertical-align: middle; + width: 20px; + height: 19px; + background-image: var(--search-magnification-select-image); + margin: 0 0 0 0.3em; + padding: 0; +} + +#MSearchSelectExt { + display: inline-block; + vertical-align: middle; + width: 10px; + height: 19px; + background-image: var(--search-magnification-image); + margin: 0 0 0 0.5em; + padding: 0; +} + + +#MSearchField { + display: inline-block; + vertical-align: middle; + width: 7.5em; + height: 19px; + margin: 0 0.15em; + padding: 0; + line-height: 1em; + border:none; + color: var(--search-foreground-color); + outline: none; + font-family: var(--font-family-search); + -webkit-border-radius: 0px; + border-radius: 0px; + background: none; +} + +@media(hover: none) { + /* to avoid zooming on iOS */ + #MSearchField { + font-size: 16px; + } +} + +#MSearchBox .right { + display: inline-block; + vertical-align: middle; + width: 1.4em; + height: 1.4em; +} + +#MSearchClose { + display: none; + font-size: inherit; + background : none; + border: none; + margin: 0; + padding: 0; + outline: none; + +} + +#MSearchCloseImg { + padding: 0.3em; + margin: 0; +} + +.MSearchBoxActive #MSearchField { + color: var(--search-active-color); +} + + + +/*---------------- Search filter selection */ + +#MSearchSelectWindow { + display: none; + position: absolute; + left: 0; top: 0; + border: 1px solid var(--search-filter-border-color); + background-color: var(--search-filter-background-color); + z-index: 10001; + padding-top: 4px; + padding-bottom: 4px; + -moz-border-radius: 4px; + -webkit-border-top-left-radius: 4px; + -webkit-border-top-right-radius: 4px; + -webkit-border-bottom-left-radius: 4px; + -webkit-border-bottom-right-radius: 4px; + -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); +} + +.SelectItem { + font: 8pt var(--font-family-search); + padding-left: 2px; + padding-right: 12px; + border: 0px; +} + +span.SelectionMark { + margin-right: 4px; + font-family: var(--font-family-monospace); + outline-style: none; + text-decoration: none; +} + +a.SelectItem { + display: block; + outline-style: none; + color: var(--search-filter-foreground-color); + text-decoration: none; + padding-left: 6px; + padding-right: 12px; +} + +a.SelectItem:focus, +a.SelectItem:active { + color: var(--search-filter-foreground-color); + outline-style: none; + text-decoration: none; +} + +a.SelectItem:hover { + color: var(--search-filter-highlight-text-color); + background-color: var(--search-filter-highlight-bg-color); + outline-style: none; + text-decoration: none; + cursor: pointer; + display: block; +} + +/*---------------- Search results window */ + +iframe#MSearchResults { + /*width: 60ex;*/ + height: 15em; +} + +#MSearchResultsWindow { + display: none; + position: absolute; + left: 0; top: 0; + border: 1px solid var(--search-results-border-color); + background-color: var(--search-results-background-color); + z-index:10000; + width: 300px; + height: 400px; + overflow: auto; +} + +/* ----------------------------------- */ + + +#SRIndex { + clear:both; +} + +.SREntry { + font-size: 10pt; + padding-left: 1ex; +} + +.SRPage .SREntry { + font-size: 8pt; + padding: 1px 5px; +} + +div.SRPage { + margin: 5px 2px; + background-color: var(--search-results-background-color); +} + +.SRChildren { + padding-left: 3ex; padding-bottom: .5em +} + +.SRPage .SRChildren { + display: none; +} + +.SRSymbol { + font-weight: bold; + color: var(--search-results-foreground-color); + font-family: var(--font-family-search); + text-decoration: none; + outline: none; +} + +a.SRScope { + display: block; + color: var(--search-results-foreground-color); + font-family: var(--font-family-search); + font-size: 8pt; + text-decoration: none; + outline: none; +} + +a.SRSymbol:focus, a.SRSymbol:active, +a.SRScope:focus, a.SRScope:active { + text-decoration: underline; +} + +span.SRScope { + padding-left: 4px; + font-family: var(--font-family-search); +} + +.SRPage .SRStatus { + padding: 2px 5px; + font-size: 8pt; + font-style: italic; + font-family: var(--font-family-search); +} + +.SRResult { + display: none; +} + +div.searchresults { + margin-left: 10px; + margin-right: 10px; +} + +/*---------------- External search page results */ + +.pages b { + color: white; + padding: 5px 5px 3px 5px; + background-image: var(--nav-gradient-active-image-parent); + background-repeat: repeat-x; + text-shadow: 0 1px 1px #000000; +} + +.pages { + line-height: 17px; + margin-left: 4px; + text-decoration: none; +} + +.hl { + font-weight: bold; +} + +#searchresults { + margin-bottom: 20px; +} + +.searchpages { + margin-top: 10px; +} + diff --git a/Doxygen/templates/tab_b.png b/Documentation/Doxygen/style_template/tab_b.png similarity index 100% rename from Doxygen/templates/tab_b.png rename to Documentation/Doxygen/style_template/tab_b.png diff --git a/Documentation/Doxygen/style_template/tab_topnav.png b/Documentation/Doxygen/style_template/tab_topnav.png new file mode 100644 index 000000000..b257b7780 Binary files /dev/null and b/Documentation/Doxygen/style_template/tab_topnav.png differ diff --git a/Documentation/Doxygen/style_template/tabs.js b/Documentation/Doxygen/style_template/tabs.js new file mode 100644 index 000000000..d9ea4092b --- /dev/null +++ b/Documentation/Doxygen/style_template/tabs.js @@ -0,0 +1,29 @@ +var strgURL = location.pathname; // path of current component + +// constructor for the array of objects +function tabElement(id, folderName, tabTxt ) { + this.id = id; // elementID as needed in html; + this.folderName = folderName; // folder name of the component + this.tabTxt = tabTxt; // Text displayed as menu on the web + this.currentListItem = '
  • ' + this.tabTxt + '
  • '; + this.listItem = '
  • ' + this.tabTxt + '
  • '; +}; + +// array of objects +var arr = []; + +// fill array +// arr.push( new tabElement( "Zone", ".", "Zone")); + +// write tabs +// called from the header file. +function writeComponentTabs() { + for ( var i=0; i < arr.length; i++ ) { + str = "/" + arr[i].folderName + "/" + if (strgURL.search(str) > 0) { // if this is the current folder + 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/version.css b/Documentation/Doxygen/style_template/version.css similarity index 93% rename from Doxygen/templates/version.css rename to Documentation/Doxygen/style_template/version.css index 8013bedeb..31cc37a4d 100644 --- a/Doxygen/templates/version.css +++ b/Documentation/Doxygen/style_template/version.css @@ -24,11 +24,6 @@ cursor: pointer; } -/* Dropdown button on hover & focus */ -#.dropbtn:hover, .dropbtn:focus { -# background-size: 0.7em; -#} - /* The container
    - needed to position the dropdown content */ .dropdown { position: relative; diff --git a/Documentation/README.md b/Documentation/README.md new file mode 100644 index 000000000..23670e6f6 --- /dev/null +++ b/Documentation/README.md @@ -0,0 +1,15 @@ +# CMSIS-DSP Documentation + +CMSIS-DSP Documentation in HTML format is published online at [https://arm-software.github.io/CMSIS-DSP](https://arm-software.github.io/CMSIS-DSP). + +The version drop-down menu there allows to switch between the documentation provided with offical releases and the latest draft documentation for the main branch. + +The documentation source is maintained in `Documentation/Doxygen/` folder as a mixture of markdown and doxygen formats. Component source files, templates and examples may also contribute information that gets integrated into the final documentation. + +Generating the HTML-formatted documentation from the source is done with `gen_doc.sh` script: + +```sh +CMSIS-DSP $ ./Documentation/Doxygen/gen_doc.sh +``` + +The script expects specific version of [doxygen](https://www.doxygen.nl/) to be installed locally. After successful execution the resulting documentation package is then available in `./Documentation/html/`. diff --git a/Documentation/index.html b/Documentation/index.html new file mode 100644 index 000000000..dda2e300d --- /dev/null +++ b/Documentation/index.html @@ -0,0 +1,14 @@ + + + +Redirect to the main page after 0 seconds + + + + + + +If the automatic redirection is failing, click open Documentation. + + + diff --git a/Documentation/version.js b/Documentation/version.js index e69de29bb..884724c74 100644 --- a/Documentation/version.js +++ b/Documentation/version.js @@ -0,0 +1 @@ +function writeVersionDropdown() {} diff --git a/Doxygen/gen_doc.sh b/Doxygen/gen_doc.sh deleted file mode 100644 index cd54912c8..000000000 --- a/Doxygen/gen_doc.sh +++ /dev/null @@ -1,67 +0,0 @@ -#!/bin/bash -# Version: 1.0 -# Date: 2022-05-31 -# This bash script generates CMSIS-NN Documentation: -# -# Pre-requisites: -# - bash shell (for Windows: install git for Windows) -# - doxygen 1.9.2 - -set -o pipefail - -DIRNAME=$(dirname $(readlink -f $0)) -DOXYGEN=$(which doxygen) -DESCRIBE=$(readlink -f ${DIRNAME}/../Scripts/git/git_describe.sh) -CHANGELOG=$(readlink -f ${DIRNAME}/../Scripts/git/gen_changelog.sh) - - -if [[ ! -f "${DOXYGEN}" ]]; then - echo "Doxygen not found!" >&2 - echo "Did you miss to add it to PATH?" - exit 1 -else - version=$("${DOXYGEN}" --version) - echo "DOXYGEN is ${DOXYGEN} at version ${version}" - if [[ "${version}" != "1.9.2" ]]; then - echo " >> Version is different from 1.9.2 !" >&2 - fi -fi - -if [ -z $VERSION ]; then - VERSION_FULL=$(/bin/bash ${DESCRIBE} "v") - VERSION=${VERSION_FULL%+*} -fi - -echo "Generating documentation ..." - -pushd $DIRNAME > /dev/null - -rm -rf ${DIRNAME}/../Documentation/html -sed -e "s/{projectNumber}/${VERSION}/" "${DIRNAME}/dsp.dxy.in" \ - > "${DIRNAME}/dsp.dxy" - -echo "${CHANGELOG} -f html > history.txt" -/bin/bash "${CHANGELOG}" -f html 1> history.txt 2>/dev/null - -echo "${DOXYGEN} dsp.dxy" -"${DOXYGEN}" dsp.dxy -popd > /dev/null - -if [[ $2 != 0 ]]; then - cp -f "${DIRNAME}/templates/search.css" "${DIRNAME}/../Documentation/html/search/" -fi - -projectName=$(grep -E "PROJECT_NAME\s+=" "${DIRNAME}/dsp.dxy" | sed -r -e 's/[^"]*"([^"]+)"/\1/') -datetime=$(date -u +'%a %b %e %Y %H:%M:%S') -year=$(date -u +'%Y') -if [[ "${year}" != "2022" ]]; then - year="2022-${year}" -fi -sed -e "s/{datetime}/${datetime}/" "${DIRNAME}/templates/footer.js.in" \ - | sed -e "s/{year}/${year}/" \ - | sed -e "s/{projectName}/${projectName}/" \ - | sed -e "s/{projectNumber}/${VERSION}/" \ - | sed -e "s/{projectNumberFull}/${VERSION_FULL}/" \ - > "${DIRNAME}/../Documentation/html/footer.js" - -exit 0 \ No newline at end of file diff --git a/Doxygen/templates/check.png b/Doxygen/templates/check.png deleted file mode 100644 index 094e59cf5..000000000 Binary files a/Doxygen/templates/check.png and /dev/null differ diff --git a/Doxygen/templates/extra_stylesheet.css b/Doxygen/templates/extra_stylesheet.css deleted file mode 100644 index e60ad6ebb..000000000 --- a/Doxygen/templates/extra_stylesheet.css +++ /dev/null @@ -1,1425 +0,0 @@ -/* The standard CSS for doxygen */ -: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; -} - -body, table, div, p, dl { - font-family: Lato, Calibri, sans-serif; - font-size: 16px; - line-height: 22px; -} - -/* styles */ - -.style1 { - text-align: center; -} -.style2 { - color: var(--arm_blue); - font-weight: normal; -} -.style3 { - text-align: left; -} -.style4 { - color: #008000; -} -.style5 { - color: #0000FF; -} -.style6 { - color: #000000; - font-style:italic; -} -.mand { - color: #0000FF; -} -.opt { - color: #008000; -} -.cond { - color: var(--arm_orange); -} - -.choice -{ - background-color:#F7F9D0; -} -.seq -{ - background-color:#C9DECB; -} -.group1 -{ - background-color:#F8F1F1; -} -.group2 -{ - background-color:#DCEDEA; -} - -.arrow { - color: var(--arm_blue); - -webkit-user-select: none; - -khtml-user-select: none; - -moz-user-select: none; - -ms-user-select: none; - user-select: none; - cursor: pointer; - font-size: 100%; - width: 16px; - height: 22px; - display: inline-block; -} - -.main-menu { - margin: 0; - padding: 0; - display: table; - line-height: 24px; -} - -ul { - list-style-type: disc; - padding-left: 2em; - margin-block-start: 0em; -} - -li { - margin-top: 0.25em; - line-height: 24px; -} - -ul ul { - list-style-type: circle; -} - -ul ul ul { - list-style-type: square; -} - -ul.hierarchy { - color: green; -} - -em { - font-style:italic; -} - -code { - font-family: monospace; - font-size: 85%; - line-height: 1.6; - background-color: var(--arm_light_gray2); - border-radius: 6px; - padding: 0.2em 0.4em; -} - -/* Tables */ -table.cmtab1 { - padding: 4px; - border-collapse: collapse; - border: 1px solid var(--arm_dark_gray); - text-align: justify; - width:70%; -} - -th.cmtab1 { - background: var(--arm_light_gray3); - font-weight: bold; - height: 28px; -} - -td.cmtab1 { - padding:1px; - text-align: left; -} - -table.cmtable { - border-collapse:collapse; - margin-top: 4px; - margin-bottom: 4px; -} - -table.cmtable td, table.cmtable th { - border: 1px solid var(--arm_light_gray); - padding: 7px 10px 5px; - text-align:left; -} - -table.cmtable th { - background-color: var(--arm_blue); - color: white; -} - -table.cmtable tr:nth-child(even) { - background-color: var(--arm_light_gray3); -} - -td.MonoTxt { - font-family:"Arial monospaced for SAP"; -} - -td.XML-Token -{ - azimuth: 180; - font-style:italic; - color:Maroon; - z-index:20; -} - -span.XML-Token -{ - azimuth: 180; - font-style:italic; - color:Maroon; - z-index:20; -} - -span.h2 -{ - font-size: 120%; - font-weight: bold; -} - -div.new -{ - background-color:#ccffcc; /* light green */ -} - -div.mod -{ - background-color:#ffe6cc; /* light amber */ -} - -div.del -{ - background-color:#ffcccc; /* light red */ -} - -/* @group Heading Levels */ - -h1 { - font-size: 150%; - border-top-color: var(--arm_light_gray3); - border-top-width: 2px; - border-top-style: solid; - padding: 1em 0 0; - margin-top: 0.5em; - margin-bottom: 0.75em; -} -/* -h1:before { - margin-bottom: 1em; - content: ""; - background-color: var(--arm_light_gray3); - height: 2px; - display: block; - width: 100%; -} -*/ -.title { - font-size: 150%; - font-weight: bold; - margin: 10px 2px; -} - -h2 { - font-size: 120%; - margin-top: 1.25em; - margin-bottom: 0.25em; -} - -h3 { - font-size: 100%; - margin-top: 1.25em; - margin-bottom: 0.25em; -} - -h4 { - font-size: 100%; - color: #505050; -} - -h1, h2, h3, h4, h5, h6 { - -webkit-transition: text-shadow 0.5s linear; - -moz-transition: text-shadow 0.5s linear; - -ms-transition: text-shadow 0.5s linear; - -o-transition: text-shadow 0.5s linear; - transition: text-shadow 0.5s linear; - margin-right: 15px; -} - -h1.glow, h2.glow, h3.glow, h4.glow, h5.glow, h6.glow { - text-shadow: 0 0 15px cyan; -} - -dt { - font-weight: bold; -} - -div.multicol { - -moz-column-gap: 1em; - -webkit-column-gap: 1em; - -moz-column-count: 3; - -webkit-column-count: 3; -} - -p { - margin-block-start: 1em; - margin-block-end: 0.5em; -} - -p.startli, p.startdd, p.starttd { - margin-top: 2px; -} - -p.endli { - margin-bottom: 0px; -} - -p.enddd { - margin-bottom: 4px; -} - -p.endtd { - margin-bottom: 2px; -} - -/* @end */ - -caption { - font-weight: bold; -} - -span.legend { - font-size: 70%; - text-align: center; -} - -h3.version { - font-size: 90%; - text-align: center; -} - -div.qindex, div.navtab{ - background-color: #EBEFF6; - border: 1px solid #A2B4D8; - text-align: center; -} - -div.qindex, div.navpath { - width: 100%; - line-height: 140%; -} - -div.navtab { - margin-right: 15px; -} - -/* @group Link Styling */ - -a { - color: var(--arm_blue); - text-decoration: none; -} - -.contents a:visited { - color: var(--arm_blue); -} - -a:hover { - text-decoration: underline; -} - -a.qindex { - font-weight: bold; -} - -a.qindexHL { - font-weight: bold; - background-color: #9AAED5; - color: #ffffff; - border: 1px double #849CCC; -} - -.contents a.qindexHL:visited { - color: #ffffff; -} - -a.el { - font-weight: bold; -} - -a.elRef { -} - -a.code, a.code:visited { - color: #4665A2; -} - -a.codeRef, a.codeRef:visited { - color: #4665A2; -} - -/* @end */ - -dl.el { - margin-left: -1cm; -} - - -pre.fragment { - font-family: monospace; - background-color: var(--arm_light_gray2); - border-radius: 6px; - padding: 0.2em 0.4em; - font-size: 85%; - line-height: 1.45; - margin: 0.5em 0px; -} - -div.fragment { - font-family: monospace; - background-color: var(--arm_light_gray2); - border-radius: 6px; - padding: 0.2em 0.4em; - font-size: 85%; - line-height: 1.45; -} - -div.line { - font-family: monospace; - font-size: 100%; - line-height: 1.45; - text-wrap: unrestricted; - white-space: -moz-pre-wrap; /* Moz */ - white-space: -pre-wrap; /* Opera 4-6 */ - white-space: -o-pre-wrap; /* Opera 7 */ - white-space: pre-wrap; /* CSS3 */ - word-wrap: break-word; /* IE 5.5+ */ - text-indent: -53px; - padding-left: 53px; - padding-bottom: 0px; - margin: 0px; -} - -span.lineno { - padding-right: 4px; - text-align: right; - border-right: 2px solid #0F0; - background-color: #E8E8E8; - white-space: pre; -} -span.lineno a { - background-color: #D8D8D8; -} - -span.lineno a:hover { - background-color: #C8C8C8; -} - -div.ah { - background-color: black; - font-weight: bold; - color: #ffffff; - margin-bottom: 3px; - margin-top: 3px; - padding: 0.2em; - border: solid thin #333; - border-radius: 0.5em; - -webkit-border-radius: .5em; - -moz-border-radius: .5em; -} - -div.groupHeader { - margin-left: 16px; - margin-top: 12px; - font-weight: bold; -} - -div.groupText { - margin-left: 16px; - font-style: italic; -} - -body { - background-color: white; - color: black; - margin: 0; -} - -div.contents { - margin-top: 10px; - margin-left: 12px; - margin-right: 8px; -} - -td.indexkey { - background-color: #EBEFF6; - font-weight: bold; - border: 1px solid #C3CFE6; - margin: 2px 0px 2px 0; - padding: 2px 10px; - white-space: nowrap; - vertical-align: top; -} - -td.indexvalue { - background-color: #EBEFF6; - border: 1px solid #C3CFE6; - padding: 2px 10px; - margin: 2px 0px; -} - -tr.memlist { - background-color: #EDF1F7; -} - -p.formulaDsp { - text-align: center; -} - -img.formulaDsp { - -} - -img.formulaInl { - vertical-align: middle; -} - -div.center { - text-align: center; - margin-top: 0px; - margin-bottom: 0px; - padding: 0px; -} - -div.center img { - border: 0px; -} - -address.footer { - text-align: right; - padding-right: 12px; -} - -img.footer { - border: 0px; - vertical-align: middle; -} - -/* @group Code Colorization */ - -span.keyword { - color: #008000 -} - -span.keywordtype { - color: #604020 -} - -span.keywordflow { - color: #e08000 -} - -span.comment { - color: #800000 -} - -span.preprocessor { - color: #806020 -} - -span.stringliteral { - color: #002080 -} - -span.charliteral { - color: #008080 -} - -span.vhdldigit { - color: #ff00ff -} - -span.vhdlchar { - color: #000000 -} - -span.vhdlkeyword { - color: #700070 -} - -span.vhdllogic { - color: #ff0000 -} - -blockquote { - background-color: #F7F8FB; - border-left: 2px solid #9AAED5; - margin: 0 24px 0 4px; - padding: 0 12px 0 16px; -} - -/* @end */ - -/* -.search { - color: #003399; - font-weight: bold; -} - -form.search { - margin-bottom: 0px; - margin-top: 0px; -} - -input.search { - font-size: 75%; - color: #000080; - font-weight: normal; - background-color: #e8eef2; -} -*/ - -td.tiny { - font-size: 75%; -} - -.dirtab { - padding: 4px; - border-collapse: collapse; - border: 1px solid #A2B4D8; -} - -th.dirtab { - background: #EBEFF6; - font-weight: bold; -} - -hr { - height: 0px; - border: none; - border-top: 1px solid #4769AD; -} - -hr.footer { - height: 1px; -} - -/* @group Member Descriptions */ - -table.memberdecls { - border-spacing: 0px; - padding: 0px; -} - -.memberdecls td { - -webkit-transition-property: background-color, box-shadow; - -webkit-transition-duration: 0.5s; - -moz-transition-property: background-color, box-shadow; - -moz-transition-duration: 0.5s; - -ms-transition-property: background-color, box-shadow; - -ms-transition-duration: 0.5s; - -o-transition-property: background-color, box-shadow; - -o-transition-duration: 0.5s; - transition-property: background-color, box-shadow; - transition-duration: 0.5s; -} - -.memberdecls td.glow { - background-color: cyan; - /*box-shadow: 0 0 15px cyan; */ -} - -.mdescLeft, .mdescRight, -.memItemLeft, .memItemRight, -.memTemplItemLeft, .memTemplItemRight, .memTemplParams { - background-color: #F9FAFC; - border: none; - margin: 4px; - padding: 1px 0 0 8px; -} - -.mdescLeft, .mdescRight { - padding: 0px 8px 4px 8px; - color: #555; -} - -.memItemLeft, .memItemRight, .memTemplParams { - border-top: 1px solid var(--arm_light_gray);/*#C3CFE6;*/ -} - -.memItemLeft, .memTemplItemLeft { - white-space: nowrap; -} - -.memItemRight { - width: 100%; -} - -.memTemplParams { - color: #4464A5; - white-space: nowrap; -} - -/* @end */ - -/* @group Member Details */ - -/* Styles for detailed member documentation */ - -.memtitle { - display: inline-block; - padding: 8px; - padding-bottom: 12px; - padding-right: 12px; - border-top: 1px solid var(--arm_dark_gray); - border-left: 1px solid var(--arm_dark_gray); - border-right: 1px solid var(--arm_dark_gray); - border-top-right-radius: 4px; - border-top-left-radius: 4px; - margin-bottom: -1px; - background-color: var(--arm_light_gray2); - line-height: 1.25; - font-weight: 600; - float:top; -} - -.permalink -{ - font-size: 100%; - display: inline-block; - vertical-align: middle; - padding-bottom:6px; -} - -.memtemplate { - font-size: 80%; - color: #4464A5; - font-weight: normal; - margin-left: 9px; -} - -.memnav { - background-color: #EBEFF6; - border: 1px solid #A2B4D8; - text-align: center; - margin: 2px; - margin-right: 15px; - padding: 2px; -} - -.mempage { - width: 100%; -} - -.memitem { - padding: 0; - margin-bottom: 10px; - margin-right: 5px; - -webkit-transition: box-shadow 0.5s linear; - -moz-transition: box-shadow 0.5s linear; - -ms-transition: box-shadow 0.5s linear; - -o-transition: box-shadow 0.5s linear; - transition: box-shadow 0.5s linear; -} - -.memitem.glow { - /*box-shadow: 0 0 15px cyan; */ -} - -.memname { - font-weight: bold; - margin-left: 6px; -} - -.memname td { - vertical-align: bottom; -} - -.memproto, dl.reflist dt { - border-top: 1px solid var(--arm_dark_gray); - border-left: 1px solid var(--arm_dark_gray); - border-right: 1px solid var(--arm_dark_gray); - padding: 6px 0px 6px 0px; - color: var(--arm_black); - font-weight: bold; - background-color: var(--arm_light_gray2); - border-top-right-radius: 4px; - border-top-left-radius: 0px; - /* firefox specific markup */ - -moz-border-radius-topright: 4px; - -moz-border-radius-topleft: 0px; - /* webkit specific markup */ - -webkit-border-top-right-radius: 4px; - -webkit-border-top-left-radius: 0px; -} - -.memdoc, dl.reflist dd { - border: 1px solid var(--arm_dark_gray); - padding: 6px 10px 2px 10px; - background-color: #FFFFFF; - /* opera specific markup */ - border-bottom-left-radius: 4px; - border-bottom-right-radius: 4px; - /* firefox specific markup */ - -moz-border-radius-bottomleft: 4px; - -moz-border-radius-bottomright: 4px; - /* webkit specific markup */ - -webkit-border-bottom-left-radius: 4px; - -webkit-border-bottom-right-radius: 4px; -} - -dl.reflist dt { - padding: 5px; -} - -dl.reflist dd { - margin: 0px 0px 10px 0px; - padding: 5px; -} - -.paramkey { - text-align: right; -} - -.paramtype { - white-space: nowrap; -} - -.paramname { - color: #602020; - white-space: nowrap; -} -.paramname em { - font-style: normal; -} - -.params, .retval, .exception, .tparams { - margin-left: 0px; - padding-left: 0px; -} - -.params .paramname, .retval .paramname { - font-weight: bold; - vertical-align: top; -} - -.params .paramtype { - font-style: italic; - vertical-align: top; -} - -.params .paramdir { - font-family: "courier new",courier,monospace; - vertical-align: top; -} - -table.mlabels { - border-spacing: 0px; -} - -td.mlabels-left { - width: 100%; - padding: 0px; -} - -td.mlabels-right { - vertical-align: bottom; - padding: 0px; - white-space: nowrap; -} - -span.mlabels { - margin-left: 8px; -} - -span.mlabel { - background-color: #708CC4; - border-top:1px solid #5072B7; - border-left:1px solid #5072B7; - border-right:1px solid #C3CFE6; - border-bottom:1px solid #C3CFE6; - text-shadow: none; - color: white; - margin-right: 4px; - padding: 2px 3px; - border-radius: 3px; - font-size: 7pt; - white-space: nowrap; -} - - - -/* @end */ - -/* these are for tree view when not used as main index */ - -div.directory { - margin: 10px 0px; - border-top: 1px solid var(--arm_dark_gray); - border-bottom: 1px solid var(--arm_dark_gray); - width: 100%; -} - -.directory table { - border-collapse:collapse; -} - -.directory td { - margin: 0px; - padding: 0px 0px 15px 0px; - vertical-align: top; -} - -.directory td.entry { - white-space: nowrap; - padding-right: 6px; -} - -.directory td.entry a { - outline:none; - padding-left: 6px; -} - -.directory td.desc { - width: 100%; - padding-left: 6px; - padding-right: 6px; - border-left: 1px solid rgba(0,0,0,0.05); -} - -.directory tr.even { - padding-left: 6px; - background-color: #F7F8FB; -} - -.directory img { - vertical-align: -30%; -} - -.directory .levels { - white-space: nowrap; - width: 100%; - text-align: right; - font-size: 9pt; -} - -.directory .levels span { - cursor: pointer; - padding-left: 2px; - padding-right: 2px; - color: #3A568E; -} - -div.dynheader { - margin-top: 8px; - -webkit-touch-callout: none; - -webkit-user-select: none; - -khtml-user-select: none; - -moz-user-select: none; - -ms-user-select: none; - user-select: none; -} - -address { - font-style: normal; - color: #293C63; -} - -table.doxtable { - border-collapse:collapse; - margin-top: 4px; - margin-bottom: 4px; -} - -table.doxtable td, table.doxtable th { - border: 1px solid var(--arm_light_gray); - padding: 7px 10px 5px; - text-align:left; -} - -table.doxtable th { - background-color: var(--arm_blue); - color: white; -} - -table.doxtable tr:nth-child(even) { - background-color: #F9FAFC; /*var(--arm_light_gray3); */ -} - -table.fieldtable { - width: 100%; - margin-bottom: 10px; - border: 1px solid var(--arm_dark_gray); - border-spacing: 0px; - -moz-border-radius: 4px; - -webkit-border-radius: 4px; - border-radius: 4px; -} - -.fieldtable td, .fieldtable th { - padding: 3px 7px 2px; -} - -.fieldtable td.fieldtype, .fieldtable td.fieldname, td.fieldoc{ - white-space: nowrap; - border-right: 1px solid var(--arm_dark_gray); - border-bottom: 1px solid var(--arm_dark_gray); - vertical-align: top; -} - -.fieldtable td.fielddoc { - border-bottom: 1px solid var(--arm_dark_gray); - width: 100%; -} - -.fieldtable td.fielddoc p { - margin-top: 0px; -} - -.fieldtable tr:last-child td { - border-bottom: none; -} - -.fieldtable th { - background-color: var(--arm_light_gray1); - font-size: 100%; - color: var(--arm_black); - padding-bottom: 4px; - padding-top: 5px; - text-align:left; - -moz-border-radius-topleft: 4px; - -moz-border-radius-topright: 4px; - -webkit-border-top-left-radius: 4px; - -webkit-border-top-right-radius: 4px; - border-top-left-radius: 4px; - border-top-right-radius: 4px; - border-bottom: 1px solid var(--arm_dark_gray); -} - - -/* @group Markdown */ - -table.markdownTable { - border-collapse:collapse; - margin-top: 4px; - margin-bottom: 4px; -} - -table.markdownTable td, table.markdownTable th { - border: 1px solid var(--arm_light_gray); - padding: 7px 10px 5px; -} - -table.markdownTable th { - background-color: var(--arm_blue); - color: white; -} - -table.markdownTable tr:nth-child(even) { - background-color: var(--arm_light_gray3); -} - -/* for hyperlinks in table head rows */ -table.markdownTable th a{ - color: white; - text-decoration: underline; -} - -table.markdownTable th a:visited{ - color: white; -} - -table.markdownTable th a:hover{ - color: var(--arm_yellow); -} - -th.markdownTableHeadLeft, td.markdownTableBodyLeft { - text-align: left -} - -th.markdownTableHeadRight, td.markdownTableBodyRight { - text-align: right -} - -th.markdownTableHeadCenter, td.markdownTableBodyCenter { - text-align: center -} - -/* @end */ - - -.tabsearch { - top: 0px; - left: 10px; - height: 36px; - background-image: url('tab_b.png'); - z-index: 101; - overflow: hidden; - font-size: 13px; -} - -.navpath ul -{ - font-size: 11px; - background-color:var(--arm_black); - height:30px; - line-height:30px; - color:white; - border:solid 1px #C1CDE5; - overflow:hidden; - margin:0px; - padding:0px; -} - -.navpath li -{ - list-style-type:none; - float:left; - padding-left:10px; - padding-right:15px; - color:#344D7E; -} - -.navpath li.navelem a -{ - height:32px; - display:block; - text-decoration: none; - outline: none; -} - -.navpath li.navelem a:hover -{ - color:#6583BF; -} - -.navpath li.footer -{ - list-style-type:none; - float:right; - padding-left:10px; - padding-right:15px; - color:var(--arm_white); - font-size: 8pt; -} - -div.summary -{ - float: right; - font-size: 8pt; - padding-right: 5px; - width: 50%; - text-align: right; -} - -div.summary a -{ - white-space: nowrap; -} - -div.ingroups -{ - margin-left: 5px; - font-size: 8pt; - padding-left: 5px; - width: 50%; - text-align: left; -} - -div.ingroups a -{ - white-space: nowrap; -} - -div.header -{ - background-color: white; - margin: 0px; -} - -div.headertitle -{ - padding: 5px 5px 5px 7px; -} - -dl -{ - padding: 0 0 0 10px; -} - -/* dl.note, dl.warning, dl.attention, dl.pre, dl.post, dl.invariant, dl.deprecated, dl.todo, dl.test, dl.bug */ -dl.section -{ - margin-left: 0px; - padding-left: 0px; -} - -dl.note -{ - margin-left:-7px; - padding-left: 3px; - border-left:4px solid; - border-color: #D0C000; -} - -dl.warning, dl.attention -{ - margin-left:-7px; - padding-left: 3px; - border-left:4px solid; - border-color: #FF0000; -} - -dl.pre, dl.post, dl.invariant -{ - margin-left:-7px; - padding-left: 3px; - border-left:4px solid; - border-color: #00D000; -} - -dl.deprecated -{ - margin-left:-7px; - padding-left: 3px; - border-left:4px solid; - border-color: #505050; -} - -dl.todo -{ - margin-left:-7px; - padding-left: 3px; - border-left:4px solid; - border-color: #00C0E0; -} - -dl.test -{ - margin-left:-7px; - padding-left: 3px; - border-left:4px solid; - border-color: #3030E0; -} - -dl.bug -{ - margin-left:-7px; - padding-left: 3px; - border-left:4px solid; - border-color: #C08050; -} - -dl.safety -{ - margin-left:-7px; - padding-left: 3px; - border-left:4px solid; - border-color: #008000; -} - - -dl.section dd { - margin-bottom: 6px; -} - - -#projectlogo -{ - text-align: center; - vertical-align: middle; - border-collapse: separate; -} - -#projectlogo img -{ - border: 0px none; -} - -#projectname -{ - font: 270% 'Lato Lite', Lato, Caibri, sans-serif; - font-weight: 600; - margin: 0px; - color: white; - padding: 2px 0px; -} - -#projectbrief -{ - font: 140% "Lato Lite", Lato, Caibri, sans-serif; - margin: 0px; - color: white; - padding: 4px 0px 4px; -} - -#projectnumber -{ - font: 50% "Lato Lite", Lato, Caibri, sans-serif; - margin: 0px; - color: white; - padding: 0px; -} - -#titlearea -{ - padding: 0px; - margin: 0px; - width: 100%; - border-bottom: 1px solid var(--arm_dark_gray); - background-color: var(--arm_black); -} - -.image -{ - text-align: left; - display: grid; - justify-content: start; - align-items: baseline; - justify-items: center; -} - -.dotgraph -{ - text-align: center; -} - -.mscgraph -{ - text-align: center; -} - -.caption -{ - font-weight: bold; - font-size: 80%; -} - -div.zoom -{ - border: 1px solid #8EA4D0; -} - -dl.citelist { - margin-bottom:50px; -} - -dl.citelist dt { - color:#314877; - float:left; - font-weight:bold; - margin-right:10px; - padding:5px; -} - -dl.citelist dd { - margin:2px 0; - padding:5px 0; -} - -div.toc { - padding: 14px 25px; - background-color: #F4F6FA; - border: 1px solid #D7DFEE; - border-radius: 7px 7px 7px 7px; - float: right; - height: auto; - margin: 0 20px 10px 10px; - width: 200px; -} - -div.toc li { - background: url("bdwn.png") no-repeat scroll 0 5px transparent; - font: 10px/1.2 Verdana,DejaVu Sans,Geneva,sans-serif; - margin-top: 5px; - padding-left: 10px; - padding-top: 2px; -} - -div.toc h3 { - font: bold 12px/1.2 Arial,FreeSans,sans-serif; - color: #4464A5; - border-bottom: 0 none; - margin: 0; -} - -div.toc ul { - list-style: none outside none; - border: medium none; - padding: 0px; -} - -div.toc li.level1 { - margin-left: 0px; -} - -div.toc li.level2 { - margin-left: 15px; -} - -div.toc li.level3 { - margin-left: 30px; -} - -div.toc li.level4 { - margin-left: 45px; -} - -.inherit_header { - font-weight: bold; - color: gray; - cursor: pointer; - -webkit-touch-callout: none; - -webkit-user-select: none; - -khtml-user-select: none; - -moz-user-select: none; - -ms-user-select: none; - user-select: none; -} - -.inherit_header td { - padding: 6px 0px 2px 5px; -} - -.inherit { - display: none; -} - -tr.heading h2 { - margin-top: 12px; - margin-bottom: 4px; -} - -@media print -{ - #top { display: none; } - #side-nav { display: none; } - #nav-path { display: none; } - body { overflow:visible; } - h1, h2, h3, h4, h5, h6 { page-break-after: avoid; } - .summary { display: none; } - .memitem { page-break-inside: avoid; } - #doc-content - { - margin-left:0 !important; - height:auto !important; - width:auto !important; - overflow:inherit; - display:inline; - } -} - diff --git a/Doxygen/templates/search.css b/Doxygen/templates/search.css deleted file mode 100644 index da3b50990..000000000 --- a/Doxygen/templates/search.css +++ /dev/null @@ -1,240 +0,0 @@ -/*---------------- Search Box */ - -#FSearchBox { - float: left; -} - -#searchli { - float: right; - display: block; - width: 170px; - height: 24px; -} - -#MSearchBox { - white-space : nowrap; - position: absolute; - float: none; - display: inline; - margin-top: 3px; - right: 0px; - width: 170px; - z-index: 102; -} - -#MSearchBox .left -{ - display:block; - position:absolute; - left:10px; - width:20px; - height:19px; - background:url('search_l.png') no-repeat; - background-position:right; -} - -#MSearchSelect { - display:block; - position:absolute; - width:20px; - height:19px; -} - -.left #MSearchSelect { - left:4px; -} - -.right #MSearchSelect { - right:5px; -} - -#MSearchField { - display:block; - position:absolute; - height:19px; - background:url('search_m.png') repeat-x; - border:none; - width:116px; - margin-left:20px; - padding-left:4px; - color: #909090; - outline: none; - font: 9pt Arial, Verdana, sans-serif; -} - -#FSearchBox #MSearchField { - margin-left:15px; -} - -#MSearchBox .right { - display:block; - position:absolute; - right:10px; - top:0px; - width:20px; - height:19px; - background:url('search_r.png') no-repeat; - background-position:left; -} - -#MSearchClose { - display: none; - position: absolute; - top: 4px; - background : none; - border: none; - margin: 0px 4px 0px 0px; - padding: 0px 0px; - outline: none; -} - -.left #MSearchClose { - left: 6px; -} - -.right #MSearchClose { - right: 2px; -} - -.MSearchBoxActive #MSearchField { - color: #000000; -} - -/*---------------- Search filter selection */ - -#MSearchSelectWindow { - display: none; - position: absolute; - left: 0; top: 0; - border: 1px solid #90A5CE; - background-color: #F9FAFC; - z-index: 1; - padding-top: 4px; - padding-bottom: 4px; - -moz-border-radius: 4px; - -webkit-border-top-left-radius: 4px; - -webkit-border-top-right-radius: 4px; - -webkit-border-bottom-left-radius: 4px; - -webkit-border-bottom-right-radius: 4px; - -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15); -} - -.SelectItem { - font: 8pt Arial, Verdana, sans-serif; - padding-left: 2px; - padding-right: 12px; - border: 0px; -} - -span.SelectionMark { - margin-right: 4px; - font-family: monospace; - outline-style: none; - text-decoration: none; -} - -a.SelectItem { - display: block; - outline-style: none; - color: #000000; - text-decoration: none; - padding-left: 6px; - padding-right: 12px; -} - -a.SelectItem:focus, -a.SelectItem:active { - color: #000000; - outline-style: none; - text-decoration: none; -} - -a.SelectItem:hover { - color: #FFFFFF; - background-color: #3D578C; - outline-style: none; - text-decoration: none; - cursor: pointer; - display: block; -} - -/*---------------- Search results window */ - -iframe#MSearchResults { - width: 60ex; - height: 15em; -} - -#MSearchResultsWindow { - display: none; - position: absolute; - left: 0; top: 0; - border: 1px solid #000; - background-color: #EEF1F7; -} - -/* ----------------------------------- */ - - -#SRIndex { - clear:both; - padding-bottom: 15px; -} - -.SREntry { - font-size: 10pt; - padding-left: 1ex; -} - -.SRPage .SREntry { - font-size: 8pt; - padding: 1px 5px; -} - -body.SRPage { - margin: 5px 2px; -} - -.SRChildren { - padding-left: 3ex; padding-bottom: .5em -} - -.SRPage .SRChildren { - display: none; -} - -.SRSymbol { - font-weight: bold; - color: #425E97; - font-family: Arial, Verdana, sans-serif; - text-decoration: none; - outline: none; -} - -a.SRScope { - display: block; - color: #425E97; - font-family: Arial, Verdana, sans-serif; - text-decoration: none; - outline: none; -} - -a.SRSymbol:focus, a.SRSymbol:active, -a.SRScope:focus, a.SRScope:active { - text-decoration: underline; -} - -.SRPage .SRStatus { - padding: 2px 5px; - font-size: 8pt; - font-style: italic; -} - -.SRResult { - display: none; -} - -DIV.searchresults { - margin-left: 10px; - margin-right: 10px; -} diff --git a/Examples/ARM/arm_bayes_example/arm_bayes_example_f32.c b/Examples/ARM/arm_bayes_example/arm_bayes_example_f32.c index 07678b281..d339a7cb8 100755 --- a/Examples/ARM/arm_bayes_example/arm_bayes_example_f32.c +++ b/Examples/ARM/arm_bayes_example/arm_bayes_example_f32.c @@ -39,10 +39,9 @@ * -------------------------------------------------------------------- */ /** - * @ingroup groupExamples - */ - -/** + * @addtogroup groupExamples Examples + * @{ + * * @defgroup BayesExample Bayes Example * * \par Description: @@ -51,11 +50,9 @@ * about classical ML with CMSIS-DSP and python scikit-learn: * https://developer.arm.com/solutions/machine-learning-on-arm/developer-material/how-to-guides/implement-classical-ml-with-arm-cmsis-dsp-libraries * - */ - - -/** \example arm_bayes_example_f32.c - */ + * \example arm_bayes_example_f32.c + * + * @} */ #include #include diff --git a/Examples/ARM/arm_class_marks_example/arm_class_marks_example_f32.c b/Examples/ARM/arm_class_marks_example/arm_class_marks_example_f32.c index fe35350f0..d10200537 100644 --- a/Examples/ARM/arm_class_marks_example/arm_class_marks_example_f32.c +++ b/Examples/ARM/arm_class_marks_example/arm_class_marks_example_f32.c @@ -40,10 +40,9 @@ * -------------------------------------------------------------------- */ /** - * @ingroup groupExamples - */ - -/** + * @addtogroup groupExamples + * @{ + * * @defgroup ClassMarks Class Marks Example * * \par Description: @@ -76,11 +75,10 @@ * Refer * \link arm_class_marks_example_f32.c \endlink * - */ - + * \example arm_class_marks_example_f32.c + * + * @} */ -/** \example arm_class_marks_example_f32.c - */ #include "arm_math.h" #if defined(SEMIHOSTING) diff --git a/Examples/ARM/arm_convolution_example/arm_convolution_example_f32.c b/Examples/ARM/arm_convolution_example/arm_convolution_example_f32.c index 099f92e97..c70b82b28 100644 --- a/Examples/ARM/arm_convolution_example/arm_convolution_example_f32.c +++ b/Examples/ARM/arm_convolution_example/arm_convolution_example_f32.c @@ -39,10 +39,9 @@ * -------------------------------------------------------------------- */ /** - * @ingroup groupExamples - */ - -/** + * @addtogroup groupExamples + * @{ + * * @defgroup ConvolutionExample Convolution Example * * \par Description: @@ -96,11 +95,9 @@ * Refer * \link arm_convolution_example_f32.c \endlink * - */ - - -/** \example arm_convolution_example_f32.c - */ + * \example arm_convolution_example_f32.c + * + * @} */ #include "arm_math.h" #include "math_helper.h" diff --git a/Examples/ARM/arm_dotproduct_example/arm_dotproduct_example_f32.c b/Examples/ARM/arm_dotproduct_example/arm_dotproduct_example_f32.c index a94a415b8..4a6e98d5c 100644 --- a/Examples/ARM/arm_dotproduct_example/arm_dotproduct_example_f32.c +++ b/Examples/ARM/arm_dotproduct_example/arm_dotproduct_example_f32.c @@ -39,10 +39,9 @@ * -------------------------------------------------------------------- */ /** - * @ingroup groupExamples - */ - -/** + * @addtogroup groupExamples + * @{ + * * @defgroup DotproductExample Dot Product Example * * \par Description: @@ -77,11 +76,9 @@ * Refer * \link arm_dotproduct_example_f32.c \endlink * - */ - - -/** \example arm_dotproduct_example_f32.c - */ + * \example arm_dotproduct_example_f32.c + * + * @} */ #include #include "arm_math.h" diff --git a/Examples/ARM/arm_fft_bin_example/arm_fft_bin_example_f32.c b/Examples/ARM/arm_fft_bin_example/arm_fft_bin_example_f32.c index e0d95d0d1..baad6fadc 100644 --- a/Examples/ARM/arm_fft_bin_example/arm_fft_bin_example_f32.c +++ b/Examples/ARM/arm_fft_bin_example/arm_fft_bin_example_f32.c @@ -40,10 +40,9 @@ * -------------------------------------------------------------------- */ /** - * @ingroup groupExamples - */ - -/** + * @addtogroup groupExamples + * @{ + * * @defgroup FrequencyBin Frequency Bin Example * * \par Description @@ -87,12 +86,9 @@ * Refer * \link arm_fft_bin_example_f32.c \endlink * - */ - - -/** \example arm_fft_bin_example_f32.c - */ - + * \example arm_fft_bin_example_f32.c + * + * @}*/ #include "arm_math.h" #include "arm_const_structs.h" diff --git a/Examples/ARM/arm_fir_example/arm_fir_example_f32.c b/Examples/ARM/arm_fir_example/arm_fir_example_f32.c index f28359fbb..90fc74072 100644 --- a/Examples/ARM/arm_fir_example/arm_fir_example_f32.c +++ b/Examples/ARM/arm_fir_example/arm_fir_example_f32.c @@ -40,10 +40,9 @@ * -------------------------------------------------------------------- */ /** - * @ingroup groupExamples - */ - -/** + * @addtogroup groupExamples + * @{ + * * @defgroup FIRLPF FIR Lowpass Filter Example * * \par Description: @@ -112,11 +111,9 @@ * Refer * \link arm_fir_example_f32.c \endlink * - */ - - -/** \example arm_fir_example_f32.c - */ + * \example arm_fir_example_f32.c + * + * @} */ /* ---------------------------------------------------------------------- ** Include Files diff --git a/Examples/ARM/arm_graphic_equalizer_example/arm_graphic_equalizer_example_q31.c b/Examples/ARM/arm_graphic_equalizer_example/arm_graphic_equalizer_example_q31.c index 2f68584ac..23ebd3215 100644 --- a/Examples/ARM/arm_graphic_equalizer_example/arm_graphic_equalizer_example_q31.c +++ b/Examples/ARM/arm_graphic_equalizer_example/arm_graphic_equalizer_example_q31.c @@ -40,10 +40,9 @@ * -------------------------------------------------------------------- */ /** - * @ingroup groupExamples - */ - -/** + * @addtogroup groupExamples + * @{ + * * @defgroup GEQ5Band Graphic Audio Equalizer Example * * \par Description: @@ -119,12 +118,9 @@ * Refer * \link arm_graphic_equalizer_example_q31.c \endlink * - */ - - -/** \example arm_graphic_equalizer_example_q31.c - */ - + * \example arm_graphic_equalizer_example_q31.c + * + * @} */ #include "arm_math.h" #include "math_helper.h" diff --git a/Examples/ARM/arm_linear_interp_example/arm_linear_interp_example_f32.c b/Examples/ARM/arm_linear_interp_example/arm_linear_interp_example_f32.c index f8120842b..63ffb7dee 100644 --- a/Examples/ARM/arm_linear_interp_example/arm_linear_interp_example_f32.c +++ b/Examples/ARM/arm_linear_interp_example/arm_linear_interp_example_f32.c @@ -41,10 +41,9 @@ /** - * @ingroup groupExamples - */ - -/** + * @addtogroup groupExamples + * @{ + * * @defgroup LinearInterpExample Linear Interpolate Example * * CMSIS DSP Software Library -- Linear Interpolate Example @@ -78,11 +77,9 @@ * Refer * \link arm_linear_interp_example_f32.c \endlink * - */ - - -/** \example arm_linear_interp_example_f32.c - */ + * \example arm_linear_interp_example_f32.c + * + * @} */ #include "arm_math.h" #include "math_helper.h" diff --git a/Examples/ARM/arm_matrix_example/arm_matrix_example_f32.c b/Examples/ARM/arm_matrix_example/arm_matrix_example_f32.c index 265466f1a..3f4cc8846 100644 --- a/Examples/ARM/arm_matrix_example/arm_matrix_example_f32.c +++ b/Examples/ARM/arm_matrix_example/arm_matrix_example_f32.c @@ -40,10 +40,9 @@ * -------------------------------------------------------------------- */ /** - * @ingroup groupExamples - */ - -/** + * @addtogroup groupExamples + * @{ + * * @defgroup MatrixExample Matrix Example * * \par Description: @@ -83,11 +82,9 @@ * Refer * \link arm_matrix_example_f32.c \endlink * - */ - - -/** \example arm_matrix_example_f32.c - */ + * \example arm_matrix_example_f32.c + * + * @} */ #include "arm_math.h" #include "math_helper.h" diff --git a/Examples/ARM/arm_signal_converge_example/arm_signal_converge_example_f32.c b/Examples/ARM/arm_signal_converge_example/arm_signal_converge_example_f32.c index 155c001d4..711e2bc95 100644 --- a/Examples/ARM/arm_signal_converge_example/arm_signal_converge_example_f32.c +++ b/Examples/ARM/arm_signal_converge_example/arm_signal_converge_example_f32.c @@ -40,10 +40,9 @@ * -------------------------------------------------------------------- */ /** - * @ingroup groupExamples - */ - -/** + * @addtogroup groupExamples + * @{ + * * @defgroup SignalConvergence Signal Convergence Example * * \par Description: @@ -100,11 +99,9 @@ * Refer * \link arm_signal_converge_example_f32.c \endlink * - */ - - -/** \example arm_signal_converge_example_f32.c - */ + * \example arm_signal_converge_example_f32.c + * + * @} */ #include "arm_math.h" #include "math_helper.h" diff --git a/Examples/ARM/arm_sin_cos_example/arm_sin_cos_example_f32.c b/Examples/ARM/arm_sin_cos_example/arm_sin_cos_example_f32.c index 41614fcec..ec7d1b444 100644 --- a/Examples/ARM/arm_sin_cos_example/arm_sin_cos_example_f32.c +++ b/Examples/ARM/arm_sin_cos_example/arm_sin_cos_example_f32.c @@ -39,10 +39,9 @@ * -------------------------------------------------------------------- */ /** - * @ingroup groupExamples - */ - -/** + * @addtogroup groupExamples + * @{ + * * @defgroup SinCosExample SineCosine Example * * \par Description: @@ -75,11 +74,9 @@ * Refer * \link arm_sin_cos_example_f32.c \endlink * - */ - - -/** \example arm_sin_cos_example_f32.c - */ + * \example arm_sin_cos_example_f32.c + * + * @} */ #include #include "arm_math.h" diff --git a/Examples/ARM/arm_svm_example/arm_svm_example_f32.c b/Examples/ARM/arm_svm_example/arm_svm_example_f32.c index bcadcbc89..9241946b5 100755 --- a/Examples/ARM/arm_svm_example/arm_svm_example_f32.c +++ b/Examples/ARM/arm_svm_example/arm_svm_example_f32.c @@ -39,10 +39,9 @@ * -------------------------------------------------------------------- */ /** - * @ingroup groupExamples - */ - -/** + * @addtogroup groupExamples + * @{ + * * @defgroup SVMExample SVM Example * * \par Description: @@ -51,11 +50,9 @@ * about classical ML with CMSIS-DSP and python scikit-learn: * https://developer.arm.com/solutions/machine-learning-on-arm/developer-material/how-to-guides/implement-classical-ml-with-arm-cmsis-dsp-libraries * - */ - - -/** \example arm_svm_example_f32.c - */ + * \example arm_svm_example_f32.c + * + * @} */ #include #include diff --git a/Examples/ARM/arm_variance_example/arm_variance_example_f32.c b/Examples/ARM/arm_variance_example/arm_variance_example_f32.c index f40e0187f..f359e8320 100644 --- a/Examples/ARM/arm_variance_example/arm_variance_example_f32.c +++ b/Examples/ARM/arm_variance_example/arm_variance_example_f32.c @@ -39,10 +39,9 @@ * -------------------------------------------------------------------- */ /** - * @ingroup groupExamples - */ - -/** + * @addtogroup groupExamples + * @{ + * * @defgroup VarianceExample Variance Example * * \par Description: @@ -85,11 +84,9 @@ * Refer * \link arm_variance_example_f32.c \endlink * - */ - - -/** \example arm_variance_example_f32.c - */ + * \example arm_variance_example_f32.c + * + * @} */ #include #include "arm_math.h" diff --git a/Include/arm_math.h b/Include/arm_math.h index 06bb46635..cb1b6ece0 100644 --- a/Include/arm_math.h +++ b/Include/arm_math.h @@ -23,159 +23,6 @@ * limitations under the License. */ -/** - \mainpage CMSIS DSP Software Library - * - * \section intro Introduction - * - * This user manual describes the CMSIS DSP software library, - * a suite of common compute processing functions for use on Cortex-M and Cortex-A processor - * based devices. - * - * The library is divided into a number of functions each covering a specific category: - * - \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" - * - \ref groupWindow "Window 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 and 64-bit floating-point values. - * - * The library is providing vectorized versions of most algorithms for Helium - * and of most f32 algorithms for Neon. - * - * When using a vectorized version, provide a little bit of padding after the end of - * a buffer (3 words) because the vectorized code may read a little bit after the end - * of a buffer. You don't have to modify your buffers but just ensure that the - * end of buffer + padding is not outside of a memory region. - * - * A Python wrapper is also available with a Python API as close as possible - * to the C one. It can be used to start developing and testing an algorithm with NumPy and - * SciPy before writing the C version. Is is available on PyPI.org. - * It can be installed with : pip install cmsisdsp - * - * - * \section using Using the Library - * - * 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. - * 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. - * - * \section example Examples - * - * 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 - * - * The library is now tested on Fast Models building with cmake. - * Core M0, M4, M7, M33, M55, A32 are tested. - * - * - * \section preprocessor Preprocessor Macros - * - * 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 - * 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. - * 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. - * 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 - * 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 - * 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: - * |File/Folder |Content | - * |---------------------------------|------------------------------------------------------------------------| - * |\b CMSIS\\Documentation\\DSP | This documentation | - * |\b CMSIS\\DSP\\Examples | Example projects demonstrating the usage of the library functions | - * |\b CMSIS\\DSP\\ComputeLibrary | Small Neon kernels when building on Cortex-A - * |\b CMSIS\\DSP\\Include | include files for using and building the lib - * |\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. - */ - - - - - - - - - - - -/** - * @defgroup groupExamples Examples - */ - - - - #ifndef _ARM_MATH_H #define _ARM_MATH_H diff --git a/Include/arm_math_memory.h b/Include/arm_math_memory.h index 7bd83dc27..a6ca3c57b 100755 --- a/Include/arm_math_memory.h +++ b/Include/arm_math_memory.h @@ -105,7 +105,6 @@ __STATIC_FORCEINLINE q31_t read_q15x2 ( @brief Write 2 Q15 to Q15 pointer and increment pointer afterwards. @param[in] pQ15 points to input value @param[in] value Q31 value - @return none */ __STATIC_FORCEINLINE void write_q15x2_ia ( q15_t ** pQ15, @@ -126,7 +125,6 @@ __STATIC_FORCEINLINE void write_q15x2_ia ( @brief Write 2 Q15 to Q15 pointer. @param[in] pQ15 points to input value @param[in] value Q31 value - @return none */ __STATIC_FORCEINLINE void write_q15x2 ( q15_t * pQ15, @@ -179,7 +177,6 @@ __STATIC_FORCEINLINE q31_t read_q7x4 ( @brief Write 4 Q7 to Q7 pointer and increment pointer afterwards. @param[in] pQ7 points to input value @param[in] value Q31 value - @return none */ __STATIC_FORCEINLINE void write_q7x4_ia ( q7_t ** pQ7, diff --git a/Include/dsp/basic_math_functions.h b/Include/dsp/basic_math_functions.h index dcc1f2a5c..0b2cc0a29 100755 --- a/Include/dsp/basic_math_functions.h +++ b/Include/dsp/basic_math_functions.h @@ -652,7 +652,6 @@ const float64_t * pSrc, * @param[in] pSrcB points to input vector B * @param[out] pDst points to output vector * @param[in] blockSize number of samples in each vector - * @return none */ void arm_and_u16( const uint16_t * pSrcA, @@ -666,7 +665,6 @@ const float64_t * pSrc, * @param[in] pSrcB points to input vector B * @param[out] pDst points to output vector * @param[in] blockSize number of samples in each vector - * @return none */ void arm_and_u32( const uint32_t * pSrcA, @@ -680,7 +678,6 @@ const float64_t * pSrc, * @param[in] pSrcB points to input vector B * @param[out] pDst points to output vector * @param[in] blockSize number of samples in each vector - * @return none */ void arm_and_u8( const uint8_t * pSrcA, @@ -694,7 +691,6 @@ const float64_t * pSrc, * @param[in] pSrcB points to input vector B * @param[out] pDst points to output vector * @param[in] blockSize number of samples in each vector - * @return none */ void arm_or_u16( const uint16_t * pSrcA, @@ -708,7 +704,6 @@ const float64_t * pSrc, * @param[in] pSrcB points to input vector B * @param[out] pDst points to output vector * @param[in] blockSize number of samples in each vector - * @return none */ void arm_or_u32( const uint32_t * pSrcA, @@ -722,7 +717,6 @@ const float64_t * pSrc, * @param[in] pSrcB points to input vector B * @param[out] pDst points to output vector * @param[in] blockSize number of samples in each vector - * @return none */ void arm_or_u8( const uint8_t * pSrcA, @@ -735,7 +729,6 @@ const float64_t * pSrc, * @param[in] pSrc points to input vector * @param[out] pDst points to output vector * @param[in] blockSize number of samples in each vector - * @return none */ void arm_not_u16( const uint16_t * pSrc, @@ -747,7 +740,6 @@ const float64_t * pSrc, * @param[in] pSrc points to input vector * @param[out] pDst points to output vector * @param[in] blockSize number of samples in each vector - * @return none */ void arm_not_u32( const uint32_t * pSrc, @@ -759,7 +751,6 @@ const float64_t * pSrc, * @param[in] pSrc points to input vector * @param[out] pDst points to output vector * @param[in] blockSize number of samples in each vector - * @return none */ void arm_not_u8( const uint8_t * pSrc, @@ -772,7 +763,6 @@ const float64_t * pSrc, * @param[in] pSrcB points to input vector B * @param[out] pDst points to output vector * @param[in] blockSize number of samples in each vector - * @return none */ void arm_xor_u16( const uint16_t * pSrcA, @@ -786,7 +776,6 @@ const float64_t * pSrc, * @param[in] pSrcB points to input vector B * @param[out] pDst points to output vector * @param[in] blockSize number of samples in each vector - * @return none */ void arm_xor_u32( const uint32_t * pSrcA, @@ -800,7 +789,6 @@ const float64_t * pSrc, * @param[in] pSrcB points to input vector B * @param[out] pDst points to output vector * @param[in] blockSize number of samples in each vector - * @return none */ void arm_xor_u8( const uint8_t * pSrcA, @@ -815,7 +803,6 @@ const float64_t * pSrc, @param[in] low lower bound @param[in] high higher bound @param[in] numSamples number of samples to clip - @return none */ void arm_clip_f32(const float32_t * pSrc, @@ -831,7 +818,6 @@ void arm_clip_f32(const float32_t * pSrc, @param[in] low lower bound @param[in] high higher bound @param[in] numSamples number of samples to clip - @return none */ void arm_clip_q31(const q31_t * pSrc, @@ -847,7 +833,6 @@ void arm_clip_q31(const q31_t * pSrc, @param[in] low lower bound @param[in] high higher bound @param[in] numSamples number of samples to clip - @return none */ void arm_clip_q15(const q15_t * pSrc, @@ -863,7 +848,6 @@ void arm_clip_q15(const q15_t * pSrc, @param[in] low lower bound @param[in] high higher bound @param[in] numSamples number of samples to clip - @return none */ void arm_clip_q7(const q7_t * pSrc, diff --git a/Include/dsp/basic_math_functions_f16.h b/Include/dsp/basic_math_functions_f16.h index 285e4a054..20705cb10 100755 --- a/Include/dsp/basic_math_functions_f16.h +++ b/Include/dsp/basic_math_functions_f16.h @@ -149,9 +149,7 @@ extern "C" @param[in] low lower bound @param[in] high higher bound @param[in] numSamples number of samples to clip - @return none */ - void arm_clip_f16(const float16_t * pSrc, float16_t * pDst, float16_t low, diff --git a/Include/dsp/bayes_functions.h b/Include/dsp/bayes_functions.h index 824c50e83..cd780510e 100755 --- a/Include/dsp/bayes_functions.h +++ b/Include/dsp/bayes_functions.h @@ -72,10 +72,7 @@ typedef struct * @param[out] *pOutputProbabilities points to a buffer of length numberOfClasses containing estimated probabilities * @param[out] *pBufferB points to a temporary buffer of length numberOfClasses * @return The predicted class - * */ - - uint32_t arm_gaussian_naive_bayes_predict_f32(const arm_gaussian_naive_bayes_instance_f32 *S, const float32_t * in, float32_t *pOutputProbabilities, diff --git a/Include/dsp/bayes_functions_f16.h b/Include/dsp/bayes_functions_f16.h index 5c4ae42fe..b18bb57ff 100755 --- a/Include/dsp/bayes_functions_f16.h +++ b/Include/dsp/bayes_functions_f16.h @@ -63,10 +63,7 @@ typedef struct * @param[out] *pOutputProbabilities points to a buffer of length numberOfClasses containing estimated probabilities * @param[out] *pBufferB points to a temporary buffer of length numberOfClasses * @return The predicted class - * */ - - uint32_t arm_gaussian_naive_bayes_predict_f16(const arm_gaussian_naive_bayes_instance_f16 *S, const float16_t * in, float16_t *pOutputProbabilities, diff --git a/Include/dsp/controller_functions.h b/Include/dsp/controller_functions.h index 667c40e6c..85389ed01 100755 --- a/Include/dsp/controller_functions.h +++ b/Include/dsp/controller_functions.h @@ -445,7 +445,6 @@ __STATIC_FORCEINLINE q15_t arm_pid_q15( * @param[out] pIq points to output rotor reference frame q * @param[in] sinVal sine value of rotation angle theta * @param[in] cosVal cosine value of rotation angle theta - * @return none * * The function implements the forward Park transform. * @@ -475,7 +474,6 @@ __STATIC_FORCEINLINE q15_t arm_pid_q15( @param[out] pIq points to output rotor reference frame q @param[in] sinVal sine value of rotation angle theta @param[in] cosVal cosine value of rotation angle theta - @return none \par Scaling and Overflow Behavior The function is implemented using an internal 32-bit accumulator. @@ -547,7 +545,6 @@ __STATIC_FORCEINLINE void arm_park_q31( * @param[out] pIbeta points to output two-phase orthogonal vector axis beta * @param[in] sinVal sine value of rotation angle theta * @param[in] cosVal cosine value of rotation angle theta - * @return none */ __STATIC_FORCEINLINE void arm_inv_park_f32( float32_t Id, @@ -574,7 +571,6 @@ __STATIC_FORCEINLINE void arm_park_q31( @param[out] pIbeta points to output two-phase orthogonal vector axis beta @param[in] sinVal sine value of rotation angle theta @param[in] cosVal cosine value of rotation angle theta - @return none @par Scaling and Overflow Behavior The function is implemented using an internal 32-bit accumulator. @@ -648,7 +644,6 @@ __STATIC_FORCEINLINE void arm_inv_park_q31( * @param[in] Ib input three-phase coordinate b * @param[out] pIalpha points to output two-phase orthogonal vector axis alpha * @param[out] pIbeta points to output two-phase orthogonal vector axis beta - * @return none */ __STATIC_FORCEINLINE void arm_clarke_f32( float32_t Ia, @@ -671,7 +666,6 @@ __STATIC_FORCEINLINE void arm_inv_park_q31( @param[in] Ib input three-phase coordinate b @param[out] pIalpha points to output two-phase orthogonal vector axis alpha @param[out] pIbeta points to output two-phase orthogonal vector axis beta - @return none \par Scaling and Overflow Behavior The function is implemented using an internal 32-bit accumulator. @@ -730,7 +724,6 @@ __STATIC_FORCEINLINE void arm_clarke_q31( * @param[in] Ibeta input two-phase orthogonal vector axis beta * @param[out] pIa points to output three-phase coordinate a * @param[out] pIb points to output three-phase coordinate b - * @return none */ __STATIC_FORCEINLINE void arm_inv_clarke_f32( float32_t Ialpha, @@ -753,7 +746,6 @@ __STATIC_FORCEINLINE void arm_clarke_q31( @param[in] Ibeta input two-phase orthogonal vector axis beta @param[out] pIa points to output three-phase coordinate a @param[out] pIb points to output three-phase coordinate b - @return none \par Scaling and Overflow Behavior The function is implemented using an internal 32-bit accumulator. diff --git a/Include/dsp/distance_functions.h b/Include/dsp/distance_functions.h index 135cba694..354cd4e09 100755 --- a/Include/dsp/distance_functions.h +++ b/Include/dsp/distance_functions.h @@ -45,7 +45,7 @@ extern "C" /** - * @defgroup groupDistance Distance functions + * @defgroup groupDistance Distance Functions * * Distance functions for use with clustering algorithms. * There are distance functions for float vectors and boolean vectors. @@ -373,7 +373,6 @@ arm_status arm_dtw_distance_f32(const arm_matrix_instance_f32 *pDistance, * @param[in] pDTW Cost matrix (Query rows * Template columns) * @param[out] pPath Warping path in cost matrix 2*(nb rows + nb columns) * @param[out] pathLength Length of path in number of points - * @return none * */ diff --git a/Include/dsp/distance_functions_f16.h b/Include/dsp/distance_functions_f16.h index a7ceb3c15..4e74dd183 100755 --- a/Include/dsp/distance_functions_f16.h +++ b/Include/dsp/distance_functions_f16.h @@ -57,18 +57,16 @@ extern "C" * @param[in] pB Second vector * @param[in] blockSize vector length * @return distance - * */ - float16_t arm_euclidean_distance_f16(const float16_t *pA,const float16_t *pB, uint32_t blockSize); + /** * @brief Bray-Curtis distance between two vectors * @param[in] pA First vector * @param[in] pB Second vector * @param[in] blockSize vector length * @return distance - * */ float16_t arm_braycurtis_distance_f16(const float16_t *pA,const float16_t *pB, uint32_t blockSize); @@ -83,7 +81,6 @@ float16_t arm_braycurtis_distance_f16(const float16_t *pA,const float16_t *pB, u * @param[in] pB Second vector * @param[in] blockSize vector length * @return distance - * */ float16_t arm_canberra_distance_f16(const float16_t *pA,const float16_t *pB, uint32_t blockSize); @@ -94,7 +91,6 @@ float16_t arm_canberra_distance_f16(const float16_t *pA,const float16_t *pB, uin * @param[in] pB Second vector * @param[in] blockSize vector length * @return distance - * */ float16_t arm_chebyshev_distance_f16(const float16_t *pA,const float16_t *pB, uint32_t blockSize); @@ -105,10 +101,10 @@ float16_t arm_chebyshev_distance_f16(const float16_t *pA,const float16_t *pB, ui * @param[in] pB Second vector * @param[in] blockSize vector length * @return distance - * */ float16_t arm_cityblock_distance_f16(const float16_t *pA,const float16_t *pB, uint32_t blockSize); + /** * @brief Correlation distance between two vectors * @@ -118,10 +114,10 @@ float16_t arm_cityblock_distance_f16(const float16_t *pA,const float16_t *pB, ui * @param[in] pB Second vector * @param[in] blockSize vector length * @return distance - * */ float16_t arm_correlation_distance_f16(float16_t *pA,float16_t *pB, uint32_t blockSize); + /** * @brief Cosine distance between two vectors * @@ -129,11 +125,10 @@ float16_t arm_correlation_distance_f16(float16_t *pA,float16_t *pB, uint32_t blo * @param[in] pB Second vector * @param[in] blockSize vector length * @return distance - * */ - float16_t arm_cosine_distance_f16(const float16_t *pA,const float16_t *pB, uint32_t blockSize); + /** * @brief Jensen-Shannon distance between two vectors * @@ -151,11 +146,10 @@ float16_t arm_cosine_distance_f16(const float16_t *pA,const float16_t *pB, uint3 * @param[in] pB Second vector * @param[in] blockSize vector length * @return distance - * */ - float16_t arm_jensenshannon_distance_f16(const float16_t *pA,const float16_t *pB,uint32_t blockSize); + /** * @brief Minkowski distance between two vectors * @@ -164,11 +158,7 @@ float16_t arm_jensenshannon_distance_f16(const float16_t *pA,const float16_t *pB * @param[in] n Norm order (>= 2) * @param[in] blockSize vector length * @return distance - * */ - - - float16_t arm_minkowski_distance_f16(const float16_t *pA,const float16_t *pB, int32_t order, uint32_t blockSize); diff --git a/Include/dsp/fast_math_functions.h b/Include/dsp/fast_math_functions.h index 70ec1f409..a9c756708 100755 --- a/Include/dsp/fast_math_functions.h +++ b/Include/dsp/fast_math_functions.h @@ -128,7 +128,6 @@ extern "C" @param[in] pSrc points to the input vector @param[out] pDst points to the output vector @param[in] blockSize number of samples in each vector - @return none */ void arm_vlog_f32( const float32_t * pSrc, @@ -142,7 +141,6 @@ extern "C" @param[in] pSrc points to the input vector @param[out] pDst points to the output vector @param[in] blockSize number of samples in each vector - @return none */ void arm_vlog_f64( const float64_t * pSrc, @@ -156,7 +154,6 @@ extern "C" * @param[in] pSrc points to the input vector in q31 * @param[out] pDst points to the output vector in q5.26 * @param[in] blockSize number of samples in each vector - * @return none */ void arm_vlog_q31(const q31_t * pSrc, q31_t * pDst, @@ -167,7 +164,6 @@ extern "C" * @param[in] pSrc points to the input vector in q15 * @param[out] pDst points to the output vector in q4.11 * @param[in] blockSize number of samples in each vector - * @return none */ void arm_vlog_q15(const q15_t * pSrc, q15_t * pDst, @@ -180,7 +176,6 @@ extern "C" @param[in] pSrc points to the input vector @param[out] pDst points to the output vector @param[in] blockSize number of samples in each vector - @return none */ void arm_vexp_f32( const float32_t * pSrc, @@ -194,7 +189,6 @@ extern "C" @param[in] pSrc points to the input vector @param[out] pDst points to the output vector @param[in] blockSize number of samples in each vector - @return none */ void arm_vexp_f64( const float64_t * pSrc, diff --git a/Include/dsp/fast_math_functions_f16.h b/Include/dsp/fast_math_functions_f16.h index 46ae06ddc..b8ebef5e8 100755 --- a/Include/dsp/fast_math_functions_f16.h +++ b/Include/dsp/fast_math_functions_f16.h @@ -77,7 +77,6 @@ __STATIC_FORCEINLINE arm_status arm_sqrt_f16( @param[in] pSrc points to the input vector @param[out] pDst points to the output vector @param[in] blockSize number of samples in each vector - @return none */ void arm_vlog_f16( const float16_t * pSrc, @@ -89,7 +88,6 @@ __STATIC_FORCEINLINE arm_status arm_sqrt_f16( @param[in] pSrc points to the input vector @param[out] pDst points to the output vector @param[in] blockSize number of samples in each vector - @return none */ void arm_vexp_f16( const float16_t * pSrc, @@ -101,7 +99,6 @@ __STATIC_FORCEINLINE arm_status arm_sqrt_f16( @param[in] pSrc points to the input vector @param[out] pDst points to the output vector @param[in] blockSize number of samples in each vector - @return none */ void arm_vinverse_f16( const float16_t * pSrc, diff --git a/Include/dsp/filtering_functions.h b/Include/dsp/filtering_functions.h index 28a95689f..3b0a2d3ba 100755 --- a/Include/dsp/filtering_functions.h +++ b/Include/dsp/filtering_functions.h @@ -1216,7 +1216,6 @@ arm_status arm_fir_decimate_init_f32( @param[in] numStages number of 2nd order stages in the filter. @param[in] pCoeffs points to the original filter coefficients. @param[in] pComputedCoeffs points to the new computed coefficients for the vectorized version. - @return none */ void arm_biquad_cascade_df2T_compute_coefs_f32( uint8_t numStages, @@ -1891,7 +1890,6 @@ void arm_correlate_opt_q15( @param[in] pSrcB points to the second input sequence @param[in] srcBLen length of the second input sequence @param[out] pDst points to the location where the output result is written. Length 2 * max(srcALen, srcBLen) - 1. - @return none */ void arm_correlate_fast_q15( const q15_t * pSrcA, @@ -2501,7 +2499,6 @@ void arm_correlate_fast_q31( @param[out] a autoregressive coefficients @param[out] err prediction error (variance) @param[in] nbCoefs number of autoregressive coefficients - @return none */ void arm_levinson_durbin_f32(const float32_t *phi, float32_t *a, @@ -2515,7 +2512,6 @@ void arm_levinson_durbin_f32(const float32_t *phi, @param[out] a autoregressive coefficients @param[out] err prediction error (variance) @param[in] nbCoefs number of autoregressive coefficients - @return none */ void arm_levinson_durbin_q31(const q31_t *phi, q31_t *a, diff --git a/Include/dsp/filtering_functions_f16.h b/Include/dsp/filtering_functions_f16.h index fd8b0bbaf..250ae0f97 100755 --- a/Include/dsp/filtering_functions_f16.h +++ b/Include/dsp/filtering_functions_f16.h @@ -222,7 +222,6 @@ extern "C" @param[out] a autoregressive coefficients @param[out] err prediction error (variance) @param[in] nbCoefs number of autoregressive coefficients - @return none */ void arm_levinson_durbin_f16(const float16_t *phi, float16_t *a, diff --git a/Include/dsp/interpolation_functions_f16.h b/Include/dsp/interpolation_functions_f16.h index 7b880488b..eb7cdb8da 100755 --- a/Include/dsp/interpolation_functions_f16.h +++ b/Include/dsp/interpolation_functions_f16.h @@ -68,7 +68,6 @@ typedef struct * @param[in,out] S is an instance of the floating-point Linear Interpolation structure * @param[in] x input sample to process * @return y processed output sample. - * */ float16_t arm_linear_interp_f16( arm_linear_interp_instance_f16 * S, diff --git a/Include/dsp/matrix_functions_f16.h b/Include/dsp/matrix_functions_f16.h index 8ce4bf290..24689e722 100755 --- a/Include/dsp/matrix_functions_f16.h +++ b/Include/dsp/matrix_functions_f16.h @@ -228,7 +228,6 @@ void arm_mat_init_f16( - \ref ARM_MATH_SIZE_MISMATCH : Matrix size check failed - \ref ARM_MATH_SINGULAR : Input matrix is found to be singular (non-invertible) */ - arm_status arm_mat_qr_f16( const arm_matrix_instance_f16 * pSrc, const float16_t threshold, @@ -247,7 +246,6 @@ arm_status arm_mat_qr_f16( @param[outQ] pOut points to the output vector. @return beta return the scaling factor beta */ - float16_t arm_householder_f16( const float16_t * pSrc, const float16_t threshold, diff --git a/Include/dsp/quaternion_math_functions.h b/Include/dsp/quaternion_math_functions.h index 0c5d0674e..2cc4b334d 100755 --- a/Include/dsp/quaternion_math_functions.h +++ b/Include/dsp/quaternion_math_functions.h @@ -52,11 +52,7 @@ extern "C" @param[in] pInputQuaternions points to the input vector of quaternions @param[out] pNorms points to the output vector of norms @param[in] nbQuaternions number of quaternions in each vector - @return none */ - - - void arm_quaternion_norm_f32(const float32_t *pInputQuaternions, float32_t *pNorms, uint32_t nbQuaternions); @@ -67,30 +63,28 @@ void arm_quaternion_norm_f32(const float32_t *pInputQuaternions, @param[in] pInputQuaternions points to the input vector of quaternions @param[out] pInverseQuaternions points to the output vector of inverse quaternions @param[in] nbQuaternions number of quaternions in each vector - @return none */ - void arm_quaternion_inverse_f32(const float32_t *pInputQuaternions, float32_t *pInverseQuaternions, uint32_t nbQuaternions); + /** @brief Floating-point quaternion conjugates. @param[in] pInputQuaternions points to the input vector of quaternions @param[out] pConjugateQuaternions points to the output vector of conjugate quaternions @param[in] nbQuaternions number of quaternions in each vector - @return none */ void arm_quaternion_conjugate_f32(const float32_t *inputQuaternions, float32_t *pConjugateQuaternions, uint32_t nbQuaternions); + /** @brief Floating-point normalization of quaternions. @param[in] pInputQuaternions points to the input vector of quaternions @param[out] pNormalizedQuaternions points to the output vector of normalized quaternions @param[in] nbQuaternions number of quaternions in each vector - @return none */ void arm_quaternion_normalize_f32(const float32_t *inputQuaternions, float32_t *pNormalizedQuaternions, @@ -102,31 +96,30 @@ void arm_quaternion_normalize_f32(const float32_t *inputQuaternions, @param[in] qa First quaternion @param[in] qb Second quaternion @param[out] r Product of two quaternions - @return none */ void arm_quaternion_product_single_f32(const float32_t *qa, const float32_t *qb, float32_t *r); + /** @brief Floating-point elementwise product two quaternions. @param[in] qa First array of quaternions @param[in] qb Second array of quaternions @param[out] r Elementwise product of quaternions @param[in] nbQuaternions Number of quaternions in the array - @return none */ void arm_quaternion_product_f32(const float32_t *qa, const float32_t *qb, float32_t *r, uint32_t nbQuaternions); + /** * @brief Conversion of quaternion to equivalent rotation matrix. * @param[in] pInputQuaternions points to an array of normalized quaternions * @param[out] pOutputRotations points to an array of 3x3 rotations (in row order) * @param[in] nbQuaternions in the array - * @return none. * * Format of rotation matrix * \par @@ -141,17 +134,18 @@ void arm_quaternion2rotation_f32(const float32_t *pInputQuaternions, float32_t *pOutputRotations, uint32_t nbQuaternions); + /** * @brief Conversion of a rotation matrix to equivalent quaternion. * @param[in] pInputRotations points to an array 3x3 rotation matrix (in row order) * @param[out] pOutputQuaternions points to an array of quaternions * @param[in] nbQuaternions in the array - * @return none. */ void arm_rotation2quaternion_f32(const float32_t *pInputRotations, float32_t *pOutputQuaternions, uint32_t nbQuaternions); + #ifdef __cplusplus } #endif diff --git a/Include/dsp/statistics_functions.h b/Include/dsp/statistics_functions.h index 805b45dc8..94b28e9f5 100755 --- a/Include/dsp/statistics_functions.h +++ b/Include/dsp/statistics_functions.h @@ -780,7 +780,6 @@ float64_t arm_kullback_leibler_f64(const float64_t * pSrcA, @param[in] pSrc points to the input vector @param[in] blockSize number of samples in input vector @param[out] pResult maximum value returned here - @return none */ void arm_max_no_idx_f32( const float32_t *pSrc, @@ -792,7 +791,6 @@ float64_t arm_kullback_leibler_f64(const float64_t * pSrcA, @param[in] pSrc points to the input vector @param[in] blockSize number of samples in input vector @param[out] pResult minimum value returned here - @return none */ void arm_min_no_idx_f32( const float32_t *pSrc, @@ -804,7 +802,6 @@ float64_t arm_kullback_leibler_f64(const float64_t * pSrcA, @param[in] pSrc points to the input vector @param[in] blockSize number of samples in input vector @param[out] pResult maximum value returned here - @return none */ void arm_max_no_idx_f64( const float64_t *pSrc, @@ -816,7 +813,6 @@ float64_t arm_kullback_leibler_f64(const float64_t * pSrcA, @param[in] pSrc points to the input vector @param[in] blockSize number of samples in input vector @param[out] pResult maximum value returned here - @return none */ void arm_max_no_idx_q31( const q31_t *pSrc, @@ -828,7 +824,6 @@ float64_t arm_kullback_leibler_f64(const float64_t * pSrcA, @param[in] pSrc points to the input vector @param[in] blockSize number of samples in input vector @param[out] pResult maximum value returned here - @return none */ void arm_max_no_idx_q15( const q15_t *pSrc, @@ -840,7 +835,6 @@ float64_t arm_kullback_leibler_f64(const float64_t * pSrcA, @param[in] pSrc points to the input vector @param[in] blockSize number of samples in input vector @param[out] pResult maximum value returned here - @return none */ void arm_max_no_idx_q7( const q7_t *pSrc, @@ -852,7 +846,6 @@ float64_t arm_kullback_leibler_f64(const float64_t * pSrcA, @param[in] pSrc points to the input vector @param[in] blockSize number of samples in input vector @param[out] pResult minimum value returned here - @return none */ void arm_min_no_idx_f64( const float64_t *pSrc, @@ -864,7 +857,6 @@ float64_t arm_kullback_leibler_f64(const float64_t * pSrcA, @param[in] pSrc points to the input vector @param[in] blockSize number of samples in input vector @param[out] pResult minimum value returned here - @return none */ void arm_min_no_idx_q31( const q31_t *pSrc, @@ -876,7 +868,6 @@ float64_t arm_kullback_leibler_f64(const float64_t * pSrcA, @param[in] pSrc points to the input vector @param[in] blockSize number of samples in input vector @param[out] pResult minimum value returned here - @return none */ void arm_min_no_idx_q15( const q15_t *pSrc, @@ -888,10 +879,9 @@ float64_t arm_kullback_leibler_f64(const float64_t * pSrcA, @param[in] pSrc points to the input vector @param[in] blockSize number of samples in input vector @param[out] pResult minimum value returned here - @return none */ - void arm_min_no_idx_q7( - const q7_t *pSrc, +void arm_min_no_idx_q7( + const q7_t *pSrc, uint32_t blockSize, q7_t *pResult); @@ -901,7 +891,6 @@ float64_t arm_kullback_leibler_f64(const float64_t * pSrcA, @param[in] pSrcB points to the second input vector @param[in] blockSize number of samples in input vector @param[out] pResult mean square error - @return none */ void arm_mse_q7( @@ -916,7 +905,6 @@ void arm_mse_q7( @param[in] pSrcB points to the second input vector @param[in] blockSize number of samples in input vector @param[out] pResult mean square error - @return none */ void arm_mse_q15( @@ -931,7 +919,6 @@ void arm_mse_q15( @param[in] pSrcB points to the second input vector @param[in] blockSize number of samples in input vector @param[out] pResult mean square error - @return none */ void arm_mse_q31( @@ -946,7 +933,6 @@ void arm_mse_q31( @param[in] pSrcB points to the second input vector @param[in] blockSize number of samples in input vector @param[out] pResult mean square error - @return none */ void arm_mse_f32( @@ -961,7 +947,6 @@ void arm_mse_f32( @param[in] pSrcB points to the second input vector @param[in] blockSize number of samples in input vector @param[out] pResult mean square error - @return none */ void arm_mse_f64( diff --git a/Include/dsp/statistics_functions_f16.h b/Include/dsp/statistics_functions_f16.h index 33b12c4bf..defab1472 100755 --- a/Include/dsp/statistics_functions_f16.h +++ b/Include/dsp/statistics_functions_f16.h @@ -179,14 +179,13 @@ extern "C" * @param[in] pSrcA Array of input values. * @param[in] blockSize Number of samples in the input array. * @return Entropy -Sum(p ln p) - * */ - - float16_t arm_entropy_f16(const float16_t * pSrcA,uint32_t blockSize); + float16_t arm_logsumexp_f16(const float16_t *in, uint32_t blockSize); + /** * @brief Dot product with log arithmetic * @@ -197,15 +196,13 @@ float16_t arm_logsumexp_f16(const float16_t *in, uint32_t blockSize); * @param[in] blockSize number of samples in each vector * @param[in] pTmpBuffer temporary buffer of length blockSize * @return The log of the dot product . - * */ - - float16_t arm_logsumexp_dot_prod_f16(const float16_t * pSrcA, const float16_t * pSrcB, uint32_t blockSize, float16_t *pTmpBuffer); + /** * @brief Kullback-Leibler * @@ -213,45 +210,43 @@ float16_t arm_logsumexp_dot_prod_f16(const float16_t * pSrcA, * @param[in] pSrcB Pointer to an array of input values for probability distribution B. * @param[in] blockSize Number of samples in the input array. * @return Kullback-Leibler Divergence D(A || B) - * */ float16_t arm_kullback_leibler_f16(const float16_t * pSrcA ,const float16_t * pSrcB ,uint32_t blockSize); + /** @brief Maximum value of a floating-point vector. @param[in] pSrc points to the input vector @param[in] blockSize number of samples in input vector @param[out] pResult maximum value returned here - @return none */ void arm_max_no_idx_f16( const float16_t *pSrc, uint32_t blockSize, float16_t *pResult); + /** @brief Minimum value of a floating-point vector. @param[in] pSrc points to the input vector @param[in] blockSize number of samples in input vector @param[out] pResult minimum value returned here - @return none */ void arm_min_no_idx_f16( const float16_t *pSrc, uint32_t blockSize, float16_t *pResult); + /** @brief Mean square error between two half precision float vectors. @param[in] pSrcA points to the first input vector @param[in] pSrcB points to the second input vector @param[in] blockSize number of samples in input vector @param[out] pResult mean square error - @return none */ - void arm_mse_f16( const float16_t * pSrcA, const float16_t * pSrcB, diff --git a/Include/dsp/support_functions.h b/Include/dsp/support_functions.h index 5358d28d1..979126949 100755 --- a/Include/dsp/support_functions.h +++ b/Include/dsp/support_functions.h @@ -522,7 +522,6 @@ float32_t arm_weighted_sum_f32(const float32_t *in * @param[out] out Barycenter * @param[in] nbVectors Number of vectors * @param[in] vecDim Dimension of space (vector dimension) - * @return None * */ void arm_barycenter_f32(const float32_t *in diff --git a/Include/dsp/support_functions_f16.h b/Include/dsp/support_functions_f16.h index bce2841de..d676e85dc 100755 --- a/Include/dsp/support_functions_f16.h +++ b/Include/dsp/support_functions_f16.h @@ -48,6 +48,7 @@ extern "C" */ void arm_copy_f16(const float16_t * pSrc, float16_t * pDst, uint32_t blockSize); + /** * @brief Fills a constant value into a floating-point vector. * @param[in] value input value to be filled @@ -56,6 +57,7 @@ void arm_copy_f16(const float16_t * pSrc, float16_t * pDst, uint32_t blockSize); */ void arm_fill_f16(float16_t value, float16_t * pDst, uint32_t blockSize); + /** * @brief Converts the elements of the floating-point vector to Q31 vector. * @param[in] pSrc points to the f16 input vector @@ -64,6 +66,7 @@ void arm_fill_f16(float16_t value, float16_t * pDst, uint32_t blockSize); */ void arm_f16_to_q15(const float16_t * pSrc, q15_t * pDst, uint32_t blockSize); + /** * @brief Converts the elements of the floating-point vector to Q31 vector. * @param[in] pSrc points to the q15 input vector @@ -72,6 +75,7 @@ void arm_f16_to_q15(const float16_t * pSrc, q15_t * pDst, uint32_t blockSize); */ void arm_q15_to_f16(const q15_t * pSrc, float16_t * pDst, uint32_t blockSize); + /** * @brief Converts the elements of the 64 bit floating-point vector to 16 bit floating-point vector. * @param[in] pSrc points to the f64 input vector @@ -80,6 +84,7 @@ void arm_q15_to_f16(const q15_t * pSrc, float16_t * pDst, uint32_t blockSize); */ void arm_f64_to_f16(const float64_t * pSrc, float16_t * pDst, uint32_t blockSize); + /** * @brief Converts the elements of the 16 bit floating-point vector to 64 bit floating-point vector. * @param[in] pSrc points to the f16 input vector @@ -88,6 +93,7 @@ void arm_f64_to_f16(const float64_t * pSrc, float16_t * pDst, uint32_t blockSize */ void arm_f16_to_f64(const float16_t * pSrc, float64_t * pDst, uint32_t blockSize); + /** * @brief Converts the elements of the floating-point vector to Q31 vector. * @param[in] pSrc points to the f32 input vector @@ -96,6 +102,7 @@ void arm_f16_to_f64(const float16_t * pSrc, float64_t * pDst, uint32_t blockSize */ void arm_float_to_f16(const float32_t * pSrc, float16_t * pDst, uint32_t blockSize); + /** * @brief Converts the elements of the floating-point vector to Q31 vector. * @param[in] pSrc points to the f16 input vector @@ -104,31 +111,26 @@ void arm_float_to_f16(const float32_t * pSrc, float16_t * pDst, uint32_t blockSi */ void arm_f16_to_float(const float16_t * pSrc, float32_t * pDst, uint32_t blockSize); + /** * @brief Weighted sum - * - * * @param[in] *in Array of input values. * @param[in] *weigths Weights * @param[in] blockSize Number of samples in the input array. * @return Weighted sum - * */ float16_t arm_weighted_sum_f16(const float16_t *in , const float16_t *weigths , uint32_t blockSize); + /** * @brief Barycenter - * - * * @param[in] in List of vectors * @param[in] weights Weights of the vectors * @param[out] out Barycenter * @param[in] nbVectors Number of vectors * @param[in] vecDim Dimension of space (vector dimension) - * @return None - * */ void arm_barycenter_f16(const float16_t *in , const float16_t *weights diff --git a/Include/dsp/svm_functions.h b/Include/dsp/svm_functions.h index 3acc6211c..3cf70ac94 100755 --- a/Include/dsp/svm_functions.h +++ b/Include/dsp/svm_functions.h @@ -60,7 +60,6 @@ extern "C" * @param[in] x value * @param[in] nb integer exponent >= 1 * @return x^nb - * */ __STATIC_INLINE float32_t arm_exponent_f32(float32_t x, int32_t nb) { @@ -74,9 +73,6 @@ __STATIC_INLINE float32_t arm_exponent_f32(float32_t x, int32_t nb) return(r); } - - - /** * @brief Instance structure for linear SVM prediction function. @@ -108,6 +104,7 @@ typedef struct float32_t gamma; /**< Gamma factor */ } arm_svm_polynomial_instance_f32; + /** * @brief Instance structure for rbf SVM prediction function. */ @@ -122,6 +119,7 @@ typedef struct float32_t gamma; /**< Gamma factor */ } arm_svm_rbf_instance_f32; + /** * @brief Instance structure for sigmoid SVM prediction function. */ @@ -137,6 +135,7 @@ typedef struct float32_t gamma; /**< Gamma factor */ } arm_svm_sigmoid_instance_f32; + /** * @brief SVM linear instance init function * @param[in] S Parameters for SVM functions @@ -146,11 +145,7 @@ typedef struct * @param[in] dualCoefficients Array of dual coefficients * @param[in] supportVectors Array of support vectors * @param[in] classes Array of 2 classes ID - * @return none. - * */ - - void arm_svm_linear_init_f32(arm_svm_linear_instance_f32 *S, uint32_t nbOfSupportVectors, uint32_t vectorDimension, @@ -159,15 +154,13 @@ void arm_svm_linear_init_f32(arm_svm_linear_instance_f32 *S, const float32_t *supportVectors, const int32_t *classes); + /** * @brief SVM linear prediction * @param[in] S Pointer to an instance of the linear SVM structure. * @param[in] in Pointer to input vector * @param[out] pResult Decision value - * @return none. - * */ - void arm_svm_linear_predict_f32(const arm_svm_linear_instance_f32 *S, const float32_t * in, int32_t * pResult); @@ -185,11 +178,7 @@ void arm_svm_linear_predict_f32(const arm_svm_linear_instance_f32 *S, * @param[in] degree Polynomial degree * @param[in] coef0 coeff0 (scikit-learn terminology) * @param[in] gamma gamma (scikit-learn terminology) - * @return none. - * */ - - void arm_svm_polynomial_init_f32(arm_svm_polynomial_instance_f32 *S, uint32_t nbOfSupportVectors, uint32_t vectorDimension, @@ -202,13 +191,12 @@ void arm_svm_polynomial_init_f32(arm_svm_polynomial_instance_f32 *S, float32_t gamma ); + /** * @brief SVM polynomial prediction * @param[in] S Pointer to an instance of the polynomial SVM structure. * @param[in] in Pointer to input vector * @param[out] pResult Decision value - * @return none. - * */ void arm_svm_polynomial_predict_f32(const arm_svm_polynomial_instance_f32 *S, const float32_t * in, @@ -225,10 +213,7 @@ void arm_svm_polynomial_predict_f32(const arm_svm_polynomial_instance_f32 *S, * @param[in] supportVectors Array of support vectors * @param[in] classes Array of 2 classes ID * @param[in] gamma gamma (scikit-learn terminology) - * @return none. - * */ - void arm_svm_rbf_init_f32(arm_svm_rbf_instance_f32 *S, uint32_t nbOfSupportVectors, uint32_t vectorDimension, @@ -239,18 +224,18 @@ void arm_svm_rbf_init_f32(arm_svm_rbf_instance_f32 *S, float32_t gamma ); + /** * @brief SVM rbf prediction * @param[in] S Pointer to an instance of the rbf SVM structure. * @param[in] in Pointer to input vector * @param[out] pResult decision value - * @return none. - * */ void arm_svm_rbf_predict_f32(const arm_svm_rbf_instance_f32 *S, const float32_t * in, int32_t * pResult); + /** * @brief SVM sigmoid instance init function * @param[in] S points to an instance of the rbf SVM structure. @@ -262,10 +247,7 @@ void arm_svm_rbf_predict_f32(const arm_svm_rbf_instance_f32 *S, * @param[in] classes Array of 2 classes ID * @param[in] coef0 coeff0 (scikit-learn terminology) * @param[in] gamma gamma (scikit-learn terminology) - * @return none. - * */ - void arm_svm_sigmoid_init_f32(arm_svm_sigmoid_instance_f32 *S, uint32_t nbOfSupportVectors, uint32_t vectorDimension, @@ -277,13 +259,12 @@ void arm_svm_sigmoid_init_f32(arm_svm_sigmoid_instance_f32 *S, float32_t gamma ); + /** * @brief SVM sigmoid prediction * @param[in] S Pointer to an instance of the rbf SVM structure. * @param[in] in Pointer to input vector * @param[out] pResult Decision value - * @return none. - * */ void arm_svm_sigmoid_predict_f32(const arm_svm_sigmoid_instance_f32 *S, const float32_t * in, diff --git a/Include/dsp/svm_functions_f16.h b/Include/dsp/svm_functions_f16.h index 7c9fbab9d..c240f9bd5 100755 --- a/Include/dsp/svm_functions_f16.h +++ b/Include/dsp/svm_functions_f16.h @@ -90,6 +90,7 @@ typedef struct float16_t gamma; /**< Gamma factor */ } arm_svm_polynomial_instance_f16; + /** * @brief Instance structure for rbf SVM prediction function. */ @@ -104,6 +105,7 @@ typedef struct float16_t gamma; /**< Gamma factor */ } arm_svm_rbf_instance_f16; + /** * @brief Instance structure for sigmoid SVM prediction function. */ @@ -119,6 +121,7 @@ typedef struct float16_t gamma; /**< Gamma factor */ } arm_svm_sigmoid_instance_f16; + /** * @brief SVM linear instance init function * @param[in] S Parameters for SVM functions @@ -128,11 +131,7 @@ typedef struct * @param[in] dualCoefficients Array of dual coefficients * @param[in] supportVectors Array of support vectors * @param[in] classes Array of 2 classes ID - * @return none. - * */ - - void arm_svm_linear_init_f16(arm_svm_linear_instance_f16 *S, uint32_t nbOfSupportVectors, uint32_t vectorDimension, @@ -146,10 +145,7 @@ void arm_svm_linear_init_f16(arm_svm_linear_instance_f16 *S, * @param[in] S Pointer to an instance of the linear SVM structure. * @param[in] in Pointer to input vector * @param[out] pResult Decision value - * @return none. - * */ - void arm_svm_linear_predict_f16(const arm_svm_linear_instance_f16 *S, const float16_t * in, int32_t * pResult); @@ -167,11 +163,7 @@ void arm_svm_linear_predict_f16(const arm_svm_linear_instance_f16 *S, * @param[in] degree Polynomial degree * @param[in] coef0 coeff0 (scikit-learn terminology) * @param[in] gamma gamma (scikit-learn terminology) - * @return none. - * */ - - void arm_svm_polynomial_init_f16(arm_svm_polynomial_instance_f16 *S, uint32_t nbOfSupportVectors, uint32_t vectorDimension, @@ -184,13 +176,12 @@ void arm_svm_polynomial_init_f16(arm_svm_polynomial_instance_f16 *S, float16_t gamma ); + /** * @brief SVM polynomial prediction * @param[in] S Pointer to an instance of the polynomial SVM structure. * @param[in] in Pointer to input vector * @param[out] pResult Decision value - * @return none. - * */ void arm_svm_polynomial_predict_f16(const arm_svm_polynomial_instance_f16 *S, const float16_t * in, @@ -207,10 +198,7 @@ void arm_svm_polynomial_predict_f16(const arm_svm_polynomial_instance_f16 *S, * @param[in] supportVectors Array of support vectors * @param[in] classes Array of 2 classes ID * @param[in] gamma gamma (scikit-learn terminology) - * @return none. - * */ - void arm_svm_rbf_init_f16(arm_svm_rbf_instance_f16 *S, uint32_t nbOfSupportVectors, uint32_t vectorDimension, @@ -221,18 +209,18 @@ void arm_svm_rbf_init_f16(arm_svm_rbf_instance_f16 *S, float16_t gamma ); + /** * @brief SVM rbf prediction * @param[in] S Pointer to an instance of the rbf SVM structure. * @param[in] in Pointer to input vector * @param[out] pResult decision value - * @return none. - * */ void arm_svm_rbf_predict_f16(const arm_svm_rbf_instance_f16 *S, const float16_t * in, int32_t * pResult); + /** * @brief SVM sigmoid instance init function * @param[in] S points to an instance of the rbf SVM structure. @@ -244,10 +232,7 @@ void arm_svm_rbf_predict_f16(const arm_svm_rbf_instance_f16 *S, * @param[in] classes Array of 2 classes ID * @param[in] coef0 coeff0 (scikit-learn terminology) * @param[in] gamma gamma (scikit-learn terminology) - * @return none. - * */ - void arm_svm_sigmoid_init_f16(arm_svm_sigmoid_instance_f16 *S, uint32_t nbOfSupportVectors, uint32_t vectorDimension, @@ -259,13 +244,12 @@ void arm_svm_sigmoid_init_f16(arm_svm_sigmoid_instance_f16 *S, float16_t gamma ); + /** * @brief SVM sigmoid prediction * @param[in] S Pointer to an instance of the rbf SVM structure. * @param[in] in Pointer to input vector * @param[out] pResult Decision value - * @return none. - * */ void arm_svm_sigmoid_predict_f16(const arm_svm_sigmoid_instance_f16 *S, const float16_t * in, diff --git a/Include/dsp/transform_functions.h b/Include/dsp/transform_functions.h index b1f15e4a5..3a34ce56e 100755 --- a/Include/dsp/transform_functions.h +++ b/Include/dsp/transform_functions.h @@ -859,7 +859,6 @@ arm_status arm_mfcc_init_f32( @param[in] pSrc points to the input samples @param[out] pDst points to the output MFCC values @param[inout] pTmp points to a temporary buffer of complex - @return none */ void arm_mfcc_f32( const arm_mfcc_instance_f32 * S, diff --git a/Include/dsp/transform_functions_f16.h b/Include/dsp/transform_functions_f16.h index dee4b2754..0f37dba63 100755 --- a/Include/dsp/transform_functions_f16.h +++ b/Include/dsp/transform_functions_f16.h @@ -298,7 +298,6 @@ arm_status arm_mfcc_init_f16( @param[in] pSrc points to the input samples @param[out] pDst points to the output MFCC values @param[inout] pTmp points to a temporary buffer of complex - @return none */ void arm_mfcc_f16( const arm_mfcc_instance_f16 * S, diff --git a/Scripts/git/check_links.sh b/Scripts/git/check_links.sh deleted file mode 100644 index 355639cb4..000000000 --- a/Scripts/git/check_links.sh +++ /dev/null @@ -1,52 +0,0 @@ -#!/bin/bash - -usage() { - echo "" - echo "Usage: $(basename $0) " - echo " Index.html file to start link scanning at." - echo " Directory with doxygen source files." - echo "" -} - -if [ ! -f "$1" ]; then - if [ -z "$1" ]; then - echo "No index file provided!" >&2 - else - echo "Index file not found: '$1'" >&2 - fi - usage - exit 1 -fi - -if [ ! -d "$2" ]; then - if [ -z "$2" ]; then - echo "No source directory provided!" >&2 - else - echo "Source dir not found: '$2'" >&2 - fi - usage - exit 1 -fi - -linkchecker -F csv --timeout 3 --check-extern $1 - -OFS=$IFS -IFS=$'\n' - -for line in $(grep -E '^[^#]' linkchecker-out.csv | tail -n +2); do - link=$(echo $line | cut -d';' -f 1) - msg=$(echo $line | cut -d';' -f 4) - origin=$(grep -Ern "href=['\"]${link}['\"]" $2) - for o in $origin; do - ofile=$(echo $o | cut -d':' -f 1) - oline=$(echo $o | cut -d':' -f 2) - match=$(echo $o | cut -d':' -f 3-) - rest="${match#*$link}" - ocolumn=$((${#match} - ${#rest} - ${#link})) - echo "$(readlink -f -n $ofile):${oline}:${ocolumn};${link};${msg};URL '${link}' results to '${msg}'" >&2 - done -done - -IFS=$OFS - -exit 0 diff --git a/Scripts/git/gen_changelog.sh b/Scripts/git/gen_changelog.sh deleted file mode 100644 index c03b024d6..000000000 --- a/Scripts/git/gen_changelog.sh +++ /dev/null @@ -1,161 +0,0 @@ -#!/bin/bash - -DIRNAME=$(dirname $(readlink -f $0)) -DESCRIBE=$(readlink -f ${DIRNAME}/git_describe.sh) - -function usage { - echo "$(basename $0) [-h|--help] [-f|--format ] [tag-prefix]" - echo "" - echo "Arguments:" - echo " -h|--help Print this usage message and exit." - echo " -f|--format Print changelog in given format." - echo " text Release notes in plain text." - echo " pdsc Release notes for PDSC" - echo " dxy Release notes for Doxygen" - echo " html Release notes for HTML" - echo " -p|--pre Include latest pre-release." - echo " tag-prefix Prefix to filter tags." - echo "" -} - -function print_text_head { - true -} - -function print_text { - if [ -z "$2" ]; then - echo "$1" - else - echo "$1 ($2)" - fi - - echo -e "$3" -} - -function print_text_tail { - true -} - -function print_pdsc_head { - echo "" -} - -function print_pdsc { - if [ -z "$2" ]; then - echo " " - else - echo " " - fi - echo -e "$3" | \ - sed "s/^/ /" | \ - sed "s/
    //" | \ - sed "s/
      //" | \ - sed "s/<\/ul>//" | \ - sed "s/
    • /- /" | \ - sed "s/<\/li>//" | \ - sed "s/[ ]*$//" | \ - sed "/^$/d" - echo -e " " -} - -function print_pdsc_tail { - echo "" -} - -function print_dxy_head { - echo "/**" - echo "\page ChangeLog_pg Revision History of CMSIS-DSP" - echo "" - echo "Version | Description" - echo ":----------|:------------------------------------------" -} - -function print_dxy { - printf "%-10s | %s\n" "$1" "$3" -} - -function print_dxy_tail { - echo "" - echo "*/" -} - -function print_html_head { - echo "/**" - echo "\page ChangeLog_pg Revision History" - echo "" - echo "" - echo "" - echo " " - echo " " - echo "" -} - -function print_html { - echo "" - echo " " - echo " " - echo "" -} - -function print_html_tail { - echo "
      VersionDescription
      $1" - echo -e "$3" | sed "s/^/ /" - echo "
      " - echo "" - echo "*/" -} - -POSITIONAL=() -FORMAT="text" -PRERELEASE=0 -while [[ $# -gt 0 ]] -do - key="$1" - - case $key in - '-h'|'--help') - usage - exit 1 - ;; - '-f'|'--format') - shift - FORMAT=$1 - shift - ;; - '-p'|'--pre') - PRERELEASE=1 - shift - ;; - *) # unknown option - POSITIONAL+=("$1") # save it in an array for later - shift # past argument - ;; - esac -done -set -- "${POSITIONAL[@]}" # restore positional parameters - -echo "Generating changelog ..." >&2 - -PREFIX="v" -if [ -n "$1" ]; then - PREFIX=$1 -fi -TAGS=$(git for-each-ref --format "%(objecttype) %(refname)" --sort="-v:refname" "refs/tags/${PREFIX}*" 2>/dev/null | cut -d\ -f2) -LATEST=$(/bin/bash ${DESCRIBE} "${PREFIX}") - -print_${FORMAT}_head - -if [[ $PRERELEASE != 0 ]] && ! git rev-list "${PREFIX}${LATEST}" >/dev/null; then - print_$FORMAT "${LATEST}" "" "Active development ..." -fi - -for TAG in $TAGS; do - TAG="${TAG#refs/tags/}" - DESC=$(git tag -l -n99 --format "%(contents)" ${TAG} 2>/dev/null) - DATE=$(git tag -l -n99 --format "%(taggerdate:short)" ${TAG} 2>/dev/null) - print_$FORMAT "${TAG#${PREFIX}}" "${DATE}" "${DESC}" -done - -print_${FORMAT}_tail - -exit 0 diff --git a/Scripts/git/gen_pack.sh b/Scripts/git/gen_pack.sh deleted file mode 100644 index e003d5f96..000000000 --- a/Scripts/git/gen_pack.sh +++ /dev/null @@ -1,307 +0,0 @@ -#!/bin/bash -# Version: 1.5 -# Date: 2022-06-01 -# This bash script generates a CMSIS Software Pack: -# -# Pre-requisites: -# - bash shell (for Windows: install git for Windows) -# - git in path (for Windows: install git for Windows) -# - 7z in path (zip archiving utility) -# e.g. Ubuntu: sudo apt-get install p7zip-full p7zip-rar) -# - packchk is taken from latest install CMSIS Pack installed in $CMSIS_PACK_ROOT -# - xmllint in path (XML schema validation) - -############### EDIT BELOW ############### -# Extend Path environment variable locally -# - -set -o pipefail - -DIRNAME=$(dirname $(readlink -f $0)) -CHANGELOG=$(readlink -f ${DIRNAME}/gen_changelog.sh) -DESCRIBE=$(readlink -f ${DIRNAME}/git_describe.sh) -VERSION=$(/bin/bash ${DESCRIBE} v) - -function usage { - echo "$(basename $0) [-h|--help] []" - echo "" - echo "Arguments:" - echo " -k|--keep Keep build directory." - echo " -h|--help Print this usage message and exit." - echo " pdsc The pack description to generate the pack for." - echo "" - echo "Environment:" - echo " 7z" - echo " packchk" - echo " xmllint (optional)" - echo "" -} - -KEEP=0 -POSITIONAL=() -while [[ $# -gt 0 ]] -do - key="$1" - - case $key in - '-h'|'--help') - usage - exit 1 - ;; - '-k'|'--keep') - shift - KEEP=1 - ;; - *) # unknown option - POSITIONAL+=("$1") # save it in an array for later - shift # past argument - ;; - esac -done -set -- "${POSITIONAL[@]}" # restore positional parameters - -OS=$(uname -s) -case $OS in - 'Linux') - if [ -z ${CMSIS_PACK_ROOT+x} ] ; then - CMSIS_PACK_ROOT="/home/$USER/.arm/Packs" - fi - CMSIS_TOOLSDIR="$(ls -drv ${CMSIS_PACK_ROOT}/ARM/CMSIS/* | head -1)/CMSIS/Utilities/Linux64" - ;; - 'WindowsNT'|MINGW*|CYGWIN*) - if [ -z ${CMSIS_PACK_ROOT+x} ] ; then - CMSIS_PACK_ROOT="$LOCALAPPDATA/Arm/Packs" - fi - CMSIS_PACK_ROOT="/$(echo ${CMSIS_PACK_ROOT} | sed -e 's/\\/\//g' -e 's/://g' -e 's/\"//g')" - CMSIS_TOOLSDIR="$(ls -drv ${CMSIS_PACK_ROOT}/ARM/CMSIS/* | head -1)/CMSIS/Utilities/Win32" - ;; - 'Darwin') - echo "Error: CMSIS Tools not available for Mac at present." - exit 1 - ;; - *) - echo "Error: unrecognized OS $OS" - exit 1 - ;; -esac - -PATH_TO_ADD="$CMSIS_TOOLSDIR" - -[[ ":$PATH:" != *":${PATH_TO_ADD}:"* ]] && PATH="${PATH}:${PATH_TO_ADD}" -echo $PATH_TO_ADD appended to PATH -echo " " - -# Pack warehouse directory - destination -PACK_WAREHOUSE=./output - -# Temporary pack build directory -PACK_BUILD=./build - -# Specify directory names to be added to pack base directory -PACK_DIRS=" - Documentation - Include - Source - PrivateInclude - ComputeLibrary - Examples -" - -# Specify file names to be added to pack base directory -PACK_BASE_FILES=" - LICENSE -" - -# Specify file names to be deleted from pack build directory -PACK_DELETE_FILES="" - -# Specify patches to be applied -PACK_PATCH_FILES="" - -############ DO NOT EDIT BELOW ########### -echo Starting CMSIS-Pack Generation: `date` -# Zip utility check -ZIP=7z -if ! type -a "${ZIP}"; then - echo "Error: No 7zip Utility found" - echo "Action: Add 7zip to your path" - echo " " - exit 1 -fi - -# Pack checking utility check -PACKCHK=packchk -if ! type -a ${PACKCHK}; then - echo "Error: No PackChk Utility found" - echo "Action: Add PackChk to your path" - echo "Hint: Included in CMSIS Pack:" - echo "$CMSIS_PACK_ROOT/ARM/CMSIS//CMSIS/Utilities//" - echo " " - exit 1 -fi -echo " " - -# Locate Package Description file -# check whether there is more than one pdsc file -NUM_PDSCS=$(ls -1 *.pdsc | wc -l) -PACK_DESCRIPTION_FILE=$(ls *.pdsc) -if [[ -n $1 && -f $1 ]]; then - PACK_DESCRIPTION_FILE=$1 -elif [ ${NUM_PDSCS} -lt 1 ]; then - echo "Error: No *.pdsc file found in current directory" - echo " " - exit 1 -elif [ ${NUM_PDSCS} -gt 1 ]; then - echo "Error: Only one PDSC file allowed in directory structure:" - echo "Found:" - echo "$PACK_DESCRIPTION_FILE" - echo "Action: Provide PDSC file explicitly!" - echo " " - usage - exit 1 -fi - -SAVEIFS=$IFS -IFS=. -set ${PACK_DESCRIPTION_FILE} -# Pack Vendor -PACK_VENDOR=$1 -# Pack Name -PACK_NAME=$2 -echo "Generating Pack: for $PACK_VENDOR.$PACK_NAME" -echo " " -IFS=$SAVEIFS - -#if $PACK_BUILD directory does not exist, create it. -if [ ! -d "$PACK_BUILD" ]; then - mkdir -p "$PACK_BUILD" -fi - -# Copy files into build base directory: $PACK_BUILD -# pdsc file is mandatory in base directory: -first=$(grep -n "" ${PACK_VENDOR}.${PACK_NAME}.pdsc | cut -d: -f1) -last=$(grep -n "" ${PACK_VENDOR}.${PACK_NAME}.pdsc | cut -d: -f1) -let first-=1 -let last+=1 -head -n ${first} "./${PACK_VENDOR}.${PACK_NAME}.pdsc" > "${PACK_BUILD}/${PACK_VENDOR}.${PACK_NAME}.pdsc" -/bin/bash "${CHANGELOG}" -p -f pdsc 2>/dev/null | sed "s/^/ /" >> "${PACK_BUILD}/${PACK_VENDOR}.${PACK_NAME}.pdsc" -tail -n +${last} "./${PACK_VENDOR}.${PACK_NAME}.pdsc" | \ - sed -e "s/Cversion=\"[^\"]*\"/Cversion=\"${VERSION}\"/" >> "${PACK_BUILD}/${PACK_VENDOR}.${PACK_NAME}.pdsc" - -# Add directories -echo Adding directories to pack: -#echo "${PACK_DIRS}" -echo " " -for d in ${PACK_DIRS}; do - echo "$d" - cp -r --parents "$d" "${PACK_BUILD}" -done - -# Add files -echo Adding files to pack: -#echo "${PACK_BASE_FILES}" -echo " " -if [ ! -x ${PACK_BASE_FILES+x} ]; then - for f in ${PACK_BASE_FILES}; do - echo "$f" - cp -f --parents "$f" $PACK_BUILD/ - done -fi - -# Delete files -echo Deleting files from pack: -echo "${PACK_DELETE_FILES}" -echo " " -if [ ! -x ${PACK_DELETE_FILES+x} ]; then - for f in ${PACK_DELETE_FILES}; do - find $PACK_BUILD/$(dirname "$f") -name $(basename "$f") -delete - done -fi - -# Apply patches -echo Applying patches to pack: -echo "${PACK_PATCH_FILES}" -echo " " -if [ ! -x ${PACK_PATCH_FILES+x} ]; then - CWD=$(pwd) - pushd $PACK_BUILD > /dev/null - for f in ${PACK_PATCH_FILES}; do - patch -p0 -t -i "${CWD}/${f}" - done - popd > /dev/null -fi - -# Run Schema Check (for Linux only): -# sudo apt-get install libxml2-utils - - -if type -a xmllint; then - echo "Running schema check for ${PACK_VENDOR}.${PACK_NAME}.pdsc" - SCHEMA=$(realpath -m ${CMSIS_TOOLSDIR}/../PACK.xsd) - if [ ! -f $SCHEMA ]; then - SCHEMAURL=$(grep -Pio "xs:noNamespaceSchemaLocation=\"\K[^\"]+" ${PACK_BUILD}/${PACK_VENDOR}.${PACK_NAME}.pdsc) - curl -L $SCHEMAURL --output PACK.xsd - SCHEMA="PACK.xsd" - fi - xmllint --noout --schema ${SCHEMA} "${PACK_BUILD}/${PACK_VENDOR}.${PACK_NAME}.pdsc" - errorlevel=$? - if [ $errorlevel -ne 0 ]; then - echo "build aborted: Schema check of $PACK_VENDOR.$PACK_NAME.pdsc against PACK.xsd failed" - echo " " - exit 1 - fi -else - echo "Use MDK PackInstaller to run schema validation for $PACK_VENDOR.$PACK_NAME.pdsc" -fi - -# Run Pack Check and generate PackName file with version -"${PACKCHK}" "${PACK_BUILD}/${PACK_VENDOR}.${PACK_NAME}.pdsc" \ - -i "${CMSIS_PACK_ROOT}/.Web/ARM.CMSIS.pdsc" \ - -n PackName.txt -errorlevel=$? -if [ $errorlevel -ne 0 ]; then - echo "build aborted: pack check failed" - echo " " - exit 1 -fi - -PACKNAME=$(cat PackName.txt) -rm -rf PackName.txt - -# Create checksum file -echo Creating checksum file: -pushd $PACK_BUILD > /dev/null -find . -type f -exec sha1sum -b {} + > ../${PACK_VENDOR}.${PACK_NAME}.sha1 -mv ../${PACK_VENDOR}.${PACK_NAME}.sha1 . -popd > /dev/null - -# Archiving -# $ZIP a $PACKNAME -echo "creating pack file $PACKNAME" -#if $PACK_WAREHOUSE directory does not exist create it -if [ ! -d "$PACK_WAREHOUSE" ]; then - mkdir -p "$PACK_WAREHOUSE" -fi -pushd "$PACK_WAREHOUSE" > /dev/null -PACK_WAREHOUSE=$(pwd) -popd > /dev/null -pushd "$PACK_BUILD" > /dev/null -PACK_BUILD=$(pwd) -"$ZIP" a "$PACK_WAREHOUSE/$PACKNAME" -tzip -popd > /dev/null -errorlevel=$? -if [ $errorlevel -ne 0 ]; then - echo "build aborted: archiving failed" - exit 1 -fi - -echo "build of pack succeeded" -# Clean up -echo "cleaning up ..." - -if [[ $KEEP == 0 ]]; then - rm -rf "$PACK_BUILD" -fi -echo " " - -echo Completed CMSIS-Pack Generation: $(date) diff --git a/Scripts/git/git-configure.sh b/Scripts/git/git-configure.sh deleted file mode 100644 index da14d11f9..000000000 --- a/Scripts/git/git-configure.sh +++ /dev/null @@ -1,9 +0,0 @@ -#!/bin/bash - -DIRNAME=$(git rev-parse --show-toplevel) - -if ! git config --local -l | egrep -q include.path=../.gitconfig$; then - git config --local --add include.path ../.gitconfig - rm ${DIRNAME}/.git/index - git checkout HEAD -- ${DIRNAME} -fi diff --git a/Scripts/git/git-version.clean b/Scripts/git/git-version.clean deleted file mode 100644 index acedf9047..000000000 --- a/Scripts/git/git-version.clean +++ /dev/null @@ -1,4 +0,0 @@ -#!/bin/bash - -sed -e "s/release version=\"[^\"]*\"/release version=\"0.0.0\"/" | \ - sed -e "s/Cversion=\"[^\"]*\"/Cversion=\"0.0.0\"/" diff --git a/Scripts/git/git-version.smudge b/Scripts/git/git-version.smudge deleted file mode 100644 index 44e2e5562..000000000 --- a/Scripts/git/git-version.smudge +++ /dev/null @@ -1,8 +0,0 @@ -#!/bin/bash - -DIRNAME=$(dirname $(readlink -f $0)) -DESCRIBE=$(readlink -f ${DIRNAME}/git_describe.sh) -VERSION=$(${DESCRIBE} v) - -sed -e "s/release version=\"0.0.0\"/release version=\"${VERSION}\"/" | \ - sed -e "s/Cversion=\"0.0.0\"/Cversion=\"${VERSION}\"/" diff --git a/Scripts/git/git_describe.sh b/Scripts/git/git_describe.sh deleted file mode 100644 index 5c614c1af..000000000 --- a/Scripts/git/git_describe.sh +++ /dev/null @@ -1,17 +0,0 @@ -#!/bin/bash - -if git rev-parse --git-dir 2>&1 >/dev/null; then - gitversion=$(git describe --tags --long --match "$1*" --abbrev=7 || echo "0.0.0-dirty-0-g$(git describe --tags --match "$1*" --always --abbrev=7 2>/dev/null)") - patch=$(sed -r -e 's/[0-9]+\.[0-9]+\.([0-9]+).*/\1/' <<< ${gitversion#$1}) - let patch+=1 - version=$(sed -r -e 's/-0-(g[0-9a-f]{7})//' <<< ${gitversion#$1}) - version=$(sed -r -e "s/\.[0-9]+-([0-9]+)-(g[0-9a-f]{7})/.${patch}-dev\1+\2/" <<< ${version}) - version=$(sed -r -e "s/-([0-9]+)-(g[0-9a-f]{7})/+p\1+\2/" <<< ${version}) - echo "Git version: '$version'" >&2 - echo $version -else - echo "No Git repository: '0.0.0-nogit'" >&2 - echo "0.0.0-nogit" -fi - -exit 0 diff --git a/Source/BasicMathFunctions/arm_abs_f16.c b/Source/BasicMathFunctions/arm_abs_f16.c index ef1ea1585..aaa2f6f9a 100755 --- a/Source/BasicMathFunctions/arm_abs_f16.c +++ b/Source/BasicMathFunctions/arm_abs_f16.c @@ -44,7 +44,6 @@ @param[in] pSrc points to the input vector @param[out] pDst points to the output vector @param[in] blockSize number of samples in each vector - @return none */ diff --git a/Source/BasicMathFunctions/arm_abs_f32.c b/Source/BasicMathFunctions/arm_abs_f32.c index 1e67f4e33..0de9e257e 100644 --- a/Source/BasicMathFunctions/arm_abs_f32.c +++ b/Source/BasicMathFunctions/arm_abs_f32.c @@ -57,7 +57,6 @@ @param[in] pSrc points to the input vector @param[out] pDst points to the output vector @param[in] blockSize number of samples in each vector - @return none */ diff --git a/Source/BasicMathFunctions/arm_abs_f64.c b/Source/BasicMathFunctions/arm_abs_f64.c index 04a79f7a8..184df9df1 100644 --- a/Source/BasicMathFunctions/arm_abs_f64.c +++ b/Source/BasicMathFunctions/arm_abs_f64.c @@ -43,7 +43,6 @@ @param[in] pSrc points to the input vector @param[out] pDst points to the output vector @param[in] blockSize number of samples in each vector - @return none */ void arm_abs_f64( diff --git a/Source/BasicMathFunctions/arm_abs_q15.c b/Source/BasicMathFunctions/arm_abs_q15.c index 7c38ef518..3f5fb1923 100644 --- a/Source/BasicMathFunctions/arm_abs_q15.c +++ b/Source/BasicMathFunctions/arm_abs_q15.c @@ -42,7 +42,6 @@ @param[in] pSrc points to the input vector @param[out] pDst points to the output vector @param[in] blockSize number of samples in each vector - @return none @par Scaling and Overflow Behavior The function uses saturating arithmetic. diff --git a/Source/BasicMathFunctions/arm_abs_q31.c b/Source/BasicMathFunctions/arm_abs_q31.c index 7043aa0cf..0416028fe 100644 --- a/Source/BasicMathFunctions/arm_abs_q31.c +++ b/Source/BasicMathFunctions/arm_abs_q31.c @@ -42,7 +42,6 @@ @param[in] pSrc points to the input vector @param[out] pDst points to the output vector @param[in] blockSize number of samples in each vector - @return none @par Scaling and Overflow Behavior The function uses saturating arithmetic. diff --git a/Source/BasicMathFunctions/arm_abs_q7.c b/Source/BasicMathFunctions/arm_abs_q7.c index bd79582e4..b0c76902d 100644 --- a/Source/BasicMathFunctions/arm_abs_q7.c +++ b/Source/BasicMathFunctions/arm_abs_q7.c @@ -42,7 +42,6 @@ @param[in] pSrc points to the input vector @param[out] pDst points to the output vector @param[in] blockSize number of samples in each vector - @return none @par Conditions for optimum performance Input and output buffers should be aligned by 32-bit diff --git a/Source/BasicMathFunctions/arm_add_f16.c b/Source/BasicMathFunctions/arm_add_f16.c index e2689e0b8..7e697af36 100755 --- a/Source/BasicMathFunctions/arm_add_f16.c +++ b/Source/BasicMathFunctions/arm_add_f16.c @@ -44,7 +44,6 @@ @param[in] pSrcB points to second input vector @param[out] pDst points to output vector @param[in] blockSize number of samples in each vector - @return none */ #if defined(ARM_MATH_MVE_FLOAT16) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/BasicMathFunctions/arm_add_f32.c b/Source/BasicMathFunctions/arm_add_f32.c index 9741e4a6b..fba08a9f1 100644 --- a/Source/BasicMathFunctions/arm_add_f32.c +++ b/Source/BasicMathFunctions/arm_add_f32.c @@ -55,7 +55,6 @@ @param[in] pSrcB points to second input vector @param[out] pDst points to output vector @param[in] blockSize number of samples in each vector - @return none */ #if defined(ARM_MATH_MVEF) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/BasicMathFunctions/arm_add_f64.c b/Source/BasicMathFunctions/arm_add_f64.c index 2d772339f..1af792133 100644 --- a/Source/BasicMathFunctions/arm_add_f64.c +++ b/Source/BasicMathFunctions/arm_add_f64.c @@ -43,7 +43,6 @@ @param[in] pSrcB points to second input vector @param[out] pDst points to output vector @param[in] blockSize number of samples in each vector - @return none */ void arm_add_f64( diff --git a/Source/BasicMathFunctions/arm_add_q15.c b/Source/BasicMathFunctions/arm_add_q15.c index 0bf9d06ad..c33a76cab 100644 --- a/Source/BasicMathFunctions/arm_add_q15.c +++ b/Source/BasicMathFunctions/arm_add_q15.c @@ -43,7 +43,6 @@ @param[in] pSrcB points to the second input vector @param[out] pDst points to the output vector @param[in] blockSize number of samples in each vector - @return none @par Scaling and Overflow Behavior The function uses saturating arithmetic. diff --git a/Source/BasicMathFunctions/arm_add_q31.c b/Source/BasicMathFunctions/arm_add_q31.c index a6783e7f6..f96d762fb 100644 --- a/Source/BasicMathFunctions/arm_add_q31.c +++ b/Source/BasicMathFunctions/arm_add_q31.c @@ -43,7 +43,6 @@ @param[in] pSrcB points to the second input vector @param[out] pDst points to the output vector @param[in] blockSize number of samples in each vector - @return none @par Scaling and Overflow Behavior The function uses saturating arithmetic. diff --git a/Source/BasicMathFunctions/arm_add_q7.c b/Source/BasicMathFunctions/arm_add_q7.c index f58ff866e..502af1553 100644 --- a/Source/BasicMathFunctions/arm_add_q7.c +++ b/Source/BasicMathFunctions/arm_add_q7.c @@ -44,7 +44,6 @@ @param[in] pSrcB points to the second input vector @param[out] pDst points to the output vector @param[in] blockSize number of samples in each vector - @return none @par Scaling and Overflow Behavior The function uses saturating arithmetic. diff --git a/Source/BasicMathFunctions/arm_and_u16.c b/Source/BasicMathFunctions/arm_and_u16.c index 7a7427dcf..9a4903ef0 100644 --- a/Source/BasicMathFunctions/arm_and_u16.c +++ b/Source/BasicMathFunctions/arm_and_u16.c @@ -51,7 +51,6 @@ @param[in] pSrcB points to input vector B @param[out] pDst points to output vector @param[in] blockSize number of samples in each vector - @return none */ void arm_and_u16( diff --git a/Source/BasicMathFunctions/arm_and_u32.c b/Source/BasicMathFunctions/arm_and_u32.c index ddf838c25..a656b4872 100644 --- a/Source/BasicMathFunctions/arm_and_u32.c +++ b/Source/BasicMathFunctions/arm_and_u32.c @@ -43,7 +43,6 @@ @param[in] pSrcB points to input vector B @param[out] pDst points to output vector @param[in] blockSize number of samples in each vector - @return none */ void arm_and_u32( diff --git a/Source/BasicMathFunctions/arm_and_u8.c b/Source/BasicMathFunctions/arm_and_u8.c index bd1a1abe5..3e92d49e7 100644 --- a/Source/BasicMathFunctions/arm_and_u8.c +++ b/Source/BasicMathFunctions/arm_and_u8.c @@ -44,7 +44,6 @@ @param[in] pSrcB points to input vector B @param[out] pDst points to output vector @param[in] blockSize number of samples in each vector - @return none */ void arm_and_u8( diff --git a/Source/BasicMathFunctions/arm_clip_f16.c b/Source/BasicMathFunctions/arm_clip_f16.c index f784a2382..4a3259991 100755 --- a/Source/BasicMathFunctions/arm_clip_f16.c +++ b/Source/BasicMathFunctions/arm_clip_f16.c @@ -45,7 +45,6 @@ @param[in] low lower bound @param[in] high higher bound @param[in] numSamples number of samples to clip - @return none */ #if defined(ARM_MATH_MVE_FLOAT16) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/BasicMathFunctions/arm_clip_f32.c b/Source/BasicMathFunctions/arm_clip_f32.c index 4cc279940..7bf93e61e 100755 --- a/Source/BasicMathFunctions/arm_clip_f32.c +++ b/Source/BasicMathFunctions/arm_clip_f32.c @@ -54,7 +54,6 @@ @param[in] low lower bound @param[in] high higher bound @param[in] numSamples number of samples to clip - @return none */ #if defined(ARM_MATH_MVEF) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/BasicMathFunctions/arm_clip_q15.c b/Source/BasicMathFunctions/arm_clip_q15.c index 0d67c3760..2a18d7788 100755 --- a/Source/BasicMathFunctions/arm_clip_q15.c +++ b/Source/BasicMathFunctions/arm_clip_q15.c @@ -45,7 +45,6 @@ @param[in] low lower bound @param[in] high higher bound @param[in] numSamples number of samples to clip - @return none */ #if defined(ARM_MATH_MVEI) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/BasicMathFunctions/arm_clip_q31.c b/Source/BasicMathFunctions/arm_clip_q31.c index 72b80d38e..010eb8897 100755 --- a/Source/BasicMathFunctions/arm_clip_q31.c +++ b/Source/BasicMathFunctions/arm_clip_q31.c @@ -45,7 +45,6 @@ @param[in] low lower bound @param[in] high higher bound @param[in] numSamples number of samples to clip - @return none */ #if defined(ARM_MATH_MVEI) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/BasicMathFunctions/arm_clip_q7.c b/Source/BasicMathFunctions/arm_clip_q7.c index a41e0c919..529119b1f 100755 --- a/Source/BasicMathFunctions/arm_clip_q7.c +++ b/Source/BasicMathFunctions/arm_clip_q7.c @@ -45,7 +45,6 @@ @param[in] low lower bound @param[in] high higher bound @param[in] numSamples number of samples to clip - @return none */ #if defined(ARM_MATH_MVEI) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/BasicMathFunctions/arm_dot_prod_f16.c b/Source/BasicMathFunctions/arm_dot_prod_f16.c index 6137ae85f..f3ef3b017 100755 --- a/Source/BasicMathFunctions/arm_dot_prod_f16.c +++ b/Source/BasicMathFunctions/arm_dot_prod_f16.c @@ -44,7 +44,6 @@ @param[in] pSrcB points to the second input vector. @param[in] blockSize number of samples in each vector. @param[out] result output result returned here. - @return none */ #if defined(ARM_MATH_MVE_FLOAT16) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/BasicMathFunctions/arm_dot_prod_f32.c b/Source/BasicMathFunctions/arm_dot_prod_f32.c index 62b865783..6aefb1814 100644 --- a/Source/BasicMathFunctions/arm_dot_prod_f32.c +++ b/Source/BasicMathFunctions/arm_dot_prod_f32.c @@ -56,7 +56,6 @@ @param[in] pSrcB points to the second input vector. @param[in] blockSize number of samples in each vector. @param[out] result output result returned here. - @return none */ #if defined(ARM_MATH_MVEF) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/BasicMathFunctions/arm_dot_prod_f64.c b/Source/BasicMathFunctions/arm_dot_prod_f64.c index 1f367abc9..96e557174 100644 --- a/Source/BasicMathFunctions/arm_dot_prod_f64.c +++ b/Source/BasicMathFunctions/arm_dot_prod_f64.c @@ -43,7 +43,6 @@ @param[in] pSrcB points to the second input vector. @param[in] blockSize number of samples in each vector. @param[out] result output result returned here. - @return none */ #if defined(ARM_MATH_NEON) && defined(__aarch64__) void arm_dot_prod_f64( diff --git a/Source/BasicMathFunctions/arm_dot_prod_q15.c b/Source/BasicMathFunctions/arm_dot_prod_q15.c index cb42609b0..555b31631 100644 --- a/Source/BasicMathFunctions/arm_dot_prod_q15.c +++ b/Source/BasicMathFunctions/arm_dot_prod_q15.c @@ -43,7 +43,6 @@ @param[in] pSrcB points to the second input vector @param[in] blockSize number of samples in each vector @param[out] result output result returned here - @return none @par Scaling and Overflow Behavior The intermediate multiplications are in 1.15 x 1.15 = 2.30 format and these diff --git a/Source/BasicMathFunctions/arm_dot_prod_q31.c b/Source/BasicMathFunctions/arm_dot_prod_q31.c index b85da3798..d7a8699c5 100644 --- a/Source/BasicMathFunctions/arm_dot_prod_q31.c +++ b/Source/BasicMathFunctions/arm_dot_prod_q31.c @@ -43,7 +43,6 @@ @param[in] pSrcB points to the second input vector. @param[in] blockSize number of samples in each vector. @param[out] result output result returned here. - @return none @par Scaling and Overflow Behavior The intermediate multiplications are in 1.31 x 1.31 = 2.62 format and these diff --git a/Source/BasicMathFunctions/arm_dot_prod_q7.c b/Source/BasicMathFunctions/arm_dot_prod_q7.c index 2de4e2789..1f5e7a838 100644 --- a/Source/BasicMathFunctions/arm_dot_prod_q7.c +++ b/Source/BasicMathFunctions/arm_dot_prod_q7.c @@ -43,7 +43,6 @@ @param[in] pSrcB points to the second input vector @param[in] blockSize number of samples in each vector @param[out] result output result returned here - @return none @par Scaling and Overflow Behavior The intermediate multiplications are in 1.7 x 1.7 = 2.14 format and these diff --git a/Source/BasicMathFunctions/arm_mult_f16.c b/Source/BasicMathFunctions/arm_mult_f16.c index cac6d20b0..f9c71e0c2 100755 --- a/Source/BasicMathFunctions/arm_mult_f16.c +++ b/Source/BasicMathFunctions/arm_mult_f16.c @@ -44,7 +44,6 @@ @param[in] pSrcB points to the second input vector. @param[out] pDst points to the output vector. @param[in] blockSize number of samples in each vector. - @return none */ diff --git a/Source/BasicMathFunctions/arm_mult_f32.c b/Source/BasicMathFunctions/arm_mult_f32.c index 4df04e962..33e5979fb 100644 --- a/Source/BasicMathFunctions/arm_mult_f32.c +++ b/Source/BasicMathFunctions/arm_mult_f32.c @@ -55,7 +55,6 @@ @param[in] pSrcB points to the second input vector. @param[out] pDst points to the output vector. @param[in] blockSize number of samples in each vector. - @return none */ #if defined(ARM_MATH_MVEF) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/BasicMathFunctions/arm_mult_f64.c b/Source/BasicMathFunctions/arm_mult_f64.c index 1a5afd9af..3c3733d68 100644 --- a/Source/BasicMathFunctions/arm_mult_f64.c +++ b/Source/BasicMathFunctions/arm_mult_f64.c @@ -43,7 +43,6 @@ @param[in] pSrcB points to the second input vector. @param[out] pDst points to the output vector. @param[in] blockSize number of samples in each vector. - @return none */ void arm_mult_f64( diff --git a/Source/BasicMathFunctions/arm_mult_q15.c b/Source/BasicMathFunctions/arm_mult_q15.c index 17951c7a1..04eef1b4c 100644 --- a/Source/BasicMathFunctions/arm_mult_q15.c +++ b/Source/BasicMathFunctions/arm_mult_q15.c @@ -43,7 +43,6 @@ @param[in] pSrcB points to second input vector @param[out] pDst points to output vector @param[in] blockSize number of samples in each vector - @return none @par Scaling and Overflow Behavior The function uses saturating arithmetic. diff --git a/Source/BasicMathFunctions/arm_mult_q31.c b/Source/BasicMathFunctions/arm_mult_q31.c index 63ad73c41..22c9e6024 100644 --- a/Source/BasicMathFunctions/arm_mult_q31.c +++ b/Source/BasicMathFunctions/arm_mult_q31.c @@ -43,7 +43,6 @@ @param[in] pSrcB points to the second input vector. @param[out] pDst points to the output vector. @param[in] blockSize number of samples in each vector. - @return none @par Scaling and Overflow Behavior The function uses saturating arithmetic. diff --git a/Source/BasicMathFunctions/arm_mult_q7.c b/Source/BasicMathFunctions/arm_mult_q7.c index 7be80db50..f5ea37b5f 100644 --- a/Source/BasicMathFunctions/arm_mult_q7.c +++ b/Source/BasicMathFunctions/arm_mult_q7.c @@ -43,7 +43,6 @@ @param[in] pSrcB points to the second input vector @param[out] pDst points to the output vector @param[in] blockSize number of samples in each vector - @return none @par Scaling and Overflow Behavior The function uses saturating arithmetic. diff --git a/Source/BasicMathFunctions/arm_negate_f16.c b/Source/BasicMathFunctions/arm_negate_f16.c index b24ffbc76..db464dd6f 100755 --- a/Source/BasicMathFunctions/arm_negate_f16.c +++ b/Source/BasicMathFunctions/arm_negate_f16.c @@ -43,7 +43,6 @@ @param[in] pSrc points to input vector. @param[out] pDst points to output vector. @param[in] blockSize number of samples in each vector. - @return none */ #if defined(ARM_MATH_MVE_FLOAT16) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/BasicMathFunctions/arm_negate_f32.c b/Source/BasicMathFunctions/arm_negate_f32.c index 4f243cdac..0c4408a5c 100644 --- a/Source/BasicMathFunctions/arm_negate_f32.c +++ b/Source/BasicMathFunctions/arm_negate_f32.c @@ -56,7 +56,6 @@ @param[in] pSrc points to input vector. @param[out] pDst points to output vector. @param[in] blockSize number of samples in each vector. - @return none */ #if defined(ARM_MATH_MVEF) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/BasicMathFunctions/arm_negate_f64.c b/Source/BasicMathFunctions/arm_negate_f64.c index c8a73417b..de8bc7a33 100644 --- a/Source/BasicMathFunctions/arm_negate_f64.c +++ b/Source/BasicMathFunctions/arm_negate_f64.c @@ -42,7 +42,6 @@ @param[in] pSrc points to input vector. @param[out] pDst points to output vector. @param[in] blockSize number of samples in each vector. - @return none */ void arm_negate_f64( diff --git a/Source/BasicMathFunctions/arm_negate_q15.c b/Source/BasicMathFunctions/arm_negate_q15.c index 43d5b0d06..0d87bb83e 100644 --- a/Source/BasicMathFunctions/arm_negate_q15.c +++ b/Source/BasicMathFunctions/arm_negate_q15.c @@ -42,7 +42,6 @@ @param[in] pSrc points to the input vector. @param[out] pDst points to the output vector. @param[in] blockSize number of samples in each vector. - @return none @par Conditions for optimum performance Input and output buffers should be aligned by 32-bit diff --git a/Source/BasicMathFunctions/arm_negate_q31.c b/Source/BasicMathFunctions/arm_negate_q31.c index 3ee77ed74..ac0151be9 100644 --- a/Source/BasicMathFunctions/arm_negate_q31.c +++ b/Source/BasicMathFunctions/arm_negate_q31.c @@ -42,7 +42,6 @@ @param[in] pSrc points to the input vector. @param[out] pDst points to the output vector. @param[in] blockSize number of samples in each vector. - @return none @par Scaling and Overflow Behavior The function uses saturating arithmetic. diff --git a/Source/BasicMathFunctions/arm_negate_q7.c b/Source/BasicMathFunctions/arm_negate_q7.c index 9fd3122eb..269c8f894 100644 --- a/Source/BasicMathFunctions/arm_negate_q7.c +++ b/Source/BasicMathFunctions/arm_negate_q7.c @@ -42,8 +42,7 @@ @param[in] pSrc points to the input vector. @param[out] pDst points to the output vector. @param[in] blockSize number of samples in each vector. - @return none - + @par Scaling and Overflow Behavior The function uses saturating arithmetic. The Q7 value -1 (0x80) is saturated to the maximum allowable positive value 0x7F. diff --git a/Source/BasicMathFunctions/arm_not_u16.c b/Source/BasicMathFunctions/arm_not_u16.c index e553d2879..c2599b727 100644 --- a/Source/BasicMathFunctions/arm_not_u16.c +++ b/Source/BasicMathFunctions/arm_not_u16.c @@ -50,7 +50,6 @@ @param[in] pSrc points to input vector @param[out] pDst points to output vector @param[in] blockSize number of samples in each vector - @return none */ void arm_not_u16( diff --git a/Source/BasicMathFunctions/arm_not_u32.c b/Source/BasicMathFunctions/arm_not_u32.c index f46284c87..712d34773 100644 --- a/Source/BasicMathFunctions/arm_not_u32.c +++ b/Source/BasicMathFunctions/arm_not_u32.c @@ -42,7 +42,6 @@ @param[in] pSrc points to input vector @param[out] pDst points to output vector @param[in] blockSize number of samples in each vector - @return none */ void arm_not_u32( diff --git a/Source/BasicMathFunctions/arm_not_u8.c b/Source/BasicMathFunctions/arm_not_u8.c index e06828386..99646d9fd 100644 --- a/Source/BasicMathFunctions/arm_not_u8.c +++ b/Source/BasicMathFunctions/arm_not_u8.c @@ -42,7 +42,6 @@ @param[in] pSrc points to input vector @param[out] pDst points to output vector @param[in] blockSize number of samples in each vector - @return none */ void arm_not_u8( diff --git a/Source/BasicMathFunctions/arm_offset_f16.c b/Source/BasicMathFunctions/arm_offset_f16.c index 7610dbcfa..31ba91a6a 100755 --- a/Source/BasicMathFunctions/arm_offset_f16.c +++ b/Source/BasicMathFunctions/arm_offset_f16.c @@ -43,7 +43,6 @@ @param[in] offset is the offset to be added @param[out] pDst points to the output vector @param[in] blockSize number of samples in each vector - @return none */ #if defined(ARM_MATH_MVE_FLOAT16) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/BasicMathFunctions/arm_offset_f32.c b/Source/BasicMathFunctions/arm_offset_f32.c index a68df050a..08270af0f 100644 --- a/Source/BasicMathFunctions/arm_offset_f32.c +++ b/Source/BasicMathFunctions/arm_offset_f32.c @@ -57,7 +57,6 @@ @param[in] offset is the offset to be added @param[out] pDst points to the output vector @param[in] blockSize number of samples in each vector - @return none */ #if defined(ARM_MATH_MVEF) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/BasicMathFunctions/arm_offset_f64.c b/Source/BasicMathFunctions/arm_offset_f64.c index 0b39da432..f27078103 100644 --- a/Source/BasicMathFunctions/arm_offset_f64.c +++ b/Source/BasicMathFunctions/arm_offset_f64.c @@ -43,7 +43,6 @@ @param[in] offset is the offset to be added @param[out] pDst points to the output vector @param[in] blockSize number of samples in each vector - @return none */ void arm_offset_f64( diff --git a/Source/BasicMathFunctions/arm_offset_q15.c b/Source/BasicMathFunctions/arm_offset_q15.c index 211776d73..4e151b0ab 100644 --- a/Source/BasicMathFunctions/arm_offset_q15.c +++ b/Source/BasicMathFunctions/arm_offset_q15.c @@ -43,7 +43,6 @@ @param[in] offset is the offset to be added @param[out] pDst points to the output vector @param[in] blockSize number of samples in each vector - @return none @par Scaling and Overflow Behavior The function uses saturating arithmetic. diff --git a/Source/BasicMathFunctions/arm_offset_q31.c b/Source/BasicMathFunctions/arm_offset_q31.c index 2f702b0ff..24d25f885 100644 --- a/Source/BasicMathFunctions/arm_offset_q31.c +++ b/Source/BasicMathFunctions/arm_offset_q31.c @@ -43,7 +43,6 @@ @param[in] offset is the offset to be added @param[out] pDst points to the output vector @param[in] blockSize number of samples in each vector - @return none @par Scaling and Overflow Behavior The function uses saturating arithmetic. diff --git a/Source/BasicMathFunctions/arm_offset_q7.c b/Source/BasicMathFunctions/arm_offset_q7.c index b53229d86..1b517e6f6 100644 --- a/Source/BasicMathFunctions/arm_offset_q7.c +++ b/Source/BasicMathFunctions/arm_offset_q7.c @@ -43,7 +43,6 @@ @param[in] offset is the offset to be added @param[out] pDst points to the output vector @param[in] blockSize number of samples in each vector - @return none @par Scaling and Overflow Behavior The function uses saturating arithmetic. diff --git a/Source/BasicMathFunctions/arm_or_u16.c b/Source/BasicMathFunctions/arm_or_u16.c index 92d28036b..9e575c370 100644 --- a/Source/BasicMathFunctions/arm_or_u16.c +++ b/Source/BasicMathFunctions/arm_or_u16.c @@ -51,7 +51,6 @@ @param[in] pSrcB points to input vector B @param[out] pDst points to output vector @param[in] blockSize number of samples in each vector - @return none */ void arm_or_u16( diff --git a/Source/BasicMathFunctions/arm_or_u32.c b/Source/BasicMathFunctions/arm_or_u32.c index 14cc83bb5..e4d8af744 100644 --- a/Source/BasicMathFunctions/arm_or_u32.c +++ b/Source/BasicMathFunctions/arm_or_u32.c @@ -43,7 +43,6 @@ @param[in] pSrcB points to input vector B @param[out] pDst points to output vector @param[in] blockSize number of samples in each vector - @return none */ void arm_or_u32( diff --git a/Source/BasicMathFunctions/arm_or_u8.c b/Source/BasicMathFunctions/arm_or_u8.c index beee07b69..628da96f9 100644 --- a/Source/BasicMathFunctions/arm_or_u8.c +++ b/Source/BasicMathFunctions/arm_or_u8.c @@ -43,7 +43,6 @@ @param[in] pSrcB points to input vector B @param[out] pDst points to output vector @param[in] blockSize number of samples in each vector - @return none */ void arm_or_u8( diff --git a/Source/BasicMathFunctions/arm_scale_f16.c b/Source/BasicMathFunctions/arm_scale_f16.c index 1400d331c..463558228 100755 --- a/Source/BasicMathFunctions/arm_scale_f16.c +++ b/Source/BasicMathFunctions/arm_scale_f16.c @@ -45,7 +45,6 @@ @param[in] scale scale factor to be applied @param[out] pDst points to the output vector @param[in] blockSize number of samples in each vector - @return none */ #if defined(ARM_MATH_MVE_FLOAT16) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/BasicMathFunctions/arm_scale_f32.c b/Source/BasicMathFunctions/arm_scale_f32.c index 59bc813fa..c39a25cff 100644 --- a/Source/BasicMathFunctions/arm_scale_f32.c +++ b/Source/BasicMathFunctions/arm_scale_f32.c @@ -70,7 +70,6 @@ @param[in] scale scale factor to be applied @param[out] pDst points to the output vector @param[in] blockSize number of samples in each vector - @return none */ #if defined(ARM_MATH_MVEF) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/BasicMathFunctions/arm_scale_f64.c b/Source/BasicMathFunctions/arm_scale_f64.c index cb2452b8a..eaa7e7ef5 100644 --- a/Source/BasicMathFunctions/arm_scale_f64.c +++ b/Source/BasicMathFunctions/arm_scale_f64.c @@ -43,7 +43,6 @@ @param[in] scale scale factor to be applied @param[out] pDst points to the output vector @param[in] blockSize number of samples in each vector - @return none */ void arm_scale_f64( diff --git a/Source/BasicMathFunctions/arm_scale_q15.c b/Source/BasicMathFunctions/arm_scale_q15.c index 823fa7b57..fb39d4cda 100644 --- a/Source/BasicMathFunctions/arm_scale_q15.c +++ b/Source/BasicMathFunctions/arm_scale_q15.c @@ -44,7 +44,6 @@ @param[in] shift number of bits to shift the result by @param[out] pDst points to the output vector @param[in] blockSize number of samples in each vector - @return none @par Scaling and Overflow Behavior The input data *pSrc and scaleFract are in 1.15 format. diff --git a/Source/BasicMathFunctions/arm_scale_q31.c b/Source/BasicMathFunctions/arm_scale_q31.c index 5f086bad4..c513f3e10 100644 --- a/Source/BasicMathFunctions/arm_scale_q31.c +++ b/Source/BasicMathFunctions/arm_scale_q31.c @@ -44,7 +44,6 @@ @param[in] shift number of bits to shift the result by @param[out] pDst points to the output vector @param[in] blockSize number of samples in each vector - @return none @par Scaling and Overflow Behavior The input data *pSrc and scaleFract are in 1.31 format. diff --git a/Source/BasicMathFunctions/arm_scale_q7.c b/Source/BasicMathFunctions/arm_scale_q7.c index e4c7e050d..70b9b70b2 100644 --- a/Source/BasicMathFunctions/arm_scale_q7.c +++ b/Source/BasicMathFunctions/arm_scale_q7.c @@ -44,7 +44,6 @@ @param[in] shift number of bits to shift the result by @param[out] pDst points to the output vector @param[in] blockSize number of samples in each vector - @return none @par Scaling and Overflow Behavior The input data *pSrc and scaleFract are in 1.7 format. diff --git a/Source/BasicMathFunctions/arm_shift_q15.c b/Source/BasicMathFunctions/arm_shift_q15.c index 2de3b2b02..1d23d2900 100644 --- a/Source/BasicMathFunctions/arm_shift_q15.c +++ b/Source/BasicMathFunctions/arm_shift_q15.c @@ -43,7 +43,6 @@ @param[in] shiftBits number of bits to shift. A positive value shifts left; a negative value shifts right. @param[out] pDst points to the output vector @param[in] blockSize number of samples in each vector - @return none @par Scaling and Overflow Behavior The function uses saturating arithmetic. diff --git a/Source/BasicMathFunctions/arm_shift_q31.c b/Source/BasicMathFunctions/arm_shift_q31.c index 5405c2411..d601884ec 100644 --- a/Source/BasicMathFunctions/arm_shift_q31.c +++ b/Source/BasicMathFunctions/arm_shift_q31.c @@ -60,7 +60,6 @@ @param[in] shiftBits number of bits to shift. A positive value shifts left; a negative value shifts right. @param[out] pDst points to the output vector @param[in] blockSize number of samples in the vector - @return none @par Scaling and Overflow Behavior The function uses saturating arithmetic. diff --git a/Source/BasicMathFunctions/arm_shift_q7.c b/Source/BasicMathFunctions/arm_shift_q7.c index 4f83edccc..1160b8b17 100644 --- a/Source/BasicMathFunctions/arm_shift_q7.c +++ b/Source/BasicMathFunctions/arm_shift_q7.c @@ -43,7 +43,6 @@ @param[in] shiftBits number of bits to shift. A positive value shifts left; a negative value shifts right. @param[out] pDst points to the output vector @param[in] blockSize number of samples in each vector - @return none @par onditions for optimum performance Input and output buffers should be aligned by 32-bit diff --git a/Source/BasicMathFunctions/arm_sub_f16.c b/Source/BasicMathFunctions/arm_sub_f16.c index 55493cff9..9498d6dfa 100755 --- a/Source/BasicMathFunctions/arm_sub_f16.c +++ b/Source/BasicMathFunctions/arm_sub_f16.c @@ -44,7 +44,6 @@ @param[in] pSrcB points to the second input vector @param[out] pDst points to the output vector @param[in] blockSize number of samples in each vector - @return none */ #if defined(ARM_MATH_MVE_FLOAT16) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/BasicMathFunctions/arm_sub_f32.c b/Source/BasicMathFunctions/arm_sub_f32.c index 2a07c0c6c..d94c2d31b 100644 --- a/Source/BasicMathFunctions/arm_sub_f32.c +++ b/Source/BasicMathFunctions/arm_sub_f32.c @@ -55,7 +55,6 @@ @param[in] pSrcB points to the second input vector @param[out] pDst points to the output vector @param[in] blockSize number of samples in each vector - @return none */ #if defined(ARM_MATH_MVEF) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/BasicMathFunctions/arm_sub_f64.c b/Source/BasicMathFunctions/arm_sub_f64.c index e409e2aec..f9564dc40 100644 --- a/Source/BasicMathFunctions/arm_sub_f64.c +++ b/Source/BasicMathFunctions/arm_sub_f64.c @@ -43,7 +43,6 @@ @param[in] pSrcB points to the second input vector @param[out] pDst points to the output vector @param[in] blockSize number of samples in each vector - @return none */ void arm_sub_f64( diff --git a/Source/BasicMathFunctions/arm_sub_q15.c b/Source/BasicMathFunctions/arm_sub_q15.c index 575bd9f4d..647ac9edc 100644 --- a/Source/BasicMathFunctions/arm_sub_q15.c +++ b/Source/BasicMathFunctions/arm_sub_q15.c @@ -43,7 +43,6 @@ @param[in] pSrcB points to the second input vector @param[out] pDst points to the output vector @param[in] blockSize number of samples in each vector - @return none @par Scaling and Overflow Behavior The function uses saturating arithmetic. diff --git a/Source/BasicMathFunctions/arm_sub_q31.c b/Source/BasicMathFunctions/arm_sub_q31.c index ed879a1e2..2ad08b95d 100644 --- a/Source/BasicMathFunctions/arm_sub_q31.c +++ b/Source/BasicMathFunctions/arm_sub_q31.c @@ -43,7 +43,6 @@ @param[in] pSrcB points to the second input vector @param[out] pDst points to the output vector @param[in] blockSize number of samples in each vector - @return none @par Scaling and Overflow Behavior The function uses saturating arithmetic. diff --git a/Source/BasicMathFunctions/arm_sub_q7.c b/Source/BasicMathFunctions/arm_sub_q7.c index 1de152e13..05493f387 100644 --- a/Source/BasicMathFunctions/arm_sub_q7.c +++ b/Source/BasicMathFunctions/arm_sub_q7.c @@ -43,7 +43,6 @@ @param[in] pSrcB points to the second input vector @param[out] pDst points to the output vector @param[in] blockSize number of samples in each vector - @return none @par Scaling and Overflow Behavior The function uses saturating arithmetic. diff --git a/Source/BasicMathFunctions/arm_xor_u16.c b/Source/BasicMathFunctions/arm_xor_u16.c index 54042ea72..cdb813dd9 100644 --- a/Source/BasicMathFunctions/arm_xor_u16.c +++ b/Source/BasicMathFunctions/arm_xor_u16.c @@ -51,7 +51,6 @@ @param[in] pSrcB points to input vector B @param[out] pDst points to output vector @param[in] blockSize number of samples in each vector - @return none */ void arm_xor_u16( diff --git a/Source/BasicMathFunctions/arm_xor_u32.c b/Source/BasicMathFunctions/arm_xor_u32.c index 9d1490844..e917de10a 100644 --- a/Source/BasicMathFunctions/arm_xor_u32.c +++ b/Source/BasicMathFunctions/arm_xor_u32.c @@ -43,7 +43,6 @@ @param[in] pSrcB points to input vector B @param[out] pDst points to output vector @param[in] blockSize number of samples in each vector - @return none */ void arm_xor_u32( diff --git a/Source/BasicMathFunctions/arm_xor_u8.c b/Source/BasicMathFunctions/arm_xor_u8.c index d708cd4e0..36c4ba575 100644 --- a/Source/BasicMathFunctions/arm_xor_u8.c +++ b/Source/BasicMathFunctions/arm_xor_u8.c @@ -43,7 +43,6 @@ @param[in] pSrcB points to input vector B @param[out] pDst points to output vector @param[in] blockSize number of samples in each vector - @return none */ void arm_xor_u8( diff --git a/Source/ComplexMathFunctions/arm_cmplx_conj_f16.c b/Source/ComplexMathFunctions/arm_cmplx_conj_f16.c index 970d91f16..c31fa85c0 100755 --- a/Source/ComplexMathFunctions/arm_cmplx_conj_f16.c +++ b/Source/ComplexMathFunctions/arm_cmplx_conj_f16.c @@ -44,7 +44,6 @@ @param[in] pSrc points to the input vector @param[out] pDst points to the output vector @param[in] numSamples number of samples in each vector - @return none */ #if defined(ARM_MATH_MVE_FLOAT16) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/ComplexMathFunctions/arm_cmplx_conj_f32.c b/Source/ComplexMathFunctions/arm_cmplx_conj_f32.c index 5920a7780..bd078a402 100644 --- a/Source/ComplexMathFunctions/arm_cmplx_conj_f32.c +++ b/Source/ComplexMathFunctions/arm_cmplx_conj_f32.c @@ -65,7 +65,6 @@ @param[in] pSrc points to the input vector @param[out] pDst points to the output vector @param[in] numSamples number of samples in each vector - @return none */ #if defined(ARM_MATH_MVEF) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/ComplexMathFunctions/arm_cmplx_conj_q15.c b/Source/ComplexMathFunctions/arm_cmplx_conj_q15.c index fb350a085..fd441eddf 100644 --- a/Source/ComplexMathFunctions/arm_cmplx_conj_q15.c +++ b/Source/ComplexMathFunctions/arm_cmplx_conj_q15.c @@ -42,7 +42,6 @@ @param[in] pSrc points to the input vector @param[out] pDst points to the output vector @param[in] numSamples number of samples in each vector - @return none @par Scaling and Overflow Behavior The function uses saturating arithmetic. diff --git a/Source/ComplexMathFunctions/arm_cmplx_conj_q31.c b/Source/ComplexMathFunctions/arm_cmplx_conj_q31.c index ec1b5b703..cdbf2dfc1 100644 --- a/Source/ComplexMathFunctions/arm_cmplx_conj_q31.c +++ b/Source/ComplexMathFunctions/arm_cmplx_conj_q31.c @@ -42,7 +42,6 @@ @param[in] pSrc points to the input vector @param[out] pDst points to the output vector @param[in] numSamples number of samples in each vector - @return none @par Scaling and Overflow Behavior The function uses saturating arithmetic. diff --git a/Source/ComplexMathFunctions/arm_cmplx_dot_prod_f16.c b/Source/ComplexMathFunctions/arm_cmplx_dot_prod_f16.c index e80a2c0f6..3fff51b78 100755 --- a/Source/ComplexMathFunctions/arm_cmplx_dot_prod_f16.c +++ b/Source/ComplexMathFunctions/arm_cmplx_dot_prod_f16.c @@ -48,7 +48,6 @@ @param[in] numSamples number of samples in each vector @param[out] realResult real part of the result returned here @param[out] imagResult imaginary part of the result returned here - @return none */ #if defined(ARM_MATH_MVE_FLOAT16) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/ComplexMathFunctions/arm_cmplx_dot_prod_f32.c b/Source/ComplexMathFunctions/arm_cmplx_dot_prod_f32.c index af60d32bc..d67bb2a14 100644 --- a/Source/ComplexMathFunctions/arm_cmplx_dot_prod_f32.c +++ b/Source/ComplexMathFunctions/arm_cmplx_dot_prod_f32.c @@ -71,7 +71,6 @@ @param[in] numSamples number of samples in each vector @param[out] realResult real part of the result returned here @param[out] imagResult imaginary part of the result returned here - @return none */ #if defined(ARM_MATH_MVEF) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/ComplexMathFunctions/arm_cmplx_dot_prod_q15.c b/Source/ComplexMathFunctions/arm_cmplx_dot_prod_q15.c index 1910d8ad9..360139444 100644 --- a/Source/ComplexMathFunctions/arm_cmplx_dot_prod_q15.c +++ b/Source/ComplexMathFunctions/arm_cmplx_dot_prod_q15.c @@ -44,7 +44,6 @@ @param[in] numSamples number of samples in each vector @param[out] realResult real part of the result returned here @param[out] imagResult imaginary part of the result returned her - @return none @par Scaling and Overflow Behavior The function is implemented using an internal 64-bit accumulator. diff --git a/Source/ComplexMathFunctions/arm_cmplx_dot_prod_q31.c b/Source/ComplexMathFunctions/arm_cmplx_dot_prod_q31.c index fac85bd0f..50e08af9f 100644 --- a/Source/ComplexMathFunctions/arm_cmplx_dot_prod_q31.c +++ b/Source/ComplexMathFunctions/arm_cmplx_dot_prod_q31.c @@ -44,7 +44,6 @@ @param[in] numSamples number of samples in each vector @param[out] realResult real part of the result returned here @param[out] imagResult imaginary part of the result returned here - @return none @par Scaling and Overflow Behavior The function is implemented using an internal 64-bit accumulator. diff --git a/Source/ComplexMathFunctions/arm_cmplx_mag_f16.c b/Source/ComplexMathFunctions/arm_cmplx_mag_f16.c index 386693406..e89447a8f 100755 --- a/Source/ComplexMathFunctions/arm_cmplx_mag_f16.c +++ b/Source/ComplexMathFunctions/arm_cmplx_mag_f16.c @@ -45,7 +45,6 @@ @param[in] pSrc points to input vector @param[out] pDst points to output vector @param[in] numSamples number of samples in each vector - @return none */ #if defined(ARM_MATH_MVE_FLOAT16) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/ComplexMathFunctions/arm_cmplx_mag_f32.c b/Source/ComplexMathFunctions/arm_cmplx_mag_f32.c index aac6fba89..d21ac0acf 100644 --- a/Source/ComplexMathFunctions/arm_cmplx_mag_f32.c +++ b/Source/ComplexMathFunctions/arm_cmplx_mag_f32.c @@ -66,7 +66,6 @@ @param[in] pSrc points to input vector @param[out] pDst points to output vector @param[in] numSamples number of samples in each vector - @return none */ #if defined(ARM_MATH_NEON) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/ComplexMathFunctions/arm_cmplx_mag_f64.c b/Source/ComplexMathFunctions/arm_cmplx_mag_f64.c index ba52e3989..1465f8fd3 100644 --- a/Source/ComplexMathFunctions/arm_cmplx_mag_f64.c +++ b/Source/ComplexMathFunctions/arm_cmplx_mag_f64.c @@ -44,7 +44,6 @@ @param[in] pSrc points to input vector @param[out] pDst points to output vector @param[in] numSamples number of samples in each vector - @return none */ void arm_cmplx_mag_f64( const float64_t * pSrc, diff --git a/Source/ComplexMathFunctions/arm_cmplx_mag_fast_q15.c b/Source/ComplexMathFunctions/arm_cmplx_mag_fast_q15.c index eac2a1435..4d4e314af 100755 --- a/Source/ComplexMathFunctions/arm_cmplx_mag_fast_q15.c +++ b/Source/ComplexMathFunctions/arm_cmplx_mag_fast_q15.c @@ -42,7 +42,6 @@ @param[in] pSrc points to input vector @param[out] pDst points to output vector @param[in] numSamples number of samples in each vector - @return none @par Scaling and Overflow Behavior The function implements 1.15 by 1.15 multiplications and finally output is converted into 2.14 format. diff --git a/Source/ComplexMathFunctions/arm_cmplx_mag_q15.c b/Source/ComplexMathFunctions/arm_cmplx_mag_q15.c index 4038ab84b..6d2775184 100644 --- a/Source/ComplexMathFunctions/arm_cmplx_mag_q15.c +++ b/Source/ComplexMathFunctions/arm_cmplx_mag_q15.c @@ -42,7 +42,6 @@ @param[in] pSrc points to input vector @param[out] pDst points to output vector @param[in] numSamples number of samples in each vector - @return none @par Scaling and Overflow Behavior The function implements 1.15 by 1.15 multiplications and finally output is converted into 2.14 format. diff --git a/Source/ComplexMathFunctions/arm_cmplx_mag_q31.c b/Source/ComplexMathFunctions/arm_cmplx_mag_q31.c index 57a72f5f1..ce340438c 100644 --- a/Source/ComplexMathFunctions/arm_cmplx_mag_q31.c +++ b/Source/ComplexMathFunctions/arm_cmplx_mag_q31.c @@ -42,7 +42,6 @@ @param[in] pSrc points to input vector @param[out] pDst points to output vector @param[in] numSamples number of samples in each vector - @return none @par Scaling and Overflow Behavior The function implements 1.31 by 1.31 multiplications and finally output is converted into 2.30 format. diff --git a/Source/ComplexMathFunctions/arm_cmplx_mag_squared_f16.c b/Source/ComplexMathFunctions/arm_cmplx_mag_squared_f16.c index fed7d2b20..3fa30fb45 100755 --- a/Source/ComplexMathFunctions/arm_cmplx_mag_squared_f16.c +++ b/Source/ComplexMathFunctions/arm_cmplx_mag_squared_f16.c @@ -45,7 +45,6 @@ @param[in] pSrc points to input vector @param[out] pDst points to output vector @param[in] numSamples number of samples in each vector - @return none */ #if defined(ARM_MATH_MVE_FLOAT16) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/ComplexMathFunctions/arm_cmplx_mag_squared_f32.c b/Source/ComplexMathFunctions/arm_cmplx_mag_squared_f32.c index 861585f16..bf6895914 100644 --- a/Source/ComplexMathFunctions/arm_cmplx_mag_squared_f32.c +++ b/Source/ComplexMathFunctions/arm_cmplx_mag_squared_f32.c @@ -66,7 +66,6 @@ @param[in] pSrc points to input vector @param[out] pDst points to output vector @param[in] numSamples number of samples in each vector - @return none */ #if defined(ARM_MATH_MVEF) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/ComplexMathFunctions/arm_cmplx_mag_squared_f64.c b/Source/ComplexMathFunctions/arm_cmplx_mag_squared_f64.c index fde0321e8..47bf40bc7 100644 --- a/Source/ComplexMathFunctions/arm_cmplx_mag_squared_f64.c +++ b/Source/ComplexMathFunctions/arm_cmplx_mag_squared_f64.c @@ -42,7 +42,6 @@ @param[in] pSrc points to input vector @param[out] pDst points to output vector @param[in] numSamples number of samples in each vector - @return none */ void arm_cmplx_mag_squared_f64( const float64_t * pSrc, diff --git a/Source/ComplexMathFunctions/arm_cmplx_mag_squared_q15.c b/Source/ComplexMathFunctions/arm_cmplx_mag_squared_q15.c index 727699e45..538bb7279 100644 --- a/Source/ComplexMathFunctions/arm_cmplx_mag_squared_q15.c +++ b/Source/ComplexMathFunctions/arm_cmplx_mag_squared_q15.c @@ -42,7 +42,6 @@ @param[in] pSrc points to input vector @param[out] pDst points to output vector @param[in] numSamples number of samples in each vector - @return none @par Scaling and Overflow Behavior The function implements 1.15 by 1.15 multiplications and finally output is converted into 3.13 format. diff --git a/Source/ComplexMathFunctions/arm_cmplx_mag_squared_q31.c b/Source/ComplexMathFunctions/arm_cmplx_mag_squared_q31.c index 4ccde36e5..2432568f8 100644 --- a/Source/ComplexMathFunctions/arm_cmplx_mag_squared_q31.c +++ b/Source/ComplexMathFunctions/arm_cmplx_mag_squared_q31.c @@ -42,7 +42,6 @@ @param[in] pSrc points to input vector @param[out] pDst points to output vector @param[in] numSamples number of samples in each vector - @return none @par Scaling and Overflow Behavior The function implements 1.31 by 1.31 multiplications and finally output is converted into 3.29 format. diff --git a/Source/ComplexMathFunctions/arm_cmplx_mult_cmplx_f16.c b/Source/ComplexMathFunctions/arm_cmplx_mult_cmplx_f16.c index fccc26ad4..592f64696 100755 --- a/Source/ComplexMathFunctions/arm_cmplx_mult_cmplx_f16.c +++ b/Source/ComplexMathFunctions/arm_cmplx_mult_cmplx_f16.c @@ -47,7 +47,6 @@ @param[in] pSrcB points to second input vector @param[out] pDst points to output vector @param[in] numSamples number of samples in each vector - @return none */ #if defined(ARM_MATH_MVE_FLOAT16) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/ComplexMathFunctions/arm_cmplx_mult_cmplx_f32.c b/Source/ComplexMathFunctions/arm_cmplx_mult_cmplx_f32.c index 5d2c66c47..9b701dbf0 100644 --- a/Source/ComplexMathFunctions/arm_cmplx_mult_cmplx_f32.c +++ b/Source/ComplexMathFunctions/arm_cmplx_mult_cmplx_f32.c @@ -65,7 +65,6 @@ @param[in] pSrcB points to second input vector @param[out] pDst points to output vector @param[in] numSamples number of samples in each vector - @return none */ #if defined(ARM_MATH_MVEF) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/ComplexMathFunctions/arm_cmplx_mult_cmplx_f64.c b/Source/ComplexMathFunctions/arm_cmplx_mult_cmplx_f64.c index 75a044c4a..b698ee554 100644 --- a/Source/ComplexMathFunctions/arm_cmplx_mult_cmplx_f64.c +++ b/Source/ComplexMathFunctions/arm_cmplx_mult_cmplx_f64.c @@ -43,7 +43,6 @@ @param[in] pSrcB points to second input vector @param[out] pDst points to output vector @param[in] numSamples number of samples in each vector - @return none */ void arm_cmplx_mult_cmplx_f64( diff --git a/Source/ComplexMathFunctions/arm_cmplx_mult_cmplx_q15.c b/Source/ComplexMathFunctions/arm_cmplx_mult_cmplx_q15.c index 53fbe58dd..665798dbd 100644 --- a/Source/ComplexMathFunctions/arm_cmplx_mult_cmplx_q15.c +++ b/Source/ComplexMathFunctions/arm_cmplx_mult_cmplx_q15.c @@ -43,7 +43,6 @@ @param[in] pSrcB points to second input vector @param[out] pDst points to output vector @param[in] numSamples number of samples in each vector - @return none @par Scaling and Overflow Behavior The function implements 1.15 by 1.15 multiplications and finally output is converted into 3.13 format. diff --git a/Source/ComplexMathFunctions/arm_cmplx_mult_cmplx_q31.c b/Source/ComplexMathFunctions/arm_cmplx_mult_cmplx_q31.c index 7f9456192..147d76653 100644 --- a/Source/ComplexMathFunctions/arm_cmplx_mult_cmplx_q31.c +++ b/Source/ComplexMathFunctions/arm_cmplx_mult_cmplx_q31.c @@ -43,7 +43,6 @@ @param[in] pSrcB points to second input vector @param[out] pDst points to output vector @param[in] numSamples number of samples in each vector - @return none @par Scaling and Overflow Behavior The function implements 1.31 by 1.31 multiplications and finally output is converted into 3.29 format. diff --git a/Source/ComplexMathFunctions/arm_cmplx_mult_real_f16.c b/Source/ComplexMathFunctions/arm_cmplx_mult_real_f16.c index 8182d3aa0..ead946487 100755 --- a/Source/ComplexMathFunctions/arm_cmplx_mult_real_f16.c +++ b/Source/ComplexMathFunctions/arm_cmplx_mult_real_f16.c @@ -46,7 +46,6 @@ @param[in] pSrcReal points to real input vector @param[out] pCmplxDst points to complex output vector @param[in] numSamples number of samples in each vector - @return none */ #if defined(ARM_MATH_MVE_FLOAT16) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/ComplexMathFunctions/arm_cmplx_mult_real_f32.c b/Source/ComplexMathFunctions/arm_cmplx_mult_real_f32.c index bc0f59b2c..b9d82f8c9 100644 --- a/Source/ComplexMathFunctions/arm_cmplx_mult_real_f32.c +++ b/Source/ComplexMathFunctions/arm_cmplx_mult_real_f32.c @@ -66,7 +66,6 @@ @param[in] pSrcReal points to real input vector @param[out] pCmplxDst points to complex output vector @param[in] numSamples number of samples in each vector - @return none */ #if defined(ARM_MATH_MVEF) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/ComplexMathFunctions/arm_cmplx_mult_real_q15.c b/Source/ComplexMathFunctions/arm_cmplx_mult_real_q15.c index 84e5ae3d9..ff98141a1 100644 --- a/Source/ComplexMathFunctions/arm_cmplx_mult_real_q15.c +++ b/Source/ComplexMathFunctions/arm_cmplx_mult_real_q15.c @@ -43,7 +43,6 @@ @param[in] pSrcReal points to real input vector @param[out] pCmplxDst points to complex output vector @param[in] numSamples number of samples in each vector - @return none @par Scaling and Overflow Behavior The function uses saturating arithmetic. diff --git a/Source/ComplexMathFunctions/arm_cmplx_mult_real_q31.c b/Source/ComplexMathFunctions/arm_cmplx_mult_real_q31.c index de13757d8..18e8e8c96 100644 --- a/Source/ComplexMathFunctions/arm_cmplx_mult_real_q31.c +++ b/Source/ComplexMathFunctions/arm_cmplx_mult_real_q31.c @@ -43,7 +43,6 @@ @param[in] pSrcReal points to real input vector @param[out] pCmplxDst points to complex output vector @param[in] numSamples number of samples in each vector - @return none @par Scaling and Overflow Behavior The function uses saturating arithmetic. diff --git a/Source/ControllerFunctions/arm_pid_init_f32.c b/Source/ControllerFunctions/arm_pid_init_f32.c index 384994bdf..b81d6e027 100644 --- a/Source/ControllerFunctions/arm_pid_init_f32.c +++ b/Source/ControllerFunctions/arm_pid_init_f32.c @@ -39,7 +39,6 @@ @param[in] resetStateFlag - value = 0: no change in state - value = 1: reset state - @return none @par Details The resetStateFlag specifies whether to set state to zero or not. \n diff --git a/Source/ControllerFunctions/arm_pid_init_q15.c b/Source/ControllerFunctions/arm_pid_init_q15.c index e1f510b31..dce712342 100644 --- a/Source/ControllerFunctions/arm_pid_init_q15.c +++ b/Source/ControllerFunctions/arm_pid_init_q15.c @@ -39,7 +39,6 @@ @param[in] resetStateFlag - value = 0: no change in state - value = 1: reset state - @return none @par Details The resetStateFlag specifies whether to set state to zero or not. \n diff --git a/Source/ControllerFunctions/arm_pid_init_q31.c b/Source/ControllerFunctions/arm_pid_init_q31.c index 53df5ee5a..671cff035 100644 --- a/Source/ControllerFunctions/arm_pid_init_q31.c +++ b/Source/ControllerFunctions/arm_pid_init_q31.c @@ -39,7 +39,6 @@ @param[in] resetStateFlag - value = 0: no change in state - value = 1: reset state - @return none @par Details The resetStateFlag specifies whether to set state to zero or not. \n diff --git a/Source/ControllerFunctions/arm_pid_reset_f32.c b/Source/ControllerFunctions/arm_pid_reset_f32.c index cb267adb8..0b29e5995 100644 --- a/Source/ControllerFunctions/arm_pid_reset_f32.c +++ b/Source/ControllerFunctions/arm_pid_reset_f32.c @@ -36,7 +36,6 @@ /** @brief Reset function for the floating-point PID Control. @param[in,out] S points to an instance of the floating-point PID structure - @return none @par Details The function resets the state buffer to zeros. diff --git a/Source/ControllerFunctions/arm_pid_reset_q15.c b/Source/ControllerFunctions/arm_pid_reset_q15.c index aa4076ec9..bcda42ef5 100644 --- a/Source/ControllerFunctions/arm_pid_reset_q15.c +++ b/Source/ControllerFunctions/arm_pid_reset_q15.c @@ -36,7 +36,6 @@ /** @brief Reset function for the Q15 PID Control. @param[in,out] S points to an instance of the Q15 PID structure - @return none @par Details The function resets the state buffer to zeros. diff --git a/Source/ControllerFunctions/arm_pid_reset_q31.c b/Source/ControllerFunctions/arm_pid_reset_q31.c index 3e9c39fe7..55d92fbe2 100644 --- a/Source/ControllerFunctions/arm_pid_reset_q31.c +++ b/Source/ControllerFunctions/arm_pid_reset_q31.c @@ -36,7 +36,6 @@ /** @brief Reset function for the Q31 PID Control. @param[in,out] S points to an instance of the Q31 PID structure - @return none @par Details The function resets the state buffer to zeros. diff --git a/Source/ControllerFunctions/arm_sin_cos_f32.c b/Source/ControllerFunctions/arm_sin_cos_f32.c index b2fa28c70..d11542999 100644 --- a/Source/ControllerFunctions/arm_sin_cos_f32.c +++ b/Source/ControllerFunctions/arm_sin_cos_f32.c @@ -39,7 +39,6 @@ @param[in] theta input value in degrees @param[out] pSinVal points to processed sine output @param[out] pCosVal points to processed cosine output - @return none */ void arm_sin_cos_f32( diff --git a/Source/ControllerFunctions/arm_sin_cos_q31.c b/Source/ControllerFunctions/arm_sin_cos_q31.c index 990c891dc..4997833f6 100644 --- a/Source/ControllerFunctions/arm_sin_cos_q31.c +++ b/Source/ControllerFunctions/arm_sin_cos_q31.c @@ -43,7 +43,6 @@ @param[in] theta scaled input value in degrees @param[out] pSinVal points to processed sine output @param[out] pCosVal points to processed cosine output - @return none The Q31 input value is in the range [-1 0.999999] and is mapped to a degree value in the range [-180 179]. */ diff --git a/Source/DistanceFunctions/arm_boolean_distance_template.h b/Source/DistanceFunctions/arm_boolean_distance_template.h index eb2e2af9f..4103382bb 100755 --- a/Source/DistanceFunctions/arm_boolean_distance_template.h +++ b/Source/DistanceFunctions/arm_boolean_distance_template.h @@ -60,7 +60,6 @@ * @param[in] pA First vector of packed booleans * @param[in] pB Second vector of packed booleans * @param[in] numberOfBools Number of booleans - * @return None * */ diff --git a/Source/DistanceFunctions/arm_dtw_path_f32.c b/Source/DistanceFunctions/arm_dtw_path_f32.c index b694354a0..934065e6e 100644 --- a/Source/DistanceFunctions/arm_dtw_path_f32.c +++ b/Source/DistanceFunctions/arm_dtw_path_f32.c @@ -47,7 +47,6 @@ * @param[in] pDTW Cost matrix (Query rows * Template columns) * @param[out] pPath Warping path in cost matrix 2*(nb rows + nb columns) * @param[out] pathLength Length of path in number of points - * @return none * * @par Warping path * diff --git a/Source/FastMathFunctions/arm_vexp_f16.c b/Source/FastMathFunctions/arm_vexp_f16.c index 2adebbba2..d64ce5fd8 100755 --- a/Source/FastMathFunctions/arm_vexp_f16.c +++ b/Source/FastMathFunctions/arm_vexp_f16.c @@ -44,7 +44,6 @@ @param[in] pSrc points to the input vector @param[out] pDst points to the output vector @param[in] blockSize number of samples in each vector - @return none */ void arm_vexp_f16( const float16_t * pSrc, diff --git a/Source/FastMathFunctions/arm_vexp_f32.c b/Source/FastMathFunctions/arm_vexp_f32.c index 83afb8470..fea3d46bc 100755 --- a/Source/FastMathFunctions/arm_vexp_f32.c +++ b/Source/FastMathFunctions/arm_vexp_f32.c @@ -53,7 +53,6 @@ @param[in] pSrc points to the input vector @param[out] pDst points to the output vector @param[in] blockSize number of samples in each vector - @return none */ void arm_vexp_f32( const float32_t * pSrc, diff --git a/Source/FastMathFunctions/arm_vlog_f16.c b/Source/FastMathFunctions/arm_vlog_f16.c index 0821d5ab5..80a6d912d 100755 --- a/Source/FastMathFunctions/arm_vlog_f16.c +++ b/Source/FastMathFunctions/arm_vlog_f16.c @@ -166,7 +166,6 @@ float16x8_t vlogq_lut_f16(float16x8_t vecIn) @param[in] pSrc points to the input vector @param[out] pDst points to the output vector @param[in] blockSize number of samples in each vector - @return none */ diff --git a/Source/FastMathFunctions/arm_vlog_q15.c b/Source/FastMathFunctions/arm_vlog_q15.c index 896988dcf..72d519fbe 100755 --- a/Source/FastMathFunctions/arm_vlog_q15.c +++ b/Source/FastMathFunctions/arm_vlog_q15.c @@ -216,8 +216,6 @@ q15x8_t vlogq_q15(q15x8_t src) @param[in] pSrc points to the input vector in q15 @param[out] pDst points to the output vector in q4.11 @param[in] blockSize number of samples in each vector - @return none - */ void arm_vlog_q15( diff --git a/Source/FastMathFunctions/arm_vlog_q31.c b/Source/FastMathFunctions/arm_vlog_q31.c index 005385947..c6cb6966b 100755 --- a/Source/FastMathFunctions/arm_vlog_q31.c +++ b/Source/FastMathFunctions/arm_vlog_q31.c @@ -210,8 +210,6 @@ q31x4_t vlogq_q31(q31x4_t src) @param[in] pSrc points to the input vector in q31 @param[out] pDst points to the output vector q5.26 @param[in] blockSize number of samples in each vector - @return none - */ void arm_vlog_q31( const q31_t * pSrc, diff --git a/Source/FilteringFunctions/arm_biquad_cascade_df1_32x64_init_q31.c b/Source/FilteringFunctions/arm_biquad_cascade_df1_32x64_init_q31.c index 565b494b7..7e48812ed 100644 --- a/Source/FilteringFunctions/arm_biquad_cascade_df1_32x64_init_q31.c +++ b/Source/FilteringFunctions/arm_biquad_cascade_df1_32x64_init_q31.c @@ -44,7 +44,6 @@ @param[in] pCoeffs points to the filter coefficients @param[in] pState points to the state buffer @param[in] postShift Shift to be applied after the accumulator. Varies according to the coefficients format - @return none @par Coefficient and State Ordering The coefficients are stored in the array pCoeffs in the following order: diff --git a/Source/FilteringFunctions/arm_biquad_cascade_df1_32x64_q31.c b/Source/FilteringFunctions/arm_biquad_cascade_df1_32x64_q31.c index b1f415d12..9690c7412 100644 --- a/Source/FilteringFunctions/arm_biquad_cascade_df1_32x64_q31.c +++ b/Source/FilteringFunctions/arm_biquad_cascade_df1_32x64_q31.c @@ -157,7 +157,6 @@ @param[in] pSrc points to the block of input data @param[out] pDst points to the block of output data @param[in] blockSize number of samples to process - @return none @par Details The function is implemented using an internal 64-bit accumulator. diff --git a/Source/FilteringFunctions/arm_biquad_cascade_df1_f16.c b/Source/FilteringFunctions/arm_biquad_cascade_df1_f16.c index bebd026e4..8fc720f86 100755 --- a/Source/FilteringFunctions/arm_biquad_cascade_df1_f16.c +++ b/Source/FilteringFunctions/arm_biquad_cascade_df1_f16.c @@ -45,7 +45,6 @@ @param[in] pSrc points to the block of input data @param[out] pDst points to the block of output data @param[in] blockSize number of samples to process - @return none */ #if defined(ARM_MATH_MVE_FLOAT16) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/FilteringFunctions/arm_biquad_cascade_df1_f32.c b/Source/FilteringFunctions/arm_biquad_cascade_df1_f32.c index 682b6ca98..7164c4d59 100644 --- a/Source/FilteringFunctions/arm_biquad_cascade_df1_f32.c +++ b/Source/FilteringFunctions/arm_biquad_cascade_df1_f32.c @@ -159,7 +159,6 @@ @param[in] pSrc points to the block of input data @param[out] pDst points to the block of output data @param[in] blockSize number of samples to process - @return none */ #if defined(ARM_MATH_MVEF) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/FilteringFunctions/arm_biquad_cascade_df1_fast_q15.c b/Source/FilteringFunctions/arm_biquad_cascade_df1_fast_q15.c index f2dd334d2..4d561d1c0 100644 --- a/Source/FilteringFunctions/arm_biquad_cascade_df1_fast_q15.c +++ b/Source/FilteringFunctions/arm_biquad_cascade_df1_fast_q15.c @@ -43,7 +43,6 @@ @param[in] pSrc points to the block of input data @param[out] pDst points to the block of output data @param[in] blockSize number of samples to process per call - @return none @par Scaling and Overflow Behavior This fast version uses a 32-bit accumulator with 2.30 format. diff --git a/Source/FilteringFunctions/arm_biquad_cascade_df1_fast_q31.c b/Source/FilteringFunctions/arm_biquad_cascade_df1_fast_q31.c index cefa592a2..403ab29a1 100644 --- a/Source/FilteringFunctions/arm_biquad_cascade_df1_fast_q31.c +++ b/Source/FilteringFunctions/arm_biquad_cascade_df1_fast_q31.c @@ -43,7 +43,6 @@ @param[in] pSrc points to the block of input data @param[out] pDst points to the block of output data @param[in] blockSize number of samples to process per call - @return none @par Scaling and Overflow Behavior This function is optimized for speed at the expense of fixed-point precision and overflow protection. diff --git a/Source/FilteringFunctions/arm_biquad_cascade_df1_init_f16.c b/Source/FilteringFunctions/arm_biquad_cascade_df1_init_f16.c index d18dd3eac..6d7e58ca4 100755 --- a/Source/FilteringFunctions/arm_biquad_cascade_df1_init_f16.c +++ b/Source/FilteringFunctions/arm_biquad_cascade_df1_init_f16.c @@ -1,3 +1,4 @@ + /* ---------------------------------------------------------------------- * Project: CMSIS DSP Library * Title: arm_biquad_cascade_df1_init_f16.c @@ -44,7 +45,6 @@ @param[in] numStages number of 2nd order stages in the filter. @param[in] pCoeffs points to the filter coefficients. @param[in] pState points to the state buffer. - @return none @par Coefficient and State Ordering The coefficients are stored in the array pCoeffs in the following order: diff --git a/Source/FilteringFunctions/arm_biquad_cascade_df1_init_f32.c b/Source/FilteringFunctions/arm_biquad_cascade_df1_init_f32.c index 1614594b6..205013765 100644 --- a/Source/FilteringFunctions/arm_biquad_cascade_df1_init_f32.c +++ b/Source/FilteringFunctions/arm_biquad_cascade_df1_init_f32.c @@ -1,3 +1,4 @@ + /* ---------------------------------------------------------------------- * Project: CMSIS DSP Library * Title: arm_biquad_cascade_df1_init_f32.c @@ -43,7 +44,6 @@ @param[in] numStages number of 2nd order stages in the filter. @param[in] pCoeffs points to the filter coefficients. @param[in] pState points to the state buffer. - @return none @par Coefficient and State Ordering The coefficients are stored in the array pCoeffs in the following order: diff --git a/Source/FilteringFunctions/arm_biquad_cascade_df1_init_q15.c b/Source/FilteringFunctions/arm_biquad_cascade_df1_init_q15.c index 0fa38255e..a4278cb3c 100644 --- a/Source/FilteringFunctions/arm_biquad_cascade_df1_init_q15.c +++ b/Source/FilteringFunctions/arm_biquad_cascade_df1_init_q15.c @@ -44,7 +44,6 @@ @param[in] pCoeffs points to the filter coefficients. @param[in] pState points to the state buffer. @param[in] postShift Shift to be applied to the accumulator result. Varies according to the coefficients format - @return none @par Coefficient and State Ordering The coefficients are stored in the array pCoeffs in the following order: diff --git a/Source/FilteringFunctions/arm_biquad_cascade_df1_init_q31.c b/Source/FilteringFunctions/arm_biquad_cascade_df1_init_q31.c index 2b3cb6288..f32fe37a9 100644 --- a/Source/FilteringFunctions/arm_biquad_cascade_df1_init_q31.c +++ b/Source/FilteringFunctions/arm_biquad_cascade_df1_init_q31.c @@ -44,7 +44,6 @@ @param[in] pCoeffs points to the filter coefficients. @param[in] pState points to the state buffer. @param[in] postShift Shift to be applied after the accumulator. Varies according to the coefficients format - @return none @par Coefficient and State Ordering The coefficients are stored in the array pCoeffs in the following order: diff --git a/Source/FilteringFunctions/arm_biquad_cascade_df1_q15.c b/Source/FilteringFunctions/arm_biquad_cascade_df1_q15.c index c77a05c49..71d790ca7 100644 --- a/Source/FilteringFunctions/arm_biquad_cascade_df1_q15.c +++ b/Source/FilteringFunctions/arm_biquad_cascade_df1_q15.c @@ -43,7 +43,6 @@ @param[in] pSrc points to the block of input data @param[out] pDst points to the location where the output result is written @param[in] blockSize number of samples to process - @return none @par Scaling and Overflow Behavior The function is implemented using a 64-bit internal accumulator. diff --git a/Source/FilteringFunctions/arm_biquad_cascade_df1_q31.c b/Source/FilteringFunctions/arm_biquad_cascade_df1_q31.c index da29183b2..764249d9a 100644 --- a/Source/FilteringFunctions/arm_biquad_cascade_df1_q31.c +++ b/Source/FilteringFunctions/arm_biquad_cascade_df1_q31.c @@ -43,7 +43,6 @@ @param[in] pSrc points to the block of input data @param[out] pDst points to the block of output data @param[in] blockSize number of samples to process - @return none @par Scaling and Overflow Behavior The function is implemented using an internal 64-bit accumulator. diff --git a/Source/FilteringFunctions/arm_biquad_cascade_df2T_f16.c b/Source/FilteringFunctions/arm_biquad_cascade_df2T_f16.c index a7b1c7abc..a47c82b62 100755 --- a/Source/FilteringFunctions/arm_biquad_cascade_df2T_f16.c +++ b/Source/FilteringFunctions/arm_biquad_cascade_df2T_f16.c @@ -44,7 +44,6 @@ @param[in] pSrc points to the block of input data @param[out] pDst points to the block of output data @param[in] blockSize number of samples to process - @return none */ #if (defined(ARM_MATH_MVE_FLOAT16) && defined(ARM_MATH_HELIUM_EXPERIMENTAL)) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/FilteringFunctions/arm_biquad_cascade_df2T_f32.c b/Source/FilteringFunctions/arm_biquad_cascade_df2T_f32.c index 922a39656..1db967cd9 100644 --- a/Source/FilteringFunctions/arm_biquad_cascade_df2T_f32.c +++ b/Source/FilteringFunctions/arm_biquad_cascade_df2T_f32.c @@ -43,7 +43,6 @@ @param[in] pSrc points to the block of input data @param[out] pDst points to the block of output data @param[in] blockSize number of samples to process - @return none */ #if (defined(ARM_MATH_MVEF) && defined(ARM_MATH_HELIUM_EXPERIMENTAL)) && !defined(ARM_MATH_AUTOVECTORIZE) #include "arm_helium_utils.h" diff --git a/Source/FilteringFunctions/arm_biquad_cascade_df2T_f64.c b/Source/FilteringFunctions/arm_biquad_cascade_df2T_f64.c index 3703bdbd5..9f6df1669 100644 --- a/Source/FilteringFunctions/arm_biquad_cascade_df2T_f64.c +++ b/Source/FilteringFunctions/arm_biquad_cascade_df2T_f64.c @@ -137,7 +137,6 @@ @param[in] pSrc points to the block of input data @param[out] pDst points to the block of output data @param[in] blockSize number of samples to process - @return none */ diff --git a/Source/FilteringFunctions/arm_biquad_cascade_df2T_init_f16.c b/Source/FilteringFunctions/arm_biquad_cascade_df2T_init_f16.c index 3f619e563..950485a02 100755 --- a/Source/FilteringFunctions/arm_biquad_cascade_df2T_init_f16.c +++ b/Source/FilteringFunctions/arm_biquad_cascade_df2T_init_f16.c @@ -44,7 +44,6 @@ @param[in] numStages number of 2nd order stages in the filter. @param[in] pCoeffs points to the filter coefficients. @param[in] pState points to the state buffer. - @return none @par Coefficient and State Ordering The coefficients are stored in the array pCoeffs in the following order diff --git a/Source/FilteringFunctions/arm_biquad_cascade_df2T_init_f32.c b/Source/FilteringFunctions/arm_biquad_cascade_df2T_init_f32.c index e3b350c30..da902bf86 100644 --- a/Source/FilteringFunctions/arm_biquad_cascade_df2T_init_f32.c +++ b/Source/FilteringFunctions/arm_biquad_cascade_df2T_init_f32.c @@ -45,7 +45,6 @@ @param[in] numStages number of 2nd order stages in the filter. @param[in] pCoeffs points to the original filter coefficients. @param[in] pComputedCoeffs points to the new computed coefficients for the vectorized Neon version. - @return none @par Size of coefficient arrays: pCoeffs has size 5 * numStages @@ -147,7 +146,6 @@ void arm_biquad_cascade_df2T_compute_coefs_f32( @param[in] numStages number of 2nd order stages in the filter. @param[in] pCoeffs points to the filter coefficients. @param[in] pState points to the state buffer. - @return none @par Coefficient and State Ordering The coefficients are stored in the array pCoeffs in the following order diff --git a/Source/FilteringFunctions/arm_biquad_cascade_df2T_init_f64.c b/Source/FilteringFunctions/arm_biquad_cascade_df2T_init_f64.c index 111f4e7ef..9cd324318 100644 --- a/Source/FilteringFunctions/arm_biquad_cascade_df2T_init_f64.c +++ b/Source/FilteringFunctions/arm_biquad_cascade_df2T_init_f64.c @@ -43,7 +43,6 @@ @param[in] numStages number of 2nd order stages in the filter @param[in] pCoeffs points to the filter coefficients @param[in] pState points to the state buffer - @return none @par Coefficient and State Ordering The coefficients are stored in the array pCoeffs in the following order: diff --git a/Source/FilteringFunctions/arm_biquad_cascade_stereo_df2T_f16.c b/Source/FilteringFunctions/arm_biquad_cascade_stereo_df2T_f16.c index 60caf8d27..480aed5dc 100755 --- a/Source/FilteringFunctions/arm_biquad_cascade_stereo_df2T_f16.c +++ b/Source/FilteringFunctions/arm_biquad_cascade_stereo_df2T_f16.c @@ -44,7 +44,6 @@ @param[in] pSrc points to the block of input data @param[out] pDst points to the block of output data @param[in] blockSize number of samples to process - @return none */ #if defined(ARM_MATH_MVE_FLOAT16) && !defined(ARM_MATH_AUTOVECTORIZE) && defined(__CMSIS_GCC_H) diff --git a/Source/FilteringFunctions/arm_biquad_cascade_stereo_df2T_f32.c b/Source/FilteringFunctions/arm_biquad_cascade_stereo_df2T_f32.c index ddd154621..6fe2bc28c 100644 --- a/Source/FilteringFunctions/arm_biquad_cascade_stereo_df2T_f32.c +++ b/Source/FilteringFunctions/arm_biquad_cascade_stereo_df2T_f32.c @@ -43,7 +43,6 @@ @param[in] pSrc points to the block of input data @param[out] pDst points to the block of output data @param[in] blockSize number of samples to process - @return none */ #if (defined(ARM_MATH_MVEF) && defined(ARM_MATH_HELIUM_EXPERIMENTAL)) && !defined(ARM_MATH_AUTOVECTORIZE) #include "arm_helium_utils.h" diff --git a/Source/FilteringFunctions/arm_biquad_cascade_stereo_df2T_init_f16.c b/Source/FilteringFunctions/arm_biquad_cascade_stereo_df2T_init_f16.c index 633fbfef2..043c53099 100755 --- a/Source/FilteringFunctions/arm_biquad_cascade_stereo_df2T_init_f16.c +++ b/Source/FilteringFunctions/arm_biquad_cascade_stereo_df2T_init_f16.c @@ -45,7 +45,6 @@ @param[in] numStages number of 2nd order stages in the filter. @param[in] pCoeffs points to the filter coefficients. @param[in] pState points to the state buffer. - @return none @par Coefficient and State Ordering The coefficients are stored in the array pCoeffs in the following order: diff --git a/Source/FilteringFunctions/arm_biquad_cascade_stereo_df2T_init_f32.c b/Source/FilteringFunctions/arm_biquad_cascade_stereo_df2T_init_f32.c index 6932b9a48..b19f5fec0 100644 --- a/Source/FilteringFunctions/arm_biquad_cascade_stereo_df2T_init_f32.c +++ b/Source/FilteringFunctions/arm_biquad_cascade_stereo_df2T_init_f32.c @@ -43,7 +43,6 @@ @param[in] numStages number of 2nd order stages in the filter. @param[in] pCoeffs points to the filter coefficients. @param[in] pState points to the state buffer. - @return none @par Coefficient and State Ordering The coefficients are stored in the array pCoeffs in the following order: diff --git a/Source/FilteringFunctions/arm_conv_f32.c b/Source/FilteringFunctions/arm_conv_f32.c index fb82c6731..0c2aeae04 100644 --- a/Source/FilteringFunctions/arm_conv_f32.c +++ b/Source/FilteringFunctions/arm_conv_f32.c @@ -100,7 +100,6 @@ @param[in] pSrcB points to the second input sequence @param[in] srcBLen length of the second input sequence @param[out] pDst points to the location where the output result is written. Length srcALen+srcBLen-1. - @return none */ #if defined(ARM_MATH_MVEF) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/FilteringFunctions/arm_conv_fast_opt_q15.c b/Source/FilteringFunctions/arm_conv_fast_opt_q15.c index 06629f1ac..362416cec 100644 --- a/Source/FilteringFunctions/arm_conv_fast_opt_q15.c +++ b/Source/FilteringFunctions/arm_conv_fast_opt_q15.c @@ -46,7 +46,6 @@ @param[out] pDst points to the location where the output result is written. Length srcALen+srcBLen-1 @param[in] pScratch1 points to scratch buffer of size max(srcALen, srcBLen) + 2*min(srcALen, srcBLen) - 2 @param[in] pScratch2 points to scratch buffer of size min(srcALen, srcBLen - @return none @par Scaling and Overflow Behavior This fast version uses a 32-bit accumulator with 2.30 format. diff --git a/Source/FilteringFunctions/arm_conv_fast_q15.c b/Source/FilteringFunctions/arm_conv_fast_q15.c index 5337a82ea..68e74b546 100644 --- a/Source/FilteringFunctions/arm_conv_fast_q15.c +++ b/Source/FilteringFunctions/arm_conv_fast_q15.c @@ -44,7 +44,6 @@ @param[in] pSrcB points to the second input sequence @param[in] srcBLen length of the second input sequence @param[out] pDst points to the location where the output result is written. Length srcALen+srcBLen-1 - @return none @par Scaling and Overflow Behavior This fast version uses a 32-bit accumulator with 2.30 format. diff --git a/Source/FilteringFunctions/arm_conv_fast_q31.c b/Source/FilteringFunctions/arm_conv_fast_q31.c index 133c322c2..32042eb52 100644 --- a/Source/FilteringFunctions/arm_conv_fast_q31.c +++ b/Source/FilteringFunctions/arm_conv_fast_q31.c @@ -44,7 +44,6 @@ @param[in] pSrcB points to the second input sequence. @param[in] srcBLen length of the second input sequence. @param[out] pDst points to the location where the output result is written. Length srcALen+srcBLen-1. - @return none @par Scaling and Overflow Behavior This function is optimized for speed at the expense of fixed-point precision and overflow protection. diff --git a/Source/FilteringFunctions/arm_conv_opt_q15.c b/Source/FilteringFunctions/arm_conv_opt_q15.c index 1f3efe00a..c0cb97f43 100644 --- a/Source/FilteringFunctions/arm_conv_opt_q15.c +++ b/Source/FilteringFunctions/arm_conv_opt_q15.c @@ -46,7 +46,6 @@ @param[out] pDst points to the location where the output result is written. Length srcALen+srcBLen-1. @param[in] pScratch1 points to scratch buffer of size max(srcALen, srcBLen) + 2*min(srcALen, srcBLen) - 2. @param[in] pScratch2 points to scratch buffer of size min(srcALen, srcBLen). - @return none @par Scaling and Overflow Behavior The function is implemented using a 64-bit internal accumulator. diff --git a/Source/FilteringFunctions/arm_conv_opt_q7.c b/Source/FilteringFunctions/arm_conv_opt_q7.c index 1f12f0d2b..de890efc6 100644 --- a/Source/FilteringFunctions/arm_conv_opt_q7.c +++ b/Source/FilteringFunctions/arm_conv_opt_q7.c @@ -46,7 +46,6 @@ @param[out] pDst points to the location where the output result is written. Length srcALen+srcBLen-1. @param[in] pScratch1 points to scratch buffer(of type q15_t) of size max(srcALen, srcBLen) + 2*min(srcALen, srcBLen) - 2. @param[in] pScratch2 points to scratch buffer (of type q15_t) of size min(srcALen, srcBLen). - @return none @par Scaling and Overflow Behavior The function is implemented using a 32-bit internal accumulator. diff --git a/Source/FilteringFunctions/arm_conv_q15.c b/Source/FilteringFunctions/arm_conv_q15.c index e7e92ee55..7eccd5aeb 100644 --- a/Source/FilteringFunctions/arm_conv_q15.c +++ b/Source/FilteringFunctions/arm_conv_q15.c @@ -44,7 +44,6 @@ @param[in] pSrcB points to the second input sequence @param[in] srcBLen length of the second input sequence @param[out] pDst points to the location where the output result is written. Length srcALen+srcBLen-1. - @return none @par Scaling and Overflow Behavior The function is implemented using a 64-bit internal accumulator. diff --git a/Source/FilteringFunctions/arm_conv_q31.c b/Source/FilteringFunctions/arm_conv_q31.c index cb40d3b2b..24cb6be40 100644 --- a/Source/FilteringFunctions/arm_conv_q31.c +++ b/Source/FilteringFunctions/arm_conv_q31.c @@ -44,7 +44,6 @@ @param[in] pSrcB points to the second input sequence @param[in] srcBLen length of the second input sequence @param[out] pDst points to the location where the output result is written. Length srcALen+srcBLen-1. - @return none @par Scaling and Overflow Behavior The function is implemented using an internal 64-bit accumulator. diff --git a/Source/FilteringFunctions/arm_conv_q7.c b/Source/FilteringFunctions/arm_conv_q7.c index 0c84b6950..3921721ab 100644 --- a/Source/FilteringFunctions/arm_conv_q7.c +++ b/Source/FilteringFunctions/arm_conv_q7.c @@ -44,7 +44,6 @@ @param[in] pSrcB points to the second input sequence @param[in] srcBLen length of the second input sequence @param[out] pDst points to the location where the output result is written. Length srcALen+srcBLen-1. - @return none @par Scaling and Overflow Behavior The function is implemented using a 32-bit internal accumulator. diff --git a/Source/FilteringFunctions/arm_correlate_f16.c b/Source/FilteringFunctions/arm_correlate_f16.c index 62abde8c2..bf9a0a197 100755 --- a/Source/FilteringFunctions/arm_correlate_f16.c +++ b/Source/FilteringFunctions/arm_correlate_f16.c @@ -47,7 +47,6 @@ @param[in] pSrcB points to the second input sequence @param[in] srcBLen length of the second input sequence @param[out] pDst points to the location where the output result is written. Length 2 * max(srcALen, srcBLen) - 1. - @return none */ #if defined(ARM_MATH_MVE_FLOAT16) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/FilteringFunctions/arm_correlate_f32.c b/Source/FilteringFunctions/arm_correlate_f32.c index fc8d0bbf5..560c9c4bb 100644 --- a/Source/FilteringFunctions/arm_correlate_f32.c +++ b/Source/FilteringFunctions/arm_correlate_f32.c @@ -99,7 +99,6 @@ @param[in] pSrcB points to the second input sequence @param[in] srcBLen length of the second input sequence @param[out] pDst points to the location where the output result is written. Length 2 * max(srcALen, srcBLen) - 1. - @return none */ #if defined(ARM_MATH_MVEF) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/FilteringFunctions/arm_correlate_f64.c b/Source/FilteringFunctions/arm_correlate_f64.c index 2d10bca33..6cc29b475 100644 --- a/Source/FilteringFunctions/arm_correlate_f64.c +++ b/Source/FilteringFunctions/arm_correlate_f64.c @@ -44,7 +44,6 @@ @param[in] pSrcB points to the second input sequence @param[in] srcBLen length of the second input sequence @param[out] pDst points to the location where the output result is written. Length 2 * max(srcALen, srcBLen) - 1. - @return none */ void arm_correlate_f64( diff --git a/Source/FilteringFunctions/arm_correlate_fast_opt_q15.c b/Source/FilteringFunctions/arm_correlate_fast_opt_q15.c index 0b37b1874..7ba5597bf 100644 --- a/Source/FilteringFunctions/arm_correlate_fast_opt_q15.c +++ b/Source/FilteringFunctions/arm_correlate_fast_opt_q15.c @@ -45,7 +45,6 @@ @param[in] srcBLen length of the second input sequence. @param[out] pDst points to the location where the output result is written. Length 2 * max(srcALen, srcBLen) - 1. @param[in] pScratch points to scratch buffer of size max(srcALen, srcBLen) + 2*min(srcALen, srcBLen) - 2. - @return none @par Scaling and Overflow Behavior This fast version uses a 32-bit accumulator with 2.30 format. diff --git a/Source/FilteringFunctions/arm_correlate_fast_q15.c b/Source/FilteringFunctions/arm_correlate_fast_q15.c index 7d8857adb..518e212ee 100644 --- a/Source/FilteringFunctions/arm_correlate_fast_q15.c +++ b/Source/FilteringFunctions/arm_correlate_fast_q15.c @@ -44,7 +44,6 @@ @param[in] pSrcB points to the second input sequence @param[in] srcBLen length of the second input sequence @param[out] pDst points to the location where the output result is written. Length 2 * max(srcALen, srcBLen) - 1. - @return none @par Scaling and Overflow Behavior This fast version uses a 32-bit accumulator with 2.30 format. diff --git a/Source/FilteringFunctions/arm_correlate_fast_q31.c b/Source/FilteringFunctions/arm_correlate_fast_q31.c index e3d2bbf8c..8be5907d1 100644 --- a/Source/FilteringFunctions/arm_correlate_fast_q31.c +++ b/Source/FilteringFunctions/arm_correlate_fast_q31.c @@ -44,7 +44,6 @@ @param[in] pSrcB points to the second input sequence @param[in] srcBLen length of the second input sequence @param[out] pDst points to the location where the output result is written. Length 2 * max(srcALen, srcBLen) - 1. - @return none @par Scaling and Overflow Behavior This function is optimized for speed at the expense of fixed-point precision and overflow protection. diff --git a/Source/FilteringFunctions/arm_correlate_opt_q15.c b/Source/FilteringFunctions/arm_correlate_opt_q15.c index 00bb08897..a0eea20a1 100644 --- a/Source/FilteringFunctions/arm_correlate_opt_q15.c +++ b/Source/FilteringFunctions/arm_correlate_opt_q15.c @@ -45,7 +45,6 @@ @param[in] srcBLen length of the second input sequence @param[out] pDst points to the location where the output result is written. Length 2 * max(srcALen, srcBLen) - 1. @param[in] pScratch points to scratch buffer of size max(srcALen, srcBLen) + 2*min(srcALen, srcBLen) - 2. - @return none @par Scaling and Overflow Behavior The function is implemented using a 64-bit internal accumulator. diff --git a/Source/FilteringFunctions/arm_correlate_opt_q7.c b/Source/FilteringFunctions/arm_correlate_opt_q7.c index 145ba2ae8..9e635a1bd 100644 --- a/Source/FilteringFunctions/arm_correlate_opt_q7.c +++ b/Source/FilteringFunctions/arm_correlate_opt_q7.c @@ -46,7 +46,6 @@ @param[out] pDst points to the location where the output result is written. Length 2 * max(srcALen, srcBLen) - 1. @param[in] pScratch1 points to scratch buffer(of type q15_t) of size max(srcALen, srcBLen) + 2*min(srcALen, srcBLen) - 2. @param[in] pScratch2 points to scratch buffer (of type q15_t) of size min(srcALen, srcBLen). - @return none @par Scaling and Overflow Behavior The function is implemented using a 32-bit internal accumulator. diff --git a/Source/FilteringFunctions/arm_correlate_q15.c b/Source/FilteringFunctions/arm_correlate_q15.c index ef36b8db9..53b963a98 100644 --- a/Source/FilteringFunctions/arm_correlate_q15.c +++ b/Source/FilteringFunctions/arm_correlate_q15.c @@ -44,7 +44,6 @@ @param[in] pSrcB points to the second input sequence @param[in] srcBLen length of the second input sequence @param[out] pDst points to the location where the output result is written. Length 2 * max(srcALen, srcBLen) - 1. - @return none @par Scaling and Overflow Behavior The function is implemented using a 64-bit internal accumulator. diff --git a/Source/FilteringFunctions/arm_correlate_q31.c b/Source/FilteringFunctions/arm_correlate_q31.c index 98d3d0aa0..2997c7aa4 100644 --- a/Source/FilteringFunctions/arm_correlate_q31.c +++ b/Source/FilteringFunctions/arm_correlate_q31.c @@ -44,7 +44,6 @@ @param[in] pSrcB points to the second input sequence @param[in] srcBLen length of the second input sequence @param[out] pDst points to the location where the output result is written. Length 2 * max(srcALen, srcBLen) - 1. - @return none @par Scaling and Overflow Behavior The function is implemented using an internal 64-bit accumulator. diff --git a/Source/FilteringFunctions/arm_correlate_q7.c b/Source/FilteringFunctions/arm_correlate_q7.c index 897e91121..9ec8c1669 100644 --- a/Source/FilteringFunctions/arm_correlate_q7.c +++ b/Source/FilteringFunctions/arm_correlate_q7.c @@ -44,7 +44,6 @@ @param[in] pSrcB points to the second input sequence @param[in] srcBLen length of the second input sequence @param[out] pDst points to the location where the output result is written. Length 2 * max(srcALen, srcBLen) - 1. - @return none @par Scaling and Overflow Behavior The function is implemented using a 32-bit internal accumulator. diff --git a/Source/FilteringFunctions/arm_fir_decimate_f32.c b/Source/FilteringFunctions/arm_fir_decimate_f32.c index 6d7a320f8..73690ff14 100644 --- a/Source/FilteringFunctions/arm_fir_decimate_f32.c +++ b/Source/FilteringFunctions/arm_fir_decimate_f32.c @@ -122,7 +122,6 @@ @param[in] pSrc points to the block of input data @param[out] pDst points to the block of output data @param[in] blockSize number of input samples to process - @return none */ #if defined(ARM_MATH_MVEF) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/FilteringFunctions/arm_fir_decimate_fast_q15.c b/Source/FilteringFunctions/arm_fir_decimate_fast_q15.c index 15bbb78a5..24e108e26 100644 --- a/Source/FilteringFunctions/arm_fir_decimate_fast_q15.c +++ b/Source/FilteringFunctions/arm_fir_decimate_fast_q15.c @@ -43,7 +43,6 @@ @param[in] pSrc points to the block of input data @param[out] pDst points to the block of output data @param[in] blockSize number of input samples to process per call - @return none @par Scaling and Overflow Behavior This fast version uses a 32-bit accumulator with 2.30 format. diff --git a/Source/FilteringFunctions/arm_fir_decimate_fast_q31.c b/Source/FilteringFunctions/arm_fir_decimate_fast_q31.c index 993f7ac73..f2d1579cb 100644 --- a/Source/FilteringFunctions/arm_fir_decimate_fast_q31.c +++ b/Source/FilteringFunctions/arm_fir_decimate_fast_q31.c @@ -43,7 +43,6 @@ @param[in] pSrc points to the block of input data @param[out] pDst points to the block of output data @param[in] blockSize number of samples to process - @return none @par Scaling and Overflow Behavior This function is optimized for speed at the expense of fixed-point precision and overflow protection. diff --git a/Source/FilteringFunctions/arm_fir_decimate_q15.c b/Source/FilteringFunctions/arm_fir_decimate_q15.c index 21f18e5c6..8e3c77a04 100644 --- a/Source/FilteringFunctions/arm_fir_decimate_q15.c +++ b/Source/FilteringFunctions/arm_fir_decimate_q15.c @@ -43,7 +43,6 @@ @param[in] pSrc points to the block of input data @param[out] pDst points to the block of output data @param[in] blockSize number of input samples to process per call - @return none @par Scaling and Overflow Behavior The function is implemented using a 64-bit internal accumulator. diff --git a/Source/FilteringFunctions/arm_fir_decimate_q31.c b/Source/FilteringFunctions/arm_fir_decimate_q31.c index dbaf25312..f0053b897 100644 --- a/Source/FilteringFunctions/arm_fir_decimate_q31.c +++ b/Source/FilteringFunctions/arm_fir_decimate_q31.c @@ -43,7 +43,6 @@ @param[in] pSrc points to the block of input data @param[out] pDst points to the block of output data @param[in] blockSize number of input samples to process - @return none @par Scaling and Overflow Behavior The function is implemented using an internal 64-bit accumulator. diff --git a/Source/FilteringFunctions/arm_fir_f16.c b/Source/FilteringFunctions/arm_fir_f16.c index f46dbece0..cb1f2a84d 100755 --- a/Source/FilteringFunctions/arm_fir_f16.c +++ b/Source/FilteringFunctions/arm_fir_f16.c @@ -45,7 +45,6 @@ @param[in] pSrc points to the block of input data @param[out] pDst points to the block of output data @param[in] blockSize number of samples to process - @return none */ #if defined(ARM_MATH_MVE_FLOAT16) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/FilteringFunctions/arm_fir_f32.c b/Source/FilteringFunctions/arm_fir_f32.c index f8c1d8061..aadd9c227 100644 --- a/Source/FilteringFunctions/arm_fir_f32.c +++ b/Source/FilteringFunctions/arm_fir_f32.c @@ -63,6 +63,7 @@
             {x[n-numTaps+1], x[n-numTaps], x[n-numTaps-1], x[n-numTaps-2]....x[n](==pSrc[0]), x[n+1](==pSrc[1]), ..., x[n+blockSize-1](==pSrc[blockSize-1])}
         
      + @par Note that the length of the state buffer exceeds the length of the coefficient array by blockSize-1. The increased state buffer length allows circular addressing, which is traditionally used in the FIR filters, @@ -82,6 +83,7 @@ - Zeros out the values in the state buffer. To do this manually without calling the init function, assign the follow subfields of the instance structure: numTaps, pCoeffs, pState. Also set all of the values in pState to zero. + @par Use of the initialization function is optional. However, if the initialization function is used, then the instance structure cannot be placed into a const data section. @@ -96,6 +98,7 @@ where numTaps is the number of filter coefficients in the filter; pState is the address of the state buffer; pCoeffs is the address of the coefficient buffer. + @par Initialization of Helium version For Helium version the array of coefficients must be padded with zero to contain a full number of lanes. @@ -113,13 +116,13 @@ the implementation may require to read more coefficients due to the vectorization and to avoid having to manage too many different cases in the code. - @par Helium state buffer The state buffer must contain some additional temporary data used during the computation but which is not the state of the FIR. The first A samples are temporary data. The remaining samples are the state of the FIR filter. - @par + + @par So the state buffer has size numTaps + A + blockSize - 1 : - A is blockSize for f32 - A is 8*ceil(blockSize/8) for f16 @@ -145,7 +148,6 @@ @param[in] pSrc points to the block of input data @param[out] pDst points to the block of output data @param[in] blockSize number of samples to process - @return none */ #if defined(ARM_MATH_MVEF) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/FilteringFunctions/arm_fir_f64.c b/Source/FilteringFunctions/arm_fir_f64.c index 0ced562a7..a0a471883 100644 --- a/Source/FilteringFunctions/arm_fir_f64.c +++ b/Source/FilteringFunctions/arm_fir_f64.c @@ -43,7 +43,6 @@ @param[in] pSrc points to the block of input data @param[out] pDst points to the block of output data @param[in] blockSize number of samples to process - @return none */ #if defined(ARM_MATH_NEON) && defined(__aarch64__) void arm_fir_f64( diff --git a/Source/FilteringFunctions/arm_fir_fast_q15.c b/Source/FilteringFunctions/arm_fir_fast_q15.c index ccd3ed8ef..16ede8b1c 100644 --- a/Source/FilteringFunctions/arm_fir_fast_q15.c +++ b/Source/FilteringFunctions/arm_fir_fast_q15.c @@ -43,7 +43,6 @@ @param[in] pSrc points to the block of input data @param[out] pDst points to the block of output data @param[in] blockSize number of samples to process - @return none @par Scaling and Overflow Behavior This fast version uses a 32-bit accumulator with 2.30 format. diff --git a/Source/FilteringFunctions/arm_fir_fast_q31.c b/Source/FilteringFunctions/arm_fir_fast_q31.c index bc628c9f7..1afadb59d 100644 --- a/Source/FilteringFunctions/arm_fir_fast_q31.c +++ b/Source/FilteringFunctions/arm_fir_fast_q31.c @@ -43,7 +43,6 @@ @param[in] pSrc points to the block of input data @param[out] pDst points to the block of output data @param[in] blockSize number of samples to process - @return none @par Scaling and Overflow Behavior This function is optimized for speed at the expense of fixed-point precision and overflow protection. diff --git a/Source/FilteringFunctions/arm_fir_init_f16.c b/Source/FilteringFunctions/arm_fir_init_f16.c index 40b8061d6..f3d759b04 100755 --- a/Source/FilteringFunctions/arm_fir_init_f16.c +++ b/Source/FilteringFunctions/arm_fir_init_f16.c @@ -42,11 +42,10 @@ /** @brief Initialization function for the floating-point FIR filter. @param[in,out] S points to an instance of the floating-point FIR filter structure - @param[in] numTaps number of filter coefficients in the filter + @param[in] numTaps number of filter coefficients in the filter @param[in] pCoeffs points to the filter coefficients buffer @param[in] pState points to the state buffer @param[in] blockSize number of samples processed per call - @return none @par Details pCoeffs points to the array of filter coefficients stored in time reversed order: diff --git a/Source/FilteringFunctions/arm_fir_init_f32.c b/Source/FilteringFunctions/arm_fir_init_f32.c index e0a58755b..129393c34 100644 --- a/Source/FilteringFunctions/arm_fir_init_f32.c +++ b/Source/FilteringFunctions/arm_fir_init_f32.c @@ -40,11 +40,10 @@ /** @brief Initialization function for the floating-point FIR filter. @param[in,out] S points to an instance of the floating-point FIR filter structure - @param[in] numTaps number of filter coefficients in the filter + @param[in] numTaps number of filter coefficients in the filter @param[in] pCoeffs points to the filter coefficients buffer @param[in] pState points to the state buffer @param[in] blockSize number of samples processed per call - @return none @par Details pCoeffs points to the array of filter coefficients stored in time reversed order: diff --git a/Source/FilteringFunctions/arm_fir_init_f64.c b/Source/FilteringFunctions/arm_fir_init_f64.c index fe616dea8..4fd85a297 100644 --- a/Source/FilteringFunctions/arm_fir_init_f64.c +++ b/Source/FilteringFunctions/arm_fir_init_f64.c @@ -40,11 +40,10 @@ /** @brief Initialization function for the floating-point FIR filter. @param[in,out] S points to an instance of the floating-point FIR filter structure - @param[in] numTaps number of filter coefficients in the filter + @param[in] numTaps number of filter coefficients in the filter @param[in] pCoeffs points to the filter coefficients buffer @param[in] pState points to the state buffer @param[in] blockSize number of samples processed per call - @return none @par Details pCoeffs points to the array of filter coefficients stored in time reversed order: diff --git a/Source/FilteringFunctions/arm_fir_init_q15.c b/Source/FilteringFunctions/arm_fir_init_q15.c index 3682fb09f..d8a185e19 100644 --- a/Source/FilteringFunctions/arm_fir_init_q15.c +++ b/Source/FilteringFunctions/arm_fir_init_q15.c @@ -40,7 +40,7 @@ /** @brief Initialization function for the Q15 FIR filter. @param[in,out] S points to an instance of the Q15 FIR filter structure. - @param[in] numTaps number of filter coefficients in the filter. Must be even and greater than or equal to 4. + @param[in] numTaps number of filter coefficients in the filter. Must be even and greater than or equal to 4. @param[in] pCoeffs points to the filter coefficients buffer. @param[in] pState points to the state buffer. @param[in] blockSize number of samples processed per call. diff --git a/Source/FilteringFunctions/arm_fir_init_q31.c b/Source/FilteringFunctions/arm_fir_init_q31.c index 85bdf4f44..7dc9a5e4c 100644 --- a/Source/FilteringFunctions/arm_fir_init_q31.c +++ b/Source/FilteringFunctions/arm_fir_init_q31.c @@ -40,11 +40,10 @@ /** @brief Initialization function for the Q31 FIR filter. @param[in,out] S points to an instance of the Q31 FIR filter structure - @param[in] numTaps number of filter coefficients in the filter + @param[in] numTaps number of filter coefficients in the filter @param[in] pCoeffs points to the filter coefficients buffer @param[in] pState points to the state buffer @param[in] blockSize number of samples processed - @return none @par Details pCoeffs points to the array of filter coefficients stored in time reversed order: diff --git a/Source/FilteringFunctions/arm_fir_init_q7.c b/Source/FilteringFunctions/arm_fir_init_q7.c index 1ad05a557..fd1d6b727 100644 --- a/Source/FilteringFunctions/arm_fir_init_q7.c +++ b/Source/FilteringFunctions/arm_fir_init_q7.c @@ -40,11 +40,10 @@ /** @brief Initialization function for the Q7 FIR filter. @param[in,out] S points to an instance of the Q7 FIR filter structure - @param[in] numTaps number of filter coefficients in the filter + @param[in] numTaps number of filter coefficients in the filter @param[in] pCoeffs points to the filter coefficients buffer @param[in] pState points to the state buffer @param[in] blockSize number of samples processed - @return none @par Details pCoeffs points to the array of filter coefficients stored in time reversed order: diff --git a/Source/FilteringFunctions/arm_fir_interpolate_f32.c b/Source/FilteringFunctions/arm_fir_interpolate_f32.c index f16bd3095..c269f9bb3 100644 --- a/Source/FilteringFunctions/arm_fir_interpolate_f32.c +++ b/Source/FilteringFunctions/arm_fir_interpolate_f32.c @@ -126,7 +126,6 @@ @param[in] pSrc points to the block of input data @param[out] pDst points to the block of output data @param[in] blockSize number of input samples to process - @return none */ #if defined(ARM_MATH_MVEF) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/FilteringFunctions/arm_fir_interpolate_q15.c b/Source/FilteringFunctions/arm_fir_interpolate_q15.c index 4e1bf63e1..3466a95dd 100644 --- a/Source/FilteringFunctions/arm_fir_interpolate_q15.c +++ b/Source/FilteringFunctions/arm_fir_interpolate_q15.c @@ -43,7 +43,6 @@ @param[in] pSrc points to the block of input data @param[out] pDst points to the block of output data @param[in] blockSize number of input samples to process - @return none @par Scaling and Overflow Behavior The function is implemented using a 64-bit internal accumulator. diff --git a/Source/FilteringFunctions/arm_fir_interpolate_q31.c b/Source/FilteringFunctions/arm_fir_interpolate_q31.c index 0761fcdc6..4e192fdca 100644 --- a/Source/FilteringFunctions/arm_fir_interpolate_q31.c +++ b/Source/FilteringFunctions/arm_fir_interpolate_q31.c @@ -43,7 +43,6 @@ @param[in] pSrc points to the block of input data @param[out] pDst points to the block of output data @param[in] blockSize number of input samples to process - @return none @par Scaling and Overflow Behavior The function is implemented using an internal 64-bit accumulator. diff --git a/Source/FilteringFunctions/arm_fir_lattice_f32.c b/Source/FilteringFunctions/arm_fir_lattice_f32.c index 0e3b3771e..ece276ea4 100644 --- a/Source/FilteringFunctions/arm_fir_lattice_f32.c +++ b/Source/FilteringFunctions/arm_fir_lattice_f32.c @@ -118,7 +118,6 @@ @param[in] pSrc points to the block of input data @param[out] pDst points to the block of output data @param[in] blockSize number of samples to process - @return none */ void arm_fir_lattice_f32( diff --git a/Source/FilteringFunctions/arm_fir_lattice_init_f32.c b/Source/FilteringFunctions/arm_fir_lattice_init_f32.c index a3a0c224c..af07f0ec1 100644 --- a/Source/FilteringFunctions/arm_fir_lattice_init_f32.c +++ b/Source/FilteringFunctions/arm_fir_lattice_init_f32.c @@ -43,7 +43,6 @@ @param[in] numStages number of filter stages @param[in] pCoeffs points to the coefficient buffer. The array is of length numStages @param[in] pState points to the state buffer. The array is of length numStages - @return none */ void arm_fir_lattice_init_f32( diff --git a/Source/FilteringFunctions/arm_fir_lattice_init_q15.c b/Source/FilteringFunctions/arm_fir_lattice_init_q15.c index 3996d4846..968393923 100644 --- a/Source/FilteringFunctions/arm_fir_lattice_init_q15.c +++ b/Source/FilteringFunctions/arm_fir_lattice_init_q15.c @@ -43,7 +43,6 @@ @param[in] numStages number of filter stages @param[in] pCoeffs points to the coefficient buffer. The array is of length numStages @param[in] pState points to the state buffer. The array is of length numStages - @return none */ void arm_fir_lattice_init_q15( diff --git a/Source/FilteringFunctions/arm_fir_lattice_init_q31.c b/Source/FilteringFunctions/arm_fir_lattice_init_q31.c index 4a91b5904..010468100 100644 --- a/Source/FilteringFunctions/arm_fir_lattice_init_q31.c +++ b/Source/FilteringFunctions/arm_fir_lattice_init_q31.c @@ -43,7 +43,6 @@ @param[in] numStages number of filter stages @param[in] pCoeffs points to the coefficient buffer. The array is of length numStages @param[in] pState points to the state buffer. The array is of length numStages - @return none */ void arm_fir_lattice_init_q31( diff --git a/Source/FilteringFunctions/arm_fir_lattice_q15.c b/Source/FilteringFunctions/arm_fir_lattice_q15.c index 14b7076d6..3d9b45421 100644 --- a/Source/FilteringFunctions/arm_fir_lattice_q15.c +++ b/Source/FilteringFunctions/arm_fir_lattice_q15.c @@ -43,7 +43,6 @@ @param[in] pSrc points to the block of input data @param[out] pDst points to the block of output data @param[in] blockSize number of samples to process - @return none */ void arm_fir_lattice_q15( diff --git a/Source/FilteringFunctions/arm_fir_lattice_q31.c b/Source/FilteringFunctions/arm_fir_lattice_q31.c index 3b8355185..9bcf43000 100644 --- a/Source/FilteringFunctions/arm_fir_lattice_q31.c +++ b/Source/FilteringFunctions/arm_fir_lattice_q31.c @@ -43,7 +43,6 @@ @param[in] pSrc points to the block of input data @param[out] pDst points to the block of output data @param[in] blockSize number of samples to process - @return none @par Scaling and Overflow Behavior In order to avoid overflows the input signal must be scaled down by 2*log2(numStages) bits. diff --git a/Source/FilteringFunctions/arm_fir_q15.c b/Source/FilteringFunctions/arm_fir_q15.c index 6b7d99057..d210e4c7c 100644 --- a/Source/FilteringFunctions/arm_fir_q15.c +++ b/Source/FilteringFunctions/arm_fir_q15.c @@ -43,7 +43,6 @@ @param[in] pSrc points to the block of input data @param[out] pDst points to the block of output data @param[in] blockSize number of samples to process - @return none @par Scaling and Overflow Behavior The function is implemented using a 64-bit internal accumulator. diff --git a/Source/FilteringFunctions/arm_fir_q31.c b/Source/FilteringFunctions/arm_fir_q31.c index fd5f9c36a..b9f46876a 100644 --- a/Source/FilteringFunctions/arm_fir_q31.c +++ b/Source/FilteringFunctions/arm_fir_q31.c @@ -44,7 +44,6 @@ @param[in] pSrc points to the block of input data @param[out] pDst points to the block of output data @param[in] blockSize number of samples to process - @return none @par Scaling and Overflow Behavior The function is implemented using an internal 64-bit accumulator. diff --git a/Source/FilteringFunctions/arm_fir_q7.c b/Source/FilteringFunctions/arm_fir_q7.c index c05fa3214..a5e5ba3ff 100755 --- a/Source/FilteringFunctions/arm_fir_q7.c +++ b/Source/FilteringFunctions/arm_fir_q7.c @@ -43,7 +43,6 @@ @param[in] pSrc points to the block of input data @param[out] pDst points to the block of output data @param[in] blockSize number of samples to process - @return none @par Scaling and Overflow Behavior The function is implemented using a 32-bit internal accumulator. diff --git a/Source/FilteringFunctions/arm_fir_sparse_f32.c b/Source/FilteringFunctions/arm_fir_sparse_f32.c index fd3d67a54..36caafbd2 100644 --- a/Source/FilteringFunctions/arm_fir_sparse_f32.c +++ b/Source/FilteringFunctions/arm_fir_sparse_f32.c @@ -107,7 +107,6 @@ @param[out] pDst points to the block of output data @param[in] pScratchIn points to a temporary buffer of size blockSize @param[in] blockSize number of input samples to process - @return none */ void arm_fir_sparse_f32( diff --git a/Source/FilteringFunctions/arm_fir_sparse_init_f32.c b/Source/FilteringFunctions/arm_fir_sparse_init_f32.c index dce0d6f7d..6178abd31 100644 --- a/Source/FilteringFunctions/arm_fir_sparse_init_f32.c +++ b/Source/FilteringFunctions/arm_fir_sparse_init_f32.c @@ -46,7 +46,6 @@ @param[in] pTapDelay points to the array of offset times @param[in] maxDelay maximum offset time supported @param[in] blockSize number of samples that will be processed per block - @return none @par Details pCoeffs holds the filter coefficients and has length numTaps. diff --git a/Source/FilteringFunctions/arm_fir_sparse_init_q15.c b/Source/FilteringFunctions/arm_fir_sparse_init_q15.c index 6a48743ed..fc400bebc 100644 --- a/Source/FilteringFunctions/arm_fir_sparse_init_q15.c +++ b/Source/FilteringFunctions/arm_fir_sparse_init_q15.c @@ -46,7 +46,6 @@ @param[in] pTapDelay points to the array of offset times @param[in] maxDelay maximum offset time supported @param[in] blockSize number of samples that will be processed per block - @return none @par Details pCoeffs holds the filter coefficients and has length numTaps. diff --git a/Source/FilteringFunctions/arm_fir_sparse_init_q31.c b/Source/FilteringFunctions/arm_fir_sparse_init_q31.c index a333f1cc8..c6dec8171 100644 --- a/Source/FilteringFunctions/arm_fir_sparse_init_q31.c +++ b/Source/FilteringFunctions/arm_fir_sparse_init_q31.c @@ -46,7 +46,6 @@ @param[in] pTapDelay points to the array of offset times @param[in] maxDelay maximum offset time supported @param[in] blockSize number of samples that will be processed per block - @return none @par Details pCoeffs holds the filter coefficients and has length numTaps. diff --git a/Source/FilteringFunctions/arm_fir_sparse_init_q7.c b/Source/FilteringFunctions/arm_fir_sparse_init_q7.c index 3e2b9c9a2..1d8d217f2 100644 --- a/Source/FilteringFunctions/arm_fir_sparse_init_q7.c +++ b/Source/FilteringFunctions/arm_fir_sparse_init_q7.c @@ -46,7 +46,6 @@ @param[in] pTapDelay points to the array of offset times @param[in] maxDelay maximum offset time supported @param[in] blockSize number of samples that will be processed per block - @return none @par Details pCoeffs holds the filter coefficients and has length numTaps. diff --git a/Source/FilteringFunctions/arm_fir_sparse_q15.c b/Source/FilteringFunctions/arm_fir_sparse_q15.c index 606692255..75d28018c 100644 --- a/Source/FilteringFunctions/arm_fir_sparse_q15.c +++ b/Source/FilteringFunctions/arm_fir_sparse_q15.c @@ -45,7 +45,6 @@ @param[in] pScratchIn points to a temporary buffer of size blockSize @param[in] pScratchOut points to a temporary buffer of size blockSize @param[in] blockSize number of input samples to process per call - @return none @par Scaling and Overflow Behavior The function is implemented using an internal 32-bit accumulator. diff --git a/Source/FilteringFunctions/arm_fir_sparse_q31.c b/Source/FilteringFunctions/arm_fir_sparse_q31.c index 33c66df47..a45c5b69b 100644 --- a/Source/FilteringFunctions/arm_fir_sparse_q31.c +++ b/Source/FilteringFunctions/arm_fir_sparse_q31.c @@ -44,7 +44,6 @@ @param[out] pDst points to the block of output data @param[in] pScratchIn points to a temporary buffer of size blockSize @param[in] blockSize number of input samples to process - @return none @par Scaling and Overflow Behavior The function is implemented using an internal 32-bit accumulator. diff --git a/Source/FilteringFunctions/arm_fir_sparse_q7.c b/Source/FilteringFunctions/arm_fir_sparse_q7.c index e47d889c2..2c99160f0 100644 --- a/Source/FilteringFunctions/arm_fir_sparse_q7.c +++ b/Source/FilteringFunctions/arm_fir_sparse_q7.c @@ -45,7 +45,6 @@ @param[in] pScratchIn points to a temporary buffer of size blockSize @param[in] pScratchOut points to a temporary buffer of size blockSize @param[in] blockSize number of input samples to process - @return none @par Scaling and Overflow Behavior The function is implemented using a 32-bit internal accumulator. diff --git a/Source/FilteringFunctions/arm_iir_lattice_f32.c b/Source/FilteringFunctions/arm_iir_lattice_f32.c index bf0b178c4..9cae36ea3 100644 --- a/Source/FilteringFunctions/arm_iir_lattice_f32.c +++ b/Source/FilteringFunctions/arm_iir_lattice_f32.c @@ -115,7 +115,6 @@ @param[in] pSrc points to the block of input data @param[out] pDst points to the block of output data @param[in] blockSize number of samples to process - @return none */ void arm_iir_lattice_f32( diff --git a/Source/FilteringFunctions/arm_iir_lattice_init_f32.c b/Source/FilteringFunctions/arm_iir_lattice_init_f32.c index 389e1ea8f..69d6ddb20 100644 --- a/Source/FilteringFunctions/arm_iir_lattice_init_f32.c +++ b/Source/FilteringFunctions/arm_iir_lattice_init_f32.c @@ -45,7 +45,6 @@ @param[in] pvCoeffs points to ladder coefficient buffer. The array is of length numStages+1 @param[in] pState points to state buffer. The array is of length numStages+blockSize @param[in] blockSize number of samples to process - @return none */ void arm_iir_lattice_init_f32( diff --git a/Source/FilteringFunctions/arm_iir_lattice_init_q15.c b/Source/FilteringFunctions/arm_iir_lattice_init_q15.c index 873c342ae..3631658d0 100644 --- a/Source/FilteringFunctions/arm_iir_lattice_init_q15.c +++ b/Source/FilteringFunctions/arm_iir_lattice_init_q15.c @@ -45,7 +45,6 @@ @param[in] pvCoeffs points to ladder coefficient buffer. The array is of length numStages+1 @param[in] pState points to state buffer. The array is of length numStages+blockSize @param[in] blockSize number of samples to process - @return none */ void arm_iir_lattice_init_q15( diff --git a/Source/FilteringFunctions/arm_iir_lattice_init_q31.c b/Source/FilteringFunctions/arm_iir_lattice_init_q31.c index 59b26d3c7..102168f0f 100644 --- a/Source/FilteringFunctions/arm_iir_lattice_init_q31.c +++ b/Source/FilteringFunctions/arm_iir_lattice_init_q31.c @@ -45,7 +45,6 @@ @param[in] pvCoeffs points to ladder coefficient buffer. The array is of length numStages+1 @param[in] pState points to state buffer. The array is of length numStages+blockSize @param[in] blockSize number of samples to process - @return none */ void arm_iir_lattice_init_q31( diff --git a/Source/FilteringFunctions/arm_iir_lattice_q15.c b/Source/FilteringFunctions/arm_iir_lattice_q15.c index d3cf7f668..be5b77f88 100644 --- a/Source/FilteringFunctions/arm_iir_lattice_q15.c +++ b/Source/FilteringFunctions/arm_iir_lattice_q15.c @@ -43,7 +43,6 @@ @param[in] pSrc points to the block of input data @param[out] pDst points to the block of output data @param[in] blockSize number of samples to process - @return none @par Scaling and Overflow Behavior The function is implemented using an internal 64-bit accumulator. diff --git a/Source/FilteringFunctions/arm_iir_lattice_q31.c b/Source/FilteringFunctions/arm_iir_lattice_q31.c index 633449553..517b7ae0f 100644 --- a/Source/FilteringFunctions/arm_iir_lattice_q31.c +++ b/Source/FilteringFunctions/arm_iir_lattice_q31.c @@ -43,7 +43,6 @@ @param[in] pSrc points to the block of input data @param[out] pDst points to the block of output data @param[in] blockSize number of samples to process - @return none @par Scaling and Overflow Behavior The function is implemented using an internal 64-bit accumulator. diff --git a/Source/FilteringFunctions/arm_levinson_durbin_f16.c b/Source/FilteringFunctions/arm_levinson_durbin_f16.c index 8e52ee2eb..0f94f1a0a 100755 --- a/Source/FilteringFunctions/arm_levinson_durbin_f16.c +++ b/Source/FilteringFunctions/arm_levinson_durbin_f16.c @@ -45,7 +45,6 @@ @param[out] a autoregressive coefficients @param[out] err prediction error (variance) @param[in] nbCoefs number of autoregressive coefficients - @return none */ #if defined(ARM_MATH_MVE_FLOAT16) && !defined(ARM_MATH_AUTOVECTORIZE) && defined(__CMSIS_GCC_H) diff --git a/Source/FilteringFunctions/arm_levinson_durbin_f32.c b/Source/FilteringFunctions/arm_levinson_durbin_f32.c index b244048c2..c8fdcffda 100755 --- a/Source/FilteringFunctions/arm_levinson_durbin_f32.c +++ b/Source/FilteringFunctions/arm_levinson_durbin_f32.c @@ -48,7 +48,6 @@ @param[out] a autoregressive coefficients @param[out] err prediction error (variance) @param[in] nbCoefs number of autoregressive coefficients - @return none */ #if defined(ARM_MATH_MVE_FLOAT16) && !defined(ARM_MATH_AUTOVECTORIZE) && defined(__CMSIS_GCC_H) diff --git a/Source/FilteringFunctions/arm_levinson_durbin_q31.c b/Source/FilteringFunctions/arm_levinson_durbin_q31.c index 86b10b326..c1f2af949 100755 --- a/Source/FilteringFunctions/arm_levinson_durbin_q31.c +++ b/Source/FilteringFunctions/arm_levinson_durbin_q31.c @@ -106,7 +106,6 @@ __STATIC_FORCEINLINE q31_t divide(q31_t n, q31_t d) @param[out] a autoregressive coefficients @param[out] err prediction error (variance) @param[in] nbCoefs number of autoregressive coefficients - @return none */ #if defined(ARM_MATH_MVE_FLOAT16) && !defined(ARM_MATH_AUTOVECTORIZE) && defined(__CMSIS_GCC_H) diff --git a/Source/FilteringFunctions/arm_lms_f32.c b/Source/FilteringFunctions/arm_lms_f32.c index 99cbeb424..e9cd23917 100644 --- a/Source/FilteringFunctions/arm_lms_f32.c +++ b/Source/FilteringFunctions/arm_lms_f32.c @@ -160,7 +160,6 @@ @param[out] pOut points to the block of output data @param[out] pErr points to the block of error data @param[in] blockSize number of samples to process - @return none */ #if defined(ARM_MATH_NEON) void arm_lms_f32( diff --git a/Source/FilteringFunctions/arm_lms_init_f32.c b/Source/FilteringFunctions/arm_lms_init_f32.c index cf472afde..18125c69c 100644 --- a/Source/FilteringFunctions/arm_lms_init_f32.c +++ b/Source/FilteringFunctions/arm_lms_init_f32.c @@ -41,7 +41,6 @@ @param[in] pState points to state buffer @param[in] mu step size that controls filter coefficient updates @param[in] blockSize number of samples to process - @return none @par Details pCoeffs points to the array of filter coefficients stored in time reversed order: diff --git a/Source/FilteringFunctions/arm_lms_init_q15.c b/Source/FilteringFunctions/arm_lms_init_q15.c index 31c2bff24..a731a98ec 100644 --- a/Source/FilteringFunctions/arm_lms_init_q15.c +++ b/Source/FilteringFunctions/arm_lms_init_q15.c @@ -46,7 +46,6 @@ @param[in] mu step size that controls filter coefficient updates. @param[in] blockSize number of samples to process. @param[in] postShift bit shift applied to coefficients. - @return none @par Details pCoeffs points to the array of filter coefficients stored in time reversed order: diff --git a/Source/FilteringFunctions/arm_lms_init_q31.c b/Source/FilteringFunctions/arm_lms_init_q31.c index e657a9382..49445dca6 100644 --- a/Source/FilteringFunctions/arm_lms_init_q31.c +++ b/Source/FilteringFunctions/arm_lms_init_q31.c @@ -46,7 +46,6 @@ @param[in] mu step size that controls filter coefficient updates @param[in] blockSize number of samples to process @param[in] postShift bit shift applied to coefficients - @return none @par Details pCoeffs points to the array of filter coefficients stored in time reversed order: diff --git a/Source/FilteringFunctions/arm_lms_norm_f32.c b/Source/FilteringFunctions/arm_lms_norm_f32.c index 85f8211c9..2ffb08d63 100644 --- a/Source/FilteringFunctions/arm_lms_norm_f32.c +++ b/Source/FilteringFunctions/arm_lms_norm_f32.c @@ -153,7 +153,6 @@ @param[out] pOut points to the block of output data @param[out] pErr points to the block of error data @param[in] blockSize number of samples to process - @return none */ #if defined(ARM_MATH_NEON) diff --git a/Source/FilteringFunctions/arm_lms_norm_init_f32.c b/Source/FilteringFunctions/arm_lms_norm_init_f32.c index b0b7ea505..47615cfa2 100644 --- a/Source/FilteringFunctions/arm_lms_norm_init_f32.c +++ b/Source/FilteringFunctions/arm_lms_norm_init_f32.c @@ -45,7 +45,6 @@ @param[in] pState points to state buffer @param[in] mu step size that controls filter coefficient updates @param[in] blockSize number of samples to process - @return none @par Details pCoeffs points to the array of filter coefficients stored in time reversed order: diff --git a/Source/FilteringFunctions/arm_lms_norm_init_q15.c b/Source/FilteringFunctions/arm_lms_norm_init_q15.c index 5bbfc4205..4420eb0c1 100644 --- a/Source/FilteringFunctions/arm_lms_norm_init_q15.c +++ b/Source/FilteringFunctions/arm_lms_norm_init_q15.c @@ -43,7 +43,6 @@ @param[in] mu step size that controls filter coefficient updates. @param[in] blockSize number of samples to process. @param[in] postShift bit shift applied to coefficients. - @return none @par Details pCoeffs points to the array of filter coefficients stored in time reversed order: diff --git a/Source/FilteringFunctions/arm_lms_norm_init_q31.c b/Source/FilteringFunctions/arm_lms_norm_init_q31.c index cc429b009..85e162eb0 100644 --- a/Source/FilteringFunctions/arm_lms_norm_init_q31.c +++ b/Source/FilteringFunctions/arm_lms_norm_init_q31.c @@ -43,7 +43,6 @@ @param[in] mu step size that controls filter coefficient updates. @param[in] blockSize number of samples to process. @param[in] postShift bit shift applied to coefficients. - @return none @par Details pCoeffs points to the array of filter coefficients stored in time reversed order: diff --git a/Source/FilteringFunctions/arm_lms_norm_q15.c b/Source/FilteringFunctions/arm_lms_norm_q15.c index b38c5ba36..8c144b26c 100644 --- a/Source/FilteringFunctions/arm_lms_norm_q15.c +++ b/Source/FilteringFunctions/arm_lms_norm_q15.c @@ -45,7 +45,6 @@ @param[out] pOut points to the block of output data @param[out] pErr points to the block of error data @param[in] blockSize number of samples to process - @return none @par Scaling and Overflow Behavior The function is implemented using a 64-bit internal accumulator. diff --git a/Source/FilteringFunctions/arm_lms_norm_q31.c b/Source/FilteringFunctions/arm_lms_norm_q31.c index ff266a32a..7217e0775 100644 --- a/Source/FilteringFunctions/arm_lms_norm_q31.c +++ b/Source/FilteringFunctions/arm_lms_norm_q31.c @@ -45,7 +45,6 @@ @param[out] pOut points to the block of output data @param[out] pErr points to the block of error data @param[in] blockSize number of samples to process - @return none @par Scaling and Overflow Behavior The function is implemented using an internal 64-bit accumulator. diff --git a/Source/FilteringFunctions/arm_lms_q15.c b/Source/FilteringFunctions/arm_lms_q15.c index 76cab0320..04a72b698 100644 --- a/Source/FilteringFunctions/arm_lms_q15.c +++ b/Source/FilteringFunctions/arm_lms_q15.c @@ -45,7 +45,6 @@ @param[out] pOut points to the block of output data @param[out] pErr points to the block of error data @param[in] blockSize number of samples to process - @return none @par Scaling and Overflow Behavior The function is implemented using an internal 64-bit accumulator. diff --git a/Source/FilteringFunctions/arm_lms_q31.c b/Source/FilteringFunctions/arm_lms_q31.c index 1ed61f276..63b35cac6 100644 --- a/Source/FilteringFunctions/arm_lms_q31.c +++ b/Source/FilteringFunctions/arm_lms_q31.c @@ -45,7 +45,6 @@ @param[out] pOut points to the block of output data. @param[out] pErr points to the block of error data. @param[in] blockSize number of samples to process. - @return none @par Scaling and Overflow Behavior The function is implemented using an internal 64-bit accumulator. diff --git a/Source/MatrixFunctions/arm_mat_init_f16.c b/Source/MatrixFunctions/arm_mat_init_f16.c index 6a48102d1..e71538712 100755 --- a/Source/MatrixFunctions/arm_mat_init_f16.c +++ b/Source/MatrixFunctions/arm_mat_init_f16.c @@ -47,7 +47,6 @@ @param[in] nRows number of rows in the matrix @param[in] nColumns number of columns in the matrix @param[in] pData points to the matrix data array - @return none */ void arm_mat_init_f16( diff --git a/Source/MatrixFunctions/arm_mat_init_f32.c b/Source/MatrixFunctions/arm_mat_init_f32.c index d2a52013a..b2634d8f0 100644 --- a/Source/MatrixFunctions/arm_mat_init_f32.c +++ b/Source/MatrixFunctions/arm_mat_init_f32.c @@ -52,7 +52,6 @@ @param[in] nRows number of rows in the matrix @param[in] nColumns number of columns in the matrix @param[in] pData points to the matrix data array - @return none */ void arm_mat_init_f32( diff --git a/Source/MatrixFunctions/arm_mat_init_f64.c b/Source/MatrixFunctions/arm_mat_init_f64.c index f053124e4..f77ab5817 100644 --- a/Source/MatrixFunctions/arm_mat_init_f64.c +++ b/Source/MatrixFunctions/arm_mat_init_f64.c @@ -52,7 +52,6 @@ @param[in] nRows number of rows in the matrix @param[in] nColumns number of columns in the matrix @param[in] pData points to the matrix data array - @return none */ void arm_mat_init_f64( diff --git a/Source/MatrixFunctions/arm_mat_init_q15.c b/Source/MatrixFunctions/arm_mat_init_q15.c index 33942b50b..8f2da4f2f 100644 --- a/Source/MatrixFunctions/arm_mat_init_q15.c +++ b/Source/MatrixFunctions/arm_mat_init_q15.c @@ -43,7 +43,6 @@ @param[in] nRows number of rows in the matrix @param[in] nColumns number of columns in the matrix @param[in] pData points to the matrix data array - @return none */ void arm_mat_init_q15( diff --git a/Source/MatrixFunctions/arm_mat_init_q31.c b/Source/MatrixFunctions/arm_mat_init_q31.c index 9031cdab2..ad421592d 100644 --- a/Source/MatrixFunctions/arm_mat_init_q31.c +++ b/Source/MatrixFunctions/arm_mat_init_q31.c @@ -45,7 +45,6 @@ @param[in] nRows number of rows in the matrix @param[in] nColumns number of columns in the matrix @param[in] pData points to the matrix data array - @return none */ void arm_mat_init_q31( diff --git a/Source/QuaternionMathFunctions/arm_quaternion2rotation_f32.c b/Source/QuaternionMathFunctions/arm_quaternion2rotation_f32.c index 388c2d2c4..8a518c1ad 100755 --- a/Source/QuaternionMathFunctions/arm_quaternion2rotation_f32.c +++ b/Source/QuaternionMathFunctions/arm_quaternion2rotation_f32.c @@ -59,7 +59,6 @@ @param[in] pInputQuaternions points to an array of normalized quaternions @param[out] pOutputRotations points to an array of 3x3 rotations (in row order) @param[in] nbQuaternions number of quaternions in the array - @return none. @par Format of rotation matrix diff --git a/Source/QuaternionMathFunctions/arm_quaternion_conjugate_f32.c b/Source/QuaternionMathFunctions/arm_quaternion_conjugate_f32.c index 213a5bbca..6ba6b9de3 100755 --- a/Source/QuaternionMathFunctions/arm_quaternion_conjugate_f32.c +++ b/Source/QuaternionMathFunctions/arm_quaternion_conjugate_f32.c @@ -49,7 +49,6 @@ @param[in] pInputQuaternions points to the input vector of quaternions @param[out] pConjugateQuaternions points to the output vector of conjugate quaternions @param[in] nbQuaternions number of quaternions in each vector - @return none */ #if defined(ARM_MATH_MVEF) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/QuaternionMathFunctions/arm_quaternion_inverse_f32.c b/Source/QuaternionMathFunctions/arm_quaternion_inverse_f32.c index 094d3f460..b6c24ddc3 100755 --- a/Source/QuaternionMathFunctions/arm_quaternion_inverse_f32.c +++ b/Source/QuaternionMathFunctions/arm_quaternion_inverse_f32.c @@ -49,7 +49,6 @@ @param[in] pInputQuaternions points to the input vector of quaternions @param[out] pInverseQuaternions points to the output vector of inverse quaternions @param[in] nbQuaternions number of quaternions in each vector - @return none */ diff --git a/Source/QuaternionMathFunctions/arm_quaternion_norm_f32.c b/Source/QuaternionMathFunctions/arm_quaternion_norm_f32.c index d9b92e1bc..d56651048 100755 --- a/Source/QuaternionMathFunctions/arm_quaternion_norm_f32.c +++ b/Source/QuaternionMathFunctions/arm_quaternion_norm_f32.c @@ -49,7 +49,6 @@ @param[in] pInputQuaternions points to the input vector of quaternions @param[out] pNorms points to the output vector of norms @param[in] nbQuaternions number of quaternions in the input vector - @return none */ diff --git a/Source/QuaternionMathFunctions/arm_quaternion_normalize_f32.c b/Source/QuaternionMathFunctions/arm_quaternion_normalize_f32.c index 0f50c92a6..cbd234fc4 100755 --- a/Source/QuaternionMathFunctions/arm_quaternion_normalize_f32.c +++ b/Source/QuaternionMathFunctions/arm_quaternion_normalize_f32.c @@ -49,7 +49,6 @@ @param[in] pInputQuaternions points to the input vector of quaternions @param[out] pNormalizedQuaternions points to the output vector of normalized quaternions @param[in] nbQuaternions number of quaternions in each vector - @return none */ #if defined(ARM_MATH_MVEF) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/QuaternionMathFunctions/arm_quaternion_product_f32.c b/Source/QuaternionMathFunctions/arm_quaternion_product_f32.c index 83ebf5efa..26c136823 100755 --- a/Source/QuaternionMathFunctions/arm_quaternion_product_f32.c +++ b/Source/QuaternionMathFunctions/arm_quaternion_product_f32.c @@ -60,7 +60,6 @@ @param[in] qb second array of quaternions @param[out] qr elementwise product of quaternions @param[in] nbQuaternions number of quaternions in the array - @return none */ #if defined(ARM_MATH_MVEF) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/QuaternionMathFunctions/arm_quaternion_product_single_f32.c b/Source/QuaternionMathFunctions/arm_quaternion_product_single_f32.c index 96f23e99b..c06e8ae9b 100755 --- a/Source/QuaternionMathFunctions/arm_quaternion_product_single_f32.c +++ b/Source/QuaternionMathFunctions/arm_quaternion_product_single_f32.c @@ -50,7 +50,6 @@ @param[in] qa first quaternion @param[in] qb second quaternion @param[out] qr product of two quaternions - @return none */ #if defined(ARM_MATH_MVEF) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/QuaternionMathFunctions/arm_rotation2quaternion_f32.c b/Source/QuaternionMathFunctions/arm_rotation2quaternion_f32.c index 5d57492b9..a75c3de92 100755 --- a/Source/QuaternionMathFunctions/arm_rotation2quaternion_f32.c +++ b/Source/QuaternionMathFunctions/arm_rotation2quaternion_f32.c @@ -52,7 +52,6 @@ * @param[in] pInputRotations points to an array 3x3 rotation matrix (in row order) * @param[out] pOutputQuaternions points to an array quaternions * @param[in] nbQuaternions number of quaternions in the array - * @return none. * * q and -q are representing the same rotation. This ambiguity must be taken into * account when using the output of this function. diff --git a/Source/SVMFunctions/arm_svm_linear_init_f16.c b/Source/SVMFunctions/arm_svm_linear_init_f16.c index 260177f0c..1b96e513d 100755 --- a/Source/SVMFunctions/arm_svm_linear_init_f16.c +++ b/Source/SVMFunctions/arm_svm_linear_init_f16.c @@ -58,7 +58,6 @@ * @param[in] dualCoefficients Array of dual coefficients * @param[in] supportVectors Array of support vectors * @param[in] classes Array of 2 classes ID - * @return none. * */ diff --git a/Source/SVMFunctions/arm_svm_linear_init_f32.c b/Source/SVMFunctions/arm_svm_linear_init_f32.c index 75395aa9c..e6f64a16e 100755 --- a/Source/SVMFunctions/arm_svm_linear_init_f32.c +++ b/Source/SVMFunctions/arm_svm_linear_init_f32.c @@ -64,7 +64,6 @@ * @param[in] dualCoefficients Array of dual coefficients * @param[in] supportVectors Array of support vectors * @param[in] classes Array of 2 classes ID - * @return none. * */ diff --git a/Source/SVMFunctions/arm_svm_linear_predict_f16.c b/Source/SVMFunctions/arm_svm_linear_predict_f16.c index fe907e5e4..07ddebe2f 100755 --- a/Source/SVMFunctions/arm_svm_linear_predict_f16.c +++ b/Source/SVMFunctions/arm_svm_linear_predict_f16.c @@ -45,7 +45,6 @@ * @param[in] S Pointer to an instance of the linear SVM structure. * @param[in] in Pointer to input vector * @param[out] pResult Decision value - * @return none. * */ #if defined(ARM_MATH_MVE_FLOAT16) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/SVMFunctions/arm_svm_linear_predict_f32.c b/Source/SVMFunctions/arm_svm_linear_predict_f32.c index caf09df07..54a11a336 100755 --- a/Source/SVMFunctions/arm_svm_linear_predict_f32.c +++ b/Source/SVMFunctions/arm_svm_linear_predict_f32.c @@ -42,7 +42,6 @@ * @param[in] S Pointer to an instance of the linear SVM structure. * @param[in] in Pointer to input vector * @param[out] pResult Decision value - * @return none. * */ #if defined(ARM_MATH_MVEF) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/SVMFunctions/arm_svm_polynomial_init_f16.c b/Source/SVMFunctions/arm_svm_polynomial_init_f16.c index 03e7f5ede..10a7f83fb 100755 --- a/Source/SVMFunctions/arm_svm_polynomial_init_f16.c +++ b/Source/SVMFunctions/arm_svm_polynomial_init_f16.c @@ -60,7 +60,6 @@ * @param[in] degree Polynomial degree * @param[in] coef0 coeff0 (scikit-learn terminology) * @param[in] gamma gamma (scikit-learn terminology) - * @return none. * */ diff --git a/Source/SVMFunctions/arm_svm_polynomial_init_f32.c b/Source/SVMFunctions/arm_svm_polynomial_init_f32.c index 7d33cd79c..f764eb549 100755 --- a/Source/SVMFunctions/arm_svm_polynomial_init_f32.c +++ b/Source/SVMFunctions/arm_svm_polynomial_init_f32.c @@ -62,7 +62,6 @@ * @param[in] degree Polynomial degree * @param[in] coef0 coeff0 (scikit-learn terminology) * @param[in] gamma gamma (scikit-learn terminology) - * @return none. * */ diff --git a/Source/SVMFunctions/arm_svm_polynomial_predict_f16.c b/Source/SVMFunctions/arm_svm_polynomial_predict_f16.c index 724f286dc..67779c1c5 100755 --- a/Source/SVMFunctions/arm_svm_polynomial_predict_f16.c +++ b/Source/SVMFunctions/arm_svm_polynomial_predict_f16.c @@ -74,7 +74,6 @@ __STATIC_INLINE float16_t arm_exponent_f16(float16_t x, int32_t nb) * @param[in] S Pointer to an instance of the polynomial SVM structure. * @param[in] in Pointer to input vector * @param[out] pResult Decision value - * @return none. * */ void arm_svm_polynomial_predict_f16( @@ -333,7 +332,6 @@ void arm_svm_polynomial_predict_f16( * @param[in] S Pointer to an instance of the polynomial SVM structure. * @param[in] in Pointer to input vector * @param[out] pResult Decision value - * @return none. * */ void arm_svm_polynomial_predict_f16( diff --git a/Source/SVMFunctions/arm_svm_polynomial_predict_f32.c b/Source/SVMFunctions/arm_svm_polynomial_predict_f32.c index 13b1f84c4..aff86ff46 100755 --- a/Source/SVMFunctions/arm_svm_polynomial_predict_f32.c +++ b/Source/SVMFunctions/arm_svm_polynomial_predict_f32.c @@ -45,7 +45,6 @@ * @param[in] S Pointer to an instance of the polynomial SVM structure. * @param[in] in Pointer to input vector * @param[out] pResult Decision value - * @return none. * */ diff --git a/Source/SVMFunctions/arm_svm_rbf_init_f16.c b/Source/SVMFunctions/arm_svm_rbf_init_f16.c index fe4f8851b..4e64c1616 100755 --- a/Source/SVMFunctions/arm_svm_rbf_init_f16.c +++ b/Source/SVMFunctions/arm_svm_rbf_init_f16.c @@ -59,7 +59,6 @@ * @param[in] supportVectors Array of support vectors * @param[in] classes Array of 2 classes ID * @param[in] gamma gamma (scikit-learn terminology) - * @return none. * */ diff --git a/Source/SVMFunctions/arm_svm_rbf_init_f32.c b/Source/SVMFunctions/arm_svm_rbf_init_f32.c index 77bf28246..2a32cb2fe 100755 --- a/Source/SVMFunctions/arm_svm_rbf_init_f32.c +++ b/Source/SVMFunctions/arm_svm_rbf_init_f32.c @@ -61,7 +61,6 @@ * @param[in] supportVectors Array of support vectors * @param[in] classes Array of 2 classes ID * @param[in] gamma gamma (scikit-learn terminology) - * @return none. * */ diff --git a/Source/SVMFunctions/arm_svm_rbf_predict_f16.c b/Source/SVMFunctions/arm_svm_rbf_predict_f16.c index cfffcbb3b..2d9ec00c4 100755 --- a/Source/SVMFunctions/arm_svm_rbf_predict_f16.c +++ b/Source/SVMFunctions/arm_svm_rbf_predict_f16.c @@ -45,7 +45,6 @@ * @param[in] S Pointer to an instance of the rbf SVM structure. * @param[in] in Pointer to input vector * @param[out] pResult decision value - * @return none. * */ diff --git a/Source/SVMFunctions/arm_svm_rbf_predict_f32.c b/Source/SVMFunctions/arm_svm_rbf_predict_f32.c index bb12e0624..4c111802e 100755 --- a/Source/SVMFunctions/arm_svm_rbf_predict_f32.c +++ b/Source/SVMFunctions/arm_svm_rbf_predict_f32.c @@ -42,7 +42,6 @@ * @param[in] S Pointer to an instance of the rbf SVM structure. * @param[in] in Pointer to input vector * @param[out] pResult decision value - * @return none. * */ diff --git a/Source/SVMFunctions/arm_svm_sigmoid_init_f16.c b/Source/SVMFunctions/arm_svm_sigmoid_init_f16.c index c43379a86..b0b9c4008 100755 --- a/Source/SVMFunctions/arm_svm_sigmoid_init_f16.c +++ b/Source/SVMFunctions/arm_svm_sigmoid_init_f16.c @@ -59,7 +59,6 @@ * @param[in] classes Array of 2 classes ID * @param[in] coef0 coeff0 (scikit-learn terminology) * @param[in] gamma gamma (scikit-learn terminology) - * @return none. * */ diff --git a/Source/SVMFunctions/arm_svm_sigmoid_init_f32.c b/Source/SVMFunctions/arm_svm_sigmoid_init_f32.c index a7f16c289..6a38be951 100755 --- a/Source/SVMFunctions/arm_svm_sigmoid_init_f32.c +++ b/Source/SVMFunctions/arm_svm_sigmoid_init_f32.c @@ -61,7 +61,6 @@ * @param[in] classes Array of 2 classes ID * @param[in] coef0 coeff0 (scikit-learn terminology) * @param[in] gamma gamma (scikit-learn terminology) - * @return none. * */ diff --git a/Source/SVMFunctions/arm_svm_sigmoid_predict_f16.c b/Source/SVMFunctions/arm_svm_sigmoid_predict_f16.c index e2d541fb3..a161c1f6c 100755 --- a/Source/SVMFunctions/arm_svm_sigmoid_predict_f16.c +++ b/Source/SVMFunctions/arm_svm_sigmoid_predict_f16.c @@ -45,7 +45,6 @@ * @param[in] S Pointer to an instance of the rbf SVM structure. * @param[in] in Pointer to input vector * @param[out] pResult Decision value - * @return none. * */ diff --git a/Source/SVMFunctions/arm_svm_sigmoid_predict_f32.c b/Source/SVMFunctions/arm_svm_sigmoid_predict_f32.c index 37c8a0801..1c93bb874 100755 --- a/Source/SVMFunctions/arm_svm_sigmoid_predict_f32.c +++ b/Source/SVMFunctions/arm_svm_sigmoid_predict_f32.c @@ -42,7 +42,6 @@ * @param[in] S Pointer to an instance of the rbf SVM structure. * @param[in] in Pointer to input vector * @param[out] pResult Decision value - * @return none. * */ diff --git a/Source/StatisticsFunctions/arm_absmax_f16.c b/Source/StatisticsFunctions/arm_absmax_f16.c index 4241eb5db..07f5ac391 100755 --- a/Source/StatisticsFunctions/arm_absmax_f16.c +++ b/Source/StatisticsFunctions/arm_absmax_f16.c @@ -50,7 +50,6 @@ @param[in] blockSize number of samples in input vector @param[out] pResult maximum value returned here @param[out] pIndex index of maximum value returned here - @return none */ #if defined(ARM_MATH_MVE_FLOAT16) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/StatisticsFunctions/arm_absmax_f32.c b/Source/StatisticsFunctions/arm_absmax_f32.c index a571ae0d7..243c601e2 100755 --- a/Source/StatisticsFunctions/arm_absmax_f32.c +++ b/Source/StatisticsFunctions/arm_absmax_f32.c @@ -54,7 +54,6 @@ @param[in] blockSize number of samples in input vector @param[out] pResult maximum value returned here @param[out] pIndex index of maximum value returned here - @return none */ #if defined(ARM_MATH_MVEF) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/StatisticsFunctions/arm_absmax_f64.c b/Source/StatisticsFunctions/arm_absmax_f64.c index 987c32ca3..fa5b644ed 100644 --- a/Source/StatisticsFunctions/arm_absmax_f64.c +++ b/Source/StatisticsFunctions/arm_absmax_f64.c @@ -43,7 +43,6 @@ @param[in] blockSize number of samples in input vector @param[out] pResult maximum value returned here @param[out] pIndex index of maximum value returned here - @return none */ void arm_absmax_f64( const float64_t * pSrc, diff --git a/Source/StatisticsFunctions/arm_absmax_no_idx_f16.c b/Source/StatisticsFunctions/arm_absmax_no_idx_f16.c index 82820c621..eb6414a5a 100755 --- a/Source/StatisticsFunctions/arm_absmax_no_idx_f16.c +++ b/Source/StatisticsFunctions/arm_absmax_no_idx_f16.c @@ -49,7 +49,6 @@ @param[in] pSrc points to the input vector @param[in] blockSize number of samples in input vector @param[out] pResult maximum value returned here - @return none */ #if defined(ARM_MATH_MVE_FLOAT16) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/StatisticsFunctions/arm_absmax_no_idx_f32.c b/Source/StatisticsFunctions/arm_absmax_no_idx_f32.c index 13d99bab4..3e567250c 100755 --- a/Source/StatisticsFunctions/arm_absmax_no_idx_f32.c +++ b/Source/StatisticsFunctions/arm_absmax_no_idx_f32.c @@ -46,7 +46,6 @@ @param[in] pSrc points to the input vector @param[in] blockSize number of samples in input vector @param[out] pResult maximum value returned here - @return none */ #if defined(ARM_MATH_MVEF) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/StatisticsFunctions/arm_absmax_no_idx_f64.c b/Source/StatisticsFunctions/arm_absmax_no_idx_f64.c index 0890f6025..a64184bea 100755 --- a/Source/StatisticsFunctions/arm_absmax_no_idx_f64.c +++ b/Source/StatisticsFunctions/arm_absmax_no_idx_f64.c @@ -44,7 +44,6 @@ @param[in] pSrc points to the input vector @param[in] blockSize number of samples in input vector @param[out] pResult maximum value returned here - @return none */ #if defined(ARM_MATH_NEON) && defined(__aarch64__) diff --git a/Source/StatisticsFunctions/arm_absmax_no_idx_q15.c b/Source/StatisticsFunctions/arm_absmax_no_idx_q15.c index 89db0f213..950785235 100755 --- a/Source/StatisticsFunctions/arm_absmax_no_idx_q15.c +++ b/Source/StatisticsFunctions/arm_absmax_no_idx_q15.c @@ -42,7 +42,6 @@ @param[in] pSrc points to the input vector @param[in] blockSize number of samples in input vector @param[out] pResult maximum value returned here - @return none */ #if defined(ARM_MATH_MVEI) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/StatisticsFunctions/arm_absmax_no_idx_q31.c b/Source/StatisticsFunctions/arm_absmax_no_idx_q31.c index 0b0f86845..92162575b 100755 --- a/Source/StatisticsFunctions/arm_absmax_no_idx_q31.c +++ b/Source/StatisticsFunctions/arm_absmax_no_idx_q31.c @@ -42,7 +42,6 @@ @param[in] pSrc points to the input vector @param[in] blockSize number of samples in input vector @param[out] pResult maximum value returned here - @return none */ #if defined(ARM_MATH_MVEI) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/StatisticsFunctions/arm_absmax_no_idx_q7.c b/Source/StatisticsFunctions/arm_absmax_no_idx_q7.c index 68480b363..160c3b1f6 100755 --- a/Source/StatisticsFunctions/arm_absmax_no_idx_q7.c +++ b/Source/StatisticsFunctions/arm_absmax_no_idx_q7.c @@ -42,7 +42,6 @@ @param[in] pSrc points to the input vector @param[in] blockSize number of samples in input vector @param[out] pResult maximum value returned here - @return none */ diff --git a/Source/StatisticsFunctions/arm_absmax_q15.c b/Source/StatisticsFunctions/arm_absmax_q15.c index 156a5cf8f..84f94626e 100755 --- a/Source/StatisticsFunctions/arm_absmax_q15.c +++ b/Source/StatisticsFunctions/arm_absmax_q15.c @@ -43,7 +43,6 @@ @param[in] blockSize number of samples in input vector @param[out] pResult maximum value returned here @param[out] pIndex index of maximum value returned here - @return none */ #if defined(ARM_MATH_MVEI) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/StatisticsFunctions/arm_absmax_q31.c b/Source/StatisticsFunctions/arm_absmax_q31.c index 0c85ac6d1..0c4793309 100755 --- a/Source/StatisticsFunctions/arm_absmax_q31.c +++ b/Source/StatisticsFunctions/arm_absmax_q31.c @@ -43,7 +43,6 @@ @param[in] blockSize number of samples in input vector @param[out] pResult maximum value returned here @param[out] pIndex index of maximum value returned here - @return none */ #if defined(ARM_MATH_MVEI) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/StatisticsFunctions/arm_absmax_q7.c b/Source/StatisticsFunctions/arm_absmax_q7.c index f20824758..87cfd5907 100755 --- a/Source/StatisticsFunctions/arm_absmax_q7.c +++ b/Source/StatisticsFunctions/arm_absmax_q7.c @@ -43,7 +43,6 @@ @param[in] blockSize number of samples in input vector @param[out] pResult maximum value returned here @param[out] pIndex index of maximum value returned here - @return none */ #if defined(ARM_MATH_MVE_FLOAT16) && !defined(ARM_MATH_AUTOVECTORIZE) && defined(__CMSIS_GCC_H) diff --git a/Source/StatisticsFunctions/arm_absmin_f16.c b/Source/StatisticsFunctions/arm_absmin_f16.c index 6d2ff503a..d7376efa7 100755 --- a/Source/StatisticsFunctions/arm_absmin_f16.c +++ b/Source/StatisticsFunctions/arm_absmin_f16.c @@ -51,7 +51,6 @@ @param[in] blockSize number of samples in input vector @param[out] pResult minimum value returned here @param[out] pIndex index of minimum value returned here - @return none */ #if defined(ARM_MATH_MVE_FLOAT16) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/StatisticsFunctions/arm_absmin_f32.c b/Source/StatisticsFunctions/arm_absmin_f32.c index 3a963227f..d52d34f8a 100755 --- a/Source/StatisticsFunctions/arm_absmin_f32.c +++ b/Source/StatisticsFunctions/arm_absmin_f32.c @@ -56,7 +56,6 @@ @param[in] blockSize number of samples in input vector @param[out] pResult minimum value returned here @param[out] pIndex index of minimum value returned here - @return none */ #if defined(ARM_MATH_MVEF) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/StatisticsFunctions/arm_absmin_f64.c b/Source/StatisticsFunctions/arm_absmin_f64.c index 7aac9700a..1b61d413f 100644 --- a/Source/StatisticsFunctions/arm_absmin_f64.c +++ b/Source/StatisticsFunctions/arm_absmin_f64.c @@ -43,7 +43,6 @@ @param[in] blockSize number of samples in input vector @param[out] pResult minimum value returned here @param[out] pIndex index of minimum value returned here - @return none */ void arm_absmin_f64( const float64_t * pSrc, diff --git a/Source/StatisticsFunctions/arm_absmin_no_idx_f16.c b/Source/StatisticsFunctions/arm_absmin_no_idx_f16.c index 62e105430..b4882d0c4 100755 --- a/Source/StatisticsFunctions/arm_absmin_no_idx_f16.c +++ b/Source/StatisticsFunctions/arm_absmin_no_idx_f16.c @@ -50,7 +50,6 @@ @param[in] pSrc points to the input vector @param[in] blockSize number of samples in input vector @param[out] pResult minimum value returned here - @return none */ #if defined(ARM_MATH_MVE_FLOAT16) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/StatisticsFunctions/arm_absmin_no_idx_f32.c b/Source/StatisticsFunctions/arm_absmin_no_idx_f32.c index c7108daab..9e19e9e92 100755 --- a/Source/StatisticsFunctions/arm_absmin_no_idx_f32.c +++ b/Source/StatisticsFunctions/arm_absmin_no_idx_f32.c @@ -48,7 +48,6 @@ @param[in] pSrc points to the input vector @param[in] blockSize number of samples in input vector @param[out] pResult minimum value returned here - @return none */ #if defined(ARM_MATH_MVEF) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/StatisticsFunctions/arm_absmin_no_idx_f64.c b/Source/StatisticsFunctions/arm_absmin_no_idx_f64.c index df99d7dfe..9a3b43656 100755 --- a/Source/StatisticsFunctions/arm_absmin_no_idx_f64.c +++ b/Source/StatisticsFunctions/arm_absmin_no_idx_f64.c @@ -42,7 +42,6 @@ @param[in] pSrc points to the input vector @param[in] blockSize number of samples in input vector @param[out] pResult minimum value returned here - @return none */ #if defined(ARM_MATH_NEON) && defined(__aarch64__) diff --git a/Source/StatisticsFunctions/arm_absmin_no_idx_q15.c b/Source/StatisticsFunctions/arm_absmin_no_idx_q15.c index 76a178869..cafec315b 100755 --- a/Source/StatisticsFunctions/arm_absmin_no_idx_q15.c +++ b/Source/StatisticsFunctions/arm_absmin_no_idx_q15.c @@ -43,7 +43,6 @@ @param[in] pSrc points to the input vector @param[in] blockSize number of samples in input vector @param[out] pResult minimum value returned here - @return none */ #if defined(ARM_MATH_MVEI) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/StatisticsFunctions/arm_absmin_no_idx_q31.c b/Source/StatisticsFunctions/arm_absmin_no_idx_q31.c index b52db1728..cf7123907 100755 --- a/Source/StatisticsFunctions/arm_absmin_no_idx_q31.c +++ b/Source/StatisticsFunctions/arm_absmin_no_idx_q31.c @@ -43,7 +43,6 @@ @param[in] pSrc points to the input vector @param[in] blockSize number of samples in input vector @param[out] pResult minimum value returned here - @return none */ #if defined(ARM_MATH_MVEI) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/StatisticsFunctions/arm_absmin_no_idx_q7.c b/Source/StatisticsFunctions/arm_absmin_no_idx_q7.c index f60f113d2..2b5433a89 100755 --- a/Source/StatisticsFunctions/arm_absmin_no_idx_q7.c +++ b/Source/StatisticsFunctions/arm_absmin_no_idx_q7.c @@ -43,7 +43,6 @@ @param[in] pSrc points to the input vector @param[in] blockSize number of samples in input vector @param[out] pResult minimum value returned here - @return none */ #if defined(ARM_MATH_MVEI) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/StatisticsFunctions/arm_absmin_q15.c b/Source/StatisticsFunctions/arm_absmin_q15.c index e4d0704a8..8035419ce 100755 --- a/Source/StatisticsFunctions/arm_absmin_q15.c +++ b/Source/StatisticsFunctions/arm_absmin_q15.c @@ -44,7 +44,6 @@ @param[in] blockSize number of samples in input vector @param[out] pResult minimum value returned here @param[out] pIndex index of minimum value returned here - @return none */ #if defined(ARM_MATH_MVEI) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/StatisticsFunctions/arm_absmin_q31.c b/Source/StatisticsFunctions/arm_absmin_q31.c index 21c769b86..25da61dbc 100755 --- a/Source/StatisticsFunctions/arm_absmin_q31.c +++ b/Source/StatisticsFunctions/arm_absmin_q31.c @@ -44,7 +44,6 @@ @param[in] blockSize number of samples in input vector @param[out] pResult minimum value returned here @param[out] pIndex index of minimum value returned here - @return none */ #if defined(ARM_MATH_MVEI) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/StatisticsFunctions/arm_absmin_q7.c b/Source/StatisticsFunctions/arm_absmin_q7.c index 2889891ee..4024318bf 100755 --- a/Source/StatisticsFunctions/arm_absmin_q7.c +++ b/Source/StatisticsFunctions/arm_absmin_q7.c @@ -44,7 +44,6 @@ @param[in] blockSize number of samples in input vector @param[out] pResult minimum value returned here @param[out] pIndex index of minimum value returned here - @return none */ #if defined(ARM_MATH_MVEI) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/StatisticsFunctions/arm_accumulate_f16.c b/Source/StatisticsFunctions/arm_accumulate_f16.c index 3822b0489..68c54293e 100755 --- a/Source/StatisticsFunctions/arm_accumulate_f16.c +++ b/Source/StatisticsFunctions/arm_accumulate_f16.c @@ -58,7 +58,6 @@ @param[in] pSrc points to the input vector. @param[in] blockSize number of samples in input vector. @param[out] pResult sum of values in input vector. - @return none */ void arm_accumulate_f16( diff --git a/Source/StatisticsFunctions/arm_accumulate_f32.c b/Source/StatisticsFunctions/arm_accumulate_f32.c index 8aca789c4..a7dc59e51 100644 --- a/Source/StatisticsFunctions/arm_accumulate_f32.c +++ b/Source/StatisticsFunctions/arm_accumulate_f32.c @@ -43,7 +43,6 @@ @param[in] pSrc points to the input vector. @param[in] blockSize number of samples in input vector. @param[out] pResult sum of values in input vector. - @return none */ #if defined(ARM_MATH_MVEF) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/StatisticsFunctions/arm_accumulate_f64.c b/Source/StatisticsFunctions/arm_accumulate_f64.c index d319949b5..e1837a3d6 100644 --- a/Source/StatisticsFunctions/arm_accumulate_f64.c +++ b/Source/StatisticsFunctions/arm_accumulate_f64.c @@ -43,7 +43,6 @@ @param[in] pSrc points to the input vector. @param[in] blockSize number of samples in input vector. @param[out] pResult sum of values in input vector. - @return none */ #if defined(ARM_MATH_NEON) && defined(__aarch64__) void arm_accumulate_f64( diff --git a/Source/StatisticsFunctions/arm_max_f16.c b/Source/StatisticsFunctions/arm_max_f16.c index b5017f149..39d74a2c9 100755 --- a/Source/StatisticsFunctions/arm_max_f16.c +++ b/Source/StatisticsFunctions/arm_max_f16.c @@ -50,7 +50,6 @@ @param[in] blockSize number of samples in input vector @param[out] pResult maximum value returned here @param[out] pIndex index of maximum value returned here - @return none */ #if defined(ARM_MATH_MVE_FLOAT16) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/StatisticsFunctions/arm_max_f32.c b/Source/StatisticsFunctions/arm_max_f32.c index d253032f7..7a19d9697 100644 --- a/Source/StatisticsFunctions/arm_max_f32.c +++ b/Source/StatisticsFunctions/arm_max_f32.c @@ -54,7 +54,6 @@ @param[in] blockSize number of samples in input vector @param[out] pResult maximum value returned here @param[out] pIndex index of maximum value returned here - @return none */ #if defined(ARM_MATH_MVEF) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/StatisticsFunctions/arm_max_f64.c b/Source/StatisticsFunctions/arm_max_f64.c index 83612190f..db47a2a1c 100644 --- a/Source/StatisticsFunctions/arm_max_f64.c +++ b/Source/StatisticsFunctions/arm_max_f64.c @@ -43,7 +43,6 @@ @param[in] blockSize number of samples in input vector @param[out] pResult maximum value returned here @param[out] pIndex index of maximum value returned here - @return none */ void arm_max_f64( const float64_t * pSrc, diff --git a/Source/StatisticsFunctions/arm_max_no_idx_f16.c b/Source/StatisticsFunctions/arm_max_no_idx_f16.c index f989f6039..8cf28dfcc 100755 --- a/Source/StatisticsFunctions/arm_max_no_idx_f16.c +++ b/Source/StatisticsFunctions/arm_max_no_idx_f16.c @@ -49,7 +49,6 @@ @param[in] pSrc points to the input vector @param[in] blockSize number of samples in input vector @param[out] pResult maximum value returned here - @return none */ #if defined(ARM_MATH_MVE_FLOAT16) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/StatisticsFunctions/arm_max_no_idx_f32.c b/Source/StatisticsFunctions/arm_max_no_idx_f32.c index 9a2a015a1..31a8fc88c 100755 --- a/Source/StatisticsFunctions/arm_max_no_idx_f32.c +++ b/Source/StatisticsFunctions/arm_max_no_idx_f32.c @@ -46,7 +46,6 @@ @param[in] pSrc points to the input vector @param[in] blockSize number of samples in input vector @param[out] pResult maximum value returned here - @return none */ #if defined(ARM_MATH_MVEF) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/StatisticsFunctions/arm_max_no_idx_f64.c b/Source/StatisticsFunctions/arm_max_no_idx_f64.c index d54a716f7..06f44418e 100644 --- a/Source/StatisticsFunctions/arm_max_no_idx_f64.c +++ b/Source/StatisticsFunctions/arm_max_no_idx_f64.c @@ -43,7 +43,6 @@ @param[in] pSrc points to the input vector @param[in] blockSize number of samples in input vector @param[out] pResult maximum value returned here - @return none */ #if defined(ARM_MATH_NEON) && defined(__aarch64__) void arm_max_no_idx_f64( diff --git a/Source/StatisticsFunctions/arm_max_no_idx_q15.c b/Source/StatisticsFunctions/arm_max_no_idx_q15.c index 2adea1ad7..612d86998 100755 --- a/Source/StatisticsFunctions/arm_max_no_idx_q15.c +++ b/Source/StatisticsFunctions/arm_max_no_idx_q15.c @@ -43,7 +43,6 @@ @param[in] pSrc points to the input vector @param[in] blockSize number of samples in input vector @param[out] pResult maximum value returned here - @return none */ #if defined(ARM_MATH_MVEI) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/StatisticsFunctions/arm_max_no_idx_q31.c b/Source/StatisticsFunctions/arm_max_no_idx_q31.c index 9c7a425c1..2cee4b520 100755 --- a/Source/StatisticsFunctions/arm_max_no_idx_q31.c +++ b/Source/StatisticsFunctions/arm_max_no_idx_q31.c @@ -43,7 +43,6 @@ @param[in] pSrc points to the input vector @param[in] blockSize number of samples in input vector @param[out] pResult maximum value returned here - @return none */ #if defined(ARM_MATH_MVEI) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/StatisticsFunctions/arm_max_no_idx_q7.c b/Source/StatisticsFunctions/arm_max_no_idx_q7.c index a6a61b749..c05bd212d 100755 --- a/Source/StatisticsFunctions/arm_max_no_idx_q7.c +++ b/Source/StatisticsFunctions/arm_max_no_idx_q7.c @@ -43,7 +43,6 @@ @param[in] pSrc points to the input vector @param[in] blockSize number of samples in input vector @param[out] pResult maximum value returned here - @return none */ #if defined(ARM_MATH_MVEI) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/StatisticsFunctions/arm_max_q15.c b/Source/StatisticsFunctions/arm_max_q15.c index 5715e37bd..33255891f 100644 --- a/Source/StatisticsFunctions/arm_max_q15.c +++ b/Source/StatisticsFunctions/arm_max_q15.c @@ -43,7 +43,6 @@ @param[in] blockSize number of samples in input vector @param[out] pResult maximum value returned here @param[out] pIndex index of maximum value returned here - @return none */ #if defined(ARM_MATH_MVEI) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/StatisticsFunctions/arm_max_q31.c b/Source/StatisticsFunctions/arm_max_q31.c index fed900b8f..52b4eb74e 100644 --- a/Source/StatisticsFunctions/arm_max_q31.c +++ b/Source/StatisticsFunctions/arm_max_q31.c @@ -43,7 +43,6 @@ @param[in] blockSize number of samples in input vector @param[out] pResult maximum value returned here @param[out] pIndex index of maximum value returned here - @return none */ #if defined(ARM_MATH_MVEI) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/StatisticsFunctions/arm_max_q7.c b/Source/StatisticsFunctions/arm_max_q7.c index 5deae648a..a363c631c 100644 --- a/Source/StatisticsFunctions/arm_max_q7.c +++ b/Source/StatisticsFunctions/arm_max_q7.c @@ -43,7 +43,6 @@ @param[in] blockSize number of samples in input vector @param[out] pResult maximum value returned here @param[out] pIndex index of maximum value returned here - @return none */ #if defined(ARM_MATH_MVEI) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/StatisticsFunctions/arm_mean_f16.c b/Source/StatisticsFunctions/arm_mean_f16.c index d296482e7..833ac8f0a 100755 --- a/Source/StatisticsFunctions/arm_mean_f16.c +++ b/Source/StatisticsFunctions/arm_mean_f16.c @@ -58,7 +58,6 @@ @param[in] pSrc points to the input vector. @param[in] blockSize number of samples in input vector. @param[out] pResult mean value returned here. - @return none */ #if defined(ARM_MATH_MVE_FLOAT16) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/StatisticsFunctions/arm_mean_f32.c b/Source/StatisticsFunctions/arm_mean_f32.c index dd6d817aa..0241185d2 100644 --- a/Source/StatisticsFunctions/arm_mean_f32.c +++ b/Source/StatisticsFunctions/arm_mean_f32.c @@ -43,7 +43,6 @@ @param[in] pSrc points to the input vector. @param[in] blockSize number of samples in input vector. @param[out] pResult mean value returned here. - @return none */ #if defined(ARM_MATH_MVEF) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/StatisticsFunctions/arm_mean_f64.c b/Source/StatisticsFunctions/arm_mean_f64.c index e2c72daf6..3a05dbfc7 100644 --- a/Source/StatisticsFunctions/arm_mean_f64.c +++ b/Source/StatisticsFunctions/arm_mean_f64.c @@ -43,7 +43,6 @@ @param[in] pSrc points to the input vector. @param[in] blockSize number of samples in input vector. @param[out] pResult mean value returned here. - @return none */ #if defined(ARM_MATH_NEON) && defined(__aarch64__) diff --git a/Source/StatisticsFunctions/arm_mean_q15.c b/Source/StatisticsFunctions/arm_mean_q15.c index 54949a152..60feb202b 100644 --- a/Source/StatisticsFunctions/arm_mean_q15.c +++ b/Source/StatisticsFunctions/arm_mean_q15.c @@ -42,7 +42,6 @@ @param[in] pSrc points to the input vector @param[in] blockSize number of samples in input vector @param[out] pResult mean value returned here - @return none @par Scaling and Overflow Behavior The function is implemented using a 32-bit internal accumulator. diff --git a/Source/StatisticsFunctions/arm_mean_q31.c b/Source/StatisticsFunctions/arm_mean_q31.c index 17a3da4b9..650874154 100644 --- a/Source/StatisticsFunctions/arm_mean_q31.c +++ b/Source/StatisticsFunctions/arm_mean_q31.c @@ -42,7 +42,6 @@ @param[in] pSrc points to the input vector @param[in] blockSize number of samples in input vector @param[out] pResult mean value returned here - @return none @par Scaling and Overflow Behavior The function is implemented using a 64-bit internal accumulator. diff --git a/Source/StatisticsFunctions/arm_mean_q7.c b/Source/StatisticsFunctions/arm_mean_q7.c index f0701eba6..b12de30c0 100644 --- a/Source/StatisticsFunctions/arm_mean_q7.c +++ b/Source/StatisticsFunctions/arm_mean_q7.c @@ -42,7 +42,6 @@ @param[in] pSrc points to the input vector @param[in] blockSize number of samples in input vector @param[out] pResult mean value returned here - @return none @par Scaling and Overflow Behavior The function is implemented using a 32-bit internal accumulator. diff --git a/Source/StatisticsFunctions/arm_min_f16.c b/Source/StatisticsFunctions/arm_min_f16.c index 3ff9db4f9..5fcc03335 100755 --- a/Source/StatisticsFunctions/arm_min_f16.c +++ b/Source/StatisticsFunctions/arm_min_f16.c @@ -51,7 +51,6 @@ @param[in] blockSize number of samples in input vector @param[out] pResult minimum value returned here @param[out] pIndex index of minimum value returned here - @return none */ #if defined(ARM_MATH_MVE_FLOAT16) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/StatisticsFunctions/arm_min_f32.c b/Source/StatisticsFunctions/arm_min_f32.c index a5229eca4..0708d7ecc 100644 --- a/Source/StatisticsFunctions/arm_min_f32.c +++ b/Source/StatisticsFunctions/arm_min_f32.c @@ -56,7 +56,6 @@ @param[in] blockSize number of samples in input vector @param[out] pResult minimum value returned here @param[out] pIndex index of minimum value returned here - @return none */ #if defined(ARM_MATH_MVEF) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/StatisticsFunctions/arm_min_f64.c b/Source/StatisticsFunctions/arm_min_f64.c index ef25f9201..42bf68844 100644 --- a/Source/StatisticsFunctions/arm_min_f64.c +++ b/Source/StatisticsFunctions/arm_min_f64.c @@ -43,7 +43,6 @@ @param[in] blockSize number of samples in input vector @param[out] pResult minimum value returned here @param[out] pIndex index of minimum value returned here - @return none */ void arm_min_f64( const float64_t * pSrc, diff --git a/Source/StatisticsFunctions/arm_min_no_idx_f16.c b/Source/StatisticsFunctions/arm_min_no_idx_f16.c index 5b4c0d665..0351dd708 100755 --- a/Source/StatisticsFunctions/arm_min_no_idx_f16.c +++ b/Source/StatisticsFunctions/arm_min_no_idx_f16.c @@ -49,7 +49,6 @@ @param[in] pSrc points to the input vector @param[in] blockSize number of samples in input vector @param[out] pResult minimum value returned here - @return none */ #if defined(ARM_MATH_MVE_FLOAT16) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/StatisticsFunctions/arm_min_no_idx_f32.c b/Source/StatisticsFunctions/arm_min_no_idx_f32.c index ea7c137d6..29d1f57d3 100755 --- a/Source/StatisticsFunctions/arm_min_no_idx_f32.c +++ b/Source/StatisticsFunctions/arm_min_no_idx_f32.c @@ -46,7 +46,6 @@ @param[in] pSrc points to the input vector @param[in] blockSize number of samples in input vector @param[out] pResult minimum value returned here - @return none */ #if defined(ARM_MATH_MVEF) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/StatisticsFunctions/arm_min_no_idx_f64.c b/Source/StatisticsFunctions/arm_min_no_idx_f64.c index fc016e6c7..c269c216f 100755 --- a/Source/StatisticsFunctions/arm_min_no_idx_f64.c +++ b/Source/StatisticsFunctions/arm_min_no_idx_f64.c @@ -43,7 +43,6 @@ @param[in] pSrc points to the input vector @param[in] blockSize number of samples in input vector @param[out] pResult minimum value returned here - @return none */ void arm_min_no_idx_f64( const float64_t *pSrc, diff --git a/Source/StatisticsFunctions/arm_min_no_idx_q15.c b/Source/StatisticsFunctions/arm_min_no_idx_q15.c index 207f9ea96..f8d0f610e 100755 --- a/Source/StatisticsFunctions/arm_min_no_idx_q15.c +++ b/Source/StatisticsFunctions/arm_min_no_idx_q15.c @@ -43,7 +43,6 @@ @param[in] pSrc points to the input vector @param[in] blockSize number of samples in input vector @param[out] pResult minimum value returned here - @return none */ #if defined(ARM_MATH_MVEI) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/StatisticsFunctions/arm_min_no_idx_q31.c b/Source/StatisticsFunctions/arm_min_no_idx_q31.c index e425db4f7..585a15c4c 100755 --- a/Source/StatisticsFunctions/arm_min_no_idx_q31.c +++ b/Source/StatisticsFunctions/arm_min_no_idx_q31.c @@ -43,7 +43,6 @@ @param[in] pSrc points to the input vector @param[in] blockSize number of samples in input vector @param[out] pResult minimum value returned here - @return none */ #if defined(ARM_MATH_MVEI) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/StatisticsFunctions/arm_min_no_idx_q7.c b/Source/StatisticsFunctions/arm_min_no_idx_q7.c index 2ee9a9948..7799495c4 100755 --- a/Source/StatisticsFunctions/arm_min_no_idx_q7.c +++ b/Source/StatisticsFunctions/arm_min_no_idx_q7.c @@ -43,7 +43,6 @@ @param[in] pSrc points to the input vector @param[in] blockSize number of samples in input vector @param[out] pResult minimum value returned here - @return none */ #if defined(ARM_MATH_MVEI) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/StatisticsFunctions/arm_min_q15.c b/Source/StatisticsFunctions/arm_min_q15.c index f31019dbc..2fe387695 100644 --- a/Source/StatisticsFunctions/arm_min_q15.c +++ b/Source/StatisticsFunctions/arm_min_q15.c @@ -44,7 +44,6 @@ @param[in] blockSize number of samples in input vector @param[out] pResult minimum value returned here @param[out] pIndex index of minimum value returned here - @return none */ #if defined(ARM_MATH_MVEI) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/StatisticsFunctions/arm_min_q31.c b/Source/StatisticsFunctions/arm_min_q31.c index c993004cb..187ce7116 100644 --- a/Source/StatisticsFunctions/arm_min_q31.c +++ b/Source/StatisticsFunctions/arm_min_q31.c @@ -44,7 +44,6 @@ @param[in] blockSize number of samples in input vector @param[out] pResult minimum value returned here @param[out] pIndex index of minimum value returned here - @return none */ #if defined(ARM_MATH_MVEI) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/StatisticsFunctions/arm_min_q7.c b/Source/StatisticsFunctions/arm_min_q7.c index 3e5aae536..be4d9c631 100644 --- a/Source/StatisticsFunctions/arm_min_q7.c +++ b/Source/StatisticsFunctions/arm_min_q7.c @@ -44,7 +44,6 @@ @param[in] blockSize number of samples in input vector @param[out] pResult minimum value returned here @param[out] pIndex index of minimum value returned here - @return none */ #if defined(ARM_MATH_MVEI) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/StatisticsFunctions/arm_mse_f16.c b/Source/StatisticsFunctions/arm_mse_f16.c index 3b192dd62..777edbd86 100755 --- a/Source/StatisticsFunctions/arm_mse_f16.c +++ b/Source/StatisticsFunctions/arm_mse_f16.c @@ -43,7 +43,6 @@ @param[in] pSrcB points to the second input vector @param[in] blockSize number of samples in input vector @param[out] result mean square error - @return none */ #if !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/StatisticsFunctions/arm_mse_f32.c b/Source/StatisticsFunctions/arm_mse_f32.c index 1a790cf9f..fab632a04 100755 --- a/Source/StatisticsFunctions/arm_mse_f32.c +++ b/Source/StatisticsFunctions/arm_mse_f32.c @@ -43,7 +43,6 @@ @param[in] pSrcB points to the second input vector @param[in] blockSize number of samples in input vector @param[out] pResult mean square error - @return none */ #if !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/StatisticsFunctions/arm_mse_f64.c b/Source/StatisticsFunctions/arm_mse_f64.c index 8937de735..108902df8 100755 --- a/Source/StatisticsFunctions/arm_mse_f64.c +++ b/Source/StatisticsFunctions/arm_mse_f64.c @@ -43,7 +43,6 @@ @param[in] pSrcB points to the second input vector @param[in] blockSize number of samples in input vector @param[out] pResult mean square error - @return none */ void arm_mse_f64( diff --git a/Source/StatisticsFunctions/arm_mse_q15.c b/Source/StatisticsFunctions/arm_mse_q15.c index 9e6f0c037..85d427903 100755 --- a/Source/StatisticsFunctions/arm_mse_q15.c +++ b/Source/StatisticsFunctions/arm_mse_q15.c @@ -44,7 +44,6 @@ @param[in] pSrcB points to the second input vector @param[in] blockSize number of samples in input vector @param[out] pResult mean square error - @return none */ #if defined(ARM_MATH_MVEI) && !defined(ARM_MATH_AUTOVECTORIZE) void arm_mse_q15( diff --git a/Source/StatisticsFunctions/arm_mse_q31.c b/Source/StatisticsFunctions/arm_mse_q31.c index e44440408..d09a81bc0 100755 --- a/Source/StatisticsFunctions/arm_mse_q31.c +++ b/Source/StatisticsFunctions/arm_mse_q31.c @@ -44,7 +44,6 @@ @param[in] pSrcB points to the second input vector @param[in] blockSize number of samples in input vector @param[out] pResult mean square error - @return none */ #if defined(ARM_MATH_MVEI) && !defined(ARM_MATH_AUTOVECTORIZE) void arm_mse_q31( diff --git a/Source/StatisticsFunctions/arm_mse_q7.c b/Source/StatisticsFunctions/arm_mse_q7.c index 298e9daf9..70377ffc7 100755 --- a/Source/StatisticsFunctions/arm_mse_q7.c +++ b/Source/StatisticsFunctions/arm_mse_q7.c @@ -50,7 +50,6 @@ @param[in] pSrcB points to the second input vector @param[in] blockSize number of samples in input vector @param[out] pResult mean square error - @return none */ #if defined(ARM_MATH_MVEI) && !defined(ARM_MATH_AUTOVECTORIZE) void arm_mse_q7( diff --git a/Source/StatisticsFunctions/arm_power_f16.c b/Source/StatisticsFunctions/arm_power_f16.c index fd135ebff..70e3216fc 100755 --- a/Source/StatisticsFunctions/arm_power_f16.c +++ b/Source/StatisticsFunctions/arm_power_f16.c @@ -47,7 +47,6 @@ @param[in] pSrc points to the input vector @param[in] blockSize number of samples in input vector @param[out] pResult sum of the squares value returned here - @return none */ #if defined(ARM_MATH_MVE_FLOAT16) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/StatisticsFunctions/arm_power_f32.c b/Source/StatisticsFunctions/arm_power_f32.c index ce12e57e9..73499f0bc 100644 --- a/Source/StatisticsFunctions/arm_power_f32.c +++ b/Source/StatisticsFunctions/arm_power_f32.c @@ -59,7 +59,6 @@ @param[in] pSrc points to the input vector @param[in] blockSize number of samples in input vector @param[out] pResult sum of the squares value returned here - @return none */ #if defined(ARM_MATH_MVEF) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/StatisticsFunctions/arm_power_f64.c b/Source/StatisticsFunctions/arm_power_f64.c index ac2a2cd2b..52616a817 100644 --- a/Source/StatisticsFunctions/arm_power_f64.c +++ b/Source/StatisticsFunctions/arm_power_f64.c @@ -42,7 +42,6 @@ @param[in] pSrc points to the input vector @param[in] blockSize number of samples in input vector @param[out] pResult sum of the squares value returned here - @return none */ #if defined(ARM_MATH_NEON) && defined(__aarch64__) void arm_power_f64( diff --git a/Source/StatisticsFunctions/arm_power_q15.c b/Source/StatisticsFunctions/arm_power_q15.c index 2c47f0b13..84f08f695 100644 --- a/Source/StatisticsFunctions/arm_power_q15.c +++ b/Source/StatisticsFunctions/arm_power_q15.c @@ -42,7 +42,6 @@ @param[in] pSrc points to the input vector @param[in] blockSize number of samples in input vector @param[out] pResult sum of the squares value returned here - @return none @par Scaling and Overflow Behavior The function is implemented using a 64-bit internal accumulator. diff --git a/Source/StatisticsFunctions/arm_power_q31.c b/Source/StatisticsFunctions/arm_power_q31.c index a39b3a709..9d02076b8 100644 --- a/Source/StatisticsFunctions/arm_power_q31.c +++ b/Source/StatisticsFunctions/arm_power_q31.c @@ -42,7 +42,6 @@ @param[in] pSrc points to the input vector @param[in] blockSize number of samples in input vector @param[out] pResult sum of the squares value returned here - @return none @par Scaling and Overflow Behavior The function is implemented using a 64-bit internal accumulator. diff --git a/Source/StatisticsFunctions/arm_power_q7.c b/Source/StatisticsFunctions/arm_power_q7.c index 0545f7c2c..10b8b4bf5 100644 --- a/Source/StatisticsFunctions/arm_power_q7.c +++ b/Source/StatisticsFunctions/arm_power_q7.c @@ -42,7 +42,6 @@ @param[in] pSrc points to the input vector @param[in] blockSize number of samples in input vector @param[out] pResult sum of the squares value returned here - @return none @par Scaling and Overflow Behavior The function is implemented using a 32-bit internal accumulator. diff --git a/Source/StatisticsFunctions/arm_rms_f16.c b/Source/StatisticsFunctions/arm_rms_f16.c index 1c2ea6973..26b289fd9 100755 --- a/Source/StatisticsFunctions/arm_rms_f16.c +++ b/Source/StatisticsFunctions/arm_rms_f16.c @@ -47,7 +47,6 @@ @param[in] pSrc points to the input vector @param[in] blockSize number of samples in input vector @param[out] pResult root mean square value returned here - @return none */ #if defined(ARM_MATH_MVE_FLOAT16) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/StatisticsFunctions/arm_rms_f32.c b/Source/StatisticsFunctions/arm_rms_f32.c index cb45752bc..f9c75c9be 100644 --- a/Source/StatisticsFunctions/arm_rms_f32.c +++ b/Source/StatisticsFunctions/arm_rms_f32.c @@ -55,7 +55,6 @@ @param[in] pSrc points to the input vector @param[in] blockSize number of samples in input vector @param[out] pResult root mean square value returned here - @return none */ #if defined(ARM_MATH_MVEF) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/StatisticsFunctions/arm_rms_q15.c b/Source/StatisticsFunctions/arm_rms_q15.c index 1df17b1e1..0bf8169b4 100644 --- a/Source/StatisticsFunctions/arm_rms_q15.c +++ b/Source/StatisticsFunctions/arm_rms_q15.c @@ -42,7 +42,6 @@ @param[in] pSrc points to the input vector @param[in] blockSize number of samples in input vector @param[out] pResult root mean square value returned here - @return none @par Scaling and Overflow Behavior The function is implemented using a 64-bit internal accumulator. diff --git a/Source/StatisticsFunctions/arm_rms_q31.c b/Source/StatisticsFunctions/arm_rms_q31.c index ba39b7b72..364c164a5 100644 --- a/Source/StatisticsFunctions/arm_rms_q31.c +++ b/Source/StatisticsFunctions/arm_rms_q31.c @@ -42,7 +42,6 @@ @param[in] pSrc points to the input vector @param[in] blockSize number of samples in input vector @param[out] pResult root mean square value returned here - @return none @par Scaling and Overflow Behavior The function is implemented using an internal 64-bit accumulator. diff --git a/Source/StatisticsFunctions/arm_std_f16.c b/Source/StatisticsFunctions/arm_std_f16.c index 951d16510..be0a77942 100755 --- a/Source/StatisticsFunctions/arm_std_f16.c +++ b/Source/StatisticsFunctions/arm_std_f16.c @@ -47,7 +47,6 @@ @param[in] pSrc points to the input vector @param[in] blockSize number of samples in input vector @param[out] pResult standard deviation value returned here - @return none */ void arm_std_f16( const float16_t * pSrc, diff --git a/Source/StatisticsFunctions/arm_std_f32.c b/Source/StatisticsFunctions/arm_std_f32.c index 682443d91..05438a0dc 100644 --- a/Source/StatisticsFunctions/arm_std_f32.c +++ b/Source/StatisticsFunctions/arm_std_f32.c @@ -66,7 +66,6 @@ @param[in] pSrc points to the input vector @param[in] blockSize number of samples in input vector @param[out] pResult standard deviation value returned here - @return none */ void arm_std_f32( const float32_t * pSrc, diff --git a/Source/StatisticsFunctions/arm_std_f64.c b/Source/StatisticsFunctions/arm_std_f64.c index 620ec048f..fdc7c610d 100644 --- a/Source/StatisticsFunctions/arm_std_f64.c +++ b/Source/StatisticsFunctions/arm_std_f64.c @@ -42,7 +42,6 @@ @param[in] pSrc points to the input vector @param[in] blockSize number of samples in input vector @param[out] pResult standard deviation value returned here - @return none */ void arm_std_f64( const float64_t * pSrc, diff --git a/Source/StatisticsFunctions/arm_std_q15.c b/Source/StatisticsFunctions/arm_std_q15.c index 88e273aa4..a94a3e12e 100644 --- a/Source/StatisticsFunctions/arm_std_q15.c +++ b/Source/StatisticsFunctions/arm_std_q15.c @@ -42,7 +42,6 @@ @param[in] pSrc points to the input vector @param[in] blockSize number of samples in input vector @param[out] pResult standard deviation value returned here - @return none @par Scaling and Overflow Behavior The function is implemented using a 64-bit internal accumulator. diff --git a/Source/StatisticsFunctions/arm_std_q31.c b/Source/StatisticsFunctions/arm_std_q31.c index 63170e798..8ac868d51 100644 --- a/Source/StatisticsFunctions/arm_std_q31.c +++ b/Source/StatisticsFunctions/arm_std_q31.c @@ -42,7 +42,6 @@ @param[in] pSrc points to the input vector. @param[in] blockSize number of samples in input vector. @param[out] pResult standard deviation value returned here. - @return none @par Scaling and Overflow Behavior The function is implemented using an internal 64-bit accumulator. diff --git a/Source/StatisticsFunctions/arm_var_f16.c b/Source/StatisticsFunctions/arm_var_f16.c index 0e3ade599..a40dce95d 100755 --- a/Source/StatisticsFunctions/arm_var_f16.c +++ b/Source/StatisticsFunctions/arm_var_f16.c @@ -47,7 +47,6 @@ @param[in] pSrc points to the input vector @param[in] blockSize number of samples in input vector @param[out] pResult variance value returned here - @return none */ #if defined(ARM_MATH_MVE_FLOAT16) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/StatisticsFunctions/arm_var_f32.c b/Source/StatisticsFunctions/arm_var_f32.c index 7ff344c7c..e6cd45f45 100644 --- a/Source/StatisticsFunctions/arm_var_f32.c +++ b/Source/StatisticsFunctions/arm_var_f32.c @@ -57,7 +57,6 @@ @param[in] pSrc points to the input vector @param[in] blockSize number of samples in input vector @param[out] pResult variance value returned here - @return none */ #if defined(ARM_MATH_MVEF) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/StatisticsFunctions/arm_var_f64.c b/Source/StatisticsFunctions/arm_var_f64.c index 499b5b011..f1538ef6b 100644 --- a/Source/StatisticsFunctions/arm_var_f64.c +++ b/Source/StatisticsFunctions/arm_var_f64.c @@ -42,7 +42,6 @@ @param[in] pSrc points to the input vector @param[in] blockSize number of samples in input vector @param[out] pResult variance value returned here - @return none */ void arm_var_f64( const float64_t * pSrc, diff --git a/Source/StatisticsFunctions/arm_var_q15.c b/Source/StatisticsFunctions/arm_var_q15.c index 467d54712..bba78963c 100644 --- a/Source/StatisticsFunctions/arm_var_q15.c +++ b/Source/StatisticsFunctions/arm_var_q15.c @@ -42,7 +42,6 @@ @param[in] pSrc points to the input vector @param[in] blockSize number of samples in input vector @param[out] pResult variance value returned here - @return none @par Scaling and Overflow Behavior The function is implemented using a 64-bit internal accumulator. diff --git a/Source/StatisticsFunctions/arm_var_q31.c b/Source/StatisticsFunctions/arm_var_q31.c index 45b6b66b4..2a0b8448e 100644 --- a/Source/StatisticsFunctions/arm_var_q31.c +++ b/Source/StatisticsFunctions/arm_var_q31.c @@ -42,7 +42,6 @@ @param[in] pSrc points to the input vector @param[in] blockSize number of samples in input vector @param[out] pResult variance value returned here - @return none @par Scaling and Overflow Behavior The function is implemented using an internal 64-bit accumulator. diff --git a/Source/SupportFunctions/arm_barycenter_f16.c b/Source/SupportFunctions/arm_barycenter_f16.c index 6dfe55c9e..6fc6622aa 100755 --- a/Source/SupportFunctions/arm_barycenter_f16.c +++ b/Source/SupportFunctions/arm_barycenter_f16.c @@ -58,7 +58,6 @@ * @param[out] *out Barycenter * @param[in] nbVectors Number of vectors * @param[in] vecDim Dimension of space (vector dimension) - * @return None * */ diff --git a/Source/SupportFunctions/arm_barycenter_f32.c b/Source/SupportFunctions/arm_barycenter_f32.c index 586fb397e..18eb52de7 100755 --- a/Source/SupportFunctions/arm_barycenter_f32.c +++ b/Source/SupportFunctions/arm_barycenter_f32.c @@ -46,7 +46,6 @@ * @param[out] *out Barycenter * @param[in] nbVectors Number of vectors * @param[in] vecDim Dimension of space (vector dimension) - * @return None * */ diff --git a/Source/SupportFunctions/arm_copy_f16.c b/Source/SupportFunctions/arm_copy_f16.c index d441332a8..7e8e659ba 100755 --- a/Source/SupportFunctions/arm_copy_f16.c +++ b/Source/SupportFunctions/arm_copy_f16.c @@ -46,7 +46,6 @@ @param[in] pSrc points to input vector @param[out] pDst points to output vector @param[in] blockSize number of samples in each vector - @return none */ #if defined(ARM_MATH_MVE_FLOAT16) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/SupportFunctions/arm_copy_f32.c b/Source/SupportFunctions/arm_copy_f32.c index d739f7cb5..44eef331c 100644 --- a/Source/SupportFunctions/arm_copy_f32.c +++ b/Source/SupportFunctions/arm_copy_f32.c @@ -54,7 +54,6 @@ @param[in] pSrc points to input vector @param[out] pDst points to output vector @param[in] blockSize number of samples in each vector - @return none */ #if defined(ARM_MATH_MVEF) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/SupportFunctions/arm_copy_f64.c b/Source/SupportFunctions/arm_copy_f64.c index ec1df54f6..c9312781f 100644 --- a/Source/SupportFunctions/arm_copy_f64.c +++ b/Source/SupportFunctions/arm_copy_f64.c @@ -42,7 +42,6 @@ @param[in] pSrc points to input vector @param[out] pDst points to output vector @param[in] blockSize number of samples in each vector - @return none */ void arm_copy_f64( const float64_t * pSrc, diff --git a/Source/SupportFunctions/arm_copy_q15.c b/Source/SupportFunctions/arm_copy_q15.c index 18f338762..19e593e36 100644 --- a/Source/SupportFunctions/arm_copy_q15.c +++ b/Source/SupportFunctions/arm_copy_q15.c @@ -42,7 +42,6 @@ @param[in] pSrc points to input vector @param[out] pDst points to output vector @param[in] blockSize number of samples in each vector - @return none */ #if defined(ARM_MATH_MVEI) && !defined(ARM_MATH_AUTOVECTORIZE) void arm_copy_q15( diff --git a/Source/SupportFunctions/arm_copy_q31.c b/Source/SupportFunctions/arm_copy_q31.c index 8e06bdac0..dba1a1b40 100644 --- a/Source/SupportFunctions/arm_copy_q31.c +++ b/Source/SupportFunctions/arm_copy_q31.c @@ -42,7 +42,6 @@ @param[in] pSrc points to input vector @param[out] pDst points to output vector @param[in] blockSize number of samples in each vector - @return none */ #if defined(ARM_MATH_MVEI) && !defined(ARM_MATH_AUTOVECTORIZE) void arm_copy_q31( diff --git a/Source/SupportFunctions/arm_copy_q7.c b/Source/SupportFunctions/arm_copy_q7.c index 1918d3e41..2647e521c 100644 --- a/Source/SupportFunctions/arm_copy_q7.c +++ b/Source/SupportFunctions/arm_copy_q7.c @@ -42,7 +42,6 @@ @param[in] pSrc points to input vector @param[out] pDst points to output vector @param[in] blockSize number of samples in each vector - @return none */ #if defined(ARM_MATH_MVEI) && !defined(ARM_MATH_AUTOVECTORIZE) void arm_copy_q7( diff --git a/Source/SupportFunctions/arm_f16_to_f64.c b/Source/SupportFunctions/arm_f16_to_f64.c index d27da5736..23d0973ce 100644 --- a/Source/SupportFunctions/arm_f16_to_f64.c +++ b/Source/SupportFunctions/arm_f16_to_f64.c @@ -44,7 +44,6 @@ @param[in] pSrc points to the f16 input vector @param[out] pDst points to the f64 output vector @param[in] blockSize number of samples in each vector - @return none */ diff --git a/Source/SupportFunctions/arm_f16_to_float.c b/Source/SupportFunctions/arm_f16_to_float.c index a00435394..f9b609693 100755 --- a/Source/SupportFunctions/arm_f16_to_float.c +++ b/Source/SupportFunctions/arm_f16_to_float.c @@ -49,7 +49,6 @@ @param[in] pSrc points to the f16 input vector @param[out] pDst points to the f32 output vector @param[in] blockSize number of samples in each vector - @return none */ diff --git a/Source/SupportFunctions/arm_f16_to_q15.c b/Source/SupportFunctions/arm_f16_to_q15.c index 4f32ca5f9..8ecd4763b 100755 --- a/Source/SupportFunctions/arm_f16_to_q15.c +++ b/Source/SupportFunctions/arm_f16_to_q15.c @@ -45,7 +45,6 @@ @param[in] pSrc points to the f16 input vector @param[out] pDst points to the Q15 output vector @param[in] blockSize number of samples in each vector - @return none @par Details The equation used for the conversion process is: diff --git a/Source/SupportFunctions/arm_f64_to_f16.c b/Source/SupportFunctions/arm_f64_to_f16.c index b4622f520..6169e6c33 100644 --- a/Source/SupportFunctions/arm_f64_to_f16.c +++ b/Source/SupportFunctions/arm_f64_to_f16.c @@ -48,7 +48,6 @@ @param[in] pSrc points to the f64 input vector @param[out] pDst points to the f16 output vector @param[in] blockSize number of samples in each vector - @return none */ diff --git a/Source/SupportFunctions/arm_f64_to_float.c b/Source/SupportFunctions/arm_f64_to_float.c index 945151ec6..0266352f4 100644 --- a/Source/SupportFunctions/arm_f64_to_float.c +++ b/Source/SupportFunctions/arm_f64_to_float.c @@ -43,7 +43,6 @@ @param[in] pSrc points to the f64 input vector @param[out] pDst points to the f32 output vector @param[in] blockSize number of samples in each vector - @return none */ diff --git a/Source/SupportFunctions/arm_f64_to_q15.c b/Source/SupportFunctions/arm_f64_to_q15.c index 80fc12e4d..f08067205 100644 --- a/Source/SupportFunctions/arm_f64_to_q15.c +++ b/Source/SupportFunctions/arm_f64_to_q15.c @@ -42,7 +42,6 @@ @param[in] pSrc points to the 64 bit floating-point input vector @param[out] pDst points to the Q15 output vector @param[in] blockSize number of samples in each vector - @return none @par Details The equation used for the conversion process is: diff --git a/Source/SupportFunctions/arm_f64_to_q31.c b/Source/SupportFunctions/arm_f64_to_q31.c index 7e4bd77fd..e0b0ffdb3 100644 --- a/Source/SupportFunctions/arm_f64_to_q31.c +++ b/Source/SupportFunctions/arm_f64_to_q31.c @@ -43,7 +43,6 @@ @param[in] pSrc points to the 64 bit floating-point input vector @param[out] pDst points to the Q31 output vector @param[in] blockSize number of samples in each vector - @return none @par Details The equation used for the conversion process is: diff --git a/Source/SupportFunctions/arm_f64_to_q7.c b/Source/SupportFunctions/arm_f64_to_q7.c index 36d756106..f9f060ddd 100644 --- a/Source/SupportFunctions/arm_f64_to_q7.c +++ b/Source/SupportFunctions/arm_f64_to_q7.c @@ -42,7 +42,6 @@ * @param[in] *pSrc points to the 64 bit floating-point input vector * @param[out] *pDst points to the Q7 output vector * @param[in] blockSize length of the input vector - * @return none. * *\par Description: * \par diff --git a/Source/SupportFunctions/arm_fill_f16.c b/Source/SupportFunctions/arm_fill_f16.c index 0b08f12c9..2ccd268b0 100755 --- a/Source/SupportFunctions/arm_fill_f16.c +++ b/Source/SupportFunctions/arm_fill_f16.c @@ -46,7 +46,6 @@ @param[in] value input value to be filled @param[out] pDst points to output vector @param[in] blockSize number of samples in each vector - @return none */ #if defined(ARM_MATH_MVE_FLOAT16) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/SupportFunctions/arm_fill_f32.c b/Source/SupportFunctions/arm_fill_f32.c index 50cdd8fc7..fb355ff51 100644 --- a/Source/SupportFunctions/arm_fill_f32.c +++ b/Source/SupportFunctions/arm_fill_f32.c @@ -54,7 +54,6 @@ @param[in] value input value to be filled @param[out] pDst points to output vector @param[in] blockSize number of samples in each vector - @return none */ #if defined(ARM_MATH_MVEF) && !defined(ARM_MATH_AUTOVECTORIZE) void arm_fill_f32( diff --git a/Source/SupportFunctions/arm_fill_f64.c b/Source/SupportFunctions/arm_fill_f64.c index 4bc2700d9..0283faa89 100644 --- a/Source/SupportFunctions/arm_fill_f64.c +++ b/Source/SupportFunctions/arm_fill_f64.c @@ -42,7 +42,6 @@ @param[in] value input value to be filled @param[out] pDst points to output vector @param[in] blockSize number of samples in each vector - @return none */ void arm_fill_f64( float64_t value, diff --git a/Source/SupportFunctions/arm_fill_q15.c b/Source/SupportFunctions/arm_fill_q15.c index 997a728dc..a5c5bbc3e 100644 --- a/Source/SupportFunctions/arm_fill_q15.c +++ b/Source/SupportFunctions/arm_fill_q15.c @@ -42,7 +42,6 @@ @param[in] value input value to be filled @param[out] pDst points to output vector @param[in] blockSize number of samples in each vector - @return none */ #if defined(ARM_MATH_MVEI) && !defined(ARM_MATH_AUTOVECTORIZE) void arm_fill_q15( diff --git a/Source/SupportFunctions/arm_fill_q31.c b/Source/SupportFunctions/arm_fill_q31.c index 7da5fb6ac..06970a5ca 100644 --- a/Source/SupportFunctions/arm_fill_q31.c +++ b/Source/SupportFunctions/arm_fill_q31.c @@ -42,7 +42,6 @@ @param[in] value input value to be filled @param[out] pDst points to output vector @param[in] blockSize number of samples in each vector - @return none */ #if defined(ARM_MATH_MVEI) && !defined(ARM_MATH_AUTOVECTORIZE) void arm_fill_q31( diff --git a/Source/SupportFunctions/arm_fill_q7.c b/Source/SupportFunctions/arm_fill_q7.c index 830fc7324..6cb59edaf 100644 --- a/Source/SupportFunctions/arm_fill_q7.c +++ b/Source/SupportFunctions/arm_fill_q7.c @@ -42,7 +42,6 @@ @param[in] value input value to be filled @param[out] pDst points to output vector @param[in] blockSize number of samples in each vector - @return none */ #if defined(ARM_MATH_MVEI) && !defined(ARM_MATH_AUTOVECTORIZE) void arm_fill_q7( diff --git a/Source/SupportFunctions/arm_float_to_f16.c b/Source/SupportFunctions/arm_float_to_f16.c index d627a8ada..221307cb3 100755 --- a/Source/SupportFunctions/arm_float_to_f16.c +++ b/Source/SupportFunctions/arm_float_to_f16.c @@ -45,8 +45,6 @@ @param[in] pSrc points to the f32 input vector @param[out] pDst points to the f16 output vector @param[in] blockSize number of samples in each vector - @return none - */ #if defined(ARM_MATH_MVE_FLOAT16) && !defined(ARM_MATH_AUTOVECTORIZE) && defined(__CMSIS_GCC_H) diff --git a/Source/SupportFunctions/arm_float_to_f64.c b/Source/SupportFunctions/arm_float_to_f64.c index 08415ca92..ef4822eb8 100644 --- a/Source/SupportFunctions/arm_float_to_f64.c +++ b/Source/SupportFunctions/arm_float_to_f64.c @@ -45,8 +45,6 @@ @param[in] pSrc points to the f32 input vector @param[out] pDst points to the f64 output vector @param[in] blockSize number of samples in each vector - @return none - */ void arm_float_to_f64( diff --git a/Source/SupportFunctions/arm_float_to_q15.c b/Source/SupportFunctions/arm_float_to_q15.c index d8f98e2cb..04d8bad3a 100644 --- a/Source/SupportFunctions/arm_float_to_q15.c +++ b/Source/SupportFunctions/arm_float_to_q15.c @@ -42,7 +42,6 @@ @param[in] pSrc points to the floating-point input vector @param[out] pDst points to the Q15 output vector @param[in] blockSize number of samples in each vector - @return none @par Details The equation used for the conversion process is: diff --git a/Source/SupportFunctions/arm_float_to_q31.c b/Source/SupportFunctions/arm_float_to_q31.c index a222e499c..753de3bc2 100644 --- a/Source/SupportFunctions/arm_float_to_q31.c +++ b/Source/SupportFunctions/arm_float_to_q31.c @@ -46,7 +46,6 @@ @param[in] pSrc points to the floating-point input vector @param[out] pDst points to the Q31 output vector @param[in] blockSize number of samples in each vector - @return none @par Details The equation used for the conversion process is: diff --git a/Source/SupportFunctions/arm_float_to_q7.c b/Source/SupportFunctions/arm_float_to_q7.c index 68102ba81..85c4f1c67 100644 --- a/Source/SupportFunctions/arm_float_to_q7.c +++ b/Source/SupportFunctions/arm_float_to_q7.c @@ -42,7 +42,6 @@ * @param[in] *pSrc points to the floating-point input vector * @param[out] *pDst points to the Q7 output vector * @param[in] blockSize length of the input vector - * @return none. * *\par Description: * \par diff --git a/Source/SupportFunctions/arm_q15_to_f16.c b/Source/SupportFunctions/arm_q15_to_f16.c index 22a7eaaa8..3e32a4d25 100755 --- a/Source/SupportFunctions/arm_q15_to_f16.c +++ b/Source/SupportFunctions/arm_q15_to_f16.c @@ -49,7 +49,6 @@ @param[in] pSrc points to the Q15 input vector @param[out] pDst points to the f16 output vector @param[in] blockSize number of samples in each vector - @return none @par Details The equation used for the conversion process is: diff --git a/Source/SupportFunctions/arm_q15_to_f64.c b/Source/SupportFunctions/arm_q15_to_f64.c index e5ca84cfb..98306a2bd 100644 --- a/Source/SupportFunctions/arm_q15_to_f64.c +++ b/Source/SupportFunctions/arm_q15_to_f64.c @@ -46,7 +46,6 @@ @param[in] pSrc points to the Q15 input vector @param[out] pDst points to the 64 bit floating-point output vector @param[in] blockSize number of samples in each vector - @return none @par Details The equation used for the conversion process is: diff --git a/Source/SupportFunctions/arm_q15_to_float.c b/Source/SupportFunctions/arm_q15_to_float.c index 1a20defea..0043ad5c0 100644 --- a/Source/SupportFunctions/arm_q15_to_float.c +++ b/Source/SupportFunctions/arm_q15_to_float.c @@ -46,7 +46,6 @@ @param[in] pSrc points to the Q15 input vector @param[out] pDst points to the floating-point output vector @param[in] blockSize number of samples in each vector - @return none @par Details The equation used for the conversion process is: diff --git a/Source/SupportFunctions/arm_q15_to_q31.c b/Source/SupportFunctions/arm_q15_to_q31.c index fc3c8681d..c90cabd2b 100644 --- a/Source/SupportFunctions/arm_q15_to_q31.c +++ b/Source/SupportFunctions/arm_q15_to_q31.c @@ -42,7 +42,6 @@ @param[in] pSrc points to the Q15 input vector @param[out] pDst points to the Q31 output vector @param[in] blockSize number of samples in each vector - @return none @par Details The equation used for the conversion process is: diff --git a/Source/SupportFunctions/arm_q15_to_q7.c b/Source/SupportFunctions/arm_q15_to_q7.c index a4303e247..49b2e5fad 100644 --- a/Source/SupportFunctions/arm_q15_to_q7.c +++ b/Source/SupportFunctions/arm_q15_to_q7.c @@ -42,7 +42,6 @@ @param[in] pSrc points to the Q15 input vector @param[out] pDst points to the Q7 output vector @param[in] blockSize number of samples in each vector - @return none @par Details The equation used for the conversion process is: diff --git a/Source/SupportFunctions/arm_q31_to_f64.c b/Source/SupportFunctions/arm_q31_to_f64.c index e5c5dfbad..7bca3840e 100644 --- a/Source/SupportFunctions/arm_q31_to_f64.c +++ b/Source/SupportFunctions/arm_q31_to_f64.c @@ -46,7 +46,6 @@ @param[in] pSrc points to the Q31 input vector @param[out] pDst points to the 64 bit floating-point output vector @param[in] blockSize number of samples in each vector - @return none @par Details The equation used for the conversion process is: diff --git a/Source/SupportFunctions/arm_q31_to_float.c b/Source/SupportFunctions/arm_q31_to_float.c index ce7ce4224..1d0de7788 100644 --- a/Source/SupportFunctions/arm_q31_to_float.c +++ b/Source/SupportFunctions/arm_q31_to_float.c @@ -46,7 +46,6 @@ @param[in] pSrc points to the Q31 input vector @param[out] pDst points to the floating-point output vector @param[in] blockSize number of samples in each vector - @return none @par Details The equation used for the conversion process is: diff --git a/Source/SupportFunctions/arm_q31_to_q15.c b/Source/SupportFunctions/arm_q31_to_q15.c index 7423c167d..160d229f3 100644 --- a/Source/SupportFunctions/arm_q31_to_q15.c +++ b/Source/SupportFunctions/arm_q31_to_q15.c @@ -42,7 +42,6 @@ @param[in] pSrc points to the Q31 input vector @param[out] pDst points to the Q15 output vector @param[in] blockSize number of samples in each vector - @return none @par Details The equation used for the conversion process is: diff --git a/Source/SupportFunctions/arm_q31_to_q7.c b/Source/SupportFunctions/arm_q31_to_q7.c index f07d2f69b..9b6346135 100644 --- a/Source/SupportFunctions/arm_q31_to_q7.c +++ b/Source/SupportFunctions/arm_q31_to_q7.c @@ -42,7 +42,6 @@ @param[in] pSrc points to the Q31 input vector @param[out] pDst points to the Q7 output vector @param[in] blockSize number of samples in each vector - @return none @par Details The equation used for the conversion process is: diff --git a/Source/SupportFunctions/arm_q7_to_f64.c b/Source/SupportFunctions/arm_q7_to_f64.c index 997f8c941..5985f8a4a 100644 --- a/Source/SupportFunctions/arm_q7_to_f64.c +++ b/Source/SupportFunctions/arm_q7_to_f64.c @@ -46,7 +46,6 @@ @param[in] pSrc points to the Q7 input vector @param[out] pDst points to the 64 bit floating-point output vector @param[in] blockSize number of samples in each vector - @return none @par Details The equation used for the conversion process is: diff --git a/Source/SupportFunctions/arm_q7_to_float.c b/Source/SupportFunctions/arm_q7_to_float.c index 9cbf8ad08..0c6db533f 100644 --- a/Source/SupportFunctions/arm_q7_to_float.c +++ b/Source/SupportFunctions/arm_q7_to_float.c @@ -46,7 +46,6 @@ @param[in] pSrc points to the Q7 input vector @param[out] pDst points to the floating-point output vector @param[in] blockSize number of samples in each vector - @return none @par Details The equation used for the conversion process is: diff --git a/Source/SupportFunctions/arm_q7_to_q15.c b/Source/SupportFunctions/arm_q7_to_q15.c index be5253164..54d577fb4 100644 --- a/Source/SupportFunctions/arm_q7_to_q15.c +++ b/Source/SupportFunctions/arm_q7_to_q15.c @@ -42,7 +42,6 @@ @param[in] pSrc points to the Q7 input vector @param[out] pDst points to the Q15 output vector @param[in] blockSize number of samples in each vector - @return none @par Details The equation used for the conversion process is: diff --git a/Source/SupportFunctions/arm_q7_to_q31.c b/Source/SupportFunctions/arm_q7_to_q31.c index 01d5f2b68..eb1bdb19b 100644 --- a/Source/SupportFunctions/arm_q7_to_q31.c +++ b/Source/SupportFunctions/arm_q7_to_q31.c @@ -42,7 +42,6 @@ @param[in] pSrc points to the Q7 input vector @param[out] pDst points to the Q31 output vector @param[in] blockSize number of samples in each vector - @return none @par Details The equation used for the conversion process is: diff --git a/Source/TransformFunctions/arm_bitreversal.c b/Source/TransformFunctions/arm_bitreversal.c index 687a9e86a..2bbabf426 100644 --- a/Source/TransformFunctions/arm_bitreversal.c +++ b/Source/TransformFunctions/arm_bitreversal.c @@ -36,7 +36,6 @@ @param[in] fftSize length of FFT @param[in] bitRevFactor bit reversal modifier that supports different size FFTs with the same bit reversal table @param[in] pBitRevTab points to bit reversal table - @return none */ void arm_bitreversal_f32( @@ -107,7 +106,6 @@ void arm_bitreversal_f32( @param[in] fftLen length of FFT. @param[in] bitRevFactor bit reversal modifier that supports different size FFTs with the same bit reversal table @param[in] pBitRevTab points to bit reversal table - @return none */ void arm_bitreversal_q31( @@ -178,7 +176,6 @@ void arm_bitreversal_q31( @param[in] fftLen length of FFT @param[in] bitRevFactor bit reversal modifier that supports different size FFTs with the same bit reversal table @param[in] pBitRevTab points to bit reversal table - @return none */ void arm_bitreversal_q15( diff --git a/Source/TransformFunctions/arm_bitreversal2.c b/Source/TransformFunctions/arm_bitreversal2.c index faefbb088..eb797a458 100644 --- a/Source/TransformFunctions/arm_bitreversal2.c +++ b/Source/TransformFunctions/arm_bitreversal2.c @@ -35,7 +35,6 @@ @param[in,out] pSrc points to in-place buffer of unknown 64-bit data type @param[in] bitRevLen bit reversal table length @param[in] pBitRevTab points to bit reversal table - @return none */ void arm_bitreversal_64( @@ -70,7 +69,6 @@ void arm_bitreversal_64( @param[in,out] pSrc points to in-place buffer of unknown 32-bit data type @param[in] bitRevLen bit reversal table length @param[in] pBitRevTab points to bit reversal table - @return none */ void arm_bitreversal_32( @@ -105,7 +103,6 @@ void arm_bitreversal_32( @param[in,out] pSrc points to in-place buffer of unknown 16-bit data type @param[in] bitRevLen bit reversal table length @param[in] pBitRevTab points to bit reversal table - @return none */ void arm_bitreversal_16( diff --git a/Source/TransformFunctions/arm_bitreversal_f16.c b/Source/TransformFunctions/arm_bitreversal_f16.c index 2e6463682..481014840 100755 --- a/Source/TransformFunctions/arm_bitreversal_f16.c +++ b/Source/TransformFunctions/arm_bitreversal_f16.c @@ -34,7 +34,6 @@ * @param[in] fftSize length of the FFT. * @param[in] bitRevFactor bit reversal modifier that supports different size FFTs with the same bit reversal table. * @param[in] *pBitRevTab points to the bit reversal table. -* @return none. */ #if defined(ARM_FLOAT16_SUPPORTED) diff --git a/Source/TransformFunctions/arm_cfft_f16.c b/Source/TransformFunctions/arm_cfft_f16.c index 11c688464..4e4020357 100755 --- a/Source/TransformFunctions/arm_cfft_f16.c +++ b/Source/TransformFunctions/arm_cfft_f16.c @@ -521,7 +521,6 @@ static void arm_cfft_radix4by2_inverse_f16_mve(const arm_cfft_instance_f16 * S,f @param[in] bitReverseFlag flag that enables / disables bit reversal of output - value = 0: disables bit reversal of output - value = 1: enables bit reversal of output - @return none */ @@ -615,7 +614,6 @@ extern void arm_radix4_butterfly_f16( @param[in] bitReverseFlag flag that enables / disables bit reversal of output - value = 0: disables bit reversal of output - value = 1: enables bit reversal of output - @return none */ void arm_cfft_f16( diff --git a/Source/TransformFunctions/arm_cfft_f32.c b/Source/TransformFunctions/arm_cfft_f32.c index f69fedb0a..c64a12460 100755 --- a/Source/TransformFunctions/arm_cfft_f32.c +++ b/Source/TransformFunctions/arm_cfft_f32.c @@ -524,7 +524,6 @@ static void arm_cfft_radix4by2_inverse_f32_mve(const arm_cfft_instance_f32 * S,f @param[in] bitReverseFlag flag that enables / disables bit reversal of output - value = 0: disables bit reversal of output - value = 1: enables bit reversal of output - @return none */ @@ -1127,7 +1126,6 @@ void arm_cfft_radix8by4_f32 (arm_cfft_instance_f32 * S, float32_t * p1) @param[in] bitReverseFlag flag that enables / disables bit reversal of output - value = 0: disables bit reversal of output - value = 1: enables bit reversal of output - @return none */ void arm_cfft_f32( diff --git a/Source/TransformFunctions/arm_cfft_f64.c b/Source/TransformFunctions/arm_cfft_f64.c index 165aad7c2..2c95097dd 100644 --- a/Source/TransformFunctions/arm_cfft_f64.c +++ b/Source/TransformFunctions/arm_cfft_f64.c @@ -51,7 +51,6 @@ extern void arm_bitreversal_64( * @param[in] fftLen length of the FFT. * @param[in] *pCoef points to the twiddle coefficient buffer. * @param[in] twidCoefModifier twiddle coefficient modifier that supports different size FFTs with the same twiddle factor table. -* @return none. */ void arm_radix4_butterfly_f64( @@ -185,7 +184,6 @@ void arm_radix4_butterfly_f64( * @param[in] fftLen length of the FFT. * @param[in] *pCoef points to the twiddle coefficient buffer. * @param[in] twidCoefModifier twiddle coefficient modifier that supports different size FFTs with the same twiddle factor table. -* @return none. */ void arm_cfft_radix4by2_f64( @@ -250,7 +248,6 @@ void arm_cfft_radix4by2_f64( @param[in] bitReverseFlag flag that enables / disables bit reversal of output - value = 0: disables bit reversal of output - value = 1: enables bit reversal of output - @return none */ void arm_cfft_f64( diff --git a/Source/TransformFunctions/arm_cfft_init_f16.c b/Source/TransformFunctions/arm_cfft_init_f16.c index 2b0b5b7d6..280f7c656 100755 --- a/Source/TransformFunctions/arm_cfft_init_f16.c +++ b/Source/TransformFunctions/arm_cfft_init_f16.c @@ -270,14 +270,12 @@ CFFTINIT_F16(16,16); Other versions can still initialize directly the data structure using variables declared in arm_const_structs.h - @par - This function should be used only if you don't know the FFT sizes that + @par This function should be used only if you don't know the FFT sizes that you'll need at build time. The use of this function will prevent the linker from removing the FFT tables that are not needed and the library code size will be bigger than needed. - @par - If you use CMSIS-DSP as a static library, and if you know the FFT sizes + @par If you use CMSIS-DSP as a static library, and if you know the FFT sizes that you need at build time, then it is better to use the initialization functions defined for each FFT size. */ diff --git a/Source/TransformFunctions/arm_cfft_init_f32.c b/Source/TransformFunctions/arm_cfft_init_f32.c index e07340898..51826b483 100755 --- a/Source/TransformFunctions/arm_cfft_init_f32.c +++ b/Source/TransformFunctions/arm_cfft_init_f32.c @@ -257,17 +257,18 @@ CFFTINIT_F32(16,16); - \ref ARM_MATH_SUCCESS : Operation successful - \ref ARM_MATH_ARGUMENT_ERROR : an error is detected - @par Use of this function is mandatory only for the MVE version of the FFT. + @par + Use of this function is mandatory only for the MVE version of the FFT. Other versions can still initialize directly the data structure using variables declared in arm_const_structs.h - @par + @par This function should be used only if you don't know the FFT sizes that you'll need at build time. The use of this function will prevent the linker from removing the FFT tables that are not needed and the library code size will be bigger than needed. - @par + @par If you use CMSIS-DSP as a static library, and if you know the FFT sizes that you need at build time, then it is better to use the initialization functions defined for each FFT size. diff --git a/Source/TransformFunctions/arm_cfft_init_q15.c b/Source/TransformFunctions/arm_cfft_init_q15.c index e284a27f6..391f90f65 100755 --- a/Source/TransformFunctions/arm_cfft_init_q15.c +++ b/Source/TransformFunctions/arm_cfft_init_q15.c @@ -254,13 +254,13 @@ CFFTINIT_Q15(16,16); Other versions can still initialize directly the data structure using variables declared in arm_const_structs.h - @par + @par This function should be used only if you don't know the FFT sizes that you'll need at build time. The use of this function will prevent the linker from removing the FFT tables that are not needed and the library code size will be bigger than needed. - @par + @par If you use CMSIS-DSP as a static library, and if you know the FFT sizes that you need at build time, then it is better to use the initialization functions defined for each FFT size. diff --git a/Source/TransformFunctions/arm_cfft_init_q31.c b/Source/TransformFunctions/arm_cfft_init_q31.c index 49c58e326..cd4ba16c1 100755 --- a/Source/TransformFunctions/arm_cfft_init_q31.c +++ b/Source/TransformFunctions/arm_cfft_init_q31.c @@ -255,13 +255,13 @@ CFFTINIT_Q31(16,16); Other versions can still initialize directly the data structure using variables declared in arm_const_structs.h - @par + @par This function should be used only if you don't know the FFT sizes that you'll need at build time. The use of this function will prevent the linker from removing the FFT tables that are not needed and the library code size will be bigger than needed. - @par + @par If you use CMSIS-DSP as a static library, and if you know the FFT sizes that you need at build time, then it is better to use the initialization functions defined for each FFT size. diff --git a/Source/TransformFunctions/arm_cfft_q15.c b/Source/TransformFunctions/arm_cfft_q15.c index a902de66d..79ab798bd 100644 --- a/Source/TransformFunctions/arm_cfft_q15.c +++ b/Source/TransformFunctions/arm_cfft_q15.c @@ -525,7 +525,6 @@ static void arm_cfft_radix4by2_inverse_q15_mve(const arm_cfft_instance_q15 *S, q @param[in] bitReverseFlag flag that enables / disables bit reversal of output - value = 0: disables bit reversal of output - value = 1: enables bit reversal of output - @return none */ void arm_cfft_q15( const arm_cfft_instance_q15 * S, @@ -627,7 +626,6 @@ void arm_cfft_radix4by2_inverse_q15( @param[in] bitReverseFlag flag that enables / disables bit reversal of output - value = 0: disables bit reversal of output - value = 1: enables bit reversal of output - @return none */ void arm_cfft_q15( diff --git a/Source/TransformFunctions/arm_cfft_q31.c b/Source/TransformFunctions/arm_cfft_q31.c index 502b94288..59cba99c7 100644 --- a/Source/TransformFunctions/arm_cfft_q31.c +++ b/Source/TransformFunctions/arm_cfft_q31.c @@ -559,7 +559,6 @@ static void arm_cfft_radix4by2_inverse_q31_mve(const arm_cfft_instance_q31 *S, q @param[in] bitReverseFlag flag that enables / disables bit reversal of output - value = 0: disables bit reversal of output - value = 1: enables bit reversal of output - @return none */ void arm_cfft_q31( const arm_cfft_instance_q31 * S, @@ -659,7 +658,6 @@ void arm_cfft_radix4by2_inverse_q31( @param[in] bitReverseFlag flag that enables / disables bit reversal of output - value = 0: disables bit reversal of output - value = 1: enables bit reversal of output - @return none */ void arm_cfft_q31( const arm_cfft_instance_q31 * S, diff --git a/Source/TransformFunctions/arm_cfft_radix2_f16.c b/Source/TransformFunctions/arm_cfft_radix2_f16.c index d350b9417..268426859 100755 --- a/Source/TransformFunctions/arm_cfft_radix2_f16.c +++ b/Source/TransformFunctions/arm_cfft_radix2_f16.c @@ -67,7 +67,6 @@ extern void arm_bitreversal_f16( @deprecated Do not use this function. It has been superseded by \ref arm_cfft_f16 and will be removed in the future @param[in] S points to an instance of the floating-point Radix-2 CFFT/CIFFT structure @param[in,out] pSrc points to the complex data buffer of size 2*fftLen. Processing occurs in-place - @return none */ void arm_cfft_radix2_f16( @@ -113,7 +112,6 @@ const arm_cfft_radix2_instance_f16 * S, * @param[in] fftLen length of the FFT. * @param[in] *pCoef points to the twiddle coefficient buffer. * @param[in] twidCoefModifier twiddle coefficient modifier that supports different size FFTs with the same twiddle factor table. -* @return none. */ void arm_radix2_butterfly_f16( diff --git a/Source/TransformFunctions/arm_cfft_radix2_f32.c b/Source/TransformFunctions/arm_cfft_radix2_f32.c index a8978fd0b..48591089b 100644 --- a/Source/TransformFunctions/arm_cfft_radix2_f32.c +++ b/Source/TransformFunctions/arm_cfft_radix2_f32.c @@ -59,7 +59,6 @@ extern void arm_bitreversal_f32( @deprecated Do not use this function. It has been superseded by \ref arm_cfft_f32 and will be removed in the future @param[in] S points to an instance of the floating-point Radix-2 CFFT/CIFFT structure @param[in,out] pSrc points to the complex data buffer of size 2*fftLen. Processing occurs in-place - @return none */ void arm_cfft_radix2_f32( diff --git a/Source/TransformFunctions/arm_cfft_radix2_q15.c b/Source/TransformFunctions/arm_cfft_radix2_q15.c index a7a5c13ac..eca3bb1f6 100644 --- a/Source/TransformFunctions/arm_cfft_radix2_q15.c +++ b/Source/TransformFunctions/arm_cfft_radix2_q15.c @@ -57,7 +57,6 @@ void arm_bitreversal_q15( @deprecated Do not use this function. It has been superseded by \ref arm_cfft_q15 and will be removed in the future. @param[in] S points to an instance of the fixed-point CFFT/CIFFT structure @param[in,out] pSrc points to the complex data buffer of size 2*fftLen. Processing occurs in-place - @return none */ void arm_cfft_radix2_q15( diff --git a/Source/TransformFunctions/arm_cfft_radix2_q31.c b/Source/TransformFunctions/arm_cfft_radix2_q31.c index 89409d70f..bac8027f2 100644 --- a/Source/TransformFunctions/arm_cfft_radix2_q31.c +++ b/Source/TransformFunctions/arm_cfft_radix2_q31.c @@ -57,7 +57,6 @@ void arm_bitreversal_q31( @deprecated Do not use this function. It has been superseded by \ref arm_cfft_q31 and will be removed in the future. @param[in] S points to an instance of the fixed-point CFFT/CIFFT structure @param[in,out] pSrc points to the complex data buffer of size 2*fftLen. Processing occurs in-place - @return none */ void arm_cfft_radix2_q31( diff --git a/Source/TransformFunctions/arm_cfft_radix4_f16.c b/Source/TransformFunctions/arm_cfft_radix4_f16.c index e599e049b..4c4ed8ca4 100755 --- a/Source/TransformFunctions/arm_cfft_radix4_f16.c +++ b/Source/TransformFunctions/arm_cfft_radix4_f16.c @@ -67,7 +67,6 @@ void arm_cfft_radix4by2_f16( * @param[in] fftLen length of the FFT. * @param[in] *pCoef points to the twiddle coefficient buffer. * @param[in] twidCoefModifier twiddle coefficient modifier that supports different size FFTs with the same twiddle factor table. -* @return none. */ void arm_cfft_radix4by2_f16( @@ -123,7 +122,6 @@ void arm_cfft_radix4by2_f16( @deprecated Do not use this function. It has been superseded by \ref arm_cfft_f16 and will be removed in the future. @param[in] S points to an instance of the floating-point Radix-4 CFFT/CIFFT structure @param[in,out] pSrc points to the complex data buffer of size 2*fftLen. Processing occurs in-place - @return none */ void arm_cfft_radix4_f16( @@ -163,7 +161,6 @@ void arm_cfft_radix4_f16( * @param[in] fftLen length of the FFT. * @param[in] *pCoef points to the twiddle coefficient buffer. * @param[in] twidCoefModifier twiddle coefficient modifier that supports different size FFTs with the same twiddle factor table. -* @return none. */ void arm_radix4_butterfly_f16( @@ -667,7 +664,6 @@ uint16_t twidCoefModifier) * @param[in] *pCoef points to twiddle coefficient buffer. * @param[in] twidCoefModifier twiddle coefficient modifier that supports different size FFTs with the same twiddle factor table. * @param[in] onebyfftLen value of 1/fftLen. -* @return none. */ void arm_radix4_butterfly_inverse_f16( diff --git a/Source/TransformFunctions/arm_cfft_radix4_f32.c b/Source/TransformFunctions/arm_cfft_radix4_f32.c index 89721a54b..f3e600f06 100644 --- a/Source/TransformFunctions/arm_cfft_radix4_f32.c +++ b/Source/TransformFunctions/arm_cfft_radix4_f32.c @@ -61,7 +61,6 @@ void arm_radix4_butterfly_inverse_f32( @deprecated Do not use this function. It has been superseded by \ref arm_cfft_f32 and will be removed in the future. @param[in] S points to an instance of the floating-point Radix-4 CFFT/CIFFT structure @param[in,out] pSrc points to the complex data buffer of size 2*fftLen. Processing occurs in-place - @return none */ void arm_cfft_radix4_f32( diff --git a/Source/TransformFunctions/arm_cfft_radix4_q15.c b/Source/TransformFunctions/arm_cfft_radix4_q15.c index f2ba41742..ea8013063 100644 --- a/Source/TransformFunctions/arm_cfft_radix4_q15.c +++ b/Source/TransformFunctions/arm_cfft_radix4_q15.c @@ -59,7 +59,6 @@ void arm_bitreversal_q15( @deprecated Do not use this function. It has been superseded by \ref arm_cfft_q15 and will be removed in the future. @param[in] S points to an instance of the Q15 CFFT/CIFFT structure. @param[in,out] pSrc points to the complex data buffer. Processing occurs in-place. - @return none @par Input and output formats: Internally input is downscaled by 2 for every stage to avoid saturations inside CFFT/CIFFT process. @@ -150,7 +149,6 @@ void arm_cfft_radix4_q15( @param[in] fftLen length of the FFT @param[in] pCoef16 points to twiddle coefficient buffer @param[in] twidCoefModifier twiddle coefficient modifier that supports different size FFTs with the same twiddle factor table - @return none */ void arm_radix4_butterfly_q15( @@ -980,7 +978,6 @@ void arm_radix4_butterfly_q15( @param[in] fftLen length of the FFT @param[in] pCoef16 points to twiddle coefficient buffer @param[in] twidCoefModifier twiddle coefficient modifier that supports different size FFTs with the same twiddle factor table. - @return none */ /* diff --git a/Source/TransformFunctions/arm_cfft_radix4_q31.c b/Source/TransformFunctions/arm_cfft_radix4_q31.c index daab956b3..4bc2c0dbd 100644 --- a/Source/TransformFunctions/arm_cfft_radix4_q31.c +++ b/Source/TransformFunctions/arm_cfft_radix4_q31.c @@ -58,7 +58,6 @@ void arm_bitreversal_q31( @deprecated Do not use this function. It has been superseded by \ref arm_cfft_q31 and will be removed in the future. @param[in] S points to an instance of the Q31 CFFT/CIFFT structure @param[in,out] pSrc points to the complex data buffer of size 2*fftLen. Processing occurs in-place - @return none @par Input and output formats: Internally input is downscaled by 2 for every stage to avoid saturations inside CFFT/CIFFT process. @@ -149,7 +148,6 @@ void arm_cfft_radix4_q31( @param[in] fftLen length of the FFT. @param[in] pCoef points to twiddle coefficient buffer. @param[in] twidCoefModifier twiddle coefficient modifier that supports different size FFTs with the same twiddle factor table. - @return none */ void arm_radix4_butterfly_q31( @@ -481,7 +479,6 @@ void arm_radix4_butterfly_q31( @param[in] fftLen length of the FFT. @param[in] pCoef points to twiddle coefficient buffer. @param[in] twidCoefModifier twiddle coefficient modifier that supports different size FFTs with the same twiddle factor table. - @return none */ /* diff --git a/Source/TransformFunctions/arm_dct4_f32.c b/Source/TransformFunctions/arm_dct4_f32.c index 737499b5f..66cfce256 100644 --- a/Source/TransformFunctions/arm_dct4_f32.c +++ b/Source/TransformFunctions/arm_dct4_f32.c @@ -126,7 +126,6 @@ @param[in] S points to an instance of the floating-point DCT4/IDCT4 structure @param[in] pState points to state buffer @param[in,out] pInlineBuffer points to the in-place input and output buffer - @return none */ void arm_dct4_f32( diff --git a/Source/TransformFunctions/arm_dct4_q15.c b/Source/TransformFunctions/arm_dct4_q15.c index 4d516c73a..cd2a0aec8 100644 --- a/Source/TransformFunctions/arm_dct4_q15.c +++ b/Source/TransformFunctions/arm_dct4_q15.c @@ -39,7 +39,6 @@ @param[in] S points to an instance of the Q15 DCT4 structure. @param[in] pState points to state buffer. @param[in,out] pInlineBuffer points to the in-place input and output buffer. - @return none @par Input an output formats Internally inputs are downscaled in the RFFT process function to avoid overflows. diff --git a/Source/TransformFunctions/arm_dct4_q31.c b/Source/TransformFunctions/arm_dct4_q31.c index cd9a9f3f6..c7fac3417 100644 --- a/Source/TransformFunctions/arm_dct4_q31.c +++ b/Source/TransformFunctions/arm_dct4_q31.c @@ -39,7 +39,6 @@ @param[in] S points to an instance of the Q31 DCT4 structure. @param[in] pState points to state buffer. @param[in,out] pInlineBuffer points to the in-place input and output buffer. - @return none @par Input an output formats Input samples need to be downscaled by 1 bit to avoid saturations in the Q31 DCT process, diff --git a/Source/TransformFunctions/arm_mfcc_f16.c b/Source/TransformFunctions/arm_mfcc_f16.c index e12b37601..1aa2284f7 100755 --- a/Source/TransformFunctions/arm_mfcc_f16.c +++ b/Source/TransformFunctions/arm_mfcc_f16.c @@ -63,8 +63,6 @@ @param[out] pDst points to the output MFCC values @param[inout] pTmp points to a temporary buffer of complex - @return none - @par Description The number of input samples if the FFT length used when initializing the instance data structure. diff --git a/Source/TransformFunctions/arm_mfcc_f32.c b/Source/TransformFunctions/arm_mfcc_f32.c index db1bfda65..3cfe464cd 100755 --- a/Source/TransformFunctions/arm_mfcc_f32.c +++ b/Source/TransformFunctions/arm_mfcc_f32.c @@ -53,8 +53,6 @@ @param[out] pDst points to the output MFCC values @param[inout] pTmp points to a temporary buffer of complex - @return none - @par Description The number of input samples if the FFT length used when initializing the instance data structure. diff --git a/Source/TransformFunctions/arm_mfcc_init_f16.c b/Source/TransformFunctions/arm_mfcc_init_f16.c index 508398779..437005f90 100755 --- a/Source/TransformFunctions/arm_mfcc_init_f16.c +++ b/Source/TransformFunctions/arm_mfcc_init_f16.c @@ -74,13 +74,13 @@ The folder Scripts is containing a Python script that can be used to generate the filter, dct and window arrays. - @par + @par This function should be used only if you don't know the FFT sizes that you'll need at build time. The use of this function will prevent the linker from removing the FFT tables that are not needed and the library code size will be bigger than needed. - @par + @par If you use CMSIS-DSP as a static library, and if you know the MFCC sizes that you need at build time, then it is better to use the initialization functions defined for each MFCC size. diff --git a/Source/TransformFunctions/arm_mfcc_init_f32.c b/Source/TransformFunctions/arm_mfcc_init_f32.c index 9537bca40..23e2ecac4 100755 --- a/Source/TransformFunctions/arm_mfcc_init_f32.c +++ b/Source/TransformFunctions/arm_mfcc_init_f32.c @@ -74,13 +74,13 @@ The folder Scripts is containing a Python script which can be used to generate the filter, dct and window arrays. - @par + @par This function should be used only if you don't know the FFT sizes that you'll need at build time. The use of this function will prevent the linker from removing the FFT tables that are not needed and the library code size will be bigger than needed. - @par + @par If you use CMSIS-DSP as a static library, and if you know the MFCC sizes that you need at build time, then it is better to use the initialization functions defined for each MFCC size. diff --git a/Source/TransformFunctions/arm_mfcc_init_q15.c b/Source/TransformFunctions/arm_mfcc_init_q15.c index 5064843ab..0f70e1aff 100755 --- a/Source/TransformFunctions/arm_mfcc_init_q15.c +++ b/Source/TransformFunctions/arm_mfcc_init_q15.c @@ -73,13 +73,13 @@ The folder Scripts is containing a Python script which can be used to generate the filter, dct and window arrays. - @par + @par This function should be used only if you don't know the FFT sizes that you'll need at build time. The use of this function will prevent the linker from removing the FFT tables that are not needed and the library code size will be bigger than needed. - @par + @par If you use CMSIS-DSP as a static library, and if you know the MFCC sizes that you need at build time, then it is better to use the initialization functions defined for each MFCC size. diff --git a/Source/TransformFunctions/arm_mfcc_init_q31.c b/Source/TransformFunctions/arm_mfcc_init_q31.c index 3e14ed7c6..e93e41008 100755 --- a/Source/TransformFunctions/arm_mfcc_init_q31.c +++ b/Source/TransformFunctions/arm_mfcc_init_q31.c @@ -73,13 +73,14 @@ The folder Scripts is containing a Python script which can be used to generate the filter, dct and window arrays. - @par + + @par This function should be used only if you don't know the FFT sizes that you'll need at build time. The use of this function will prevent the linker from removing the FFT tables that are not needed and the library code size will be bigger than needed. - @par + @par If you use CMSIS-DSP as a static library, and if you know the MFCC sizes that you need at build time, then it is better to use the initialization functions defined for each MFCC size. diff --git a/Source/TransformFunctions/arm_mfcc_q15.c b/Source/TransformFunctions/arm_mfcc_q15.c index e9e31b22f..824fb1afe 100755 --- a/Source/TransformFunctions/arm_mfcc_q15.c +++ b/Source/TransformFunctions/arm_mfcc_q15.c @@ -57,8 +57,6 @@ @param[out] pDst points to the output MFCC values in q8.7 format @param[inout] pTmp points to a temporary buffer of complex - @return none - @par Description The number of input samples is the FFT length used when initializing the instance data structure. diff --git a/Source/TransformFunctions/arm_mfcc_q31.c b/Source/TransformFunctions/arm_mfcc_q31.c index b1adaaba3..8b57e4d66 100755 --- a/Source/TransformFunctions/arm_mfcc_q31.c +++ b/Source/TransformFunctions/arm_mfcc_q31.c @@ -57,8 +57,6 @@ @param[out] pDst points to the output MFCC values in q8.23 format @param[inout] pTmp points to a temporary buffer of complex - @return none - @par Description The number of input samples is the FFT length used when initializing the instance data structure. diff --git a/Source/TransformFunctions/arm_rfft_f32.c b/Source/TransformFunctions/arm_rfft_f32.c index f599f4213..e5bf43eda 100644 --- a/Source/TransformFunctions/arm_rfft_f32.c +++ b/Source/TransformFunctions/arm_rfft_f32.c @@ -82,7 +82,6 @@ void arm_split_rifft_f32( @param[in] S points to an instance of the floating-point RFFT/RIFFT structure @param[in] pSrc points to the input buffer @param[out] pDst points to the output buffer - @return none */ @@ -140,7 +139,6 @@ void arm_rfft_f32( @param[in] pBTable points to twiddle Coef B buffer @param[out] pDst points to output buffer @param[in] modifier twiddle coefficient modifier that supports different size FFTs with the same twiddle factor table - @return none */ void arm_split_rfft_f32( @@ -236,7 +234,6 @@ void arm_split_rfft_f32( @param[in] pBTable points to twiddle Coef B buffer @param[out] pDst points to output buffer @param[in] modifier twiddle coefficient modifier that supports different size FFTs with the same twiddle factor table - @return none */ void arm_split_rifft_f32( diff --git a/Source/TransformFunctions/arm_rfft_fast_f16.c b/Source/TransformFunctions/arm_rfft_fast_f16.c index 0103cc94a..bea35aed4 100755 --- a/Source/TransformFunctions/arm_rfft_fast_f16.c +++ b/Source/TransformFunctions/arm_rfft_fast_f16.c @@ -484,7 +484,6 @@ void merge_rfft_f16( @param[in] ifftFlag - value = 0: RFFT - value = 1: RIFFT - @return none */ void arm_rfft_fast_f16( diff --git a/Source/TransformFunctions/arm_rfft_fast_f32.c b/Source/TransformFunctions/arm_rfft_fast_f32.c index 0b6ed9100..a74c751ec 100644 --- a/Source/TransformFunctions/arm_rfft_fast_f32.c +++ b/Source/TransformFunctions/arm_rfft_fast_f32.c @@ -591,7 +591,6 @@ void merge_rfft_f32( @param[in] ifftFlag - value = 0: RFFT - value = 1: RIFFT - @return none */ void arm_rfft_fast_f32( diff --git a/Source/TransformFunctions/arm_rfft_fast_f64.c b/Source/TransformFunctions/arm_rfft_fast_f64.c index f02b750a6..a25ab8948 100755 --- a/Source/TransformFunctions/arm_rfft_fast_f64.c +++ b/Source/TransformFunctions/arm_rfft_fast_f64.c @@ -195,7 +195,6 @@ void merge_rfft_f64( @param[in] ifftFlag - value = 0: RFFT - value = 1: RIFFT - @return none */ void arm_rfft_fast_f64( diff --git a/Source/TransformFunctions/arm_rfft_fast_init_f16.c b/Source/TransformFunctions/arm_rfft_fast_init_f16.c index 3e68661b8..fce511258 100755 --- a/Source/TransformFunctions/arm_rfft_fast_init_f16.c +++ b/Source/TransformFunctions/arm_rfft_fast_init_f16.c @@ -260,16 +260,17 @@ arm_status arm_rfft_fast_init_4096_f16( arm_rfft_fast_instance_f16 * S ) { @par Description The parameter fftLen specifies the length of RFFT/CIFFT process. Supported FFT Lengths are 32, 64, 128, 256, 512, 1024, 2048, 4096. + + @par + This Function also initializes Twiddle factor table pointer and Bit reversal table pointer. + @par - This Function also initializes Twiddle factor table pointer and Bit reversal table pointer. - - @par This function should be used only if you don't know the FFT sizes that you'll need at build time. The use of this function will prevent the linker from removing the FFT tables that are not needed and the library code size will be bigger than needed. - @par + @par If you use CMSIS-DSP as a static library, and if you know the FFT sizes that you need at build time, then it is better to use the initialization functions defined for each FFT size. diff --git a/Source/TransformFunctions/arm_rfft_fast_init_f32.c b/Source/TransformFunctions/arm_rfft_fast_init_f32.c index 7e375dd58..f4e140b2f 100644 --- a/Source/TransformFunctions/arm_rfft_fast_init_f32.c +++ b/Source/TransformFunctions/arm_rfft_fast_init_f32.c @@ -257,19 +257,20 @@ arm_status arm_rfft_fast_init_4096_f32( arm_rfft_fast_instance_f32 * S ) { @par Description The parameter fftLen specifies the length of RFFT/CIFFT process. Supported FFT Lengths are 32, 64, 128, 256, 512, 1024, 2048, 4096. + + @par + This Function also initializes Twiddle factor table pointer and Bit reversal table pointer. + + @par + This function should be used only if you don't know the FFT sizes that + you'll need at build time. The use of this function will prevent the + linker from removing the FFT tables that are not needed and the library + code size will be bigger than needed. + @par - This Function also initializes Twiddle factor table pointer and Bit reversal table pointer. - - @par - This function should be used only if you don't know the FFT sizes that - you'll need at build time. The use of this function will prevent the - linker from removing the FFT tables that are not needed and the library - code size will be bigger than needed. - - @par - If you use CMSIS-DSP as a static library, and if you know the FFT sizes - that you need at build time, then it is better to use the initialization - functions defined for each FFT size. + If you use CMSIS-DSP as a static library, and if you know the FFT sizes + that you need at build time, then it is better to use the initialization + functions defined for each FFT size. */ diff --git a/Source/TransformFunctions/arm_rfft_fast_init_f64.c b/Source/TransformFunctions/arm_rfft_fast_init_f64.c index 1fef473f4..37a0a8e4f 100755 --- a/Source/TransformFunctions/arm_rfft_fast_init_f64.c +++ b/Source/TransformFunctions/arm_rfft_fast_init_f64.c @@ -261,16 +261,17 @@ arm_status arm_rfft_fast_init_4096_f64( arm_rfft_fast_instance_f64 * S ) { @par Description The parameter fftLen specifies the length of RFFT/CIFFT process. Supported FFT Lengths are 32, 64, 128, 256, 512, 1024, 2048, 4096. + + @par + This Function also initializes Twiddle factor table pointer and Bit reversal table pointer. + @par - This Function also initializes Twiddle factor table pointer and Bit reversal table pointer. - - @par This function should be used only if you don't know the FFT sizes that you'll need at build time. The use of this function will prevent the linker from removing the FFT tables that are not needed and the library code size will be bigger than needed. - @par + @par If you use CMSIS-DSP as a library, and if you know the FFT sizes that you need at build time, then it is better to use the initialization functions defined for each FFT size. diff --git a/Source/TransformFunctions/arm_rfft_init_q15.c b/Source/TransformFunctions/arm_rfft_init_q15.c index 1a2edcd8c..8fdff3675 100644 --- a/Source/TransformFunctions/arm_rfft_init_q15.c +++ b/Source/TransformFunctions/arm_rfft_init_q15.c @@ -350,17 +350,15 @@ RFFTINIT_Q15(32,16,256); Set(=1) bitReverseFlag for output to be in normal order otherwise output is in bit reversed order. @par This function also initializes Twiddle factor table. - - @par - This function should be used only if you don't know the FFT sizes that - you'll need at build time. The use of this function will prevent the - linker from removing the FFT tables that are not needed and the library - code size will be bigger than needed. - - @par - If you use CMSIS-DSP as a static library, and if you know the FFT sizes - that you need at build time, then it is better to use the initialization - functions defined for each FFT size. + @par + This function should be used only if you don't know the FFT sizes that + you'll need at build time. The use of this function will prevent the + linker from removing the FFT tables that are not needed and the library + code size will be bigger than needed. + @par + If you use CMSIS-DSP as a static library, and if you know the FFT sizes + that you need at build time, then it is better to use the initialization + functions defined for each FFT size. */ diff --git a/Source/TransformFunctions/arm_rfft_init_q31.c b/Source/TransformFunctions/arm_rfft_init_q31.c index 793ad8e3b..d8b0c684a 100644 --- a/Source/TransformFunctions/arm_rfft_init_q31.c +++ b/Source/TransformFunctions/arm_rfft_init_q31.c @@ -348,17 +348,15 @@ RFFTINIT_Q31(32,16,256); Set(=1) bitReverseFlag for output to be in normal order otherwise output is in bit reversed order. @par This function also initializes Twiddle factor table. - - @par - This function should be used only if you don't know the FFT sizes that - you'll need at build time. The use of this function will prevent the - linker from removing the FFT tables that are not needed and the library - code size will be bigger than needed. - - @par - If you use CMSIS-DSP as a static library, and if you know the FFT sizes - that you need at build time, then it is better to use the initialization - functions defined for each FFT size. + @par + This function should be used only if you don't know the FFT sizes that + you'll need at build time. The use of this function will prevent the + linker from removing the FFT tables that are not needed and the library + code size will be bigger than needed. + @par + If you use CMSIS-DSP as a static library, and if you know the FFT sizes + that you need at build time, then it is better to use the initialization + functions defined for each FFT size. */ diff --git a/Source/TransformFunctions/arm_rfft_q15.c b/Source/TransformFunctions/arm_rfft_q15.c index 8490f0051..2704a457c 100644 --- a/Source/TransformFunctions/arm_rfft_q15.c +++ b/Source/TransformFunctions/arm_rfft_q15.c @@ -58,7 +58,6 @@ void arm_split_rifft_q15( @param[in] S points to an instance of the Q15 RFFT/RIFFT structure @param[in] pSrc points to input buffer (Source buffer is modified by this function.) @param[out] pDst points to output buffer - @return none @par Input an output formats Internally input is downscaled by 2 for every stage to avoid saturations inside CFFT/CIFFT process. @@ -150,7 +149,6 @@ void arm_rfft_q15( @param[in] pBTable points to twiddle Coef B buffer @param[out] pDst points to output buffer @param[in] modifier twiddle coefficient modifier that supports different size FFTs with the same twiddle factor table - @return none @par The function implements a Real FFT @@ -382,7 +380,6 @@ void arm_split_rfft_q15( @param[in] pBTable points to twiddle Coef B buffer @param[out] pDst points to output buffer @param[in] modifier twiddle coefficient modifier that supports different size FFTs with the same twiddle factor table - @return none @par The function implements a Real IFFT diff --git a/Source/TransformFunctions/arm_rfft_q31.c b/Source/TransformFunctions/arm_rfft_q31.c index b50e74801..410976633 100644 --- a/Source/TransformFunctions/arm_rfft_q31.c +++ b/Source/TransformFunctions/arm_rfft_q31.c @@ -58,7 +58,6 @@ void arm_split_rifft_q31( @param[in] S points to an instance of the Q31 RFFT/RIFFT structure @param[in] pSrc points to input buffer (Source buffer is modified by this function) @param[out] pDst points to output buffer - @return none @par Input an output formats Internally input is downscaled by 2 for every stage to avoid saturations inside CFFT/CIFFT process. @@ -151,7 +150,6 @@ void arm_rfft_q31( @param[in] pBTable points to twiddle Coef B buffer @param[out] pDst points to output buffer @param[in] modifier twiddle coefficient modifier that supports different size FFTs with the same twiddle factor table - @return none */ #if defined(ARM_MATH_MVEI) && !defined(ARM_MATH_AUTOVECTORIZE) @@ -319,7 +317,6 @@ void arm_split_rfft_q31( @param[in] pBTable points to twiddle Coef B buffer @param[out] pDst points to output buffer @param[in] modifier twiddle coefficient modifier that supports different size FFTs with the same twiddle factor table - @return none */ #if defined(ARM_MATH_MVEI) && !defined(ARM_MATH_AUTOVECTORIZE) diff --git a/Source/WindowFunctions/arm_bartlett_f32.c b/Source/WindowFunctions/arm_bartlett_f32.c index d28821581..352a563a6 100644 --- a/Source/WindowFunctions/arm_bartlett_f32.c +++ b/Source/WindowFunctions/arm_bartlett_f32.c @@ -53,7 +53,6 @@ @brief Bartlett window generating function (f32). @param[out] pDst points to the output generated window @param[in] blockSize number of samples in the window - @return none @par Parameters of the window diff --git a/Source/WindowFunctions/arm_bartlett_f64.c b/Source/WindowFunctions/arm_bartlett_f64.c index a93552159..b0f9b79b1 100644 --- a/Source/WindowFunctions/arm_bartlett_f64.c +++ b/Source/WindowFunctions/arm_bartlett_f64.c @@ -49,7 +49,6 @@ @brief Bartlett window generating function (f64). @param[out] pDst points to the output generated window @param[in] blockSize number of samples in the window - @return none @par Parameters of the window diff --git a/Source/WindowFunctions/arm_blackman_harris_92db_f32.c b/Source/WindowFunctions/arm_blackman_harris_92db_f32.c index e541ca783..3440c5db4 100644 --- a/Source/WindowFunctions/arm_blackman_harris_92db_f32.c +++ b/Source/WindowFunctions/arm_blackman_harris_92db_f32.c @@ -54,7 +54,6 @@ @brief 92 dB Blackman Harris window generating function (f32). @param[out] pDst points to the output generated window @param[in] blockSize number of samples in the window - @return none @par Parameters of the window diff --git a/Source/WindowFunctions/arm_blackman_harris_92db_f64.c b/Source/WindowFunctions/arm_blackman_harris_92db_f64.c index edc5ba612..5126a1fc3 100644 --- a/Source/WindowFunctions/arm_blackman_harris_92db_f64.c +++ b/Source/WindowFunctions/arm_blackman_harris_92db_f64.c @@ -50,7 +50,6 @@ @brief 92 dB Blackman Harris window generating function (f64). @param[out] pDst points to the output generated window @param[in] blockSize number of samples in the window - @return none @par Parameters of the window diff --git a/Source/WindowFunctions/arm_hamming_f32.c b/Source/WindowFunctions/arm_hamming_f32.c index 1460fa156..a14cbe073 100644 --- a/Source/WindowFunctions/arm_hamming_f32.c +++ b/Source/WindowFunctions/arm_hamming_f32.c @@ -54,7 +54,6 @@ @brief Hamming window generating function (f32). @param[out] pDst points to the output generated window @param[in] blockSize number of samples in the window - @return none @par Parameters of the window diff --git a/Source/WindowFunctions/arm_hamming_f64.c b/Source/WindowFunctions/arm_hamming_f64.c index 651c4cb85..d3b0a406d 100644 --- a/Source/WindowFunctions/arm_hamming_f64.c +++ b/Source/WindowFunctions/arm_hamming_f64.c @@ -50,7 +50,6 @@ @brief Hamming window generating function (f64). @param[out] pDst points to the output generated window @param[in] blockSize number of samples in the window - @return none @par Parameters of the window diff --git a/Source/WindowFunctions/arm_hanning_f32.c b/Source/WindowFunctions/arm_hanning_f32.c index 32239049c..ce4c7a810 100644 --- a/Source/WindowFunctions/arm_hanning_f32.c +++ b/Source/WindowFunctions/arm_hanning_f32.c @@ -55,7 +55,6 @@ @brief Hanning window generating function (f32). @param[out] pDst points to the output generated window @param[in] blockSize number of samples in the window - @return none @par Parameters of the window diff --git a/Source/WindowFunctions/arm_hanning_f64.c b/Source/WindowFunctions/arm_hanning_f64.c index 2a34dd846..0612365ae 100644 --- a/Source/WindowFunctions/arm_hanning_f64.c +++ b/Source/WindowFunctions/arm_hanning_f64.c @@ -51,7 +51,6 @@ @brief Hanning window generating function (f64). @param[out] pDst points to the output generated window @param[in] blockSize number of samples in the window - @return none @par Parameters of the window diff --git a/Source/WindowFunctions/arm_hft116d_f32.c b/Source/WindowFunctions/arm_hft116d_f32.c index 299013610..c956ba980 100644 --- a/Source/WindowFunctions/arm_hft116d_f32.c +++ b/Source/WindowFunctions/arm_hft116d_f32.c @@ -55,7 +55,6 @@ @brief Hft116d window generating function (f32). @param[out] pDst points to the output generated window @param[in] blockSize number of samples in the window - @return none @par Parameters of the window diff --git a/Source/WindowFunctions/arm_hft116d_f64.c b/Source/WindowFunctions/arm_hft116d_f64.c index 2d87d65fb..8729946f9 100644 --- a/Source/WindowFunctions/arm_hft116d_f64.c +++ b/Source/WindowFunctions/arm_hft116d_f64.c @@ -51,7 +51,6 @@ @brief Hft116d window generating function (f64). @param[out] pDst points to the output generated window @param[in] blockSize number of samples in the window - @return none @par Parameters of the window diff --git a/Source/WindowFunctions/arm_hft144d_f32.c b/Source/WindowFunctions/arm_hft144d_f32.c index a2c72e501..5de643044 100644 --- a/Source/WindowFunctions/arm_hft144d_f32.c +++ b/Source/WindowFunctions/arm_hft144d_f32.c @@ -54,7 +54,6 @@ @brief Hft144d window generating function (f32). @param[out] pDst points to the output generated window @param[in] blockSize number of samples in the window - @return none @par Parameters of the window diff --git a/Source/WindowFunctions/arm_hft144d_f64.c b/Source/WindowFunctions/arm_hft144d_f64.c index 2e546c449..d56be82af 100644 --- a/Source/WindowFunctions/arm_hft144d_f64.c +++ b/Source/WindowFunctions/arm_hft144d_f64.c @@ -50,7 +50,6 @@ @brief Hft144d window generating function (f64). @param[out] pDst points to the output generated window @param[in] blockSize number of samples in the window - @return none @par Parameters of the window diff --git a/Source/WindowFunctions/arm_hft169d_f32.c b/Source/WindowFunctions/arm_hft169d_f32.c index a53e9f740..160fcb562 100644 --- a/Source/WindowFunctions/arm_hft169d_f32.c +++ b/Source/WindowFunctions/arm_hft169d_f32.c @@ -54,7 +54,6 @@ @brief Hft169d window generating function (f32). @param[out] pDst points to the output generated window @param[in] blockSize number of samples in the window - @return none @par Parameters of the window diff --git a/Source/WindowFunctions/arm_hft169d_f64.c b/Source/WindowFunctions/arm_hft169d_f64.c index 99dd3e11a..474de850b 100644 --- a/Source/WindowFunctions/arm_hft169d_f64.c +++ b/Source/WindowFunctions/arm_hft169d_f64.c @@ -50,7 +50,6 @@ @brief Hft169d window generating function (f64). @param[out] pDst points to the output generated window @param[in] blockSize number of samples in the window - @return none @par Parameters of the window diff --git a/Source/WindowFunctions/arm_hft196d_f32.c b/Source/WindowFunctions/arm_hft196d_f32.c index 3cbe37c85..85a4ad38b 100644 --- a/Source/WindowFunctions/arm_hft196d_f32.c +++ b/Source/WindowFunctions/arm_hft196d_f32.c @@ -54,7 +54,6 @@ @brief Hft196d window generating function (f32). @param[out] pDst points to the output generated window @param[in] blockSize number of samples in the window - @return none @par Parameters of the window diff --git a/Source/WindowFunctions/arm_hft196d_f64.c b/Source/WindowFunctions/arm_hft196d_f64.c index f561dab49..9ad520bb6 100644 --- a/Source/WindowFunctions/arm_hft196d_f64.c +++ b/Source/WindowFunctions/arm_hft196d_f64.c @@ -50,7 +50,6 @@ @brief Hft196d window generating function (f64). @param[out] pDst points to the output generated window @param[in] blockSize number of samples in the window - @return none @par Parameters of the window diff --git a/Source/WindowFunctions/arm_hft223d_f32.c b/Source/WindowFunctions/arm_hft223d_f32.c index 364487da9..23bc5beaa 100644 --- a/Source/WindowFunctions/arm_hft223d_f32.c +++ b/Source/WindowFunctions/arm_hft223d_f32.c @@ -54,7 +54,6 @@ @brief Hft223d window generating function (f32). @param[out] pDst points to the output generated window @param[in] blockSize number of samples in the window - @return none @par Parameters of the window diff --git a/Source/WindowFunctions/arm_hft223d_f64.c b/Source/WindowFunctions/arm_hft223d_f64.c index ffa6b34c5..1c4141cb1 100644 --- a/Source/WindowFunctions/arm_hft223d_f64.c +++ b/Source/WindowFunctions/arm_hft223d_f64.c @@ -50,7 +50,6 @@ @brief Hft223d window generating function (f64). @param[out] pDst points to the output generated window @param[in] blockSize number of samples in the window - @return none @par Parameters of the window diff --git a/Source/WindowFunctions/arm_hft248d_f32.c b/Source/WindowFunctions/arm_hft248d_f32.c index 1cae1745c..1a0cd47da 100644 --- a/Source/WindowFunctions/arm_hft248d_f32.c +++ b/Source/WindowFunctions/arm_hft248d_f32.c @@ -54,7 +54,6 @@ @brief Hft248d window generating function (f32). @param[out] pDst points to the output generated window @param[in] blockSize number of samples in the window - @return none @par Parameters of the window diff --git a/Source/WindowFunctions/arm_hft248d_f64.c b/Source/WindowFunctions/arm_hft248d_f64.c index 8259c771c..d6f768194 100644 --- a/Source/WindowFunctions/arm_hft248d_f64.c +++ b/Source/WindowFunctions/arm_hft248d_f64.c @@ -50,7 +50,6 @@ @brief Hft248d window generating function (f64). @param[out] pDst points to the output generated window @param[in] blockSize number of samples in the window - @return none @par Parameters of the window diff --git a/Source/WindowFunctions/arm_hft90d_f32.c b/Source/WindowFunctions/arm_hft90d_f32.c index 5a65b6e69..f8b38b002 100644 --- a/Source/WindowFunctions/arm_hft90d_f32.c +++ b/Source/WindowFunctions/arm_hft90d_f32.c @@ -55,7 +55,6 @@ @brief Hft90d window generating function (f32). @param[out] pDst points to the output generated window @param[in] blockSize number of samples in the window - @return none @par Parameters of the window diff --git a/Source/WindowFunctions/arm_hft90d_f64.c b/Source/WindowFunctions/arm_hft90d_f64.c index ebcad7ed6..40d07d3c6 100644 --- a/Source/WindowFunctions/arm_hft90d_f64.c +++ b/Source/WindowFunctions/arm_hft90d_f64.c @@ -62,7 +62,6 @@ @brief Hft90d window generating function (f64). @param[out] pDst points to the output generated window @param[in] blockSize number of samples in the window - @return none @par Parameters of the window diff --git a/Source/WindowFunctions/arm_hft95_f32.c b/Source/WindowFunctions/arm_hft95_f32.c index d001336fa..cef48d666 100644 --- a/Source/WindowFunctions/arm_hft95_f32.c +++ b/Source/WindowFunctions/arm_hft95_f32.c @@ -54,7 +54,6 @@ @brief Hft95 window generating function (f32). @param[out] pDst points to the output generated window @param[in] blockSize number of samples in the window - @return none @par Parameters of the window diff --git a/Source/WindowFunctions/arm_hft95_f64.c b/Source/WindowFunctions/arm_hft95_f64.c index 4537fafba..2c508a544 100644 --- a/Source/WindowFunctions/arm_hft95_f64.c +++ b/Source/WindowFunctions/arm_hft95_f64.c @@ -50,7 +50,6 @@ @brief Hft95 window generating function (f64). @param[out] pDst points to the output generated window @param[in] blockSize number of samples in the window - @return none @par Parameters of the window diff --git a/Source/WindowFunctions/arm_nuttall3_f32.c b/Source/WindowFunctions/arm_nuttall3_f32.c index d2bb79be5..87a2052b2 100644 --- a/Source/WindowFunctions/arm_nuttall3_f32.c +++ b/Source/WindowFunctions/arm_nuttall3_f32.c @@ -54,7 +54,6 @@ @brief Nuttall3 window generating function (f32). @param[out] pDst points to the output generated window @param[in] blockSize number of samples in the window - @return none @par Parameters of the window diff --git a/Source/WindowFunctions/arm_nuttall3_f64.c b/Source/WindowFunctions/arm_nuttall3_f64.c index b548a5880..cbc414b2e 100644 --- a/Source/WindowFunctions/arm_nuttall3_f64.c +++ b/Source/WindowFunctions/arm_nuttall3_f64.c @@ -50,7 +50,6 @@ @brief Nuttall3 window generating function (f64). @param[out] pDst points to the output generated window @param[in] blockSize number of samples in the window - @return none @par Parameters of the window diff --git a/Source/WindowFunctions/arm_nuttall3a_f32.c b/Source/WindowFunctions/arm_nuttall3a_f32.c index 7fa2cc70b..b500c3eb1 100644 --- a/Source/WindowFunctions/arm_nuttall3a_f32.c +++ b/Source/WindowFunctions/arm_nuttall3a_f32.c @@ -55,7 +55,6 @@ @brief Nuttall3a window generating function (f32). @param[out] pDst points to the output generated window @param[in] blockSize number of samples in the window - @return none @par Parameters of the window diff --git a/Source/WindowFunctions/arm_nuttall3a_f64.c b/Source/WindowFunctions/arm_nuttall3a_f64.c index 27d014e63..115aa8409 100644 --- a/Source/WindowFunctions/arm_nuttall3a_f64.c +++ b/Source/WindowFunctions/arm_nuttall3a_f64.c @@ -51,7 +51,6 @@ @brief Nuttall3a window generating function (f64). @param[out] pDst points to the output generated window @param[in] blockSize number of samples in the window - @return none @par Parameters of the window diff --git a/Source/WindowFunctions/arm_nuttall3b_f32.c b/Source/WindowFunctions/arm_nuttall3b_f32.c index 9df91cbb0..14b7b007d 100644 --- a/Source/WindowFunctions/arm_nuttall3b_f32.c +++ b/Source/WindowFunctions/arm_nuttall3b_f32.c @@ -55,7 +55,6 @@ @brief Nuttall3b window generating function (f32). @param[out] pDst points to the output generated window @param[in] blockSize number of samples in the window - @return none @par Parameters of the window diff --git a/Source/WindowFunctions/arm_nuttall3b_f64.c b/Source/WindowFunctions/arm_nuttall3b_f64.c index 5cfdc0fcd..c6df9ee90 100644 --- a/Source/WindowFunctions/arm_nuttall3b_f64.c +++ b/Source/WindowFunctions/arm_nuttall3b_f64.c @@ -51,7 +51,6 @@ @brief Nuttall3b window generating function (f64). @param[out] pDst points to the output generated window @param[in] blockSize number of samples in the window - @return none @par Parameters of the window diff --git a/Source/WindowFunctions/arm_nuttall4_f32.c b/Source/WindowFunctions/arm_nuttall4_f32.c index 63fee8452..0d78f3cfd 100644 --- a/Source/WindowFunctions/arm_nuttall4_f32.c +++ b/Source/WindowFunctions/arm_nuttall4_f32.c @@ -54,7 +54,6 @@ @brief Nuttall4 window generating function (f32). @param[out] pDst points to the output generated window @param[in] blockSize number of samples in the window - @return none @par Parameters of the window diff --git a/Source/WindowFunctions/arm_nuttall4_f64.c b/Source/WindowFunctions/arm_nuttall4_f64.c index d85ad0150..e232b2a13 100644 --- a/Source/WindowFunctions/arm_nuttall4_f64.c +++ b/Source/WindowFunctions/arm_nuttall4_f64.c @@ -50,7 +50,6 @@ @brief Nuttall4 window generating function (f64). @param[out] pDst points to the output generated window @param[in] blockSize number of samples in the window - @return none @par Parameters of the window diff --git a/Source/WindowFunctions/arm_nuttall4a_f32.c b/Source/WindowFunctions/arm_nuttall4a_f32.c index f9450d669..f2fdb0376 100644 --- a/Source/WindowFunctions/arm_nuttall4a_f32.c +++ b/Source/WindowFunctions/arm_nuttall4a_f32.c @@ -55,7 +55,6 @@ @brief Nuttall4a window generating function (f32). @param[out] pDst points to the output generated window @param[in] blockSize number of samples in the window - @return none @par Parameters of the window diff --git a/Source/WindowFunctions/arm_nuttall4a_f64.c b/Source/WindowFunctions/arm_nuttall4a_f64.c index 345e7f9c8..ba1c8d8a4 100644 --- a/Source/WindowFunctions/arm_nuttall4a_f64.c +++ b/Source/WindowFunctions/arm_nuttall4a_f64.c @@ -51,7 +51,6 @@ @brief Nuttall4a window generating function (f64). @param[out] pDst points to the output generated window @param[in] blockSize number of samples in the window - @return none @par Parameters of the window diff --git a/Source/WindowFunctions/arm_nuttall4b_f32.c b/Source/WindowFunctions/arm_nuttall4b_f32.c index bf0b14ddd..fb37593bf 100644 --- a/Source/WindowFunctions/arm_nuttall4b_f32.c +++ b/Source/WindowFunctions/arm_nuttall4b_f32.c @@ -55,7 +55,6 @@ @brief Nuttall4b window generating function (f32). @param[out] pDst points to the output generated window @param[in] blockSize number of samples in the window - @return none @par Parameters of the window diff --git a/Source/WindowFunctions/arm_nuttall4b_f64.c b/Source/WindowFunctions/arm_nuttall4b_f64.c index 9949cf9e6..5ccaa4189 100644 --- a/Source/WindowFunctions/arm_nuttall4b_f64.c +++ b/Source/WindowFunctions/arm_nuttall4b_f64.c @@ -51,7 +51,6 @@ @brief Nuttall4b window generating function (f64). @param[out] pDst points to the output generated window @param[in] blockSize number of samples in the window - @return none @par Parameters of the window diff --git a/Source/WindowFunctions/arm_nuttall4c_f32.c b/Source/WindowFunctions/arm_nuttall4c_f32.c index 36aedf057..f3db93dde 100644 --- a/Source/WindowFunctions/arm_nuttall4c_f32.c +++ b/Source/WindowFunctions/arm_nuttall4c_f32.c @@ -54,7 +54,6 @@ @brief Nuttall4c window generating function (f32). @param[out] pDst points to the output generated window @param[in] blockSize number of samples in the window - @return none @par Parameters of the window diff --git a/Source/WindowFunctions/arm_nuttall4c_f64.c b/Source/WindowFunctions/arm_nuttall4c_f64.c index 3fe3f6c50..8c918a0ff 100644 --- a/Source/WindowFunctions/arm_nuttall4c_f64.c +++ b/Source/WindowFunctions/arm_nuttall4c_f64.c @@ -50,7 +50,6 @@ @brief Nuttall4c window generating function (f64). @param[out] pDst points to the output generated window @param[in] blockSize number of samples in the window - @return none @par Parameters of the window diff --git a/Source/WindowFunctions/arm_welch_f32.c b/Source/WindowFunctions/arm_welch_f32.c index 4e4619320..f30b580c7 100644 --- a/Source/WindowFunctions/arm_welch_f32.c +++ b/Source/WindowFunctions/arm_welch_f32.c @@ -53,7 +53,6 @@ @brief Welch window generating function (f32). @param[out] pDst points to the output generated window @param[in] blockSize number of samples in the window - @return none @par Parameters of the window diff --git a/Source/WindowFunctions/arm_welch_f64.c b/Source/WindowFunctions/arm_welch_f64.c index f45342221..11d69c4a2 100644 --- a/Source/WindowFunctions/arm_welch_f64.c +++ b/Source/WindowFunctions/arm_welch_f64.c @@ -58,7 +58,6 @@ @brief Welch window generating function (f64). @param[out] pDst points to the output generated window @param[in] blockSize number of samples in the window - @return none @par Parameters of the window diff --git a/gen_pack.sh b/gen_pack.sh new file mode 100644 index 000000000..a1ef7a597 --- /dev/null +++ b/gen_pack.sh @@ -0,0 +1,119 @@ +#!/usr/bin/env bash +# Version: 3.0 +# Date: 2023-11-06 +# This bash script generates a CMSIS-DSP Software Pack: +# + +set -o pipefail + +# Set version of gen pack library +# For available versions see https://github.com/Open-CMSIS-Pack/gen-pack/tags. +# Use the tag name without the prefix "v", e.g., 0.7.0 +REQUIRED_GEN_PACK_LIB="0.9.1" + +# Set default command line arguments +DEFAULT_ARGS=(-c "v") + +# Pack warehouse directory - destination +# Default: ./output +# +# PACK_OUTPUT=./output + +# Temporary pack build directory, +# Default: ./build +# +# PACK_BUILD=./build + +# Specify directory names to be added to pack base directory +# An empty list defaults to all folders next to this script. +# Default: empty (all folders) +# +PACK_DIRS=" + ComputeLibrary + Documentation + Examples + Include + PrivateInclude + Source +" + +# Specify file names to be added to pack base directory +# Default: empty +# +PACK_BASE_FILES=" + LICENSE +" + +# Specify file names to be deleted from pack build directory +# Default: empty +# +PACK_DELETE_FILES=" + Documentation/Doxygen + Documentation/README.md +" + +# Specify patches to be applied +# Default: empty +# +# PACK_PATCH_FILES="" + +# Specify addition argument to packchk +# Default: empty +# +# PACKCHK_ARGS=() + +# Specify additional dependencies for packchk +# Default: empty +# +PACKCHK_DEPS=" + ARM.CMSIS.pdsc +" + +# Optional: restrict fallback modes for changelog generation +# Default: full +# Values: +# - full Tag annotations, release descriptions, or commit messages (in order) +# - release Tag annotations, or release descriptions (in order) +# - tag Tag annotations only +# +PACK_CHANGELOG_MODE="tag" + +# +# custom pre-processing steps +# +# usage: preprocess +# The build folder +# +function preprocess() { + # add custom steps here to be executed + # before populating the pack build folder + ./Documentation/Doxygen/gen_doc.sh + return 0 +} + +# +# custom post-processing steps +# +# usage: postprocess +# The build folder +# +function postprocess() { + # add custom steps here to be executed + # after populating the pack build folder + # but before archiving the pack into output folder + return 0 +} + +############ DO NOT EDIT BELOW ########### + +# Set GEN_PACK_LIB_PATH to use a specific gen-pack library root +# ... instead of bootstrap based on REQUIRED_GEN_PACK_LIB +if [[ -f "${GEN_PACK_LIB_PATH}/gen-pack" ]]; then + . "${GEN_PACK_LIB}/gen-pack" +else + . <(curl -sL "https://raw.githubusercontent.com/Open-CMSIS-Pack/gen-pack/main/bootstrap") +fi + +gen_pack "${DEFAULT_ARGS[@]}" "$@" + +exit 0