├── .gitmodules ├── LICENSE ├── README.md ├── analysis ├── clang-tidy │ ├── clang-tidy.sh │ └── meson.build ├── complexity │ └── meson.build ├── cppcheck │ ├── cppcheck.sh │ └── meson.build ├── sloccount │ └── meson.build └── vale │ └── meson.build ├── compiler ├── c │ └── meson.build ├── check-and-apply-flags │ └── meson.build ├── cpp │ └── meson.build └── meson.build ├── cross ├── STM32F103VBIx.txt ├── arduino_mega.txt ├── arduino_uno.txt ├── arm.txt ├── armcc.txt ├── armclang.txt ├── avr.txt ├── cortex-a53.txt ├── cortex-m3.txt ├── cortex-m4_hardfloat.txt ├── cortex-m7_hardfloat.txt ├── embvm.txt ├── libc.txt ├── libcpp.txt └── libcpp_headeronly.txt ├── docs └── doxygen │ ├── Doxyfile.in │ └── meson.build ├── format ├── .clang-format ├── format.sh └── meson.build ├── linker-scripts └── stm │ └── STM32F103VBIx_FLASH.ld ├── linker ├── linker-map │ └── meson.build └── linker-script-as-property │ └── meson.build ├── native ├── clang.txt ├── embvm.txt ├── gcc-10.txt ├── gcc-11.txt ├── gcc-12.txt ├── gcc-13.txt ├── gcc-14.txt ├── gcc-7.txt ├── gcc-8.txt ├── gcc-9.txt ├── gcc-gold.txt ├── gcc.txt ├── libc.txt ├── libc_hosted.txt ├── libcpp.txt ├── libcpp_headeronly.txt ├── macos-homebrew-clang-arm.txt ├── macos-homebrew-clang-x86.txt └── osx-mainline-clang.txt ├── objcopy └── meson.build ├── package ├── meson.build └── package.sh ├── scripts ├── delete_files_in_dir.sh ├── exec_program_with_env.sh ├── git_timestamps_all_files.sh ├── git_timestamps_last_commit.sh └── make_version.sh └── test ├── catch2 └── meson.build └── cmocka └── meson.build /.gitmodules: -------------------------------------------------------------------------------- 1 | [submodule "analysis/cppcheck/cppcheck-rules"] 2 | path = analysis/cppcheck/cppcheck-rules 3 | url = https://github.com/embeddedartistry/cppcheck-rules 4 | [submodule "analysis/vale/vale-styleguide"] 5 | path = analysis/vale/vale-styleguide 6 | url = https://github.com/embeddedartistry/vale-styleguide 7 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2018 Embedded Artistry 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # meson-buildsystem 2 | 3 | 4 | ## Dependencies 5 | 6 | lizard (complexity_check.sh) 7 | -------------------------------------------------------------------------------- /analysis/clang-tidy/clang-tidy.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | # This script expects you to use a .clang-tidy file in your resposistory, rather than 4 | # supplying checks through the command line. 5 | 6 | MESON_BUILD_ROOT=${MESON_BUILD_ROOT:-./buildresults} 7 | 8 | cd "${MESON_BUILD_ROOT}" 9 | sed -i.bak 's/-pipe//g' compile_commands.json 10 | 11 | clang-tidy -quiet -p ${MESON_BUILD_ROOT} $@ 12 | 13 | # Restore the old copy 14 | mv compile_commands.json.bak compile_commands.json 15 | -------------------------------------------------------------------------------- /analysis/clang-tidy/meson.build: -------------------------------------------------------------------------------- 1 | ############################### 2 | # Clang-tidy Analysis Support # 3 | ############################### 4 | # By including this module in your build, you will gain access to a clang-tidy 5 | # target, which runs clang-tidy on your project using the default settings 6 | # which are expected to be in .clang-tidy file(s) in your source tree. 7 | # 8 | # You must provide a list of files to run `clang-tidy` on in a variable called 9 | # clangtidy_files. The value should be an array of files objects. The variable must 10 | # be declared before invoking this build module. 11 | # 12 | # If you want to provide manual options, you can specify them in a variable called 13 | # clangtidy_options, which must be defined before including this module with subdir(). 14 | # The value of the variable must be a string or an array. 15 | 16 | # Clang-tidy run target will be unavailable if the program isn't found 17 | clangtidy = find_program('clang-tidy', required: false, disabler: true) 18 | 19 | # If you want to implement a custom clang-tidy target, you can reference 20 | # This files object to gain access to the script 21 | clangtidy_script = files('clang-tidy.sh') 22 | 23 | if clangtidy.found() 24 | if get_variable('clangtidy_files', []).length() == 0 25 | warning('clangtidy_files list not defined before including module, so the target is disabled.') 26 | else 27 | run_target('clang-tidy', 28 | command: [ 29 | clangtidy_script, 30 | # Optional user overrides 31 | get_variable('clangtidy_options', ''), 32 | # Files, 33 | clangtidy_files 34 | ], 35 | ) 36 | run_target('clang-tidy-fix', 37 | command: [ 38 | clangtidy_script, 39 | # Optional user overrides 40 | get_variable('clangtidy_options', ''), 41 | '--fix-errors', '--fix-notes', 42 | # Files, 43 | clangtidy_files 44 | ], 45 | ) 46 | endif 47 | endif 48 | -------------------------------------------------------------------------------- /analysis/complexity/meson.build: -------------------------------------------------------------------------------- 1 | ############################## 2 | # Complexity Analysis Module # 3 | ############################## 4 | # 5 | # This module adds complexity analysis using Lizard to the build, with multiple run targets. 6 | # 7 | # By default, lizard will run on all sourcefiles in the `src` and `test` 8 | # directories in the source root of the project. 9 | # 10 | # This module provides multiple customization points: 11 | # - You can override the directories to analyze by setting a variable called lizard_paths. 12 | # This variable should be a string or an array of strings. 13 | # - You can add directories to the default list by setting a variable called lizard_additional_paths. 14 | # This variable should be a string or an array of strings. 15 | # - You can override the default value of specific parameters: 16 | # * lizard_length (integer) - the maximum length of a function 17 | # * lizard_ccn (integer) - the maximum CCN of a function 18 | # * lizard_arguments (integer) - the maximum arguments a function can contain 19 | # - You can insert lizard options other than --length, --CCN, --arguments by setting a variable 20 | # called lizard_insert_options. This variable should be a string or an array of strings. 21 | # This is most commonly used to exclude directories from the build. 22 | # 23 | # For maximum customization, you can also completely override all default arguments by defining 24 | # lizard_args, which must be a string or array of strings. This will grant you full control 25 | # over the settings used by the run targets. 26 | # 27 | # All variables must be defined before including this module. 28 | # 29 | # For a full list of available argument options, see the help output of the lizard program. 30 | 31 | lizard_default_paths = [ 32 | meson.project_source_root() / 'src', 33 | meson.project_source_root() / 'test', 34 | ] 35 | 36 | lizard_paths = get_variable('lizard_paths', lizard_default_paths) 37 | lizard_additional_paths = get_variable('lizard_additional_paths', []) 38 | 39 | lizard_insert_options = get_variable('lizard_insert_options', []) 40 | 41 | # Fail over this CCN 42 | lizard_ccn = get_variable('lizard_ccn', 10).to_string() 43 | # Fail when functions are longer than this 44 | lizard_length = get_variable('lizard_length', 75).to_string() 45 | # Fail at this arg count 46 | lizard_arguments = get_variable('lizard_arguments', 10).to_string() 47 | 48 | lizard_default_args = [ 49 | # Custom options to insert 50 | lizard_insert_options, 51 | # Configuration 52 | '--length', lizard_length, 53 | '--CCN', lizard_ccn, 54 | '--arguments', lizard_arguments, 55 | # Counts switch/case with multiple args as 1 56 | '--modified', 57 | # Source Directories to audit 58 | lizard_paths, 59 | lizard_additional_paths, 60 | ] 61 | 62 | lizard_args = get_variable('lizard_args', lizard_default_args) 63 | 64 | # Lizard-based targets will be unavailable if the program isn't found 65 | lizard = find_program('lizard', required: false, disabler: true) 66 | 67 | # Only print violations 68 | run_target('complexity', 69 | command: [lizard, 70 | lizard_args, 71 | '-w' 72 | ] 73 | ) 74 | 75 | # Print full output of lizard command 76 | run_target('complexity-full', 77 | command: [lizard, 78 | lizard_args 79 | ] 80 | ) 81 | 82 | # Generate XML output 83 | complexity_xml = custom_target('complexity.xml', 84 | output: 'complexity.xml', 85 | command: [ 86 | lizard, 87 | lizard_args, 88 | '--xml' 89 | ], 90 | capture: true, 91 | build_always_stale: true, 92 | build_by_default: false, 93 | ) 94 | 95 | # Convenience target to generate the XML file via a command, instead of referencing the file 96 | # directly (e.g., ninja -C buildresults/meson/analysis/complexity/complexity.xml) 97 | alias_target('complexity-xml', complexity_xml) 98 | -------------------------------------------------------------------------------- /analysis/cppcheck/cppcheck.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | # Script invocation: 4 | # cppcheck.sh [options] 5 | # 6 | # You can include any number of directories and files to pass to cppcheck. Files can be separated 7 | # by spaces: docs include buildresults/lib/libc.a 8 | # 9 | # By default, `style` checks are enabled. You can override this setting with the -c flag. 10 | # 11 | ### Example Invocation ### 12 | # cppcheck.sh -e style,file -x src test 13 | # 14 | # Arguments 15 | # `-c` takes a comma-separated list of styles that is directly passed to cppcheck. 16 | # If no -e option is specified, `style` is used. 17 | # `-e` takes a comma-separated list of directories or files to exclude from checks 18 | # `-i` takes a comma-separated list of include directory paths 19 | # `-r` takes a comma-separated list of custom rule files 20 | # `-x` will save the output in a file called `cppcheck.xml` 21 | # 22 | # Positional Arguments 23 | # 24 | # All positional arguments are directories or files to include in the checks. 25 | 26 | MESON_CURRENT_SOURCE_DIR=${MESON_CURRENT_SOURCE_DIR:-./} 27 | MESON_BUILD_ROOT=${MESON_BUILD_ROOT:-buildresults} 28 | 29 | XML_ARGS= 30 | XML_REDIRECT= 31 | CHECKS=style 32 | INCLUDES= 33 | EXCLUDES= 34 | RULES= 35 | 36 | while getopts "c:e:i:r:x" opt; do 37 | case $opt in 38 | x) XML_ARGS='--xml --xml-version=2' 39 | XML_REDIRECT="2>${MESON_BUILD_ROOT}/cppcheck.xml" 40 | ;; 41 | c) CHECKS="$OPTARG" 42 | ;; 43 | e) 44 | # Convert CSV files lists into spaces 45 | IFS=',' read -ra ENTRIES <<< "$OPTARG" 46 | for exclude in "${ENTRIES[@]}"; do 47 | EXCLUDES="$EXCLUDES -i $exclude" 48 | done 49 | ;; 50 | i) 51 | # Convert CSV files lists into spaces 52 | IFS=',' read -ra ENTRIES <<< "$OPTARG" 53 | for include in "${ENTRIES[@]}"; do 54 | INCLUDES="$INCLUDES -I $include" 55 | done 56 | ;; 57 | r) 58 | # Convert CSV files lists into spaces 59 | IFS=',' read -ra ENTRIES <<< "$OPTARG" 60 | for rules in "${ENTRIES[@]}"; do 61 | RULES="$RULES --rule-file=$rules" 62 | done 63 | ;; 64 | \?) echo "Invalid option -$OPTARG" >&2 65 | ;; 66 | esac 67 | done 68 | 69 | # Shift off the getopts args, leaving us with positional args 70 | shift $((OPTIND -1)) 71 | 72 | eval cppcheck --quiet --enable=$CHECKS --inline-suppr --force ${XML_ARGS} \ 73 | $INCLUDES $EXCLUDES $RULES $@ ${XML_REDIRECT} 74 | -------------------------------------------------------------------------------- /analysis/cppcheck/meson.build: -------------------------------------------------------------------------------- 1 | ############################# 2 | # Cppcheck Analysis Support # 3 | ############################# 4 | # By including this module in your build, you will gain access to cppcheck and 5 | # cppcheck-xml targets. 6 | # 7 | # By default, cppcheck will be run with `--enable=style` on the `src` and `test` 8 | # directories in the source root of the project. You can specify additional options like checks, 9 | # exclude paths, include directories, and custom rule files by populating these variables 10 | # before invoking this module. Configurable options are: 11 | # - cppcheck_paths 12 | # - cppcheck_additional_paths (use default, but add files/folders) 13 | # - cppcheck_includes 14 | # - cppcheck_excludes 15 | # - cppcheck_custom_rules 16 | # - cppcheck_checks 17 | # 18 | # In all cases, these variables should be defined as arrays of strings, even for n=1. 19 | # 20 | # If you need to override the default settings completely, you can do so by defining a variable 21 | # called cppcheck_args. This variable should be an array of strings, formatted as expected 22 | # by the cppcheck.sh script. You are responsible for formatting arguments in this case. 23 | 24 | cppcheck_default_paths = [ 25 | meson.project_source_root() / 'src', 26 | meson.project_source_root() / 'test', 27 | ] 28 | 29 | cppcheck_default_custom_rules = [ 30 | meson.current_source_dir() / 'cppcheck-rules/BitwiseOperatorInConditional/rule.xml', 31 | meson.current_source_dir() / 'cppcheck-rules/CollapsibleIfStatements/rule.xml', 32 | meson.current_source_dir() / 'cppcheck-rules/EmptyElseBlock/rule.xml', 33 | meson.current_source_dir() / 'cppcheck-rules/EmptyCatchStatement/rule.xml', 34 | meson.current_source_dir() / 'cppcheck-rules/EmptyDoWhileStatement/rule.xml', 35 | meson.current_source_dir() / 'cppcheck-rules/EmptyForStatement/rule.xml', 36 | meson.current_source_dir() / 'cppcheck-rules/EmptyIfStatement/rule.xml', 37 | meson.current_source_dir() / 'cppcheck-rules/EmptySwitchStatement/rule.xml', 38 | meson.current_source_dir() / 'cppcheck-rules/ForLoopShouldBeWhileLoop/rule.xml', 39 | meson.current_source_dir() / 'cppcheck-rules/InvertedLogic/rule.xml', 40 | meson.current_source_dir() / 'cppcheck-rules/MultipleUnaryOperator/rule.xml', 41 | meson.current_source_dir() / 'cppcheck-rules/RedundantConditionalOperator/rule.xml', 42 | meson.current_source_dir() / 'cppcheck-rules/RedundantIfStatement/rule.xml', 43 | meson.current_source_dir() / 'cppcheck-rules/UnnecessaryElseStatement/rule.xml', 44 | meson.current_source_dir() / 'cppcheck-rules/UseStlAlgorithm/rule.xml', 45 | ] 46 | 47 | cppcheck_paths = get_variable('cppcheck_paths', cppcheck_default_paths) 48 | cppcheck_additional_paths = get_variable('cppcheck_additional_paths', []) 49 | 50 | # Include directory search paths for Cppcheck 51 | cppcheck_includes = get_variable('cppcheck_includes', []) 52 | if cppcheck_includes.length() > 0 53 | cppcheck_includes_processed = '' 54 | foreach entry : cppcheck_includes 55 | cppcheck_includes_processed += entry + ',' 56 | endforeach 57 | # Convert to array with proper script argument 58 | cppcheck_includes_processed = ['-i', cppcheck_includes_processed] 59 | else 60 | cppcheck_includes_processed = [] 61 | endif 62 | 63 | # Files to exclude from analysis 64 | cppcheck_excludes = get_variable('cppcheck_excludes', []) 65 | if cppcheck_excludes.length() > 0 66 | cppcheck_excludes_processed = '' 67 | foreach entry : cppcheck_excludes 68 | cppcheck_excludes_processed += entry + ',' 69 | endforeach 70 | # Convert to array with proper script argument 71 | cppcheck_excludes_processed = ['-e', cppcheck_excludes_processed] 72 | else 73 | cppcheck_excludes_processed = [] 74 | endif 75 | 76 | # Custom rules to use 77 | cppcheck_custom_rules = get_variable('cppcheck_custom_rules', cppcheck_default_custom_rules) 78 | # Add additional rules to the default list 79 | cppcheck_custom_rules += get_variable('cppcheck_additional_custom_rules', []) 80 | if cppcheck_custom_rules.length() > 0 81 | cppcheck_custom_rules_processed = '' 82 | foreach entry : cppcheck_custom_rules 83 | cppcheck_custom_rules_processed += entry + ',' 84 | endforeach 85 | # Convert to array with proper script argument 86 | cppcheck_custom_rules_processed = ['-r', cppcheck_custom_rules_processed] 87 | else 88 | cppcheck_custom_rules_processed = [] 89 | endif 90 | 91 | # style checks to override 92 | cppcheck_checks = get_variable('cppcheck_checks', []) 93 | if cppcheck_checks.length() > 0 94 | cppcheck_checks_processed = '' 95 | foreach entry : cppcheck_checks 96 | cppcheck_checks_processed += entry + ',' 97 | endforeach 98 | # Convert to array with proper script argument 99 | cppcheck_checks_processed = ['-c', cppcheck_checks_processed] 100 | else 101 | cppcheck_checks_processed = [] 102 | endif 103 | 104 | cppcheck_default_args = [ 105 | # getopts arguments 106 | cppcheck_includes_processed, 107 | cppcheck_excludes_processed, 108 | cppcheck_custom_rules_processed, 109 | cppcheck_checks_processed, 110 | # Positional Arguments 111 | cppcheck_paths, 112 | cppcheck_additional_paths, 113 | ] 114 | 115 | cppcheck_args = get_variable('cppcheck_args', cppcheck_default_args) 116 | 117 | # Cppcheck run targets will be unavailable if the program isn't found 118 | cppcheck = find_program('cppcheck', required: false, disabler: true) 119 | 120 | # If you want to implement a custom cppcheck target, you can reference 121 | # This files object to gain access to the script 122 | cppcheck_script = files('cppcheck.sh') 123 | 124 | if cppcheck.found() 125 | run_target('cppcheck', 126 | command: [ 127 | cppcheck_script, 128 | # Supply Arguments 129 | cppcheck_args 130 | ] 131 | ) 132 | 133 | run_target('cppcheck-xml', 134 | command: [ 135 | cppcheck_script, 136 | # Enable XML output 137 | '-x', 138 | # Supply Arguments 139 | cppcheck_args 140 | ], 141 | ) 142 | endif 143 | 144 | -------------------------------------------------------------------------------- /analysis/sloccount/meson.build: -------------------------------------------------------------------------------- 1 | ############################## 2 | # sloccount Analysis Support # 3 | ############################## 4 | # 5 | # This module adds an sloccount target to your build system, which provides 6 | # line of code analysis and cost/effort estimates for your project. 7 | # 8 | # All variables used below can be overridden by the user. Simply define the variables 9 | # with your own values before invoking this module. 10 | # 11 | # The settings for this module default to "embedded" COCOMO mode: 12 | # Embedded: The project must operate within tight (hard-to-meet) constraints, 13 | # and requirements and interface specifications are often non-negotiable. 14 | # The software will be embedded in a complex environment that the software must deal with as-is. 15 | # 16 | # Values for the models are: 17 | # Organic: effort factor = 2.4, exponent = 1.05; schedule factor = 2.5, exponent = 0.38 18 | # Semidetached: effort factor = 3.0, exponent = 1.12; schedule factor = 2.5, exponent = 0.35 19 | # Embedded: effort factor = 3.6, exponent = 1.20; schedule factor = 2.5, exponent = 0.32 20 | # 21 | # For information on tuning the model, see: 22 | # https://dwheeler.com/sloccount/sloccount.html#cocomo 23 | 24 | sloccount_default_directories = [ 25 | meson.project_source_root() / 'src', 26 | meson.project_source_root() / 'test', 27 | ] 28 | 29 | sloccount_dirs = get_variable('sloccount_dirs', sloccount_default_directories) 30 | sloccount_additional_dirs = get_variable('sloccount_additional_dirs', []) 31 | 32 | # sloccount_effort is a pair of values [F, E], where F is the factor and E is the exponent. 33 | # this impacts calculated effort in person-months. 34 | sloccount_effort = get_variable('sloccount_effort', ['3.6', '1.12']) 35 | 36 | # sloccount_schedule is a pair of values [F, E], where F is the factor and E is the exponent. 37 | # this impacts calculated effort in person-months. 38 | sloccount_schedule = get_variable('sloccount_schedule', ['2.5', '0.32']) 39 | 40 | # The average salary value to use in cost estimates 41 | sloccount_salary = get_variable('sloccount_salary', '140000') 42 | 43 | # The developer overhead value to use in cost estimates 44 | sloccount_overhead = get_variable('sloccount_overhead', '2') 45 | 46 | sloccount_default_args = [ 47 | # Follow symbolic links 48 | '--follow', 49 | # Store data in the output directory 50 | '--datadir', meson.current_build_dir(), 51 | # Effort factor/exponent 52 | '--effort', sloccount_effort, 53 | # Schedule factor/exponent 54 | '--schedule', sloccount_schedule, 55 | # Annual Salary Setting 56 | '--personcost', sloccount_salary, 57 | # Overhead value 58 | '--overhead', sloccount_overhead, 59 | ] 60 | 61 | # Provides the ability to override the sloccount default arguments 62 | sloccount_args = get_variable('sloccount_args', sloccount_default_args) 63 | 64 | # You can use this variable to supply additional arguments 65 | # without overriding the defaults 66 | sloccount_additional_args = get_variable('sloccount_additional_args', []) 67 | 68 | # sloccount targets will be disabled if the program isn't found 69 | sloccount = find_program('sloccount', required: false, disabler: true) 70 | 71 | sloccount_arg_set = [ 72 | # Supply Arguments 73 | sloccount_args, 74 | sloccount_additional_args, 75 | # Directories to analyze 76 | sloccount_dirs, 77 | sloccount_additional_dirs, 78 | ] 79 | 80 | run_target('sloccount', 81 | command: [ 82 | sloccount, 83 | sloccount_arg_set 84 | ] 85 | ) 86 | 87 | run_target('sloccount-full', 88 | command: [ 89 | sloccount, 90 | '--details', 91 | sloccount_arg_set 92 | ] 93 | ) 94 | 95 | sloccount_lines = custom_target('sloccount.sc', 96 | output: 'sloccount.sc', 97 | command: [ 98 | sloccount, 99 | sloccount_arg_set, 100 | ], 101 | capture: true, 102 | build_by_default: false, 103 | build_always_stale: true, 104 | ) 105 | 106 | sloccount_files = custom_target('sloccount_detailed.sc', 107 | output: 'sloccount_detailed.sc', 108 | command: [ 109 | sloccount, 110 | # Show details for every source code file 111 | '--details', 112 | sloccount_arg_set, 113 | sloccount_additional_args, 114 | ], 115 | capture: true, 116 | build_by_default: false, 117 | build_always_stale: true, 118 | ) 119 | 120 | alias_target('sloccount-report', sloccount_lines) 121 | alias_target('sloccount-full-report', sloccount_files) 122 | 123 | -------------------------------------------------------------------------------- /analysis/vale/meson.build: -------------------------------------------------------------------------------- 1 | ################################ 2 | # Vale Document Linting Module # 3 | ################################ 4 | # This module adds a vale document linting target to your build system. 5 | # 6 | # All variables used below can be overridden by the user. Simply define the variables 7 | # with your own values before invoking this module. 8 | 9 | vale_default_files = [ 10 | meson.project_source_root() + '/docs/', 11 | meson.project_source_root() + '/README.md' 12 | ] 13 | 14 | # Override this variable to control what files and folders vale will analyze 15 | vale_files = get_variable('vale_files', vale_default_files) 16 | 17 | # Add additional files without redefining the defaults 18 | vale_additional_files = get_variable('vale_files', []) 19 | 20 | # Control the file types that vale will analyze. Separated by comma. 21 | vale_file_types = get_variable('vale_file_types', 'md,rst,txt') 22 | 23 | # Supply a style file, which will use this file instead of the default .vale.ini 24 | vale_config_file = get_variable('vale_config_file', 25 | files('vale-styleguide/config/documentation.vale.ini')) 26 | 27 | vale_default_args = [ 28 | # Files to include in analysis 29 | '--glob', '*.{' + vale_file_types + '}' 30 | ] 31 | 32 | if vale_config_file.length() > 0 33 | vale_default_args += ['--config', vale_config_file] 34 | endif 35 | 36 | # Control the arguments passed to vale. 37 | vale_args = get_variable('vale_args', vale_default_args) 38 | # Add additional arguments without overriding the defaults 39 | vale_additional_args = get_variable('vale_additional_args', []) 40 | 41 | vale = find_program('vale', required: false, disabler: true) 42 | 43 | run_target('vale', 44 | command: [ 45 | vale, 46 | vale_args, 47 | vale_additional_args, 48 | vale_files, 49 | vale_additional_files 50 | ] 51 | ) 52 | -------------------------------------------------------------------------------- /compiler/c/meson.build: -------------------------------------------------------------------------------- 1 | ################################################## 2 | # Common C Language Compiler Settings and Values # 3 | ################################################## 4 | 5 | native_c_compiler = meson.get_compiler('c', native: true) 6 | host_c_compiler = meson.get_compiler('c', native: false) 7 | 8 | native_c_compiler_id = native_c_compiler.get_id() 9 | host_c_compiler_id = host_c_compiler.get_id() 10 | 11 | # Use these variables to control whether you're setting flags for native: true/false 12 | desired_c_compile_flags = [] 13 | desired_native_c_compile_flags = [] 14 | -------------------------------------------------------------------------------- /compiler/check-and-apply-flags/meson.build: -------------------------------------------------------------------------------- 1 | ############################################################## 2 | # Modular Fucntion to Check and Apply Compiler Flags in Bulk # 3 | ############################################################## 4 | 5 | # To use this function, define a variable called compile_settings_list and/or link_settings_list. 6 | # These variables are used to iterate over each compiler/flag/native setting to reduce duplication. 7 | # Populate these variable before including this module. 8 | # 9 | # Common flags that apply to all configuratons are specified in varibles called: 10 | # - desired_common_compile_flags 11 | # - desired_common_link_flags 12 | # 13 | # Each element should be a dict, with the following fields: 14 | # 'lang': programming language (string) 15 | # 'compiler': compiler object to supply for has_argument() calls 16 | # 'flags': a list of flags that you want to test and apply to the project 17 | # 'isnative': true if native, false otherwise 18 | # 19 | ## Here is an example list that applies flags to C and C++ for native true/false 20 | # 21 | #compile_settings_list = [ 22 | # {'lang': 'c', 'compiler': host_c_compiler, 'flags': desired_c_compile_flags, 'isnative': false}, 23 | # {'lang': 'c', 'compiler': native_c_compiler, 'flags': desired_native_c_compile_flags, 'isnative': true}, 24 | # {'lang': 'cpp', 'compiler': host_cpp_compiler, 'flags': desired_cpp_compile_flags, 'isnative': false}, 25 | # {'lang': 'cpp', 'compiler': native_cpp_compiler, 'flags': desired_native_cpp_compile_flags, 'isnative': true}, 26 | #] 27 | # 28 | # Sometimes linker checks provide false failures due to missing symbols at link time. 29 | # To provide additional flags for linker checks, populate an optional property in your cross file: 30 | # get_supported_link_arg_flags 31 | # 32 | # The same structure is used for both compile_settings_list and link_settings_list 33 | 34 | 35 | if get_variable('compile_settings_list', []).length() == 0 36 | warning('Expected variable compile_settings_list not defined. Not processing compiler arguments.') 37 | else 38 | # Process each compiler configuration 39 | foreach entry : compile_settings_list 40 | add_project_arguments(entry.get('compiler').get_supported_arguments( 41 | entry.get('flags') + desired_common_compile_flags), 42 | language: entry.get('lang'), native: entry.get('isnative')) 43 | endforeach 44 | endif 45 | 46 | if get_variable('link_settings_list', []).length() == 0 47 | warning('Expected variable link_settings_list not defined. Not processing linker arguments.') 48 | else 49 | # Process each linker configuration 50 | foreach entry : link_settings_list 51 | supporting_link_flags = meson.get_external_property('get_supported_link_arg_flags', [], 52 | native: entry.get('isnative')) 53 | 54 | foreach flag : entry.get('flags') + desired_common_link_flags 55 | if entry.get('compiler').has_multi_link_arguments(flag, supporting_link_flags) 56 | add_project_link_arguments(flag, 57 | language: entry.get('lang'), native: entry.get('isnative')) 58 | endif 59 | endforeach 60 | endforeach 61 | endif 62 | -------------------------------------------------------------------------------- /compiler/cpp/meson.build: -------------------------------------------------------------------------------- 1 | #################################################### 2 | # Common C++ Language Compiler Settings and Values # 3 | #################################################### 4 | 5 | native_cpp_compiler = meson.get_compiler('cpp', native: true) 6 | host_cpp_compiler = meson.get_compiler('cpp', native: false) 7 | 8 | native_cpp_compiler_id = native_cpp_compiler.get_id() 9 | host_cpp_compiler_id = host_cpp_compiler.get_id() 10 | 11 | desired_cpp_common_warning_flags = [ 12 | '-Wold-style-cast', 13 | '-Wnon-virtual-dtor', 14 | '-Wctor-dtor-privacy', 15 | '-Woverloaded-virtual', 16 | '-Wnoexcept', 17 | '-Wstrict-null-sentinel', 18 | '-Wuseless-cast', 19 | '-Wzero-as-null-pointer-constant', 20 | '-Wextra-semi', 21 | ] 22 | 23 | # Use these variables to control whether you're setting flags for native: true/false 24 | desired_cpp_compile_flags = [] 25 | if meson.is_subproject() == false 26 | desired_cpp_compile_flags += desired_cpp_common_warning_flags 27 | endif 28 | desired_native_cpp_compile_flags = desired_cpp_compile_flags 29 | -------------------------------------------------------------------------------- /compiler/meson.build: -------------------------------------------------------------------------------- 1 | ################################################## 2 | # Common Non-language Specific Compiler Settings # 3 | ################################################## 4 | 5 | # NOTE: 6 | # For language-specific values, use subdir('meson/compiler/') in your top-level build file 7 | 8 | desired_common_warning_flags = [ 9 | # Disabled Warnings 10 | '-Wno-unknown-pragmas', # Some compilers complain about our use of #pragma mark 11 | '-Wno-c++98-compat', 12 | '-Wno-c++98-compat-pedantic', 13 | '-Wno-padded', 14 | '-Wno-exit-time-destructors', # causes warnings if you use static values 15 | '-Wno-global-constructors', # causes warnings if you use static values 16 | '-Wno-covered-switch-default', 17 | # Desired Warnings 18 | '-Wfloat-equal', 19 | '-Wconversion', 20 | '-Wlogical-op', 21 | '-Wundef', 22 | '-Wredundant-decls', 23 | '-Wshadow', 24 | '-Wstrict-overflow=2', 25 | '-Wwrite-strings', 26 | '-Wpointer-arith', 27 | '-Wcast-qual', 28 | '-Wformat=2', 29 | '-Wformat-truncation', 30 | '-Wmissing-include-dirs', 31 | '-Wcast-align', 32 | '-Wswitch-enum', 33 | '-Wsign-conversion', 34 | '-Wdisabled-optimization', 35 | # '-Winline', # Now disabled because it is mostly warning us about default constructors and destructors 36 | '-Winvalid-pch', 37 | '-Wmissing-declarations', 38 | '-Wdouble-promotion', 39 | '-Wshadow', 40 | '-Wtrampolines', 41 | '-Wvector-operation-performance', 42 | '-Wshift-overflow=2', 43 | '-Wnull-dereference', 44 | '-Wduplicated-cond', 45 | '-Wshift-overflow=2', 46 | '-Wnull-dereference', 47 | '-Wduplicated-cond', 48 | '-Wcast-align=strict', 49 | ] 50 | 51 | # These variables should be set for all combinations of compilers and native: true/false 52 | desired_common_compile_flags = [ 53 | # Diagnostics 54 | '-fdiagnostics-show-option', 55 | '-fcolor-diagnostics', 56 | # Compiler Optimization Flags 57 | '-ffunction-sections', # Place each function in its own section (ELF Only) 58 | '-fdata-sections', # Place each data in its own section (ELF Only) 59 | '-fdevirtualize', # Attempt to convert calls to virtual functions to direct calls 60 | ] 61 | 62 | if meson.is_subproject() == false 63 | desired_common_compile_flags += desired_common_warning_flags 64 | endif 65 | 66 | 67 | desired_common_link_flags = [ 68 | # Optimization Flags 69 | '-Wl,-dead_strip', # Strip dead symbols for MacOS 70 | '-Wl,--gc-sections', 71 | ] 72 | -------------------------------------------------------------------------------- /cross/STM32F103VBIx.txt: -------------------------------------------------------------------------------- 1 | # Meson Cross-compilation File for STM32F103VBIx Cortex-M3 processors 2 | # Note that Cortex-M3 does not provide an FPU 3 | # This file should be layered after arm.txt 4 | # Requires that arm-none-eabi-* is found in your PATH 5 | # For more information: http://mesonbuild.com/Cross-compilation.html 6 | 7 | [built-in options] 8 | c_args = [ '-mcpu=cortex-m3', '-mfloat-abi=soft', '-mabi=aapcs', '-mthumb',] 9 | c_link_args = [ '-mcpu=cortex-m3', '-mfloat-abi=soft', '-mabi=aapcs', '-mthumb',] 10 | cpp_args = [ '-mcpu=cortex-m3', '-mfloat-abi=soft', '-mabi=aapcs', '-mthumb',] 11 | cpp_link_args = [ '-mcpu=cortex-m3', '-mfloat-abi=soft', '-mabi=aapcs', '-mthumb'] 12 | 13 | [properties] 14 | linker_paths = ['build/linker-scripts/stm/'] 15 | linker_scripts = ['STM32F103VBIx_FLASH.ld'] 16 | link_depends = ['build/linker-scripts/stm/STM32F103VBIx_FLASH.ld'] 17 | 18 | [host_machine] 19 | cpu = 'STM32F103VBIx' 20 | -------------------------------------------------------------------------------- /cross/arduino_mega.txt: -------------------------------------------------------------------------------- 1 | [built-in options] 2 | c_args = [ '-ffunction-sections', '-fdata-sections', '-mmcu=atmega2560', '-DF_CPU=16000000L', '-DARDUINO=105', '-D__PROG_TYPES_COMPAT__', ] 3 | cpp_args = [ '-fno-exceptions', '-ffunction-sections', '-fdata-sections', '-mmcu=atmega2560', '-DF_CPU=16000000L', '-DARDUINO=105', '-D__PROG_TYPES_COMPAT__', ] 4 | c_link_args = ['-Wl,--gc-sections', '-mmcu=atmega2560'] 5 | cpp_link_args = ['-Wl,--gc-sections', '-mmcu=atmega2560'] 6 | 7 | [properties] 8 | # For use with ArduinoCore-avr subproject 9 | variant = 'standard' 10 | 11 | [host_machine] 12 | cpu = 'atmega2560' 13 | -------------------------------------------------------------------------------- /cross/arduino_uno.txt: -------------------------------------------------------------------------------- 1 | [built-in options] 2 | c_args = [ '-ffunction-sections', '-fdata-sections', '-mmcu=atmega328p', '-DF_CPU=16000000L', '-DARDUINO=105', '-D__PROG_TYPES_COMPAT__', ] 3 | cpp_args = [ '-fno-exceptions', '-ffunction-sections', '-fdata-sections', '-mmcu=atmega328p', '-DF_CPU=16000000L', '-DARDUINO=105', '-D__PROG_TYPES_COMPAT__', ] 4 | c_link_args = ['-Wl,--gc-sections', '-mmcu=atmega328p'] 5 | cpp_link_args = ['-Wl,--gc-sections', '-mmcu=atmega328p'] 6 | 7 | [properties] 8 | # For use with ArduinoCore-avr subproject 9 | variant = 'standard' 10 | 11 | [host_machine] 12 | cpu = 'atmega328P' 13 | -------------------------------------------------------------------------------- /cross/arm.txt: -------------------------------------------------------------------------------- 1 | # Meson Cross-compilation File Base using GCC ARM 2 | # Requires that arm-none-eabi-* is found in your PATH 3 | # For more information: http://mesonbuild.com/Cross-compilation.html 4 | 5 | [binaries] 6 | c = 'arm-none-eabi-gcc' 7 | cpp = 'arm-none-eabi-c++' 8 | # *-gcc-ar is used over *-ar to support LTO flags. 9 | # Without -gcc-ar, LTO will generate a linker warning: 10 | # arm-none-eabi-ar: file.o: plugin needed to handle lto object 11 | ar = 'arm-none-eabi-gcc-ar' 12 | strip = 'arm-none-eabi-strip' 13 | 14 | [properties] 15 | objcopy = 'arm-none-eabi-objcopy' 16 | # Flags used when checking for supported linker arguments 17 | # Use this property when flag checks fail due to linker errors with ARM GCC 18 | get_supported_link_arg_flags = ['--specs=nosys.specs'] 19 | # Keep this set, or the sanity check won't pass 20 | needs_exe_wrapper = true 21 | 22 | [host_machine] 23 | system = 'none' 24 | cpu_family = 'arm' 25 | # CPU should be redefined in child cross files - this is a placeholder 26 | # that will be used in case a child file does not override this setting 27 | cpu = 'arm-generic' 28 | endian = 'little' 29 | -------------------------------------------------------------------------------- /cross/armcc.txt: -------------------------------------------------------------------------------- 1 | # This file assumes that path to the arm compiler toolchain is added 2 | # to the environment(PATH) variable, so that Meson can find 3 | # the armclang, armlink and armar while building. 4 | [binaries] 5 | c = 'armcc' 6 | cpp = 'armcc' 7 | ar = 'armar' 8 | strip = 'armar' 9 | 10 | [host_machine] 11 | system = 'none' 12 | cpu_family = 'arm' 13 | # CPU should be redefined in child cross files - this is a placeholder 14 | # that will be used in case a child file does not override this setting 15 | cpu = 'arm-generic' 16 | endian = 'little' 17 | -------------------------------------------------------------------------------- /cross/armclang.txt: -------------------------------------------------------------------------------- 1 | # This file assumes that path to the arm compiler toolchain is added 2 | # to the environment(PATH) variable, so that Meson can find 3 | # the armclang, armlink and armar while building. 4 | [binaries] 5 | c = 'armclang' 6 | cpp = 'armclang' 7 | ar = 'armar' 8 | strip = 'armar' 9 | 10 | [host_machine] 11 | system = 'none' 12 | cpu_family = 'arm' 13 | # CPU should be redefined in child cross files - this is a placeholder 14 | # that will be used in case a child file does not override this setting 15 | cpu = 'arm-generic' 16 | endian = 'little' 17 | -------------------------------------------------------------------------------- /cross/avr.txt: -------------------------------------------------------------------------------- 1 | # Base file for AVR chips using the AVR GCC toolchain 2 | 3 | [binaries] 4 | c = 'avr-gcc' 5 | cpp = 'avr-g++' 6 | ar = 'avr-gcc-ar' 7 | strip = 'avr-strip' 8 | 9 | [properties] 10 | objcopy = 'avr-objcopy' 11 | 12 | [host_machine] 13 | system = 'none' 14 | cpu_family = 'avr' 15 | # Note that 32-bit AVR chips are big endian 16 | endian = 'little' 17 | -------------------------------------------------------------------------------- /cross/cortex-a53.txt: -------------------------------------------------------------------------------- 1 | # Meson Cross-compilation File for Cortex-A53 processors using Hardware FP 2 | # This file should be layered after arm.txt 3 | # Requires that arm-none-eabi-* is found in your PATH 4 | # For more information: http://mesonbuild.com/Cross-compilation.html 5 | 6 | [built-in options] 7 | c_args = [ '-mcpu=cortex-a53', '-mfloat-abi=hard', '-mabi=aapcs'] 8 | c_link_args = [ '-mcpu=cortex-a53', '-mfloat-abi=hard', '-mabi=aapcs'] 9 | cpp_args = [ '-mcpu=cortex-a53', '-mfloat-abi=hard', '-mabi=aapcs'] 10 | cpp_link_args = [ '-mcpu=cortex-a53', '-mfloat-abi=hard', '-mabi=aapcs'] 11 | 12 | [host_machine] 13 | cpu_family = 'aarch64' 14 | cpu = 'cortex-a53' 15 | -------------------------------------------------------------------------------- /cross/cortex-m3.txt: -------------------------------------------------------------------------------- 1 | # Meson Cross-compilation File for Cortex-M3 processors 2 | # Note that Cortex-M3 does not provide an FPU 3 | # This file should be layered after arm.txt 4 | # Requires that arm-none-eabi-* is found in your PATH 5 | # For more information: http://mesonbuild.com/Cross-compilation.html 6 | 7 | [built-in options] 8 | c_args = [ '-mcpu=cortex-m3', '-mfloat-abi=soft', '-mabi=aapcs', '-mthumb',] 9 | c_link_args = [ '-mcpu=cortex-m3', '-mfloat-abi=soft', '-mabi=aapcs', '-mthumb',] 10 | cpp_args = [ '-mcpu=cortex-m3', '-mfloat-abi=soft', '-mabi=aapcs', '-mthumb',] 11 | cpp_link_args = [ '-mcpu=cortex-m3', '-mfloat-abi=soft', '-mabi=aapcs', '-mthumb',] 12 | 13 | [host_machine] 14 | cpu = 'cortex-m3' 15 | -------------------------------------------------------------------------------- /cross/cortex-m4_hardfloat.txt: -------------------------------------------------------------------------------- 1 | # Meson Cross-compilation File for Cortex-M4 processors using Hardware FP 2 | # This file should be layered after arm.txt 3 | # Requires that arm-none-eabi-* is found in your PATH 4 | # For more information: http://mesonbuild.com/Cross-compilation.html 5 | 6 | [built-in options] 7 | c_args = [ '-mcpu=cortex-m4', '-mfloat-abi=hard', '-mfpu=fpv4-sp-d16', '-mabi=aapcs', '-mthumb',] 8 | c_link_args = [ '-mcpu=cortex-m4', '-mfloat-abi=hard', '-mfpu=fpv4-sp-d16', '-mabi=aapcs', '-mthumb',] 9 | cpp_args = [ '-mcpu=cortex-m4', '-mfloat-abi=hard', '-mfpu=fpv4-sp-d16', '-mabi=aapcs', '-mthumb',] 10 | cpp_link_args = [ '-mcpu=cortex-m4', '-mfloat-abi=hard', '-mfpu=fpv4-sp-d16', '-mabi=aapcs', '-mthumb',] 11 | 12 | [host_machine] 13 | cpu = 'cortex-m4' 14 | -------------------------------------------------------------------------------- /cross/cortex-m7_hardfloat.txt: -------------------------------------------------------------------------------- 1 | # Meson Cross-compilation File for Cortex-M7 processors using Hardware FP 2 | # This file should be layered after arm.txt 3 | # Requires that arm-none-eabi-* is found in your PATH 4 | # For more information: http://mesonbuild.com/Cross-compilation.html 5 | 6 | [built-in options] 7 | c_args = [ '-mcpu=cortex-m7', '-mfloat-abi=hard', '-mfpu=fpv5-sp-d16', '-mabi=aapcs', '-mthumb',] 8 | c_link_args = [ '-mcpu=cortex-m7', '-mfloat-abi=hard', '-mfpu=fpv5-sp-d16', '-mabi=aapcs', '-mthumb',] 9 | cpp_args = [ '-mcpu=cortex-m7', '-mfloat-abi=hard', '-mfpu=fpv5-sp-d16', '-mabi=aapcs', '-mthumb',] 10 | cpp_link_args = [ '-mcpu=cortex-m7', '-mfloat-abi=hard', '-mfpu=fpv5-sp-d16', '-mabi=aapcs', '-mthumb',] 11 | 12 | [host_machine] 13 | cpu = 'cortex-m7' 14 | -------------------------------------------------------------------------------- /cross/embvm.txt: -------------------------------------------------------------------------------- 1 | # Embedded Virtual Machine Settings 2 | # This file specifies that the embvm builds will use 3 | # the proper libc and libcpp dependencies. You can select alternative 4 | # dependencies by using a different wrap file, or overriding the options 5 | # using wrap file composition. 6 | 7 | [properties] 8 | c_stdlib = ['libc', 'libc_dep'] 9 | cpp_stdlib = ['libcpp', 'libcxx_full_dep'] 10 | -------------------------------------------------------------------------------- /cross/libc.txt: -------------------------------------------------------------------------------- 1 | # Use libc subproject for compiling this project and its subprojects 2 | 3 | [properties] 4 | c_stdlib = ['libc', 'libc_dep'] 5 | -------------------------------------------------------------------------------- /cross/libcpp.txt: -------------------------------------------------------------------------------- 1 | # Use libcpp subproject for compiling this project and its subprojects 2 | 3 | [properties] 4 | cpp_stdlib = ['libcpp', 'libcxx_full_dep'] 5 | -------------------------------------------------------------------------------- /cross/libcpp_headeronly.txt: -------------------------------------------------------------------------------- 1 | # Use header-only libcpp subproject for compiling this project and its subprojects 2 | 3 | [properties] 4 | cpp_stdlib = ['libcpp', 'libcxx_header_include_dep'] 5 | -------------------------------------------------------------------------------- /docs/doxygen/Doxyfile.in: -------------------------------------------------------------------------------- 1 | # Doxyfile 1.8.13 2 | 3 | # This file describes the settings to be used by the documentation system 4 | # doxygen (www.doxygen.org) for a project. 5 | # 6 | # All text after a double hash (##) is considered a comment and is placed in 7 | # front of the TAG it is preceding. 8 | # 9 | # All text after a single hash (#) is considered a comment and will be ignored. 10 | # The format is: 11 | # TAG = value [value, ...] 12 | # For lists, items can also be appended using: 13 | # TAG += value [value, ...] 14 | # Values that contain spaces should be placed between quotes (\" \"). 15 | 16 | #--------------------------------------------------------------------------- 17 | # Project related configuration options 18 | #--------------------------------------------------------------------------- 19 | 20 | # This tag specifies the encoding used for all characters in the config file 21 | # that follow. The default is UTF-8 which is also the encoding used for all text 22 | # before the first occurrence of this tag. Doxygen uses libiconv (or the iconv 23 | # built into libc) for the transcoding. See http://www.gnu.org/software/libiconv 24 | # for the list of possible encodings. 25 | # The default value is: UTF-8. 26 | 27 | DOXYFILE_ENCODING = UTF-8 28 | 29 | # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by 30 | # double-quotes, unless you are using Doxywizard) that should identify the 31 | # project for which the documentation is generated. This name is used in the 32 | # title of most generated pages and in a few other places. 33 | # The default value is: My Project. 34 | 35 | PROJECT_NAME = "@PROJECT_NAME@" 36 | 37 | # The PROJECT_NUMBER tag can be used to enter a project or revision number. This 38 | # could be handy for archiving the generated documentation or if some version 39 | # control system is used. 40 | 41 | PROJECT_NUMBER = @PROJECT_VERSION@ 42 | 43 | # Using the PROJECT_BRIEF tag one can provide an optional one line description 44 | # for a project that appears at the top of each page and should give viewer a 45 | # quick idea about the purpose of the project. Keep the description short. 46 | 47 | PROJECT_BRIEF = "@PROJECT_DESCRIPTION@" 48 | 49 | # With the PROJECT_LOGO tag one can specify a logo or an icon that is included 50 | # in the documentation. The maximum height of the logo should not exceed 55 51 | # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy 52 | # the logo to the output directory. 53 | 54 | PROJECT_LOGO = 55 | 56 | # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path 57 | # into which the generated documentation will be written. If a relative path is 58 | # entered, it will be relative to the location where doxygen was started. If 59 | # left blank the current directory will be used. 60 | 61 | OUTPUT_DIRECTORY = @OUTPUT_DIR@ 62 | 63 | # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- 64 | # directories (in 2 levels) under the output directory of each output format and 65 | # will distribute the generated files over these directories. Enabling this 66 | # option can be useful when feeding doxygen a huge amount of source files, where 67 | # putting all generated files in the same directory would otherwise causes 68 | # performance problems for the file system. 69 | # The default value is: NO. 70 | 71 | CREATE_SUBDIRS = YES 72 | 73 | # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII 74 | # characters to appear in the names of generated files. If set to NO, non-ASCII 75 | # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode 76 | # U+3044. 77 | # The default value is: NO. 78 | 79 | ALLOW_UNICODE_NAMES = NO 80 | 81 | # The OUTPUT_LANGUAGE tag is used to specify the language in which all 82 | # documentation generated by doxygen is written. Doxygen will use this 83 | # information to generate all constant output in the proper language. 84 | # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, 85 | # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), 86 | # Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, 87 | # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), 88 | # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, 89 | # Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, 90 | # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, 91 | # Ukrainian and Vietnamese. 92 | # The default value is: English. 93 | 94 | OUTPUT_LANGUAGE = English 95 | 96 | # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member 97 | # descriptions after the members that are listed in the file and class 98 | # documentation (similar to Javadoc). Set to NO to disable this. 99 | # The default value is: YES. 100 | 101 | BRIEF_MEMBER_DESC = YES 102 | 103 | # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief 104 | # description of a member or function before the detailed description 105 | # 106 | # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 107 | # brief descriptions will be completely suppressed. 108 | # The default value is: YES. 109 | 110 | REPEAT_BRIEF = YES 111 | 112 | # This tag implements a quasi-intelligent brief description abbreviator that is 113 | # used to form the text in various listings. Each string in this list, if found 114 | # as the leading text of the brief description, will be stripped from the text 115 | # and the result, after processing the whole list, is used as the annotated 116 | # text. Otherwise, the brief description is used as-is. If left blank, the 117 | # following values are used ($name is automatically replaced with the name of 118 | # the entity):The $name class, The $name widget, The $name file, is, provides, 119 | # specifies, contains, represents, a, an and the. 120 | 121 | ABBREVIATE_BRIEF = "The $name class" \ 122 | "The $name widget" \ 123 | "The $name file" \ 124 | is \ 125 | provides \ 126 | specifies \ 127 | contains \ 128 | represents \ 129 | a \ 130 | an \ 131 | the 132 | 133 | # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 134 | # doxygen will generate a detailed section even if there is only a brief 135 | # description. 136 | # The default value is: NO. 137 | 138 | ALWAYS_DETAILED_SEC = NO 139 | 140 | # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 141 | # inherited members of a class in the documentation of that class as if those 142 | # members were ordinary class members. Constructors, destructors and assignment 143 | # operators of the base classes will not be shown. 144 | # The default value is: NO. 145 | 146 | INLINE_INHERITED_MEMB = NO 147 | 148 | # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path 149 | # before files name in the file list and in the header files. If set to NO the 150 | # shortest path that makes the file name unique will be used 151 | # The default value is: YES. 152 | 153 | FULL_PATH_NAMES = NO 154 | 155 | # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. 156 | # Stripping is only done if one of the specified strings matches the left-hand 157 | # part of the path. The tag can be used to show relative paths in the file list. 158 | # If left blank the directory from which doxygen is run is used as the path to 159 | # strip. 160 | # 161 | # Note that you can specify absolute paths here, but also relative paths, which 162 | # will be relative from the directory where doxygen is started. 163 | # This tag requires that the tag FULL_PATH_NAMES is set to YES. 164 | 165 | STRIP_FROM_PATH = 166 | 167 | # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the 168 | # path mentioned in the documentation of a class, which tells the reader which 169 | # header file to include in order to use a class. If left blank only the name of 170 | # the header file containing the class definition is used. Otherwise one should 171 | # specify the list of include paths that are normally passed to the compiler 172 | # using the -I flag. 173 | 174 | STRIP_FROM_INC_PATH = 175 | 176 | # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but 177 | # less readable) file names. This can be useful is your file systems doesn't 178 | # support long names like on DOS, Mac, or CD-ROM. 179 | # The default value is: NO. 180 | 181 | SHORT_NAMES = NO 182 | 183 | # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the 184 | # first line (until the first dot) of a Javadoc-style comment as the brief 185 | # description. If set to NO, the Javadoc-style will behave just like regular Qt- 186 | # style comments (thus requiring an explicit @brief command for a brief 187 | # description.) 188 | # The default value is: NO. 189 | 190 | JAVADOC_AUTOBRIEF = NO 191 | 192 | # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first 193 | # line (until the first dot) of a Qt-style comment as the brief description. If 194 | # set to NO, the Qt-style will behave just like regular Qt-style comments (thus 195 | # requiring an explicit \brief command for a brief description.) 196 | # The default value is: NO. 197 | 198 | QT_AUTOBRIEF = NO 199 | 200 | # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a 201 | # multi-line C++ special comment block (i.e. a block of //! or /// comments) as 202 | # a brief description. This used to be the default behavior. The new default is 203 | # to treat a multi-line C++ comment block as a detailed description. Set this 204 | # tag to YES if you prefer the old behavior instead. 205 | # 206 | # Note that setting this tag to YES also means that rational rose comments are 207 | # not recognized any more. 208 | # The default value is: NO. 209 | 210 | MULTILINE_CPP_IS_BRIEF = NO 211 | 212 | # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the 213 | # documentation from any documented member that it re-implements. 214 | # The default value is: YES. 215 | 216 | INHERIT_DOCS = YES 217 | 218 | # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new 219 | # page for each member. If set to NO, the documentation of a member will be part 220 | # of the file/class/namespace that contains it. 221 | # The default value is: NO. 222 | 223 | SEPARATE_MEMBER_PAGES = NO 224 | 225 | # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen 226 | # uses this value to replace tabs by spaces in code fragments. 227 | # Minimum value: 1, maximum value: 16, default value: 4. 228 | 229 | TAB_SIZE = 4 230 | 231 | # This tag can be used to specify a number of aliases that act as commands in 232 | # the documentation. An alias has the form: 233 | # name=value 234 | # For example adding 235 | # "sideeffect=@par Side Effects:\n" 236 | # will allow you to put the command \sideeffect (or @sideeffect) in the 237 | # documentation, which will result in a user-defined paragraph with heading 238 | # "Side Effects:". You can put \n's in the value part of an alias to insert 239 | # newlines. 240 | 241 | ALIASES = sideeffect="\par Side Effects:^^" 242 | 243 | # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources 244 | # only. Doxygen will then generate output that is more tailored for C. For 245 | # instance, some of the names that are used will be different. The list of all 246 | # members will be omitted, etc. 247 | # The default value is: NO. 248 | 249 | OPTIMIZE_OUTPUT_FOR_C = NO 250 | 251 | # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or 252 | # Python sources only. Doxygen will then generate output that is more tailored 253 | # for that language. For instance, namespaces will be presented as packages, 254 | # qualified scopes will look different, etc. 255 | # The default value is: NO. 256 | 257 | OPTIMIZE_OUTPUT_JAVA = NO 258 | 259 | # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 260 | # sources. Doxygen will then generate output that is tailored for Fortran. 261 | # The default value is: NO. 262 | 263 | OPTIMIZE_FOR_FORTRAN = NO 264 | 265 | # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 266 | # sources. Doxygen will then generate output that is tailored for VHDL. 267 | # The default value is: NO. 268 | 269 | OPTIMIZE_OUTPUT_VHDL = NO 270 | 271 | # Doxygen selects the parser to use depending on the extension of the files it 272 | # parses. With this tag you can assign which parser to use for a given 273 | # extension. Doxygen has a built-in mapping, but you can override or extend it 274 | # using this tag. The format is ext=language, where ext is a file extension, and 275 | # language is one of the parsers supported by doxygen: IDL, Java, Javascript, 276 | # C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: 277 | # FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: 278 | # Fortran. In the later case the parser tries to guess whether the code is fixed 279 | # or free formatted code, this is the default for Fortran type files), VHDL. For 280 | # instance to make doxygen treat .inc files as Fortran files (default is PHP), 281 | # and .f files as C (default is Fortran), use: inc=Fortran f=C. 282 | # 283 | # Note: For files without extension you can use no_extension as a placeholder. 284 | # 285 | # Note that for custom extensions you also need to set FILE_PATTERNS otherwise 286 | # the files are not read by doxygen. 287 | 288 | EXTENSION_MAPPING = 289 | 290 | # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments 291 | # according to the Markdown format, which allows for more readable 292 | # documentation. See http://daringfireball.net/projects/markdown/ for details. 293 | # The output of markdown processing is further processed by doxygen, so you can 294 | # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in 295 | # case of backward compatibilities issues. 296 | # The default value is: YES. 297 | 298 | MARKDOWN_SUPPORT = YES 299 | 300 | # When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up 301 | # to that level are automatically included in the table of contents, even if 302 | # they do not have an id attribute. 303 | # Note: This feature currently applies only to Markdown headings. 304 | # Minimum value: 0, maximum value: 99, default value: 0. 305 | # This tag requires that the tag MARKDOWN_SUPPORT is set to YES. 306 | 307 | TOC_INCLUDE_HEADINGS = 0 308 | 309 | # When enabled doxygen tries to link words that correspond to documented 310 | # classes, or namespaces to their corresponding documentation. Such a link can 311 | # be prevented in individual cases by putting a % sign in front of the word or 312 | # globally by setting AUTOLINK_SUPPORT to NO. 313 | # The default value is: YES. 314 | 315 | AUTOLINK_SUPPORT = YES 316 | 317 | # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 318 | # to include (a tag file for) the STL sources as input, then you should set this 319 | # tag to YES in order to let doxygen match functions declarations and 320 | # definitions whose arguments contain STL classes (e.g. func(std::string); 321 | # versus func(std::string) {}). This also make the inheritance and collaboration 322 | # diagrams that involve STL classes more complete and accurate. 323 | # The default value is: NO. 324 | 325 | BUILTIN_STL_SUPPORT = YES 326 | 327 | # If you use Microsoft's C++/CLI language, you should set this option to YES to 328 | # enable parsing support. 329 | # The default value is: NO. 330 | 331 | CPP_CLI_SUPPORT = NO 332 | 333 | # Set the SIP_SUPPORT tag to YES if your project consists of sip (see: 334 | # http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen 335 | # will parse them like normal C++ but will assume all classes use public instead 336 | # of private inheritance when no explicit protection keyword is present. 337 | # The default value is: NO. 338 | 339 | SIP_SUPPORT = NO 340 | 341 | # For Microsoft's IDL there are propget and propput attributes to indicate 342 | # getter and setter methods for a property. Setting this option to YES will make 343 | # doxygen to replace the get and set methods by a property in the documentation. 344 | # This will only work if the methods are indeed getting or setting a simple 345 | # type. If this is not the case, or you want to show the methods anyway, you 346 | # should set this option to NO. 347 | # The default value is: YES. 348 | 349 | IDL_PROPERTY_SUPPORT = YES 350 | 351 | # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 352 | # tag is set to YES then doxygen will reuse the documentation of the first 353 | # member in the group (if any) for the other members of the group. By default 354 | # all members of a group must be documented explicitly. 355 | # The default value is: NO. 356 | 357 | DISTRIBUTE_GROUP_DOC = NO 358 | 359 | # If one adds a struct or class to a group and this option is enabled, then also 360 | # any nested class or struct is added to the same group. By default this option 361 | # is disabled and one has to add nested compounds explicitly via \ingroup. 362 | # The default value is: NO. 363 | 364 | GROUP_NESTED_COMPOUNDS = NO 365 | 366 | # Set the SUBGROUPING tag to YES to allow class member groups of the same type 367 | # (for instance a group of public functions) to be put as a subgroup of that 368 | # type (e.g. under the Public Functions section). Set it to NO to prevent 369 | # subgrouping. Alternatively, this can be done per class using the 370 | # \nosubgrouping command. 371 | # The default value is: YES. 372 | 373 | SUBGROUPING = YES 374 | 375 | # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions 376 | # are shown inside the group in which they are included (e.g. using \ingroup) 377 | # instead of on a separate page (for HTML and Man pages) or section (for LaTeX 378 | # and RTF). 379 | # 380 | # Note that this feature does not work in combination with 381 | # SEPARATE_MEMBER_PAGES. 382 | # The default value is: NO. 383 | 384 | INLINE_GROUPED_CLASSES = YES 385 | 386 | # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions 387 | # with only public data fields or simple typedef fields will be shown inline in 388 | # the documentation of the scope in which they are defined (i.e. file, 389 | # namespace, or group documentation), provided this scope is documented. If set 390 | # to NO, structs, classes, and unions are shown on a separate page (for HTML and 391 | # Man pages) or section (for LaTeX and RTF). 392 | # The default value is: NO. 393 | 394 | INLINE_SIMPLE_STRUCTS = YES 395 | 396 | # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or 397 | # enum is documented as struct, union, or enum with the name of the typedef. So 398 | # typedef struct TypeS {} TypeT, will appear in the documentation as a struct 399 | # with name TypeT. When disabled the typedef will appear as a member of a file, 400 | # namespace, or class. And the struct will be named TypeS. This can typically be 401 | # useful for C code in case the coding convention dictates that all compound 402 | # types are typedef'ed and only the typedef is referenced, never the tag name. 403 | # The default value is: NO. 404 | 405 | TYPEDEF_HIDES_STRUCT = NO 406 | 407 | # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This 408 | # cache is used to resolve symbols given their name and scope. Since this can be 409 | # an expensive process and often the same symbol appears multiple times in the 410 | # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small 411 | # doxygen will become slower. If the cache is too large, memory is wasted. The 412 | # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range 413 | # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 414 | # symbols. At the end of a run doxygen will report the cache usage and suggest 415 | # the optimal cache size from a speed point of view. 416 | # Minimum value: 0, maximum value: 9, default value: 0. 417 | 418 | LOOKUP_CACHE_SIZE = 0 419 | 420 | #--------------------------------------------------------------------------- 421 | # Build related configuration options 422 | #--------------------------------------------------------------------------- 423 | 424 | # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in 425 | # documentation are documented, even if no documentation was available. Private 426 | # class members and static file members will be hidden unless the 427 | # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. 428 | # Note: This will also disable the warnings about undocumented members that are 429 | # normally produced when WARNINGS is set to YES. 430 | # The default value is: NO. 431 | 432 | EXTRACT_ALL = YES 433 | 434 | # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will 435 | # be included in the documentation. 436 | # The default value is: NO. 437 | 438 | EXTRACT_PRIVATE = YES 439 | 440 | # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal 441 | # scope will be included in the documentation. 442 | # The default value is: NO. 443 | 444 | EXTRACT_PACKAGE = YES 445 | 446 | # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be 447 | # included in the documentation. 448 | # The default value is: NO. 449 | 450 | EXTRACT_STATIC = YES 451 | 452 | # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined 453 | # locally in source files will be included in the documentation. If set to NO, 454 | # only classes defined in header files are included. Does not have any effect 455 | # for Java sources. 456 | # The default value is: YES. 457 | 458 | EXTRACT_LOCAL_CLASSES = YES 459 | 460 | # This flag is only useful for Objective-C code. If set to YES, local methods, 461 | # which are defined in the implementation section but not in the interface are 462 | # included in the documentation. If set to NO, only methods in the interface are 463 | # included. 464 | # The default value is: NO. 465 | 466 | EXTRACT_LOCAL_METHODS = NO 467 | 468 | # If this flag is set to YES, the members of anonymous namespaces will be 469 | # extracted and appear in the documentation as a namespace called 470 | # 'anonymous_namespace{file}', where file will be replaced with the base name of 471 | # the file that contains the anonymous namespace. By default anonymous namespace 472 | # are hidden. 473 | # The default value is: NO. 474 | 475 | EXTRACT_ANON_NSPACES = NO 476 | 477 | # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all 478 | # undocumented members inside documented classes or files. If set to NO these 479 | # members will be included in the various overviews, but no documentation 480 | # section is generated. This option has no effect if EXTRACT_ALL is enabled. 481 | # The default value is: NO. 482 | 483 | HIDE_UNDOC_MEMBERS = NO 484 | 485 | # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all 486 | # undocumented classes that are normally visible in the class hierarchy. If set 487 | # to NO, these classes will be included in the various overviews. This option 488 | # has no effect if EXTRACT_ALL is enabled. 489 | # The default value is: NO. 490 | 491 | HIDE_UNDOC_CLASSES = NO 492 | 493 | # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend 494 | # (class|struct|union) declarations. If set to NO, these declarations will be 495 | # included in the documentation. 496 | # The default value is: NO. 497 | 498 | HIDE_FRIEND_COMPOUNDS = NO 499 | 500 | # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any 501 | # documentation blocks found inside the body of a function. If set to NO, these 502 | # blocks will be appended to the function's detailed documentation block. 503 | # The default value is: NO. 504 | 505 | HIDE_IN_BODY_DOCS = NO 506 | 507 | # The INTERNAL_DOCS tag determines if documentation that is typed after a 508 | # \internal command is included. If the tag is set to NO then the documentation 509 | # will be excluded. Set it to YES to include the internal documentation. 510 | # The default value is: NO. 511 | 512 | INTERNAL_DOCS = NO 513 | 514 | # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file 515 | # names in lower-case letters. If set to YES, upper-case letters are also 516 | # allowed. This is useful if you have classes or files whose names only differ 517 | # in case and if your file system supports case sensitive file names. Windows 518 | # and Mac users are advised to set this option to NO. 519 | # The default value is: system dependent. 520 | 521 | CASE_SENSE_NAMES = NO 522 | 523 | # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with 524 | # their full class and namespace scopes in the documentation. If set to YES, the 525 | # scope will be hidden. 526 | # The default value is: NO. 527 | 528 | HIDE_SCOPE_NAMES = NO 529 | 530 | # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will 531 | # append additional text to a page's title, such as Class Reference. If set to 532 | # YES the compound reference will be hidden. 533 | # The default value is: NO. 534 | 535 | HIDE_COMPOUND_REFERENCE= NO 536 | 537 | # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of 538 | # the files that are included by a file in the documentation of that file. 539 | # The default value is: YES. 540 | 541 | SHOW_INCLUDE_FILES = YES 542 | 543 | # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each 544 | # grouped member an include statement to the documentation, telling the reader 545 | # which file to include in order to use the member. 546 | # The default value is: NO. 547 | 548 | SHOW_GROUPED_MEMB_INC = NO 549 | 550 | # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include 551 | # files with double quotes in the documentation rather than with sharp brackets. 552 | # The default value is: NO. 553 | 554 | FORCE_LOCAL_INCLUDES = NO 555 | 556 | # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the 557 | # documentation for inline members. 558 | # The default value is: YES. 559 | 560 | INLINE_INFO = YES 561 | 562 | # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the 563 | # (detailed) documentation of file and class members alphabetically by member 564 | # name. If set to NO, the members will appear in declaration order. 565 | # The default value is: YES. 566 | 567 | SORT_MEMBER_DOCS = YES 568 | 569 | # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief 570 | # descriptions of file, namespace and class members alphabetically by member 571 | # name. If set to NO, the members will appear in declaration order. Note that 572 | # this will also influence the order of the classes in the class list. 573 | # The default value is: NO. 574 | 575 | SORT_BRIEF_DOCS = NO 576 | 577 | # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the 578 | # (brief and detailed) documentation of class members so that constructors and 579 | # destructors are listed first. If set to NO the constructors will appear in the 580 | # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. 581 | # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief 582 | # member documentation. 583 | # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting 584 | # detailed member documentation. 585 | # The default value is: NO. 586 | 587 | SORT_MEMBERS_CTORS_1ST = NO 588 | 589 | # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy 590 | # of group names into alphabetical order. If set to NO the group names will 591 | # appear in their defined order. 592 | # The default value is: NO. 593 | 594 | SORT_GROUP_NAMES = NO 595 | 596 | # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by 597 | # fully-qualified names, including namespaces. If set to NO, the class list will 598 | # be sorted only by class name, not including the namespace part. 599 | # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 600 | # Note: This option applies only to the class list, not to the alphabetical 601 | # list. 602 | # The default value is: NO. 603 | 604 | SORT_BY_SCOPE_NAME = NO 605 | 606 | # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper 607 | # type resolution of all parameters of a function it will reject a match between 608 | # the prototype and the implementation of a member function even if there is 609 | # only one candidate or it is obvious which candidate to choose by doing a 610 | # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still 611 | # accept a match between prototype and implementation in such cases. 612 | # The default value is: NO. 613 | 614 | STRICT_PROTO_MATCHING = NO 615 | 616 | # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo 617 | # list. This list is created by putting \todo commands in the documentation. 618 | # The default value is: YES. 619 | 620 | GENERATE_TODOLIST = YES 621 | 622 | # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test 623 | # list. This list is created by putting \test commands in the documentation. 624 | # The default value is: YES. 625 | 626 | GENERATE_TESTLIST = YES 627 | 628 | # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug 629 | # list. This list is created by putting \bug commands in the documentation. 630 | # The default value is: YES. 631 | 632 | GENERATE_BUGLIST = YES 633 | 634 | # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) 635 | # the deprecated list. This list is created by putting \deprecated commands in 636 | # the documentation. 637 | # The default value is: YES. 638 | 639 | GENERATE_DEPRECATEDLIST= YES 640 | 641 | # The ENABLED_SECTIONS tag can be used to enable conditional documentation 642 | # sections, marked by \if ... \endif and \cond 643 | # ... \endcond blocks. 644 | 645 | ENABLED_SECTIONS = 646 | 647 | # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the 648 | # initial value of a variable or macro / define can have for it to appear in the 649 | # documentation. If the initializer consists of more lines than specified here 650 | # it will be hidden. Use a value of 0 to hide initializers completely. The 651 | # appearance of the value of individual variables and macros / defines can be 652 | # controlled using \showinitializer or \hideinitializer command in the 653 | # documentation regardless of this setting. 654 | # Minimum value: 0, maximum value: 10000, default value: 30. 655 | 656 | MAX_INITIALIZER_LINES = 30 657 | 658 | # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at 659 | # the bottom of the documentation of classes and structs. If set to YES, the 660 | # list will mention the files that were used to generate the documentation. 661 | # The default value is: YES. 662 | 663 | SHOW_USED_FILES = YES 664 | 665 | # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This 666 | # will remove the Files entry from the Quick Index and from the Folder Tree View 667 | # (if specified). 668 | # The default value is: YES. 669 | 670 | SHOW_FILES = YES 671 | 672 | # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces 673 | # page. This will remove the Namespaces entry from the Quick Index and from the 674 | # Folder Tree View (if specified). 675 | # The default value is: YES. 676 | 677 | SHOW_NAMESPACES = YES 678 | 679 | # The FILE_VERSION_FILTER tag can be used to specify a program or script that 680 | # doxygen should invoke to get the current version for each file (typically from 681 | # the version control system). Doxygen will invoke the program by executing (via 682 | # popen()) the command command input-file, where command is the value of the 683 | # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided 684 | # by doxygen. Whatever the program writes to standard output is used as the file 685 | # version. For an example see the documentation. 686 | 687 | FILE_VERSION_FILTER = 688 | 689 | # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed 690 | # by doxygen. The layout file controls the global structure of the generated 691 | # output files in an output format independent way. To create the layout file 692 | # that represents doxygen's defaults, run doxygen with the -l option. You can 693 | # optionally specify a file name after the option, if omitted DoxygenLayout.xml 694 | # will be used as the name of the layout file. 695 | # 696 | # Note that if you run doxygen from a directory containing a file called 697 | # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE 698 | # tag is left empty. 699 | 700 | LAYOUT_FILE = 701 | 702 | # The CITE_BIB_FILES tag can be used to specify one or more bib files containing 703 | # the reference definitions. This must be a list of .bib files. The .bib 704 | # extension is automatically appended if omitted. This requires the bibtex tool 705 | # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. 706 | # For LaTeX the style of the bibliography can be controlled using 707 | # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the 708 | # search path. See also \cite for info how to create references. 709 | 710 | CITE_BIB_FILES = 711 | 712 | #--------------------------------------------------------------------------- 713 | # Configuration options related to warning and progress messages 714 | #--------------------------------------------------------------------------- 715 | 716 | # The QUIET tag can be used to turn on/off the messages that are generated to 717 | # standard output by doxygen. If QUIET is set to YES this implies that the 718 | # messages are off. 719 | # The default value is: NO. 720 | 721 | QUIET = YES 722 | 723 | # The WARNINGS tag can be used to turn on/off the warning messages that are 724 | # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES 725 | # this implies that the warnings are on. 726 | # 727 | # Tip: Turn warnings on while writing the documentation. 728 | # The default value is: YES. 729 | 730 | WARNINGS = YES 731 | 732 | # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate 733 | # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag 734 | # will automatically be disabled. 735 | # The default value is: YES. 736 | 737 | WARN_IF_UNDOCUMENTED = YES 738 | 739 | # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for 740 | # potential errors in the documentation, such as not documenting some parameters 741 | # in a documented function, or documenting parameters that don't exist or using 742 | # markup commands wrongly. 743 | # The default value is: YES. 744 | 745 | WARN_IF_DOC_ERROR = YES 746 | 747 | # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that 748 | # are documented, but have no documentation for their parameters or return 749 | # value. If set to NO, doxygen will only warn about wrong or incomplete 750 | # parameter documentation, but not about the absence of documentation. 751 | # The default value is: NO. 752 | 753 | WARN_NO_PARAMDOC = NO 754 | 755 | # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when 756 | # a warning is encountered. 757 | # The default value is: NO. 758 | 759 | WARN_AS_ERROR = NO 760 | 761 | # The WARN_FORMAT tag determines the format of the warning messages that doxygen 762 | # can produce. The string should contain the $file, $line, and $text tags, which 763 | # will be replaced by the file and line number from which the warning originated 764 | # and the warning text. Optionally the format may contain $version, which will 765 | # be replaced by the version of the file (if it could be obtained via 766 | # FILE_VERSION_FILTER) 767 | # The default value is: $file:$line: $text. 768 | 769 | WARN_FORMAT = "$file:$line: $text" 770 | 771 | # The WARN_LOGFILE tag can be used to specify a file to which warning and error 772 | # messages should be written. If left blank the output is written to standard 773 | # error (stderr). 774 | 775 | WARN_LOGFILE = 776 | 777 | #--------------------------------------------------------------------------- 778 | # Configuration options related to the input files 779 | #--------------------------------------------------------------------------- 780 | 781 | # The INPUT tag is used to specify the files and/or directories that contain 782 | # documented source files. You may enter file names like myfile.cpp or 783 | # directories like /usr/src/myproject. Separate the files or directories with 784 | # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING 785 | # Note: If this tag is empty the current directory is searched. 786 | 787 | INPUT = @INPUT_DIRS@ 788 | 789 | # This tag can be used to specify the character encoding of the source files 790 | # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses 791 | # libiconv (or the iconv built into libc) for the transcoding. See the libiconv 792 | # documentation (see: http://www.gnu.org/software/libiconv) for the list of 793 | # possible encodings. 794 | # The default value is: UTF-8. 795 | 796 | INPUT_ENCODING = UTF-8 797 | 798 | # If the value of the INPUT tag contains directories, you can use the 799 | # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and 800 | # *.h) to filter out the source-files in the directories. 801 | # 802 | # Note that for custom extensions or not directly supported extensions you also 803 | # need to set EXTENSION_MAPPING for the extension otherwise the files are not 804 | # read by doxygen. 805 | # 806 | # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, 807 | # *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, 808 | # *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, 809 | # *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, 810 | # *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf and *.qsf. 811 | 812 | FILE_PATTERNS = *.c \ 813 | *.cc \ 814 | *.cxx \ 815 | *.cpp \ 816 | *.c++ \ 817 | *.java \ 818 | *.ii \ 819 | *.ixx \ 820 | *.ipp \ 821 | *.i++ \ 822 | *.inl \ 823 | *.idl \ 824 | *.ddl \ 825 | *.odl \ 826 | *.h \ 827 | *.hh \ 828 | *.hxx \ 829 | *.hpp \ 830 | *.h++ \ 831 | *.cs \ 832 | *.d \ 833 | *.php \ 834 | *.php4 \ 835 | *.php5 \ 836 | *.phtml \ 837 | *.inc \ 838 | *.m \ 839 | *.markdown \ 840 | *.md \ 841 | *.mm \ 842 | *.dox \ 843 | *.py \ 844 | *.pyw \ 845 | *.f90 \ 846 | *.f95 \ 847 | *.f03 \ 848 | *.f08 \ 849 | *.f \ 850 | *.for \ 851 | *.tcl \ 852 | *.vhd \ 853 | *.vhdl \ 854 | *.ucf \ 855 | *.qsf 856 | 857 | # The RECURSIVE tag can be used to specify whether or not subdirectories should 858 | # be searched for input files as well. 859 | # The default value is: NO. 860 | 861 | RECURSIVE = YES 862 | 863 | # The EXCLUDE tag can be used to specify files and/or directories that should be 864 | # excluded from the INPUT source files. This way you can easily exclude a 865 | # subdirectory from a directory tree whose root is specified with the INPUT tag. 866 | # 867 | # Note that relative paths are relative to the directory from which doxygen is 868 | # run. 869 | 870 | EXCLUDE = 871 | 872 | # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or 873 | # directories that are symbolic links (a Unix file system feature) are excluded 874 | # from the input. 875 | # The default value is: NO. 876 | 877 | EXCLUDE_SYMLINKS = NO 878 | 879 | # If the value of the INPUT tag contains directories, you can use the 880 | # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 881 | # certain files from those directories. 882 | # 883 | # Note that the wildcards are matched against the file with absolute path, so to 884 | # exclude all test directories for example use the pattern */test/* 885 | 886 | EXCLUDE_PATTERNS = @EXCLUDE_PATTERNS 887 | 888 | # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 889 | # (namespaces, classes, functions, etc.) that should be excluded from the 890 | # output. The symbol name can be a fully qualified name, a word, or if the 891 | # wildcard * is used, a substring. Examples: ANamespace, AClass, 892 | # AClass::ANamespace, ANamespace::*Test 893 | # 894 | # Note that the wildcards are matched against the file with absolute path, so to 895 | # exclude all test directories use the pattern */test/* 896 | 897 | EXCLUDE_SYMBOLS = 898 | 899 | # The EXAMPLE_PATH tag can be used to specify one or more files or directories 900 | # that contain example code fragments that are included (see the \include 901 | # command). 902 | 903 | EXAMPLE_PATH = 904 | 905 | # If the value of the EXAMPLE_PATH tag contains directories, you can use the 906 | # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and 907 | # *.h) to filter out the source-files in the directories. If left blank all 908 | # files are included. 909 | 910 | EXAMPLE_PATTERNS = * 911 | 912 | # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 913 | # searched for input files to be used with the \include or \dontinclude commands 914 | # irrespective of the value of the RECURSIVE tag. 915 | # The default value is: NO. 916 | 917 | EXAMPLE_RECURSIVE = NO 918 | 919 | # The IMAGE_PATH tag can be used to specify one or more files or directories 920 | # that contain images that are to be included in the documentation (see the 921 | # \image command). 922 | 923 | IMAGE_PATH = 924 | 925 | # The INPUT_FILTER tag can be used to specify a program that doxygen should 926 | # invoke to filter for each input file. Doxygen will invoke the filter program 927 | # by executing (via popen()) the command: 928 | # 929 | # 930 | # 931 | # where is the value of the INPUT_FILTER tag, and is the 932 | # name of an input file. Doxygen will then use the output that the filter 933 | # program writes to standard output. If FILTER_PATTERNS is specified, this tag 934 | # will be ignored. 935 | # 936 | # Note that the filter must not add or remove lines; it is applied before the 937 | # code is scanned, but not when the output code is generated. If lines are added 938 | # or removed, the anchors will not be placed correctly. 939 | # 940 | # Note that for custom extensions or not directly supported extensions you also 941 | # need to set EXTENSION_MAPPING for the extension otherwise the files are not 942 | # properly processed by doxygen. 943 | 944 | INPUT_FILTER = 945 | 946 | # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 947 | # basis. Doxygen will compare the file name with each pattern and apply the 948 | # filter if there is a match. The filters are a list of the form: pattern=filter 949 | # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how 950 | # filters are used. If the FILTER_PATTERNS tag is empty or if none of the 951 | # patterns match the file name, INPUT_FILTER is applied. 952 | # 953 | # Note that for custom extensions or not directly supported extensions you also 954 | # need to set EXTENSION_MAPPING for the extension otherwise the files are not 955 | # properly processed by doxygen. 956 | 957 | FILTER_PATTERNS = 958 | 959 | # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 960 | # INPUT_FILTER) will also be used to filter the input files that are used for 961 | # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). 962 | # The default value is: NO. 963 | 964 | FILTER_SOURCE_FILES = NO 965 | 966 | # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file 967 | # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and 968 | # it is also possible to disable source filtering for a specific pattern using 969 | # *.ext= (so without naming a filter). 970 | # This tag requires that the tag FILTER_SOURCE_FILES is set to YES. 971 | 972 | FILTER_SOURCE_PATTERNS = 973 | 974 | # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that 975 | # is part of the input, its contents will be placed on the main page 976 | # (index.html). This can be useful if you have a project on for instance GitHub 977 | # and want to reuse the introduction page also for the doxygen output. 978 | 979 | USE_MDFILE_AS_MAINPAGE = @MD_AS_MAINPAGE@ 980 | 981 | #--------------------------------------------------------------------------- 982 | # Configuration options related to source browsing 983 | #--------------------------------------------------------------------------- 984 | 985 | # If the SOURCE_BROWSER tag is set to YES then a list of source files will be 986 | # generated. Documented entities will be cross-referenced with these sources. 987 | # 988 | # Note: To get rid of all source code in the generated output, make sure that 989 | # also VERBATIM_HEADERS is set to NO. 990 | # The default value is: NO. 991 | 992 | SOURCE_BROWSER = YES 993 | 994 | # Setting the INLINE_SOURCES tag to YES will include the body of functions, 995 | # classes and enums directly into the documentation. 996 | # The default value is: NO. 997 | 998 | INLINE_SOURCES = YES 999 | 1000 | # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any 1001 | # special comment blocks from generated source code fragments. Normal C, C++ and 1002 | # Fortran comments will always remain visible. 1003 | # The default value is: YES. 1004 | 1005 | STRIP_CODE_COMMENTS = YES 1006 | 1007 | # If the REFERENCED_BY_RELATION tag is set to YES then for each documented 1008 | # function all documented functions referencing it will be listed. 1009 | # The default value is: NO. 1010 | 1011 | REFERENCED_BY_RELATION = YES 1012 | 1013 | # If the REFERENCES_RELATION tag is set to YES then for each documented function 1014 | # all documented entities called/used by that function will be listed. 1015 | # The default value is: NO. 1016 | 1017 | REFERENCES_RELATION = YES 1018 | 1019 | # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set 1020 | # to YES then the hyperlinks from functions in REFERENCES_RELATION and 1021 | # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will 1022 | # link to the documentation. 1023 | # The default value is: YES. 1024 | 1025 | REFERENCES_LINK_SOURCE = NO 1026 | 1027 | # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the 1028 | # source code will show a tooltip with additional information such as prototype, 1029 | # brief description and links to the definition and documentation. Since this 1030 | # will make the HTML file larger and loading of large files a bit slower, you 1031 | # can opt to disable this feature. 1032 | # The default value is: YES. 1033 | # This tag requires that the tag SOURCE_BROWSER is set to YES. 1034 | 1035 | SOURCE_TOOLTIPS = YES 1036 | 1037 | # If the USE_HTAGS tag is set to YES then the references to source code will 1038 | # point to the HTML generated by the htags(1) tool instead of doxygen built-in 1039 | # source browser. The htags tool is part of GNU's global source tagging system 1040 | # (see http://www.gnu.org/software/global/global.html). You will need version 1041 | # 4.8.6 or higher. 1042 | # 1043 | # To use it do the following: 1044 | # - Install the latest version of global 1045 | # - Enable SOURCE_BROWSER and USE_HTAGS in the config file 1046 | # - Make sure the INPUT points to the root of the source tree 1047 | # - Run doxygen as normal 1048 | # 1049 | # Doxygen will invoke htags (and that will in turn invoke gtags), so these 1050 | # tools must be available from the command line (i.e. in the search path). 1051 | # 1052 | # The result: instead of the source browser generated by doxygen, the links to 1053 | # source code will now point to the output of htags. 1054 | # The default value is: NO. 1055 | # This tag requires that the tag SOURCE_BROWSER is set to YES. 1056 | 1057 | USE_HTAGS = NO 1058 | 1059 | # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a 1060 | # verbatim copy of the header file for each class for which an include is 1061 | # specified. Set to NO to disable this. 1062 | # See also: Section \class. 1063 | # The default value is: YES. 1064 | 1065 | VERBATIM_HEADERS = YES 1066 | 1067 | #--------------------------------------------------------------------------- 1068 | # Configuration options related to the alphabetical class index 1069 | #--------------------------------------------------------------------------- 1070 | 1071 | # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all 1072 | # compounds will be generated. Enable this if the project contains a lot of 1073 | # classes, structs, unions or interfaces. 1074 | # The default value is: YES. 1075 | 1076 | ALPHABETICAL_INDEX = YES 1077 | 1078 | # In case all classes in a project start with a common prefix, all classes will 1079 | # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag 1080 | # can be used to specify a prefix (or a list of prefixes) that should be ignored 1081 | # while generating the index headers. 1082 | # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 1083 | 1084 | IGNORE_PREFIX = 1085 | 1086 | #--------------------------------------------------------------------------- 1087 | # Configuration options related to the HTML output 1088 | #--------------------------------------------------------------------------- 1089 | 1090 | # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output 1091 | # The default value is: YES. 1092 | 1093 | GENERATE_HTML = YES 1094 | 1095 | # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a 1096 | # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 1097 | # it. 1098 | # The default directory is: html. 1099 | # This tag requires that the tag GENERATE_HTML is set to YES. 1100 | 1101 | HTML_OUTPUT = html 1102 | 1103 | # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each 1104 | # generated HTML page (for example: .htm, .php, .asp). 1105 | # The default value is: .html. 1106 | # This tag requires that the tag GENERATE_HTML is set to YES. 1107 | 1108 | HTML_FILE_EXTENSION = .html 1109 | 1110 | # The HTML_HEADER tag can be used to specify a user-defined HTML header file for 1111 | # each generated HTML page. If the tag is left blank doxygen will generate a 1112 | # standard header. 1113 | # 1114 | # To get valid HTML the header file that includes any scripts and style sheets 1115 | # that doxygen needs, which is dependent on the configuration options used (e.g. 1116 | # the setting GENERATE_TREEVIEW). It is highly recommended to start with a 1117 | # default header using 1118 | # doxygen -w html new_header.html new_footer.html new_stylesheet.css 1119 | # YourConfigFile 1120 | # and then modify the file new_header.html. See also section "Doxygen usage" 1121 | # for information on how to generate the default header that doxygen normally 1122 | # uses. 1123 | # Note: The header is subject to change so you typically have to regenerate the 1124 | # default header when upgrading to a newer version of doxygen. For a description 1125 | # of the possible markers and block names see the documentation. 1126 | # This tag requires that the tag GENERATE_HTML is set to YES. 1127 | 1128 | HTML_HEADER = 1129 | 1130 | # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each 1131 | # generated HTML page. If the tag is left blank doxygen will generate a standard 1132 | # footer. See HTML_HEADER for more information on how to generate a default 1133 | # footer and what special commands can be used inside the footer. See also 1134 | # section "Doxygen usage" for information on how to generate the default footer 1135 | # that doxygen normally uses. 1136 | # This tag requires that the tag GENERATE_HTML is set to YES. 1137 | 1138 | HTML_FOOTER = 1139 | 1140 | # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style 1141 | # sheet that is used by each HTML page. It can be used to fine-tune the look of 1142 | # the HTML output. If left blank doxygen will generate a default style sheet. 1143 | # See also section "Doxygen usage" for information on how to generate the style 1144 | # sheet that doxygen normally uses. 1145 | # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as 1146 | # it is more robust and this tag (HTML_STYLESHEET) will in the future become 1147 | # obsolete. 1148 | # This tag requires that the tag GENERATE_HTML is set to YES. 1149 | 1150 | HTML_STYLESHEET = 1151 | 1152 | # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined 1153 | # cascading style sheets that are included after the standard style sheets 1154 | # created by doxygen. Using this option one can overrule certain style aspects. 1155 | # This is preferred over using HTML_STYLESHEET since it does not replace the 1156 | # standard style sheet and is therefore more robust against future updates. 1157 | # Doxygen will copy the style sheet files to the output directory. 1158 | # Note: The order of the extra style sheet files is of importance (e.g. the last 1159 | # style sheet in the list overrules the setting of the previous ones in the 1160 | # list). For an example see the documentation. 1161 | # This tag requires that the tag GENERATE_HTML is set to YES. 1162 | 1163 | HTML_EXTRA_STYLESHEET = 1164 | 1165 | # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or 1166 | # other source files which should be copied to the HTML output directory. Note 1167 | # that these files will be copied to the base HTML output directory. Use the 1168 | # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these 1169 | # files. In the HTML_STYLESHEET file, use the file name only. Also note that the 1170 | # files will be copied as-is; there are no commands or markers available. 1171 | # This tag requires that the tag GENERATE_HTML is set to YES. 1172 | 1173 | HTML_EXTRA_FILES = 1174 | 1175 | # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen 1176 | # will adjust the colors in the style sheet and background images according to 1177 | # this color. Hue is specified as an angle on a colorwheel, see 1178 | # http://en.wikipedia.org/wiki/Hue for more information. For instance the value 1179 | # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 1180 | # purple, and 360 is red again. 1181 | # Minimum value: 0, maximum value: 359, default value: 220. 1182 | # This tag requires that the tag GENERATE_HTML is set to YES. 1183 | 1184 | HTML_COLORSTYLE_HUE = 220 1185 | 1186 | # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors 1187 | # in the HTML output. For a value of 0 the output will use grayscales only. A 1188 | # value of 255 will produce the most vivid colors. 1189 | # Minimum value: 0, maximum value: 255, default value: 100. 1190 | # This tag requires that the tag GENERATE_HTML is set to YES. 1191 | 1192 | HTML_COLORSTYLE_SAT = 100 1193 | 1194 | # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the 1195 | # luminance component of the colors in the HTML output. Values below 100 1196 | # gradually make the output lighter, whereas values above 100 make the output 1197 | # darker. The value divided by 100 is the actual gamma applied, so 80 represents 1198 | # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not 1199 | # change the gamma. 1200 | # Minimum value: 40, maximum value: 240, default value: 80. 1201 | # This tag requires that the tag GENERATE_HTML is set to YES. 1202 | 1203 | HTML_COLORSTYLE_GAMMA = 80 1204 | 1205 | # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML 1206 | # page will contain the date and time when the page was generated. Setting this 1207 | # to YES can help to show when doxygen was last run and thus if the 1208 | # documentation is up to date. 1209 | # The default value is: NO. 1210 | # This tag requires that the tag GENERATE_HTML is set to YES. 1211 | 1212 | HTML_TIMESTAMP = NO 1213 | 1214 | # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 1215 | # documentation will contain sections that can be hidden and shown after the 1216 | # page has loaded. 1217 | # The default value is: NO. 1218 | # This tag requires that the tag GENERATE_HTML is set to YES. 1219 | 1220 | HTML_DYNAMIC_SECTIONS = NO 1221 | 1222 | # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries 1223 | # shown in the various tree structured indices initially; the user can expand 1224 | # and collapse entries dynamically later on. Doxygen will expand the tree to 1225 | # such a level that at most the specified number of entries are visible (unless 1226 | # a fully collapsed tree already exceeds this amount). So setting the number of 1227 | # entries 1 will produce a full collapsed tree by default. 0 is a special value 1228 | # representing an infinite number of entries and will result in a full expanded 1229 | # tree by default. 1230 | # Minimum value: 0, maximum value: 9999, default value: 100. 1231 | # This tag requires that the tag GENERATE_HTML is set to YES. 1232 | 1233 | HTML_INDEX_NUM_ENTRIES = 100 1234 | 1235 | # If the GENERATE_DOCSET tag is set to YES, additional index files will be 1236 | # generated that can be used as input for Apple's Xcode 3 integrated development 1237 | # environment (see: http://developer.apple.com/tools/xcode/), introduced with 1238 | # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a 1239 | # Makefile in the HTML output directory. Running make will produce the docset in 1240 | # that directory and running make install will install the docset in 1241 | # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at 1242 | # startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html 1243 | # for more information. 1244 | # The default value is: NO. 1245 | # This tag requires that the tag GENERATE_HTML is set to YES. 1246 | 1247 | GENERATE_DOCSET = NO 1248 | 1249 | # This tag determines the name of the docset feed. A documentation feed provides 1250 | # an umbrella under which multiple documentation sets from a single provider 1251 | # (such as a company or product suite) can be grouped. 1252 | # The default value is: Doxygen generated docs. 1253 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1254 | 1255 | DOCSET_FEEDNAME = "Doxygen generated docs" 1256 | 1257 | # This tag specifies a string that should uniquely identify the documentation 1258 | # set bundle. This should be a reverse domain-name style string, e.g. 1259 | # com.mycompany.MyDocSet. Doxygen will append .docset to the name. 1260 | # The default value is: org.doxygen.Project. 1261 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1262 | 1263 | DOCSET_BUNDLE_ID = org.doxygen.Project 1264 | 1265 | # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify 1266 | # the documentation publisher. This should be a reverse domain-name style 1267 | # string, e.g. com.mycompany.MyDocSet.documentation. 1268 | # The default value is: org.doxygen.Publisher. 1269 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1270 | 1271 | DOCSET_PUBLISHER_ID = org.doxygen.Publisher 1272 | 1273 | # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. 1274 | # The default value is: Publisher. 1275 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1276 | 1277 | DOCSET_PUBLISHER_NAME = Publisher 1278 | 1279 | # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three 1280 | # additional HTML index files: index.hhp, index.hhc, and index.hhk. The 1281 | # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop 1282 | # (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on 1283 | # Windows. 1284 | # 1285 | # The HTML Help Workshop contains a compiler that can convert all HTML output 1286 | # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML 1287 | # files are now used as the Windows 98 help format, and will replace the old 1288 | # Windows help format (.hlp) on all Windows platforms in the future. Compressed 1289 | # HTML files also contain an index, a table of contents, and you can search for 1290 | # words in the documentation. The HTML workshop also contains a viewer for 1291 | # compressed HTML files. 1292 | # The default value is: NO. 1293 | # This tag requires that the tag GENERATE_HTML is set to YES. 1294 | 1295 | GENERATE_HTMLHELP = NO 1296 | 1297 | # The CHM_FILE tag can be used to specify the file name of the resulting .chm 1298 | # file. You can add a path in front of the file if the result should not be 1299 | # written to the html output directory. 1300 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1301 | 1302 | CHM_FILE = 1303 | 1304 | # The HHC_LOCATION tag can be used to specify the location (absolute path 1305 | # including file name) of the HTML help compiler (hhc.exe). If non-empty, 1306 | # doxygen will try to run the HTML help compiler on the generated index.hhp. 1307 | # The file has to be specified with full path. 1308 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1309 | 1310 | HHC_LOCATION = 1311 | 1312 | # The GENERATE_CHI flag controls if a separate .chi index file is generated 1313 | # (YES) or that it should be included in the master .chm file (NO). 1314 | # The default value is: NO. 1315 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1316 | 1317 | GENERATE_CHI = NO 1318 | 1319 | # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) 1320 | # and project file content. 1321 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1322 | 1323 | CHM_INDEX_ENCODING = 1324 | 1325 | # The BINARY_TOC flag controls whether a binary table of contents is generated 1326 | # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it 1327 | # enables the Previous and Next buttons. 1328 | # The default value is: NO. 1329 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1330 | 1331 | BINARY_TOC = NO 1332 | 1333 | # The TOC_EXPAND flag can be set to YES to add extra items for group members to 1334 | # the table of contents of the HTML help documentation and to the tree view. 1335 | # The default value is: NO. 1336 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1337 | 1338 | TOC_EXPAND = NO 1339 | 1340 | # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and 1341 | # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that 1342 | # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help 1343 | # (.qch) of the generated HTML documentation. 1344 | # The default value is: NO. 1345 | # This tag requires that the tag GENERATE_HTML is set to YES. 1346 | 1347 | GENERATE_QHP = NO 1348 | 1349 | # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify 1350 | # the file name of the resulting .qch file. The path specified is relative to 1351 | # the HTML output folder. 1352 | # This tag requires that the tag GENERATE_QHP is set to YES. 1353 | 1354 | QCH_FILE = 1355 | 1356 | # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help 1357 | # Project output. For more information please see Qt Help Project / Namespace 1358 | # (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). 1359 | # The default value is: org.doxygen.Project. 1360 | # This tag requires that the tag GENERATE_QHP is set to YES. 1361 | 1362 | QHP_NAMESPACE = org.doxygen.Project 1363 | 1364 | # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt 1365 | # Help Project output. For more information please see Qt Help Project / Virtual 1366 | # Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- 1367 | # folders). 1368 | # The default value is: doc. 1369 | # This tag requires that the tag GENERATE_QHP is set to YES. 1370 | 1371 | QHP_VIRTUAL_FOLDER = doc 1372 | 1373 | # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom 1374 | # filter to add. For more information please see Qt Help Project / Custom 1375 | # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- 1376 | # filters). 1377 | # This tag requires that the tag GENERATE_QHP is set to YES. 1378 | 1379 | QHP_CUST_FILTER_NAME = 1380 | 1381 | # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the 1382 | # custom filter to add. For more information please see Qt Help Project / Custom 1383 | # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- 1384 | # filters). 1385 | # This tag requires that the tag GENERATE_QHP is set to YES. 1386 | 1387 | QHP_CUST_FILTER_ATTRS = 1388 | 1389 | # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this 1390 | # project's filter section matches. Qt Help Project / Filter Attributes (see: 1391 | # http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). 1392 | # This tag requires that the tag GENERATE_QHP is set to YES. 1393 | 1394 | QHP_SECT_FILTER_ATTRS = 1395 | 1396 | # The QHG_LOCATION tag can be used to specify the location of Qt's 1397 | # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the 1398 | # generated .qhp file. 1399 | # This tag requires that the tag GENERATE_QHP is set to YES. 1400 | 1401 | QHG_LOCATION = 1402 | 1403 | # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be 1404 | # generated, together with the HTML files, they form an Eclipse help plugin. To 1405 | # install this plugin and make it available under the help contents menu in 1406 | # Eclipse, the contents of the directory containing the HTML and XML files needs 1407 | # to be copied into the plugins directory of eclipse. The name of the directory 1408 | # within the plugins directory should be the same as the ECLIPSE_DOC_ID value. 1409 | # After copying Eclipse needs to be restarted before the help appears. 1410 | # The default value is: NO. 1411 | # This tag requires that the tag GENERATE_HTML is set to YES. 1412 | 1413 | GENERATE_ECLIPSEHELP = NO 1414 | 1415 | # A unique identifier for the Eclipse help plugin. When installing the plugin 1416 | # the directory name containing the HTML and XML files should also have this 1417 | # name. Each documentation set should have its own identifier. 1418 | # The default value is: org.doxygen.Project. 1419 | # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. 1420 | 1421 | ECLIPSE_DOC_ID = org.doxygen.Project 1422 | 1423 | # If you want full control over the layout of the generated HTML pages it might 1424 | # be necessary to disable the index and replace it with your own. The 1425 | # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top 1426 | # of each HTML page. A value of NO enables the index and the value YES disables 1427 | # it. Since the tabs in the index contain the same information as the navigation 1428 | # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. 1429 | # The default value is: NO. 1430 | # This tag requires that the tag GENERATE_HTML is set to YES. 1431 | 1432 | DISABLE_INDEX = NO 1433 | 1434 | # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 1435 | # structure should be generated to display hierarchical information. If the tag 1436 | # value is set to YES, a side panel will be generated containing a tree-like 1437 | # index structure (just like the one that is generated for HTML Help). For this 1438 | # to work a browser that supports JavaScript, DHTML, CSS and frames is required 1439 | # (i.e. any modern browser). Windows users are probably better off using the 1440 | # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can 1441 | # further fine-tune the look of the index. As an example, the default style 1442 | # sheet generated by doxygen has an example that shows how to put an image at 1443 | # the root of the tree instead of the PROJECT_NAME. Since the tree basically has 1444 | # the same information as the tab index, you could consider setting 1445 | # DISABLE_INDEX to YES when enabling this option. 1446 | # The default value is: NO. 1447 | # This tag requires that the tag GENERATE_HTML is set to YES. 1448 | 1449 | GENERATE_TREEVIEW = YES 1450 | 1451 | # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that 1452 | # doxygen will group on one line in the generated HTML documentation. 1453 | # 1454 | # Note that a value of 0 will completely suppress the enum values from appearing 1455 | # in the overview section. 1456 | # Minimum value: 0, maximum value: 20, default value: 4. 1457 | # This tag requires that the tag GENERATE_HTML is set to YES. 1458 | 1459 | ENUM_VALUES_PER_LINE = 4 1460 | 1461 | # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used 1462 | # to set the initial width (in pixels) of the frame in which the tree is shown. 1463 | # Minimum value: 0, maximum value: 1500, default value: 250. 1464 | # This tag requires that the tag GENERATE_HTML is set to YES. 1465 | 1466 | TREEVIEW_WIDTH = 250 1467 | 1468 | # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to 1469 | # external symbols imported via tag files in a separate window. 1470 | # The default value is: NO. 1471 | # This tag requires that the tag GENERATE_HTML is set to YES. 1472 | 1473 | EXT_LINKS_IN_WINDOW = NO 1474 | 1475 | # Use this tag to change the font size of LaTeX formulas included as images in 1476 | # the HTML documentation. When you change the font size after a successful 1477 | # doxygen run you need to manually remove any form_*.png images from the HTML 1478 | # output directory to force them to be regenerated. 1479 | # Minimum value: 8, maximum value: 50, default value: 10. 1480 | # This tag requires that the tag GENERATE_HTML is set to YES. 1481 | 1482 | FORMULA_FONTSIZE = 10 1483 | 1484 | 1485 | 1486 | # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see 1487 | # http://www.mathjax.org) which uses client side Javascript for the rendering 1488 | # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX 1489 | # installed or if you want to formulas look prettier in the HTML output. When 1490 | # enabled you may also need to install MathJax separately and configure the path 1491 | # to it using the MATHJAX_RELPATH option. 1492 | # The default value is: NO. 1493 | # This tag requires that the tag GENERATE_HTML is set to YES. 1494 | 1495 | USE_MATHJAX = NO 1496 | 1497 | # When MathJax is enabled you can set the default output format to be used for 1498 | # the MathJax output. See the MathJax site (see: 1499 | # http://docs.mathjax.org/en/latest/output.html) for more details. 1500 | # Possible values are: HTML-CSS (which is slower, but has the best 1501 | # compatibility), NativeMML (i.e. MathML) and SVG. 1502 | # The default value is: HTML-CSS. 1503 | # This tag requires that the tag USE_MATHJAX is set to YES. 1504 | 1505 | MATHJAX_FORMAT = HTML-CSS 1506 | 1507 | # When MathJax is enabled you need to specify the location relative to the HTML 1508 | # output directory using the MATHJAX_RELPATH option. The destination directory 1509 | # should contain the MathJax.js script. For instance, if the mathjax directory 1510 | # is located at the same level as the HTML output directory, then 1511 | # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax 1512 | # Content Delivery Network so you can quickly see the result without installing 1513 | # MathJax. However, it is strongly recommended to install a local copy of 1514 | # MathJax from http://www.mathjax.org before deployment. 1515 | # The default value is: http://cdn.mathjax.org/mathjax/latest. 1516 | # This tag requires that the tag USE_MATHJAX is set to YES. 1517 | 1518 | MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest 1519 | 1520 | # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax 1521 | # extension names that should be enabled during MathJax rendering. For example 1522 | # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols 1523 | # This tag requires that the tag USE_MATHJAX is set to YES. 1524 | 1525 | MATHJAX_EXTENSIONS = 1526 | 1527 | # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces 1528 | # of code that will be used on startup of the MathJax code. See the MathJax site 1529 | # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an 1530 | # example see the documentation. 1531 | # This tag requires that the tag USE_MATHJAX is set to YES. 1532 | 1533 | MATHJAX_CODEFILE = 1534 | 1535 | # When the SEARCHENGINE tag is enabled doxygen will generate a search box for 1536 | # the HTML output. The underlying search engine uses javascript and DHTML and 1537 | # should work on any modern browser. Note that when using HTML help 1538 | # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) 1539 | # there is already a search function so this one should typically be disabled. 1540 | # For large projects the javascript based search engine can be slow, then 1541 | # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to 1542 | # search using the keyboard; to jump to the search box use + S 1543 | # (what the is depends on the OS and browser, but it is typically 1544 | # , /