├── .clang-format ├── .clang-tidy ├── .gitattributes ├── .github ├── FUNDING.yml └── workflows │ ├── build-and-test.yml │ └── release.yml ├── .gitignore ├── .readthedocs.yaml ├── .vscode ├── c_cpp_properties.json ├── extensions.json ├── launch.json ├── settings.json └── tasks.json ├── AUTHORS ├── CHANGELOG.md ├── CMakeLists.txt ├── CMakePresets.json ├── LICENSE ├── README.md ├── TODO.md ├── cmake ├── i686-w64-mingw32-gcc.cmake └── x86_64-w64-mingw32-gcc.cmake ├── dev ├── lwwdg_opts.h └── main.c ├── docs ├── Makefile ├── api-reference │ ├── index.rst │ ├── lwwdg.rst │ └── lwwdg_opt.rst ├── authors │ └── index.rst ├── changelog │ └── index.rst ├── conf.py ├── doxyfile.doxy ├── get-started │ └── index.rst ├── index.rst ├── make.bat ├── requirements.txt ├── static │ ├── css │ │ ├── common.css │ │ └── custom.css │ ├── dark-light │ │ ├── checked.svg │ │ ├── common-dark-light.css │ │ ├── dark-mode-toggle.mjs │ │ ├── dark.css │ │ ├── light.css │ │ ├── moon.png │ │ ├── moon.svg │ │ ├── sun.png │ │ ├── sun.svg │ │ └── unchecked.svg │ └── images │ │ ├── logo.drawio │ │ ├── logo.svg │ │ ├── logo_tm.png │ │ └── logo_tm_full.png └── user-manual │ └── index.rst ├── examples └── example_win32.c ├── library.json ├── lwwdg ├── CMakeLists.txt ├── library.cmake └── src │ ├── include │ └── lwwdg │ │ ├── lwwdg.h │ │ ├── lwwdg_opt.h │ │ └── lwwdg_opts_template.h │ └── lwwdg │ └── lwwdg.c └── tests └── test.c /.clang-format: -------------------------------------------------------------------------------- 1 | # Language part removed. With clang-format >=20.1, the C and Cpp are separately handled, 2 | # so either there is no language at all, or we need to create 2 formats for C and Cpp, separately 3 | 4 | --- 5 | # Language: Cpp 6 | # BasedOnStyle: LLVM 7 | AccessModifierOffset: -2 8 | AlignAfterOpenBracket: Align 9 | AlignArrayOfStructures: None 10 | AlignConsecutiveMacros: 11 | Enabled: true 12 | AcrossEmptyLines: true 13 | AcrossComments: true 14 | AlignConsecutiveAssignments: None 15 | AlignConsecutiveBitFields: 16 | Enabled: true 17 | AcrossEmptyLines: true 18 | AcrossComments: true 19 | AlignConsecutiveDeclarations: None 20 | AlignEscapedNewlines: Right 21 | AlignOperands: Align 22 | SortIncludes: true 23 | InsertBraces: true # Control statements must have curly brackets 24 | AlignTrailingComments: true 25 | AllowAllArgumentsOnNextLine: true 26 | AllowAllParametersOfDeclarationOnNextLine: true 27 | AllowShortEnumsOnASingleLine: true 28 | AllowShortBlocksOnASingleLine: Empty 29 | AllowShortCaseLabelsOnASingleLine: true 30 | AllowShortFunctionsOnASingleLine: All 31 | AllowShortLambdasOnASingleLine: All 32 | AllowShortIfStatementsOnASingleLine: Never 33 | AllowShortLoopsOnASingleLine: false 34 | AlwaysBreakAfterDefinitionReturnType: None 35 | AlwaysBreakAfterReturnType: AllDefinitions 36 | AlwaysBreakBeforeMultilineStrings: false 37 | AlwaysBreakTemplateDeclarations: Yes 38 | AttributeMacros: 39 | - __capability 40 | BinPackArguments: true 41 | BinPackParameters: true 42 | BraceWrapping: 43 | AfterCaseLabel: false 44 | AfterClass: false 45 | AfterControlStatement: Never 46 | AfterEnum: false 47 | AfterFunction: false 48 | AfterNamespace: false 49 | AfterObjCDeclaration: false 50 | AfterStruct: false 51 | AfterUnion: false 52 | AfterExternBlock: false 53 | BeforeCatch: false 54 | BeforeElse: false 55 | BeforeLambdaBody: false 56 | BeforeWhile: false 57 | IndentBraces: false 58 | SplitEmptyFunction: true 59 | SplitEmptyRecord: true 60 | SplitEmptyNamespace: true 61 | BreakBeforeBinaryOperators: NonAssignment 62 | BreakBeforeConceptDeclarations: true 63 | BreakBeforeBraces: Attach 64 | BreakBeforeInheritanceComma: false 65 | BreakInheritanceList: BeforeColon 66 | BreakBeforeTernaryOperators: true 67 | BreakConstructorInitializersBeforeComma: false 68 | BreakConstructorInitializers: BeforeColon 69 | BreakAfterJavaFieldAnnotations: false 70 | BreakStringLiterals: true 71 | ColumnLimit: 120 72 | CommentPragmas: "^ IWYU pragma:" 73 | QualifierAlignment: Leave 74 | CompactNamespaces: false 75 | ConstructorInitializerIndentWidth: 4 76 | ContinuationIndentWidth: 4 77 | Cpp11BracedListStyle: true 78 | DeriveLineEnding: true 79 | DerivePointerAlignment: false 80 | DisableFormat: false 81 | EmptyLineAfterAccessModifier: Never 82 | EmptyLineBeforeAccessModifier: LogicalBlock 83 | ExperimentalAutoDetectBinPacking: false 84 | PackConstructorInitializers: BinPack 85 | BasedOnStyle: "" 86 | ConstructorInitializerAllOnOneLineOrOnePerLine: false 87 | AllowAllConstructorInitializersOnNextLine: true 88 | FixNamespaceComments: true 89 | ForEachMacros: 90 | - foreach 91 | - Q_FOREACH 92 | - BOOST_FOREACH 93 | IfMacros: 94 | - KJ_IF_MAYBE 95 | IncludeBlocks: Preserve 96 | IncludeCategories: 97 | - Regex: "^<(.*)>" 98 | Priority: 0 99 | - Regex: '^"(.*)"' 100 | Priority: 1 101 | - Regex: "(.*)" 102 | Priority: 2 103 | IncludeIsMainRegex: "(Test)?$" 104 | IncludeIsMainSourceRegex: "" 105 | IndentAccessModifiers: false 106 | IndentCaseLabels: true 107 | IndentCaseBlocks: false 108 | IndentGotoLabels: true 109 | IndentPPDirectives: None 110 | IndentExternBlock: AfterExternBlock 111 | IndentRequires: true 112 | IndentWidth: 4 113 | IndentWrappedFunctionNames: false 114 | InsertTrailingCommas: None 115 | JavaScriptQuotes: Leave 116 | JavaScriptWrapImports: true 117 | KeepEmptyLinesAtTheStartOfBlocks: true 118 | LambdaBodyIndentation: Signature 119 | MacroBlockBegin: "" 120 | MacroBlockEnd: "" 121 | MaxEmptyLinesToKeep: 1 122 | NamespaceIndentation: None 123 | ObjCBinPackProtocolList: Auto 124 | ObjCBlockIndentWidth: 2 125 | ObjCBreakBeforeNestedBlockParam: true 126 | ObjCSpaceAfterProperty: false 127 | ObjCSpaceBeforeProtocolList: true 128 | PenaltyBreakAssignment: 2 129 | PenaltyBreakBeforeFirstCallParameter: 19 130 | PenaltyBreakComment: 300 131 | PenaltyBreakFirstLessLess: 120 132 | PenaltyBreakOpenParenthesis: 0 133 | PenaltyBreakString: 1000 134 | PenaltyBreakTemplateDeclaration: 10 135 | PenaltyExcessCharacter: 1000000 136 | PenaltyReturnTypeOnItsOwnLine: 60 137 | PenaltyIndentedWhitespace: 0 138 | PointerAlignment: Left 139 | PPIndentWidth: -1 140 | ReferenceAlignment: Pointer 141 | ReflowComments: false 142 | RemoveBracesLLVM: false 143 | SeparateDefinitionBlocks: Always 144 | ShortNamespaceLines: 1 145 | SortJavaStaticImport: Before 146 | SortUsingDeclarations: true 147 | SpaceAfterCStyleCast: false 148 | SpaceAfterLogicalNot: false 149 | SpaceAfterTemplateKeyword: true 150 | SpaceBeforeAssignmentOperators: true 151 | SpaceBeforeCaseColon: false 152 | SpaceBeforeParens: ControlStatements 153 | SpaceBeforeParensOptions: 154 | AfterControlStatements: true 155 | AfterForeachMacros: true 156 | AfterFunctionDefinitionName: false 157 | AfterFunctionDeclarationName: false 158 | AfterIfMacros: true 159 | AfterOverloadedOperator: false 160 | BeforeNonEmptyParentheses: false 161 | SpaceAroundPointerQualifiers: Default 162 | SpaceBeforeRangeBasedForLoopColon: true 163 | SpaceInEmptyBlock: false 164 | SpaceInEmptyParentheses: false 165 | SpacesBeforeTrailingComments: 1 166 | SpacesInAngles: Never 167 | SpacesInConditionalStatement: false 168 | SpacesInContainerLiterals: true 169 | SpacesInCStyleCastParentheses: false 170 | SpacesInLineCommentPrefix: 171 | Minimum: 1 172 | Maximum: -1 173 | SpacesInParentheses: false 174 | SpacesInSquareBrackets: false 175 | SpaceBeforeSquareBrackets: false 176 | BitFieldColonSpacing: Both 177 | Standard: Latest 178 | StatementAttributeLikeMacros: 179 | - Q_EMIT 180 | StatementMacros: 181 | - Q_UNUSED 182 | - QT_REQUIRE_VERSION 183 | TabWidth: 8 184 | UseCRLF: false 185 | UseTab: Never 186 | WhitespaceSensitiveMacros: 187 | - STRINGIZE 188 | - PP_STRINGIZE 189 | - BOOST_PP_STRINGIZE 190 | - NS_SWIFT_NAME 191 | - CF_SWIFT_NAME 192 | SpaceBeforeCpp11BracedList: false 193 | SpaceBeforeCtorInitializerColon: true 194 | SpaceBeforeInheritanceColon: true 195 | --- 196 | 197 | -------------------------------------------------------------------------------- /.clang-tidy: -------------------------------------------------------------------------------- 1 | --- 2 | Checks: "*, 3 | -abseil-*, 4 | -altera-*, 5 | -android-*, 6 | -fuchsia-*, 7 | -google-*, 8 | -llvm*, 9 | -modernize-use-trailing-return-type, 10 | -zircon-*, 11 | -readability-else-after-return, 12 | -readability-static-accessed-through-instance, 13 | -readability-avoid-const-params-in-decls, 14 | -cppcoreguidelines-non-private-member-variables-in-classes, 15 | -misc-non-private-member-variables-in-classes, 16 | " 17 | WarningsAsErrors: '' 18 | HeaderFilterRegex: '' 19 | FormatStyle: none -------------------------------------------------------------------------------- /.gitattributes: -------------------------------------------------------------------------------- 1 | # Auto detect text files and perform LF normalization 2 | * text=auto 3 | 4 | # Custom for Visual Studio 5 | *.cs diff=csharp 6 | 7 | # Standard to msysgit 8 | *.doc diff=astextplain 9 | *.DOC diff=astextplain 10 | *.docx diff=astextplain 11 | *.DOCX diff=astextplain 12 | *.dot diff=astextplain 13 | *.DOT diff=astextplain 14 | *.pdf diff=astextplain 15 | *.PDF diff=astextplain 16 | *.rtf diff=astextplain 17 | *.RTF diff=astextplain -------------------------------------------------------------------------------- /.github/FUNDING.yml: -------------------------------------------------------------------------------- 1 | # These are supported funding model platforms 2 | 3 | custom: ['paypal.me/tilz0R'] 4 | -------------------------------------------------------------------------------- /.github/workflows/build-and-test.yml: -------------------------------------------------------------------------------- 1 | name: Windows CMake Build & Test 2 | 3 | on: 4 | push: 5 | branches: 6 | - develop 7 | pull_request: 8 | branches: 9 | - develop 10 | 11 | jobs: 12 | build: 13 | runs-on: windows-latest 14 | 15 | steps: 16 | - name: Checkout Repository 17 | uses: actions/checkout@v4 18 | 19 | - name: Install MinGW 20 | run: | 21 | choco install mingw --version=12.2.0 -y 22 | echo "C:\ProgramData\chocolatey\lib\mingw\tools\install\mingw64\bin" >> $GITHUB_PATH 23 | gcc --version 24 | 25 | - name: Build 26 | run: | 27 | mkdir __build__ 28 | cd __build__ 29 | cmake -DCMAKE_C_COMPILER=gcc -DCMAKE_CXX_COMPILER=gcc -S.. -G Ninja 30 | cmake --build . 31 | 32 | - name: Run Tests 33 | working-directory: __build__ 34 | run: | 35 | ctest . --output-on-failure 36 | -------------------------------------------------------------------------------- /.github/workflows/release.yml: -------------------------------------------------------------------------------- 1 | on: 2 | push: 3 | # Sequence of patterns matched against refs/tags 4 | tags: 5 | - 'v*' # Push events to matching v*, i.e. v1.0, v20.15.10 6 | 7 | name: Create Release 8 | 9 | jobs: 10 | build: 11 | name: Create Release 12 | runs-on: ubuntu-latest 13 | steps: 14 | - name: Checkout code 15 | uses: actions/checkout@v2 16 | - name: Create Release 17 | id: create_release 18 | uses: actions/create-release@v1 19 | env: 20 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # This token is provided by Actions, you do not need to create your own token 21 | with: 22 | tag_name: ${{ github.ref }} 23 | release_name: Release ${{ github.ref }} 24 | body: | 25 | See the [CHANGELOG](CHANGELOG.md) 26 | draft: false 27 | prerelease: false -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | #Build Keil files 2 | *.rar 3 | *.o 4 | *.d 5 | *.crf 6 | *.htm 7 | *.dep 8 | *.map 9 | *.bak 10 | *.axf 11 | *.lnp 12 | *.lst 13 | *.ini 14 | *.scvd 15 | *.iex 16 | *.sct 17 | *.MajerleT 18 | *.tjuln 19 | *.tilen 20 | *.dbgconf 21 | *.uvguix 22 | *.uvoptx 23 | *.__i 24 | *.i 25 | *.txt 26 | !docs/*.txt 27 | !CMakeLists.txt 28 | RTE/ 29 | 30 | *debug 31 | 32 | # IAR Settings 33 | **/settings/*.crun 34 | **/settings/*.dbgdt 35 | **/settings/*.cspy 36 | **/settings/*.cspy.* 37 | **/settings/*.xcl 38 | **/settings/*.dni 39 | **/settings/*.wsdt 40 | **/settings/*.wspos 41 | 42 | # IAR Debug Exe 43 | **/Exe/*.sim 44 | 45 | # IAR Debug Obj 46 | **/Obj/*.pbd 47 | **/Obj/*.pbd.* 48 | **/Obj/*.pbi 49 | **/Obj/*.pbi.* 50 | 51 | *.TMP 52 | /docs_src/x_Doxyfile.doxy 53 | 54 | .DS_Store 55 | 56 | ## Ignore Visual Studio temporary files, build results, and 57 | ## files generated by popular Visual Studio add-ons. 58 | ## 59 | ## Get latest from https://github.com/github/gitignore/blob/master/VisualStudio.gitignore 60 | 61 | # User-specific files 62 | *.suo 63 | *.user 64 | *.userosscache 65 | *.sln.docstates 66 | 67 | # User-specific files (MonoDevelop/Xamarin Studio) 68 | *.userprefs 69 | 70 | # Build results 71 | [Dd]ebug/ 72 | [Dd]ebugPublic/ 73 | [Rr]elease/ 74 | [Rr]eleases/ 75 | [Dd]ebug*/ 76 | x64/ 77 | x86/ 78 | bld/ 79 | [Bb]in/ 80 | [Oo]bj/ 81 | [Ll]og/ 82 | _build/ 83 | build/ 84 | __build__/ 85 | 86 | # Visual Studio 2015/2017 cache/options directory 87 | .vs/ 88 | # Uncomment if you have tasks that create the project's static files in wwwroot 89 | #wwwroot/ 90 | 91 | # Visual Studio 2017 auto generated files 92 | Generated\ Files/ 93 | 94 | # MSTest test Results 95 | [Tt]est[Rr]esult*/ 96 | [Bb]uild[Ll]og.* 97 | 98 | # NUNIT 99 | *.VisualState.xml 100 | TestResult.xml 101 | 102 | # Build Results of an ATL Project 103 | [Dd]ebug/ 104 | [Rr]elease/ 105 | dlldata.c 106 | 107 | # Benchmark Results 108 | BenchmarkDotNet.Artifacts/ 109 | 110 | # .NET Core 111 | project.lock.json 112 | project.fragment.lock.json 113 | artifacts/ 114 | **/Properties/launchSettings.json 115 | 116 | # StyleCop 117 | StyleCopReport.xml 118 | 119 | # Files built by Visual Studio 120 | *_i.c 121 | *_p.c 122 | *_i.h 123 | *.ilk 124 | *.meta 125 | *.obj 126 | *.pch 127 | *.pdb 128 | *.pgc 129 | *.pgd 130 | *.rsp 131 | *.sbr 132 | *.tlb 133 | *.tli 134 | *.tlh 135 | *.tmp 136 | *.tmp_proj 137 | *.log 138 | *.vspscc 139 | *.vssscc 140 | .builds 141 | *.pidb 142 | *.svclog 143 | *.scc 144 | *.out 145 | *.sim 146 | 147 | # Chutzpah Test files 148 | _Chutzpah* 149 | 150 | # Visual C++ cache files 151 | ipch/ 152 | *.aps 153 | *.ncb 154 | *.opendb 155 | *.opensdf 156 | *.sdf 157 | *.cachefile 158 | *.VC.db 159 | *.VC.VC.opendb 160 | 161 | # Visual Studio profiler 162 | *.psess 163 | *.vsp 164 | *.vspx 165 | *.sap 166 | 167 | # Visual Studio Trace Files 168 | *.e2e 169 | 170 | # TFS 2012 Local Workspace 171 | $tf/ 172 | 173 | # Guidance Automation Toolkit 174 | *.gpState 175 | 176 | # ReSharper is a .NET coding add-in 177 | _ReSharper*/ 178 | *.[Rr]e[Ss]harper 179 | *.DotSettings.user 180 | 181 | # JustCode is a .NET coding add-in 182 | .JustCode 183 | 184 | # TeamCity is a build add-in 185 | _TeamCity* 186 | 187 | # DotCover is a Code Coverage Tool 188 | *.dotCover 189 | 190 | # AxoCover is a Code Coverage Tool 191 | .axoCover/* 192 | !.axoCover/settings.json 193 | 194 | # Visual Studio code coverage results 195 | *.coverage 196 | *.coveragexml 197 | 198 | # NCrunch 199 | _NCrunch_* 200 | .*crunch*.local.xml 201 | nCrunchTemp_* 202 | 203 | # MightyMoose 204 | *.mm.* 205 | AutoTest.Net/ 206 | 207 | # Web workbench (sass) 208 | .sass-cache/ 209 | 210 | # Installshield output folder 211 | [Ee]xpress/ 212 | 213 | # DocProject is a documentation generator add-in 214 | DocProject/buildhelp/ 215 | DocProject/Help/*.HxT 216 | DocProject/Help/*.HxC 217 | DocProject/Help/*.hhc 218 | DocProject/Help/*.hhk 219 | DocProject/Help/*.hhp 220 | DocProject/Help/Html2 221 | DocProject/Help/html 222 | 223 | # Click-Once directory 224 | publish/ 225 | 226 | # Publish Web Output 227 | *.[Pp]ublish.xml 228 | *.azurePubxml 229 | # Note: Comment the next line if you want to checkin your web deploy settings, 230 | # but database connection strings (with potential passwords) will be unencrypted 231 | *.pubxml 232 | *.publishproj 233 | 234 | # Microsoft Azure Web App publish settings. Comment the next line if you want to 235 | # checkin your Azure Web App publish settings, but sensitive information contained 236 | # in these scripts will be unencrypted 237 | PublishScripts/ 238 | 239 | # NuGet Packages 240 | *.nupkg 241 | # The packages folder can be ignored because of Package Restore 242 | **/[Pp]ackages/* 243 | # except build/, which is used as an MSBuild target. 244 | !**/[Pp]ackages/build/ 245 | # Uncomment if necessary however generally it will be regenerated when needed 246 | #!**/[Pp]ackages/repositories.config 247 | # NuGet v3's project.json files produces more ignorable files 248 | *.nuget.props 249 | *.nuget.targets 250 | 251 | # Microsoft Azure Build Output 252 | csx/ 253 | *.build.csdef 254 | 255 | # Microsoft Azure Emulator 256 | ecf/ 257 | rcf/ 258 | 259 | # Windows Store app package directories and files 260 | AppPackages/ 261 | BundleArtifacts/ 262 | Package.StoreAssociation.xml 263 | _pkginfo.txt 264 | *.appx 265 | 266 | # Visual Studio cache files 267 | # files ending in .cache can be ignored 268 | *.[Cc]ache 269 | # but keep track of directories ending in .cache 270 | !*.[Cc]ache/ 271 | 272 | # Others 273 | ClientBin/ 274 | ~$* 275 | *~ 276 | *.dbmdl 277 | *.dbproj.schemaview 278 | *.jfm 279 | *.pfx 280 | *.publishsettings 281 | orleans.codegen.cs 282 | 283 | # Including strong name files can present a security risk 284 | # (https://github.com/github/gitignore/pull/2483#issue-259490424) 285 | #*.snk 286 | 287 | # Since there are multiple workflows, uncomment next line to ignore bower_components 288 | # (https://github.com/github/gitignore/pull/1529#issuecomment-104372622) 289 | #bower_components/ 290 | 291 | # RIA/Silverlight projects 292 | Generated_Code/ 293 | 294 | # Backup & report files from converting an old project file 295 | # to a newer Visual Studio version. Backup files are not needed, 296 | # because we have git ;-) 297 | _UpgradeReport_Files/ 298 | Backup*/ 299 | UpgradeLog*.XML 300 | UpgradeLog*.htm 301 | 302 | # SQL Server files 303 | *.mdf 304 | *.ldf 305 | *.ndf 306 | 307 | # Business Intelligence projects 308 | *.rdl.data 309 | *.bim.layout 310 | *.bim_*.settings 311 | 312 | # Microsoft Fakes 313 | FakesAssemblies/ 314 | 315 | # GhostDoc plugin setting file 316 | *.GhostDoc.xml 317 | 318 | # Node.js Tools for Visual Studio 319 | .ntvs_analysis.dat 320 | node_modules/ 321 | 322 | # TypeScript v1 declaration files 323 | typings/ 324 | 325 | # Visual Studio 6 build log 326 | *.plg 327 | 328 | # Visual Studio 6 workspace options file 329 | *.opt 330 | 331 | # Visual Studio 6 auto-generated workspace file (contains which files were open etc.) 332 | *.vbw 333 | 334 | # Visual Studio LightSwitch build output 335 | **/*.HTMLClient/GeneratedArtifacts 336 | **/*.DesktopClient/GeneratedArtifacts 337 | **/*.DesktopClient/ModelManifest.xml 338 | **/*.Server/GeneratedArtifacts 339 | **/*.Server/ModelManifest.xml 340 | _Pvt_Extensions 341 | 342 | # Paket dependency manager 343 | .paket/paket.exe 344 | paket-files/ 345 | 346 | # FAKE - F# Make 347 | .fake/ 348 | 349 | # JetBrains Rider 350 | .idea/ 351 | *.sln.iml 352 | 353 | # CodeRush 354 | .cr/ 355 | 356 | # Python Tools for Visual Studio (PTVS) 357 | __pycache__/ 358 | *.pyc 359 | 360 | # Cake - Uncomment if you are using it 361 | # tools/** 362 | # !tools/packages.config 363 | 364 | # Tabs Studio 365 | *.tss 366 | 367 | # Telerik's JustMock configuration file 368 | *.jmconfig 369 | 370 | # BizTalk build output 371 | *.btp.cs 372 | *.btm.cs 373 | *.odx.cs 374 | *.xsd.cs 375 | 376 | # OpenCover UI analysis results 377 | OpenCover/ 378 | 379 | # Azure Stream Analytics local run output 380 | ASALocalRun/ 381 | 382 | # MSBuild Binary and Structured Log 383 | *.binlog 384 | 385 | log_file.txt 386 | .metadata/ 387 | .mxproject 388 | .settings/ 389 | project.ioc 390 | mx.scratch 391 | *.tilen majerle 392 | 393 | 394 | # Altium 395 | Project outputs* 396 | History/ 397 | *.SchDocPreview 398 | *.$$$Preview 399 | 400 | # VSCode projects 401 | project_vscode_compiled.exe -------------------------------------------------------------------------------- /.readthedocs.yaml: -------------------------------------------------------------------------------- 1 | version: 2 2 | build: 3 | os: ubuntu-22.04 4 | tools: 5 | python: "3.11" 6 | 7 | # Build documentation in the docs/ directory with Sphinx 8 | sphinx: 9 | configuration: docs/conf.py 10 | 11 | # Python configuration 12 | python: 13 | install: 14 | - requirements: docs/requirements.txt 15 | 16 | formats: 17 | - pdf 18 | - epub 19 | -------------------------------------------------------------------------------- /.vscode/c_cpp_properties.json: -------------------------------------------------------------------------------- 1 | { 2 | "version": 4, 3 | "configurations": [ 4 | { 5 | /* 6 | * Full configuration is provided by CMake plugin for vscode, 7 | * that shall be installed by user 8 | */ 9 | "name": "Win32", 10 | "intelliSenseMode": "${default}", 11 | "configurationProvider": "ms-vscode.cmake-tools" 12 | } 13 | ] 14 | } -------------------------------------------------------------------------------- /.vscode/extensions.json: -------------------------------------------------------------------------------- 1 | { 2 | "recommendations": [ 3 | "ms-vscode.cpptools", 4 | "ms-vscode.cmake-tools", 5 | "twxs.cmake", 6 | ] 7 | } -------------------------------------------------------------------------------- /.vscode/launch.json: -------------------------------------------------------------------------------- 1 | { 2 | "version": "0.2.0", 3 | "configurations": [ 4 | { 5 | /* GDB must in be in the PATH environment */ 6 | "name": "(Windows) Launch", 7 | "type": "cppdbg", 8 | "request": "launch", 9 | "program": "${command:cmake.launchTargetPath}", 10 | "args": [], 11 | "stopAtEntry": false, 12 | "cwd": "${fileDirname}", 13 | "environment": [] 14 | } 15 | ] 16 | } -------------------------------------------------------------------------------- /.vscode/settings.json: -------------------------------------------------------------------------------- 1 | { 2 | "files.associations": { 3 | "lwevt_types.h": "c", 4 | "lwevt_type.h": "c", 5 | "lwevt.h": "c", 6 | "string.h": "c", 7 | "lwevt_opt.h": "c", 8 | "lwwdg.h": "c", 9 | "lwwdg_opt.h": "c", 10 | "lwwdg_opts.h": "c", 11 | "stdint.h": "c" 12 | }, 13 | "esbonio.sphinx.confDir": "" 14 | } -------------------------------------------------------------------------------- /.vscode/tasks.json: -------------------------------------------------------------------------------- 1 | { 2 | "version": "2.0.0", 3 | "tasks": [ 4 | { 5 | "type": "cppbuild", 6 | "label": "Build project", 7 | "command": "cmake", 8 | "args": ["--build", "${command:cmake.buildDirectory}", "-j", "8"], 9 | "options": { 10 | "cwd": "${workspaceFolder}" 11 | }, 12 | "problemMatcher": ["$gcc"], 13 | "group": { 14 | "kind": "build", 15 | "isDefault": true 16 | } 17 | }, 18 | { 19 | "type": "shell", 20 | "label": "Re-build project", 21 | "command": "cmake", 22 | "args": ["--build", "${command:cmake.buildDirectory}", "--clean-first", "-v", "-j", "8"], 23 | "options": { 24 | "cwd": "${workspaceFolder}" 25 | }, 26 | "problemMatcher": ["$gcc"], 27 | }, 28 | { 29 | "type": "shell", 30 | "label": "Clean project", 31 | "command": "cmake", 32 | "args": ["--build", "${command:cmake.buildDirectory}", "--target", "clean"], 33 | "options": { 34 | "cwd": "${workspaceFolder}" 35 | }, 36 | "problemMatcher": [] 37 | }, 38 | { 39 | "type": "shell", 40 | "label": "Run application", 41 | "command": "${command:cmake.launchTargetPath}", 42 | "args": [], 43 | "problemMatcher": [], 44 | }, 45 | { 46 | "label": "Docs: Install python plugins from requirements.txt file", 47 | "type": "shell", 48 | "command": "python -m pip install -r requirements.txt", 49 | "options": { 50 | "cwd": "${workspaceFolder}/docs" 51 | }, 52 | "problemMatcher": [] 53 | }, 54 | { 55 | "label": "Docs: Generate html", 56 | "type": "shell", 57 | "command": ".\\make html", 58 | "options": { 59 | "cwd": "${workspaceFolder}/docs" 60 | }, 61 | "problemMatcher": [] 62 | }, 63 | { 64 | "label": "Docs: Clean build directory", 65 | "type": "shell", 66 | "command": ".\\make clean", 67 | "options": { 68 | "cwd": "${workspaceFolder}/docs" 69 | }, 70 | "problemMatcher": [] 71 | }, 72 | ] 73 | } -------------------------------------------------------------------------------- /AUTHORS: -------------------------------------------------------------------------------- 1 | Tilen Majerle 2 | Tilen Majerle -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # Changelog 2 | 3 | ## Develop 4 | 5 | - Rework library CMake with removed INTERFACE type 6 | 7 | ## v1.1.2 8 | 9 | - Fix race condition in `lwwdg_process` function 10 | 11 | ## v1.1.1 12 | 13 | - Fix wrong time check 14 | 15 | ## v1.1.0 16 | 17 | - Print error message only on one trial 18 | - Add print option to list all expired watchdogs 19 | 20 | ## v1.0.0 21 | 22 | - Added option to remove wdg from the list 23 | - Added option to set watchdog name and print its name on error 24 | 25 | ## v0.0.1 26 | 27 | - First version 28 | **** -------------------------------------------------------------------------------- /CMakeLists.txt: -------------------------------------------------------------------------------- 1 | cmake_minimum_required(VERSION 3.22) 2 | 3 | # Setup project 4 | project(LwLibPROJECT) 5 | 6 | if(NOT PROJECT_IS_TOP_LEVEL) 7 | add_subdirectory(lwwdg) 8 | else() 9 | enable_testing() 10 | add_executable(${CMAKE_PROJECT_NAME}) 11 | target_sources(${CMAKE_PROJECT_NAME} PRIVATE 12 | ${CMAKE_CURRENT_LIST_DIR}/dev/main.c 13 | ${CMAKE_CURRENT_LIST_DIR}/examples/example_win32.c 14 | ${CMAKE_CURRENT_LIST_DIR}/tests/test.c 15 | ) 16 | target_include_directories(${CMAKE_PROJECT_NAME} PUBLIC 17 | ${CMAKE_CURRENT_LIST_DIR}/dev 18 | ) 19 | 20 | # Add subdir with lwwdg and link to project 21 | set(LWWDG_OPTS_FILE ${CMAKE_CURRENT_LIST_DIR}/dev/lwwdg_opts.h) 22 | add_subdirectory(lwwdg) 23 | target_link_libraries(${CMAKE_PROJECT_NAME} lwwdg) 24 | 25 | # Add compile options to the library, which will propagate options to executable through public link 26 | target_compile_definitions(lwwdg PUBLIC WIN32 _DEBUG CONSOLE LWWDG_DEV) 27 | target_compile_options(lwwdg PUBLIC -Wall -Wextra -Wpedantic) 28 | 29 | # Add test 30 | add_test(NAME Test COMMAND $) 31 | endif() 32 | -------------------------------------------------------------------------------- /CMakePresets.json: -------------------------------------------------------------------------------- 1 | { 2 | "version": 3, 3 | "configurePresets": [ 4 | { 5 | "name": "default", 6 | "hidden": true, 7 | "generator": "Ninja", 8 | "binaryDir": "${sourceDir}/build/${presetName}", 9 | "cacheVariables": { 10 | "CMAKE_EXPORT_COMPILE_COMMANDS": "ON" 11 | } 12 | }, 13 | { 14 | "name": "Win32-Debug", 15 | "inherits": "default", 16 | "toolchainFile": "${sourceDir}/cmake/i686-w64-mingw32-gcc.cmake", 17 | "cacheVariables": { 18 | "CMAKE_BUILD_TYPE": "Debug" 19 | } 20 | }, 21 | { 22 | "name": "Win64-Debug", 23 | "inherits": "default", 24 | "toolchainFile": "${sourceDir}/cmake/x86_64-w64-mingw32-gcc.cmake", 25 | "cacheVariables": { 26 | "CMAKE_BUILD_TYPE": "Debug" 27 | } 28 | } 29 | ], 30 | "buildPresets": [ 31 | { 32 | "name": "Win32-Debug", 33 | "configurePreset": "Win32-Debug" 34 | }, 35 | { 36 | "name": "Win64-Debug", 37 | "configurePreset": "Win64-Debug" 38 | } 39 | ] 40 | } -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2024 Tilen MAJERLE 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 | # Lightweight Watchdog for embedded systems 2 | 3 | LwWDG is lightweight watchdog library, primarily targeting operating systems, 4 | to watch multiple threads and reset system if one of them fails. 5 | 6 |

Read first: Documentation

7 | 8 | ## Features 9 | 10 | * Written in C (C11) 11 | * Easy to use - very little platform dependency 12 | * Written for operating systems in mind 13 | 14 | ## Contribute 15 | 16 | Fresh contributions are always welcome. Simple instructions to proceed: 17 | 18 | 1. Fork Github repository 19 | 2. Follow [C style & coding rules](https://github.com/MaJerle/c-code-style) already used in the project 20 | 3. Create a pull request to develop branch with new features or bug fixes 21 | 22 | Alternatively you may: 23 | 24 | 1. Report a bug 25 | 2. Ask for a feature request 26 | -------------------------------------------------------------------------------- /TODO.md: -------------------------------------------------------------------------------- 1 | # TODO list 2 | 3 | -------------------------------------------------------------------------------- /cmake/i686-w64-mingw32-gcc.cmake: -------------------------------------------------------------------------------- 1 | set(CMAKE_SYSTEM_NAME Windows) 2 | 3 | # Some default GCC settings 4 | set(CMAKE_C_COMPILER i686-w64-mingw32-gcc) 5 | set(CMAKE_CXX_COMPILER i686-w64-mingw32-g++) 6 | 7 | set(CMAKE_TRY_COMPILE_TARGET_TYPE STATIC_LIBRARY) 8 | -------------------------------------------------------------------------------- /cmake/x86_64-w64-mingw32-gcc.cmake: -------------------------------------------------------------------------------- 1 | set(CMAKE_SYSTEM_NAME Windows) 2 | 3 | # Some default GCC settings 4 | set(CMAKE_C_COMPILER x86_64-w64-mingw32-gcc) 5 | set(CMAKE_CXX_COMPILER x86_64-w64-mingw32-g++) 6 | 7 | set(CMAKE_TRY_COMPILE_TARGET_TYPE STATIC_LIBRARY) 8 | -------------------------------------------------------------------------------- /dev/lwwdg_opts.h: -------------------------------------------------------------------------------- 1 | /** 2 | * \file lwwdg_opts_template.h 3 | * \brief LwWDG configuration file 4 | */ 5 | 6 | /* 7 | * Copyright (c) 2024 Tilen MAJERLE 8 | * 9 | * Permission is hereby granted, free of charge, to any person 10 | * obtaining a copy of this software and associated documentation 11 | * files (the "Software"), to deal in the Software without restriction, 12 | * including without limitation the rights to use, copy, modify, merge, 13 | * publish, distribute, sublicense, and/or sell copies of the Software, 14 | * and to permit persons to whom the Software is furnished to do so, 15 | * subject to the following conditions: 16 | * 17 | * The above copyright notice and this permission notice shall be 18 | * included in all copies or substantial portions of the Software. 19 | * 20 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 21 | * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES 22 | * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE 23 | * AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT 24 | * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, 25 | * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 26 | * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR 27 | * OTHER DEALINGS IN THE SOFTWARE. 28 | * 29 | * This file is part of LWWDG - Lightweight watchdog for RTOS in embedded systems. 30 | * 31 | * Author: Tilen MAJERLE 32 | * Version: v1.1.2 33 | */ 34 | #ifndef LWWDG_HDR_OPTS_H 35 | #define LWWDG_HDR_OPTS_H 36 | 37 | #include 38 | 39 | /* Win32 port */ 40 | #include "windows.h" 41 | extern uint32_t sys_get_tick(void); /* Milliseconds tick is available externally */ 42 | extern HANDLE lwwdg_mutex; /* Mutex is defined and initialized externally */ 43 | 44 | #define LWWDG_CRITICAL_SECTION_DEFINE /* Nothing to do here... */ 45 | #define LWWDG_CRITICAL_SECTION_LOCK() \ 46 | do { \ 47 | WaitForSingleObject(lwwdg_mutex, INFINITE); \ 48 | } while (0) 49 | #define LWWDG_CRITICAL_SECTION_UNLOCK() ReleaseMutex(lwwdg_mutex) 50 | #define LWWDG_GET_TIME() sys_get_tick() 51 | 52 | #define LWWDG_CFG_ENABLE_WDG_NAME 1 53 | #define LWWDG_CFG_WDG_NAME_ERR_DEBUG(_wdg_) printf("Watchdog %s failed to reload in time!\r\n", (_wdg_)) 54 | 55 | #endif /* LWWDG_HDR_OPTS_H */ 56 | -------------------------------------------------------------------------------- /dev/main.c: -------------------------------------------------------------------------------- 1 | #include 2 | #include 3 | #include "lwwdg/lwwdg.h" 4 | 5 | extern void example_win32(void); 6 | extern int test_run(void); 7 | 8 | int 9 | main(void) { 10 | #if WORKFLOW_TEST 11 | return test_run(); 12 | #else /* WORKFLOW_TEST */ 13 | example_win32(); 14 | return 0; 15 | #endif /* WORKFLOW_TEST */ 16 | } 17 | -------------------------------------------------------------------------------- /docs/Makefile: -------------------------------------------------------------------------------- 1 | # Minimal makefile for Sphinx documentation 2 | # 3 | 4 | # You can set these variables from the command line, and also 5 | # from the environment for the first two. 6 | SPHINXOPTS ?= 7 | SPHINXBUILD ?= sphinx-build 8 | SOURCEDIR = . 9 | BUILDDIR = _build 10 | 11 | # Put it first so that "make" without argument is like "make help". 12 | help: 13 | @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) 14 | 15 | .PHONY: help Makefile 16 | 17 | # Catch-all target: route all unknown targets to Sphinx using the new 18 | # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). 19 | %: Makefile 20 | @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) 21 | -------------------------------------------------------------------------------- /docs/api-reference/index.rst: -------------------------------------------------------------------------------- 1 | .. _api_reference: 2 | 3 | API reference 4 | ============= 5 | 6 | List of all the modules: 7 | 8 | .. toctree:: 9 | :maxdepth: 2 10 | :glob: 11 | 12 | * 13 | -------------------------------------------------------------------------------- /docs/api-reference/lwwdg.rst: -------------------------------------------------------------------------------- 1 | .. _api_lwwdg: 2 | 3 | LwWDG 4 | ===== 5 | 6 | .. doxygengroup:: LWWDG 7 | -------------------------------------------------------------------------------- /docs/api-reference/lwwdg_opt.rst: -------------------------------------------------------------------------------- 1 | .. _api_lwwdg_opt: 2 | 3 | Configuration 4 | ============= 5 | 6 | This is the default configuration of the middleware. 7 | When any of the settings shall be modified, it shall be done in dedicated application config ``lwwdg_opts.h`` file. 8 | 9 | .. note:: 10 | Check :ref:`getting_started` to create configuration file. 11 | 12 | .. doxygengroup:: LWWDG_OPT 13 | :inner: -------------------------------------------------------------------------------- /docs/authors/index.rst: -------------------------------------------------------------------------------- 1 | .. _authors: 2 | 3 | Authors 4 | ======= 5 | 6 | List of authors and contributors to the library 7 | 8 | .. literalinclude:: ../../AUTHORS -------------------------------------------------------------------------------- /docs/changelog/index.rst: -------------------------------------------------------------------------------- 1 | .. _changelof: 2 | 3 | Changelog 4 | ========= 5 | 6 | .. literalinclude:: ../../CHANGELOG.md 7 | -------------------------------------------------------------------------------- /docs/conf.py: -------------------------------------------------------------------------------- 1 | # Configuration file for the Sphinx documentation builder. 2 | # 3 | # This file only contains a selection of the most common options. For a full 4 | # list see the documentation: 5 | # https://www.sphinx-doc.org/en/master/usage/configuration.html 6 | 7 | # -- Path setup -------------------------------------------------------------- 8 | 9 | # If extensions (or modules to document with autodoc) are in another directory, 10 | # add these directories to sys.path here. If the directory is relative to the 11 | # documentation root, use os.path.abspath to make it absolute, like shown here. 12 | # 13 | # import os 14 | # import sys 15 | # sys.path.insert(0, os.path.abspath('.')) 16 | from sphinx.builders.html import StandaloneHTMLBuilder 17 | import subprocess, os 18 | 19 | # Run doxygen first 20 | # read_the_docs_build = os.environ.get('READTHEDOCS', None) == 'True' 21 | # if read_the_docs_build: 22 | subprocess.call('doxygen doxyfile.doxy', shell=True) 23 | # -- Project information ----------------------------------------------------- 24 | 25 | project = 'LwWDG' 26 | copyright = '2023, Tilen MAJERLE' 27 | author = 'Tilen MAJERLE' 28 | 29 | # Try to get branch at which this is running 30 | # and try to determine which version to display in sphinx 31 | # Version is using git tag if on master/main or "latest-develop" if on develop branch 32 | version = '' 33 | git_branch = '' 34 | 35 | def cmd_exec_print(t): 36 | print("cmd > ", t, "\n", os.popen(t).read().strip(), "\n") 37 | 38 | # Print demo data here 39 | cmd_exec_print('git branch') 40 | cmd_exec_print('git describe') 41 | cmd_exec_print('git describe --tags') 42 | cmd_exec_print('git describe --tags --abbrev=0') 43 | cmd_exec_print('git describe --tags --abbrev=1') 44 | 45 | # Get current branch 46 | res = os.popen('git branch').read().strip() 47 | for line in res.split("\n"): 48 | if line[0] == '*': 49 | git_branch = line[1:].strip() 50 | 51 | # Decision for display version 52 | git_branch = git_branch.replace('(HEAD detached at ', '').replace(')', '') 53 | if git_branch.find('master') >= 0 or git_branch.find('main') >= 0: 54 | #version = os.popen('git describe --tags --abbrev=0').read().strip() 55 | version = 'latest-stable' 56 | elif git_branch.find('develop-') >= 0 or git_branch.find('develop/') >= 0: 57 | version = 'branch-' + git_branch 58 | elif git_branch == 'develop' or git_branch == 'origin/develop': 59 | version = 'latest-develop' 60 | else: 61 | version = os.popen('git describe --tags --abbrev=0').read().strip() 62 | 63 | # For debugging purpose only 64 | print("GIT BRANCH: " + git_branch) 65 | print("PROJ VERSION: " + version) 66 | 67 | # -- General configuration --------------------------------------------------- 68 | 69 | # Add any Sphinx extension module names here, as strings. They can be 70 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom 71 | # ones. 72 | extensions = [ 73 | 'sphinx.ext.autodoc', 74 | 'sphinx.ext.intersphinx', 75 | 'sphinx.ext.autosectionlabel', 76 | 'sphinx.ext.todo', 77 | 'sphinx.ext.coverage', 78 | 'sphinx.ext.mathjax', 79 | 'sphinx.ext.ifconfig', 80 | 'sphinx.ext.viewcode', 81 | 'sphinx_sitemap', 82 | 83 | 'breathe', 84 | ] 85 | 86 | # Add any paths that contain templates here, relative to this directory. 87 | templates_path = ['templates'] 88 | 89 | # List of patterns, relative to source directory, that match files and 90 | # directories to ignore when looking for source files. 91 | # This pattern also affects html_static_path and html_extra_path. 92 | exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] 93 | 94 | highlight_language = 'c' 95 | 96 | # -- Options for HTML output ------------------------------------------------- 97 | 98 | # The theme to use for HTML and HTML Help pages. See the documentation for 99 | # a list of builtin themes. 100 | # 101 | html_theme = 'sphinx_rtd_theme' 102 | html_theme_options = { 103 | 'canonical_url': '', 104 | 'analytics_id': '', # Provided by Google in your dashboard 105 | 'display_version': True, 106 | 'prev_next_buttons_location': 'bottom', 107 | 'style_external_links': False, 108 | 109 | 'logo_only': False, 110 | 111 | # Toc options 112 | 'collapse_navigation': True, 113 | 'sticky_navigation': True, 114 | 'navigation_depth': 4, 115 | 'includehidden': True, 116 | 'titles_only': False 117 | } 118 | html_logo = 'static/images/logo.svg' 119 | github_url = 'https://github.com/MaJerle/lwwdg' 120 | html_baseurl = 'https://docs.majerle.eu/projects/lwwdg/' 121 | 122 | # Add any paths that contain custom static files (such as style sheets) here, 123 | # relative to this directory. They are copied after the builtin static files, 124 | # so a file named "default.css" will overwrite the builtin "default.css". 125 | html_static_path = ['static'] 126 | html_css_files = [ 127 | 'css/common.css', 128 | 'css/custom.css', 129 | 'https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.1/css/all.min.css', 130 | ] 131 | html_js_files = [ 132 | '' 133 | ] 134 | 135 | # Master index file 136 | master_doc = 'index' 137 | 138 | # --- Breathe configuration ----------------------------------------------------- 139 | breathe_projects = { 140 | "lwwdg": "_build/xml/" 141 | } 142 | breathe_default_project = "lwwdg" 143 | breathe_default_members = ('members', 'undoc-members') 144 | breathe_show_enumvalue_initializer = True -------------------------------------------------------------------------------- /docs/doxyfile.doxy: -------------------------------------------------------------------------------- 1 | # Doxyfile 1.8.10 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 = "LwWDG" 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 = "" 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 = "Lightweight watchdog for embedded systems" 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 = "_build" 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 = NO 72 | 73 | # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII 74 | # characters to appear in the names of generated files. If set to NO, non-ASCII 75 | # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode 76 | # U+3044. 77 | # The default value is: NO. 78 | 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 = 242 | 243 | # This tag can be used to specify a number of word-keyword mappings (TCL only). 244 | # A mapping has the form "name=value". For example adding "class=itcl::class" 245 | # will allow you to use the command class in the itcl::class meaning. 246 | 247 | TCL_SUBST = 248 | 249 | # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources 250 | # only. Doxygen will then generate output that is more tailored for C. For 251 | # instance, some of the names that are used will be different. The list of all 252 | # members will be omitted, etc. 253 | # The default value is: NO. 254 | 255 | OPTIMIZE_OUTPUT_FOR_C = YES 256 | 257 | # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or 258 | # Python sources only. Doxygen will then generate output that is more tailored 259 | # for that language. For instance, namespaces will be presented as packages, 260 | # qualified scopes will look different, etc. 261 | # The default value is: NO. 262 | 263 | OPTIMIZE_OUTPUT_JAVA = NO 264 | 265 | # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 266 | # sources. Doxygen will then generate output that is tailored for Fortran. 267 | # The default value is: NO. 268 | 269 | OPTIMIZE_FOR_FORTRAN = NO 270 | 271 | # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 272 | # sources. Doxygen will then generate output that is tailored for VHDL. 273 | # The default value is: NO. 274 | 275 | OPTIMIZE_OUTPUT_VHDL = NO 276 | 277 | # Doxygen selects the parser to use depending on the extension of the files it 278 | # parses. With this tag you can assign which parser to use for a given 279 | # extension. Doxygen has a built-in mapping, but you can override or extend it 280 | # using this tag. The format is ext=language, where ext is a file extension, and 281 | # language is one of the parsers supported by doxygen: IDL, Java, Javascript, 282 | # C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: 283 | # FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: 284 | # Fortran. In the later case the parser tries to guess whether the code is fixed 285 | # or free formatted code, this is the default for Fortran type files), VHDL. For 286 | # instance to make doxygen treat .inc files as Fortran files (default is PHP), 287 | # and .f files as C (default is Fortran), use: inc=Fortran f=C. 288 | # 289 | # Note: For files without extension you can use no_extension as a placeholder. 290 | # 291 | # Note that for custom extensions you also need to set FILE_PATTERNS otherwise 292 | # the files are not read by doxygen. 293 | 294 | EXTENSION_MAPPING = 295 | 296 | # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments 297 | # according to the Markdown format, which allows for more readable 298 | # documentation. See http://daringfireball.net/projects/markdown/ for details. 299 | # The output of markdown processing is further processed by doxygen, so you can 300 | # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in 301 | # case of backward compatibilities issues. 302 | # The default value is: YES. 303 | 304 | MARKDOWN_SUPPORT = YES 305 | 306 | # When enabled doxygen tries to link words that correspond to documented 307 | # classes, or namespaces to their corresponding documentation. Such a link can 308 | # be prevented in individual cases by putting a % sign in front of the word or 309 | # globally by setting AUTOLINK_SUPPORT to NO. 310 | # The default value is: YES. 311 | 312 | AUTOLINK_SUPPORT = YES 313 | 314 | # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 315 | # to include (a tag file for) the STL sources as input, then you should set this 316 | # tag to YES in order to let doxygen match functions declarations and 317 | # definitions whose arguments contain STL classes (e.g. func(std::string); 318 | # versus func(std::string) {}). This also make the inheritance and collaboration 319 | # diagrams that involve STL classes more complete and accurate. 320 | # The default value is: NO. 321 | 322 | BUILTIN_STL_SUPPORT = NO 323 | 324 | # If you use Microsoft's C++/CLI language, you should set this option to YES to 325 | # enable parsing support. 326 | # The default value is: NO. 327 | 328 | CPP_CLI_SUPPORT = NO 329 | 330 | # Set the SIP_SUPPORT tag to YES if your project consists of sip (see: 331 | # http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen 332 | # will parse them like normal C++ but will assume all classes use public instead 333 | # of private inheritance when no explicit protection keyword is present. 334 | # The default value is: NO. 335 | 336 | SIP_SUPPORT = NO 337 | 338 | # For Microsoft's IDL there are propget and propput attributes to indicate 339 | # getter and setter methods for a property. Setting this option to YES will make 340 | # doxygen to replace the get and set methods by a property in the documentation. 341 | # This will only work if the methods are indeed getting or setting a simple 342 | # type. If this is not the case, or you want to show the methods anyway, you 343 | # should set this option to NO. 344 | # The default value is: YES. 345 | 346 | IDL_PROPERTY_SUPPORT = YES 347 | 348 | # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 349 | # tag is set to YES then doxygen will reuse the documentation of the first 350 | # member in the group (if any) for the other members of the group. By default 351 | # all members of a group must be documented explicitly. 352 | # The default value is: NO. 353 | 354 | DISTRIBUTE_GROUP_DOC = NO 355 | 356 | # If one adds a struct or class to a group and this option is enabled, then also 357 | # any nested class or struct is added to the same group. By default this option 358 | # is disabled and one has to add nested compounds explicitly via \ingroup. 359 | # The default value is: NO. 360 | 361 | GROUP_NESTED_COMPOUNDS = NO 362 | 363 | # Set the SUBGROUPING tag to YES to allow class member groups of the same type 364 | # (for instance a group of public functions) to be put as a subgroup of that 365 | # type (e.g. under the Public Functions section). Set it to NO to prevent 366 | # subgrouping. Alternatively, this can be done per class using the 367 | # \nosubgrouping command. 368 | # The default value is: YES. 369 | 370 | SUBGROUPING = YES 371 | 372 | # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions 373 | # are shown inside the group in which they are included (e.g. using \ingroup) 374 | # instead of on a separate page (for HTML and Man pages) or section (for LaTeX 375 | # and RTF). 376 | # 377 | # Note that this feature does not work in combination with 378 | # SEPARATE_MEMBER_PAGES. 379 | # The default value is: NO. 380 | 381 | INLINE_GROUPED_CLASSES = NO 382 | 383 | # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions 384 | # with only public data fields or simple typedef fields will be shown inline in 385 | # the documentation of the scope in which they are defined (i.e. file, 386 | # namespace, or group documentation), provided this scope is documented. If set 387 | # to NO, structs, classes, and unions are shown on a separate page (for HTML and 388 | # Man pages) or section (for LaTeX and RTF). 389 | # The default value is: NO. 390 | 391 | INLINE_SIMPLE_STRUCTS = NO 392 | 393 | # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or 394 | # enum is documented as struct, union, or enum with the name of the typedef. So 395 | # typedef struct TypeS {} TypeT, will appear in the documentation as a struct 396 | # with name TypeT. When disabled the typedef will appear as a member of a file, 397 | # namespace, or class. And the struct will be named TypeS. This can typically be 398 | # useful for C code in case the coding convention dictates that all compound 399 | # types are typedef'ed and only the typedef is referenced, never the tag name. 400 | # The default value is: NO. 401 | 402 | TYPEDEF_HIDES_STRUCT = YES 403 | 404 | # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This 405 | # cache is used to resolve symbols given their name and scope. Since this can be 406 | # an expensive process and often the same symbol appears multiple times in the 407 | # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small 408 | # doxygen will become slower. If the cache is too large, memory is wasted. The 409 | # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range 410 | # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 411 | # symbols. At the end of a run doxygen will report the cache usage and suggest 412 | # the optimal cache size from a speed point of view. 413 | # Minimum value: 0, maximum value: 9, default value: 0. 414 | 415 | LOOKUP_CACHE_SIZE = 0 416 | 417 | #--------------------------------------------------------------------------- 418 | # Build related configuration options 419 | #--------------------------------------------------------------------------- 420 | 421 | # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in 422 | # documentation are documented, even if no documentation was available. Private 423 | # class members and static file members will be hidden unless the 424 | # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. 425 | # Note: This will also disable the warnings about undocumented members that are 426 | # normally produced when WARNINGS is set to YES. 427 | # The default value is: NO. 428 | 429 | EXTRACT_ALL = NO 430 | 431 | # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will 432 | # be included in the documentation. 433 | # The default value is: NO. 434 | 435 | EXTRACT_PRIVATE = NO 436 | 437 | # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal 438 | # scope will be included in the documentation. 439 | # The default value is: NO. 440 | 441 | EXTRACT_PACKAGE = NO 442 | 443 | # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be 444 | # included in the documentation. 445 | # The default value is: NO. 446 | 447 | EXTRACT_STATIC = YES 448 | 449 | # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined 450 | # locally in source files will be included in the documentation. If set to NO, 451 | # only classes defined in header files are included. Does not have any effect 452 | # for Java sources. 453 | # The default value is: YES. 454 | 455 | EXTRACT_LOCAL_CLASSES = YES 456 | 457 | # This flag is only useful for Objective-C code. If set to YES, local methods, 458 | # which are defined in the implementation section but not in the interface are 459 | # included in the documentation. If set to NO, only methods in the interface are 460 | # included. 461 | # The default value is: NO. 462 | 463 | EXTRACT_LOCAL_METHODS = NO 464 | 465 | # If this flag is set to YES, the members of anonymous namespaces will be 466 | # extracted and appear in the documentation as a namespace called 467 | # 'anonymous_namespace{file}', where file will be replaced with the base name of 468 | # the file that contains the anonymous namespace. By default anonymous namespace 469 | # are hidden. 470 | # The default value is: NO. 471 | 472 | EXTRACT_ANON_NSPACES = NO 473 | 474 | # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all 475 | # undocumented members inside documented classes or files. If set to NO these 476 | # members will be included in the various overviews, but no documentation 477 | # section is generated. This option has no effect if EXTRACT_ALL is enabled. 478 | # The default value is: NO. 479 | 480 | HIDE_UNDOC_MEMBERS = NO 481 | 482 | # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all 483 | # undocumented classes that are normally visible in the class hierarchy. If set 484 | # to NO, these classes will be included in the various overviews. This option 485 | # has no effect if EXTRACT_ALL is enabled. 486 | # The default value is: NO. 487 | 488 | HIDE_UNDOC_CLASSES = NO 489 | 490 | # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend 491 | # (class|struct|union) declarations. If set to NO, these declarations will be 492 | # included in the documentation. 493 | # The default value is: NO. 494 | 495 | HIDE_FRIEND_COMPOUNDS = NO 496 | 497 | # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any 498 | # documentation blocks found inside the body of a function. If set to NO, these 499 | # blocks will be appended to the function's detailed documentation block. 500 | # The default value is: NO. 501 | 502 | HIDE_IN_BODY_DOCS = NO 503 | 504 | # The INTERNAL_DOCS tag determines if documentation that is typed after a 505 | # \internal command is included. If the tag is set to NO then the documentation 506 | # will be excluded. Set it to YES to include the internal documentation. 507 | # The default value is: NO. 508 | 509 | INTERNAL_DOCS = NO 510 | 511 | # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file 512 | # names in lower-case letters. If set to YES, upper-case letters are also 513 | # allowed. This is useful if you have classes or files whose names only differ 514 | # in case and if your file system supports case sensitive file names. Windows 515 | # and Mac users are advised to set this option to NO. 516 | # The default value is: system dependent. 517 | 518 | CASE_SENSE_NAMES = NO 519 | 520 | # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with 521 | # their full class and namespace scopes in the documentation. If set to YES, the 522 | # scope will be hidden. 523 | # The default value is: NO. 524 | 525 | HIDE_SCOPE_NAMES = YES 526 | 527 | # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will 528 | # append additional text to a page's title, such as Class Reference. If set to 529 | # YES the compound reference will be hidden. 530 | # The default value is: NO. 531 | 532 | HIDE_COMPOUND_REFERENCE= NO 533 | 534 | # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of 535 | # the files that are included by a file in the documentation of that file. 536 | # The default value is: YES. 537 | 538 | SHOW_INCLUDE_FILES = YES 539 | 540 | # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each 541 | # grouped member an include statement to the documentation, telling the reader 542 | # which file to include in order to use the member. 543 | # The default value is: NO. 544 | 545 | SHOW_GROUPED_MEMB_INC = NO 546 | 547 | # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include 548 | # files with double quotes in the documentation rather than with sharp brackets. 549 | # The default value is: NO. 550 | 551 | FORCE_LOCAL_INCLUDES = NO 552 | 553 | # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the 554 | # documentation for inline members. 555 | # The default value is: YES. 556 | 557 | INLINE_INFO = YES 558 | 559 | # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the 560 | # (detailed) documentation of file and class members alphabetically by member 561 | # name. If set to NO, the members will appear in declaration order. 562 | # The default value is: YES. 563 | 564 | SORT_MEMBER_DOCS = YES 565 | 566 | # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief 567 | # descriptions of file, namespace and class members alphabetically by member 568 | # name. If set to NO, the members will appear in declaration order. Note that 569 | # this will also influence the order of the classes in the class list. 570 | # The default value is: NO. 571 | 572 | SORT_BRIEF_DOCS = NO 573 | 574 | # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the 575 | # (brief and detailed) documentation of class members so that constructors and 576 | # destructors are listed first. If set to NO the constructors will appear in the 577 | # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. 578 | # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief 579 | # member documentation. 580 | # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting 581 | # detailed member documentation. 582 | # The default value is: NO. 583 | 584 | SORT_MEMBERS_CTORS_1ST = NO 585 | 586 | # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy 587 | # of group names into alphabetical order. If set to NO the group names will 588 | # appear in their defined order. 589 | # The default value is: NO. 590 | 591 | SORT_GROUP_NAMES = NO 592 | 593 | # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by 594 | # fully-qualified names, including namespaces. If set to NO, the class list will 595 | # be sorted only by class name, not including the namespace part. 596 | # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 597 | # Note: This option applies only to the class list, not to the alphabetical 598 | # list. 599 | # The default value is: NO. 600 | 601 | SORT_BY_SCOPE_NAME = NO 602 | 603 | # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper 604 | # type resolution of all parameters of a function it will reject a match between 605 | # the prototype and the implementation of a member function even if there is 606 | # only one candidate or it is obvious which candidate to choose by doing a 607 | # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still 608 | # accept a match between prototype and implementation in such cases. 609 | # The default value is: NO. 610 | 611 | STRICT_PROTO_MATCHING = NO 612 | 613 | # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo 614 | # list. This list is created by putting \todo commands in the documentation. 615 | # The default value is: YES. 616 | 617 | GENERATE_TODOLIST = YES 618 | 619 | # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test 620 | # list. This list is created by putting \test commands in the documentation. 621 | # The default value is: YES. 622 | 623 | GENERATE_TESTLIST = YES 624 | 625 | # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug 626 | # list. This list is created by putting \bug commands in the documentation. 627 | # The default value is: YES. 628 | 629 | GENERATE_BUGLIST = YES 630 | 631 | # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) 632 | # the deprecated list. This list is created by putting \deprecated commands in 633 | # the documentation. 634 | # The default value is: YES. 635 | 636 | GENERATE_DEPRECATEDLIST= YES 637 | 638 | # The ENABLED_SECTIONS tag can be used to enable conditional documentation 639 | # sections, marked by \if ... \endif and \cond 640 | # ... \endcond blocks. 641 | 642 | ENABLED_SECTIONS = 643 | 644 | # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the 645 | # initial value of a variable or macro / define can have for it to appear in the 646 | # documentation. If the initializer consists of more lines than specified here 647 | # it will be hidden. Use a value of 0 to hide initializers completely. The 648 | # appearance of the value of individual variables and macros / defines can be 649 | # controlled using \showinitializer or \hideinitializer command in the 650 | # documentation regardless of this setting. 651 | # Minimum value: 0, maximum value: 10000, default value: 30. 652 | 653 | MAX_INITIALIZER_LINES = 30 654 | 655 | # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at 656 | # the bottom of the documentation of classes and structs. If set to YES, the 657 | # list will mention the files that were used to generate the documentation. 658 | # The default value is: YES. 659 | 660 | SHOW_USED_FILES = NO 661 | 662 | # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This 663 | # will remove the Files entry from the Quick Index and from the Folder Tree View 664 | # (if specified). 665 | # The default value is: YES. 666 | 667 | SHOW_FILES = NO 668 | 669 | # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces 670 | # page. This will remove the Namespaces entry from the Quick Index and from the 671 | # Folder Tree View (if specified). 672 | # The default value is: YES. 673 | 674 | SHOW_NAMESPACES = YES 675 | 676 | # The FILE_VERSION_FILTER tag can be used to specify a program or script that 677 | # doxygen should invoke to get the current version for each file (typically from 678 | # the version control system). Doxygen will invoke the program by executing (via 679 | # popen()) the command command input-file, where command is the value of the 680 | # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided 681 | # by doxygen. Whatever the program writes to standard output is used as the file 682 | # version. For an example see the documentation. 683 | 684 | FILE_VERSION_FILTER = 685 | 686 | # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed 687 | # by doxygen. The layout file controls the global structure of the generated 688 | # output files in an output format independent way. To create the layout file 689 | # that represents doxygen's defaults, run doxygen with the -l option. You can 690 | # optionally specify a file name after the option, if omitted DoxygenLayout.xml 691 | # will be used as the name of the layout file. 692 | # 693 | # Note that if you run doxygen from a directory containing a file called 694 | # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE 695 | # tag is left empty. 696 | 697 | LAYOUT_FILE = 698 | 699 | # The CITE_BIB_FILES tag can be used to specify one or more bib files containing 700 | # the reference definitions. This must be a list of .bib files. The .bib 701 | # extension is automatically appended if omitted. This requires the bibtex tool 702 | # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. 703 | # For LaTeX the style of the bibliography can be controlled using 704 | # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the 705 | # search path. See also \cite for info how to create references. 706 | 707 | CITE_BIB_FILES = 708 | 709 | #--------------------------------------------------------------------------- 710 | # Configuration options related to warning and progress messages 711 | #--------------------------------------------------------------------------- 712 | 713 | # The QUIET tag can be used to turn on/off the messages that are generated to 714 | # standard output by doxygen. If QUIET is set to YES this implies that the 715 | # messages are off. 716 | # The default value is: NO. 717 | 718 | QUIET = NO 719 | 720 | # The WARNINGS tag can be used to turn on/off the warning messages that are 721 | # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES 722 | # this implies that the warnings are on. 723 | # 724 | # Tip: Turn warnings on while writing the documentation. 725 | # The default value is: YES. 726 | 727 | WARNINGS = YES 728 | 729 | # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate 730 | # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag 731 | # will automatically be disabled. 732 | # The default value is: YES. 733 | 734 | WARN_IF_UNDOCUMENTED = YES 735 | 736 | # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for 737 | # potential errors in the documentation, such as not documenting some parameters 738 | # in a documented function, or documenting parameters that don't exist or using 739 | # markup commands wrongly. 740 | # The default value is: YES. 741 | 742 | WARN_IF_DOC_ERROR = YES 743 | 744 | # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that 745 | # are documented, but have no documentation for their parameters or return 746 | # value. If set to NO, doxygen will only warn about wrong or incomplete 747 | # parameter documentation, but not about the absence of documentation. 748 | # The default value is: NO. 749 | 750 | WARN_NO_PARAMDOC = YES 751 | 752 | # The WARN_FORMAT tag determines the format of the warning messages that doxygen 753 | # can produce. The string should contain the $file, $line, and $text tags, which 754 | # will be replaced by the file and line number from which the warning originated 755 | # and the warning text. Optionally the format may contain $version, which will 756 | # be replaced by the version of the file (if it could be obtained via 757 | # FILE_VERSION_FILTER) 758 | # The default value is: $file:$line: $text. 759 | 760 | WARN_FORMAT = "$file:$line: $text" 761 | 762 | # The WARN_LOGFILE tag can be used to specify a file to which warning and error 763 | # messages should be written. If left blank the output is written to standard 764 | # error (stderr). 765 | 766 | WARN_LOGFILE = 767 | 768 | #--------------------------------------------------------------------------- 769 | # Configuration options related to the input files 770 | #--------------------------------------------------------------------------- 771 | 772 | # The INPUT tag is used to specify the files and/or directories that contain 773 | # documented source files. You may enter file names like myfile.cpp or 774 | # directories like /usr/src/myproject. Separate the files or directories with 775 | # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING 776 | # Note: If this tag is empty the current directory is searched. 777 | 778 | INPUT = "../lwwdg/" 779 | 780 | # This tag can be used to specify the character encoding of the source files 781 | # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses 782 | # libiconv (or the iconv built into libc) for the transcoding. See the libiconv 783 | # documentation (see: http://www.gnu.org/software/libiconv) for the list of 784 | # possible encodings. 785 | # The default value is: UTF-8. 786 | 787 | INPUT_ENCODING = UTF-8 788 | 789 | # If the value of the INPUT tag contains directories, you can use the 790 | # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and 791 | # *.h) to filter out the source-files in the directories. 792 | # 793 | # Note that for custom extensions or not directly supported extensions you also 794 | # need to set EXTENSION_MAPPING for the extension otherwise the files are not 795 | # read by doxygen. 796 | # 797 | # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, 798 | # *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, 799 | # *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, 800 | # *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, 801 | # *.vhdl, *.ucf, *.qsf, *.as and *.js. 802 | 803 | FILE_PATTERNS = *.c \ 804 | *.cc \ 805 | *.cxx \ 806 | *.cpp \ 807 | *.c++ \ 808 | *.java \ 809 | *.ii \ 810 | *.ixx \ 811 | *.ipp \ 812 | *.i++ \ 813 | *.inl \ 814 | *.idl \ 815 | *.ddl \ 816 | *.odl \ 817 | *.h \ 818 | *.hh \ 819 | *.hxx \ 820 | *.hpp \ 821 | *.h++ \ 822 | *.cs \ 823 | *.d \ 824 | *.php \ 825 | *.php4 \ 826 | *.php5 \ 827 | *.phtml \ 828 | *.inc \ 829 | *.m \ 830 | *.markdown \ 831 | *.md \ 832 | *.mm \ 833 | *.dox \ 834 | *.py \ 835 | *.f90 \ 836 | *.f \ 837 | *.for \ 838 | *.tcl \ 839 | *.vhd \ 840 | *.vhdl \ 841 | *.ucf \ 842 | *.qsf \ 843 | *.as \ 844 | *.js 845 | 846 | # The RECURSIVE tag can be used to specify whether or not subdirectories should 847 | # be searched for input files as well. 848 | # The default value is: NO. 849 | 850 | RECURSIVE = YES 851 | 852 | # The EXCLUDE tag can be used to specify files and/or directories that should be 853 | # excluded from the INPUT source files. This way you can easily exclude a 854 | # subdirectory from a directory tree whose root is specified with the INPUT tag. 855 | # 856 | # Note that relative paths are relative to the directory from which doxygen is 857 | # run. 858 | 859 | EXCLUDE = 860 | 861 | # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or 862 | # directories that are symbolic links (a Unix file system feature) are excluded 863 | # from the input. 864 | # The default value is: NO. 865 | 866 | EXCLUDE_SYMLINKS = NO 867 | 868 | # If the value of the INPUT tag contains directories, you can use the 869 | # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 870 | # certain files from those directories. 871 | # 872 | # Note that the wildcards are matched against the file with absolute path, so to 873 | # exclude all test directories for example use the pattern */test/* 874 | 875 | EXCLUDE_PATTERNS = 876 | 877 | # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 878 | # (namespaces, classes, functions, etc.) that should be excluded from the 879 | # output. The symbol name can be a fully qualified name, a word, or if the 880 | # wildcard * is used, a substring. Examples: ANamespace, AClass, 881 | # AClass::ANamespace, ANamespace::*Test 882 | # 883 | # Note that the wildcards are matched against the file with absolute path, so to 884 | # exclude all test directories use the pattern */test/* 885 | 886 | EXCLUDE_SYMBOLS = 887 | 888 | # The EXAMPLE_PATH tag can be used to specify one or more files or directories 889 | # that contain example code fragments that are included (see the \include 890 | # command). 891 | 892 | EXAMPLE_PATH = 893 | 894 | # If the value of the EXAMPLE_PATH tag contains directories, you can use the 895 | # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and 896 | # *.h) to filter out the source-files in the directories. If left blank all 897 | # files are included. 898 | 899 | EXAMPLE_PATTERNS = * 900 | 901 | # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 902 | # searched for input files to be used with the \include or \dontinclude commands 903 | # irrespective of the value of the RECURSIVE tag. 904 | # The default value is: NO. 905 | 906 | EXAMPLE_RECURSIVE = NO 907 | 908 | # The IMAGE_PATH tag can be used to specify one or more files or directories 909 | # that contain images that are to be included in the documentation (see the 910 | # \image command). 911 | 912 | IMAGE_PATH = 913 | 914 | # The INPUT_FILTER tag can be used to specify a program that doxygen should 915 | # invoke to filter for each input file. Doxygen will invoke the filter program 916 | # by executing (via popen()) the command: 917 | # 918 | # 919 | # 920 | # where is the value of the INPUT_FILTER tag, and is the 921 | # name of an input file. Doxygen will then use the output that the filter 922 | # program writes to standard output. If FILTER_PATTERNS is specified, this tag 923 | # will be ignored. 924 | # 925 | # Note that the filter must not add or remove lines; it is applied before the 926 | # code is scanned, but not when the output code is generated. If lines are added 927 | # or removed, the anchors will not be placed correctly. 928 | 929 | INPUT_FILTER = 930 | 931 | # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 932 | # basis. Doxygen will compare the file name with each pattern and apply the 933 | # filter if there is a match. The filters are a list of the form: pattern=filter 934 | # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how 935 | # filters are used. If the FILTER_PATTERNS tag is empty or if none of the 936 | # patterns match the file name, INPUT_FILTER is applied. 937 | 938 | FILTER_PATTERNS = 939 | 940 | # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 941 | # INPUT_FILTER) will also be used to filter the input files that are used for 942 | # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). 943 | # The default value is: NO. 944 | 945 | FILTER_SOURCE_FILES = NO 946 | 947 | # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file 948 | # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and 949 | # it is also possible to disable source filtering for a specific pattern using 950 | # *.ext= (so without naming a filter). 951 | # This tag requires that the tag FILTER_SOURCE_FILES is set to YES. 952 | 953 | FILTER_SOURCE_PATTERNS = 954 | 955 | # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that 956 | # is part of the input, its contents will be placed on the main page 957 | # (index.html). This can be useful if you have a project on for instance GitHub 958 | # and want to reuse the introduction page also for the doxygen output. 959 | 960 | USE_MDFILE_AS_MAINPAGE = 961 | 962 | #--------------------------------------------------------------------------- 963 | # Configuration options related to source browsing 964 | #--------------------------------------------------------------------------- 965 | 966 | # If the SOURCE_BROWSER tag is set to YES then a list of source files will be 967 | # generated. Documented entities will be cross-referenced with these sources. 968 | # 969 | # Note: To get rid of all source code in the generated output, make sure that 970 | # also VERBATIM_HEADERS is set to NO. 971 | # The default value is: NO. 972 | 973 | SOURCE_BROWSER = NO 974 | 975 | # Setting the INLINE_SOURCES tag to YES will include the body of functions, 976 | # classes and enums directly into the documentation. 977 | # The default value is: NO. 978 | 979 | INLINE_SOURCES = NO 980 | 981 | # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any 982 | # special comment blocks from generated source code fragments. Normal C, C++ and 983 | # Fortran comments will always remain visible. 984 | # The default value is: YES. 985 | 986 | STRIP_CODE_COMMENTS = YES 987 | 988 | # If the REFERENCED_BY_RELATION tag is set to YES then for each documented 989 | # function all documented functions referencing it will be listed. 990 | # The default value is: NO. 991 | 992 | REFERENCED_BY_RELATION = NO 993 | 994 | # If the REFERENCES_RELATION tag is set to YES then for each documented function 995 | # all documented entities called/used by that function will be listed. 996 | # The default value is: NO. 997 | 998 | REFERENCES_RELATION = NO 999 | 1000 | # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set 1001 | # to YES then the hyperlinks from functions in REFERENCES_RELATION and 1002 | # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will 1003 | # link to the documentation. 1004 | # The default value is: YES. 1005 | 1006 | REFERENCES_LINK_SOURCE = YES 1007 | 1008 | # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the 1009 | # source code will show a tooltip with additional information such as prototype, 1010 | # brief description and links to the definition and documentation. Since this 1011 | # will make the HTML file larger and loading of large files a bit slower, you 1012 | # can opt to disable this feature. 1013 | # The default value is: YES. 1014 | # This tag requires that the tag SOURCE_BROWSER is set to YES. 1015 | 1016 | SOURCE_TOOLTIPS = YES 1017 | 1018 | # If the USE_HTAGS tag is set to YES then the references to source code will 1019 | # point to the HTML generated by the htags(1) tool instead of doxygen built-in 1020 | # source browser. The htags tool is part of GNU's global source tagging system 1021 | # (see http://www.gnu.org/software/global/global.html). You will need version 1022 | # 4.8.6 or higher. 1023 | # 1024 | # To use it do the following: 1025 | # - Install the latest version of global 1026 | # - Enable SOURCE_BROWSER and USE_HTAGS in the config file 1027 | # - Make sure the INPUT points to the root of the source tree 1028 | # - Run doxygen as normal 1029 | # 1030 | # Doxygen will invoke htags (and that will in turn invoke gtags), so these 1031 | # tools must be available from the command line (i.e. in the search path). 1032 | # 1033 | # The result: instead of the source browser generated by doxygen, the links to 1034 | # source code will now point to the output of htags. 1035 | # The default value is: NO. 1036 | # This tag requires that the tag SOURCE_BROWSER is set to YES. 1037 | 1038 | USE_HTAGS = NO 1039 | 1040 | # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a 1041 | # verbatim copy of the header file for each class for which an include is 1042 | # specified. Set to NO to disable this. 1043 | # See also: Section \class. 1044 | # The default value is: YES. 1045 | 1046 | VERBATIM_HEADERS = YES 1047 | 1048 | # If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the 1049 | # clang parser (see: http://clang.llvm.org/) for more accurate parsing at the 1050 | # cost of reduced performance. This can be particularly helpful with template 1051 | # rich C++ code for which doxygen's built-in parser lacks the necessary type 1052 | # information. 1053 | # Note: The availability of this option depends on whether or not doxygen was 1054 | # compiled with the --with-libclang option. 1055 | # The default value is: NO. 1056 | 1057 | CLANG_ASSISTED_PARSING = NO 1058 | 1059 | # If clang assisted parsing is enabled you can provide the compiler with command 1060 | # line options that you would normally use when invoking the compiler. Note that 1061 | # the include paths will already be set by doxygen for the files and directories 1062 | # specified with INPUT and INCLUDE_PATH. 1063 | # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. 1064 | 1065 | CLANG_OPTIONS = 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 | # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in 1079 | # which the alphabetical index list will be split. 1080 | # Minimum value: 1, maximum value: 20, default value: 5. 1081 | # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 1082 | 1083 | COLS_IN_ALPHA_INDEX = 5 1084 | 1085 | # In case all classes in a project start with a common prefix, all classes will 1086 | # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag 1087 | # can be used to specify a prefix (or a list of prefixes) that should be ignored 1088 | # while generating the index headers. 1089 | # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 1090 | 1091 | IGNORE_PREFIX = 1092 | 1093 | #--------------------------------------------------------------------------- 1094 | # Configuration options related to the HTML output 1095 | #--------------------------------------------------------------------------- 1096 | 1097 | # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output 1098 | # The default value is: YES. 1099 | 1100 | GENERATE_HTML = YES 1101 | 1102 | # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a 1103 | # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 1104 | # it. 1105 | # The default directory is: html. 1106 | # This tag requires that the tag GENERATE_HTML is set to YES. 1107 | 1108 | HTML_OUTPUT = html 1109 | 1110 | # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each 1111 | # generated HTML page (for example: .htm, .php, .asp). 1112 | # The default value is: .html. 1113 | # This tag requires that the tag GENERATE_HTML is set to YES. 1114 | 1115 | HTML_FILE_EXTENSION = .html 1116 | 1117 | # The HTML_HEADER tag can be used to specify a user-defined HTML header file for 1118 | # each generated HTML page. If the tag is left blank doxygen will generate a 1119 | # standard header. 1120 | # 1121 | # To get valid HTML the header file that includes any scripts and style sheets 1122 | # that doxygen needs, which is dependent on the configuration options used (e.g. 1123 | # the setting GENERATE_TREEVIEW). It is highly recommended to start with a 1124 | # default header using 1125 | # doxygen -w html new_header.html new_footer.html new_stylesheet.css 1126 | # YourConfigFile 1127 | # and then modify the file new_header.html. See also section "Doxygen usage" 1128 | # for information on how to generate the default header that doxygen normally 1129 | # uses. 1130 | # Note: The header is subject to change so you typically have to regenerate the 1131 | # default header when upgrading to a newer version of doxygen. For a description 1132 | # of the possible markers and block names see the documentation. 1133 | # This tag requires that the tag GENERATE_HTML is set to YES. 1134 | 1135 | HTML_HEADER = "" 1136 | 1137 | # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each 1138 | # generated HTML page. If the tag is left blank doxygen will generate a standard 1139 | # footer. See HTML_HEADER for more information on how to generate a default 1140 | # footer and what special commands can be used inside the footer. See also 1141 | # section "Doxygen usage" for information on how to generate the default footer 1142 | # that doxygen normally uses. 1143 | # This tag requires that the tag GENERATE_HTML is set to YES. 1144 | 1145 | HTML_FOOTER = "" 1146 | 1147 | # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style 1148 | # sheet that is used by each HTML page. It can be used to fine-tune the look of 1149 | # the HTML output. If left blank doxygen will generate a default style sheet. 1150 | # See also section "Doxygen usage" for information on how to generate the style 1151 | # sheet that doxygen normally uses. 1152 | # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as 1153 | # it is more robust and this tag (HTML_STYLESHEET) will in the future become 1154 | # obsolete. 1155 | # This tag requires that the tag GENERATE_HTML is set to YES. 1156 | 1157 | HTML_STYLESHEET = 1158 | 1159 | # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined 1160 | # cascading style sheets that are included after the standard style sheets 1161 | # created by doxygen. Using this option one can overrule certain style aspects. 1162 | # This is preferred over using HTML_STYLESHEET since it does not replace the 1163 | # standard style sheet and is therefore more robust against future updates. 1164 | # Doxygen will copy the style sheet files to the output directory. 1165 | # Note: The order of the extra style sheet files is of importance (e.g. the last 1166 | # style sheet in the list overrules the setting of the previous ones in the 1167 | # list). For an example see the documentation. 1168 | # This tag requires that the tag GENERATE_HTML is set to YES. 1169 | 1170 | HTML_EXTRA_STYLESHEET = 1171 | 1172 | # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or 1173 | # other source files which should be copied to the HTML output directory. Note 1174 | # that these files will be copied to the base HTML output directory. Use the 1175 | # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these 1176 | # files. In the HTML_STYLESHEET file, use the file name only. Also note that the 1177 | # files will be copied as-is; there are no commands or markers available. 1178 | # This tag requires that the tag GENERATE_HTML is set to YES. 1179 | 1180 | HTML_EXTRA_FILES = 1181 | 1182 | # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen 1183 | # will adjust the colors in the style sheet and background images according to 1184 | # this color. Hue is specified as an angle on a colorwheel, see 1185 | # http://en.wikipedia.org/wiki/Hue for more information. For instance the value 1186 | # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 1187 | # purple, and 360 is red again. 1188 | # Minimum value: 0, maximum value: 359, default value: 220. 1189 | # This tag requires that the tag GENERATE_HTML is set to YES. 1190 | 1191 | HTML_COLORSTYLE_HUE = 220 1192 | 1193 | # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors 1194 | # in the HTML output. For a value of 0 the output will use grayscales only. A 1195 | # value of 255 will produce the most vivid colors. 1196 | # Minimum value: 0, maximum value: 255, default value: 100. 1197 | # This tag requires that the tag GENERATE_HTML is set to YES. 1198 | 1199 | HTML_COLORSTYLE_SAT = 100 1200 | 1201 | # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the 1202 | # luminance component of the colors in the HTML output. Values below 100 1203 | # gradually make the output lighter, whereas values above 100 make the output 1204 | # darker. The value divided by 100 is the actual gamma applied, so 80 represents 1205 | # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not 1206 | # change the gamma. 1207 | # Minimum value: 40, maximum value: 240, default value: 80. 1208 | # This tag requires that the tag GENERATE_HTML is set to YES. 1209 | 1210 | HTML_COLORSTYLE_GAMMA = 80 1211 | 1212 | # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML 1213 | # page will contain the date and time when the page was generated. Setting this 1214 | # to YES can help to show when doxygen was last run and thus if the 1215 | # documentation is up to date. 1216 | # The default value is: NO. 1217 | # This tag requires that the tag GENERATE_HTML is set to YES. 1218 | 1219 | HTML_TIMESTAMP = YES 1220 | 1221 | # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 1222 | # documentation will contain sections that can be hidden and shown after the 1223 | # page has loaded. 1224 | # The default value is: NO. 1225 | # This tag requires that the tag GENERATE_HTML is set to YES. 1226 | 1227 | HTML_DYNAMIC_SECTIONS = NO 1228 | 1229 | # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries 1230 | # shown in the various tree structured indices initially; the user can expand 1231 | # and collapse entries dynamically later on. Doxygen will expand the tree to 1232 | # such a level that at most the specified number of entries are visible (unless 1233 | # a fully collapsed tree already exceeds this amount). So setting the number of 1234 | # entries 1 will produce a full collapsed tree by default. 0 is a special value 1235 | # representing an infinite number of entries and will result in a full expanded 1236 | # tree by default. 1237 | # Minimum value: 0, maximum value: 9999, default value: 100. 1238 | # This tag requires that the tag GENERATE_HTML is set to YES. 1239 | 1240 | HTML_INDEX_NUM_ENTRIES = 100 1241 | 1242 | # If the GENERATE_DOCSET tag is set to YES, additional index files will be 1243 | # generated that can be used as input for Apple's Xcode 3 integrated development 1244 | # environment (see: http://developer.apple.com/tools/xcode/), introduced with 1245 | # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a 1246 | # Makefile in the HTML output directory. Running make will produce the docset in 1247 | # that directory and running make install will install the docset in 1248 | # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at 1249 | # startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html 1250 | # for more information. 1251 | # The default value is: NO. 1252 | # This tag requires that the tag GENERATE_HTML is set to YES. 1253 | 1254 | GENERATE_DOCSET = NO 1255 | 1256 | # This tag determines the name of the docset feed. A documentation feed provides 1257 | # an umbrella under which multiple documentation sets from a single provider 1258 | # (such as a company or product suite) can be grouped. 1259 | # The default value is: Doxygen generated docs. 1260 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1261 | 1262 | DOCSET_FEEDNAME = "Doxygen generated docs" 1263 | 1264 | # This tag specifies a string that should uniquely identify the documentation 1265 | # set bundle. This should be a reverse domain-name style string, e.g. 1266 | # com.mycompany.MyDocSet. Doxygen will append .docset to the name. 1267 | # The default value is: org.doxygen.Project. 1268 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1269 | 1270 | DOCSET_BUNDLE_ID = org.doxygen.Project 1271 | 1272 | # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify 1273 | # the documentation publisher. This should be a reverse domain-name style 1274 | # string, e.g. com.mycompany.MyDocSet.documentation. 1275 | # The default value is: org.doxygen.Publisher. 1276 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1277 | 1278 | DOCSET_PUBLISHER_ID = org.doxygen.Publisher 1279 | 1280 | # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. 1281 | # The default value is: Publisher. 1282 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1283 | 1284 | DOCSET_PUBLISHER_NAME = Publisher 1285 | 1286 | # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three 1287 | # additional HTML index files: index.hhp, index.hhc, and index.hhk. The 1288 | # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop 1289 | # (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on 1290 | # Windows. 1291 | # 1292 | # The HTML Help Workshop contains a compiler that can convert all HTML output 1293 | # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML 1294 | # files are now used as the Windows 98 help format, and will replace the old 1295 | # Windows help format (.hlp) on all Windows platforms in the future. Compressed 1296 | # HTML files also contain an index, a table of contents, and you can search for 1297 | # words in the documentation. The HTML workshop also contains a viewer for 1298 | # compressed HTML files. 1299 | # The default value is: NO. 1300 | # This tag requires that the tag GENERATE_HTML is set to YES. 1301 | 1302 | GENERATE_HTMLHELP = NO 1303 | 1304 | # The CHM_FILE tag can be used to specify the file name of the resulting .chm 1305 | # file. You can add a path in front of the file if the result should not be 1306 | # written to the html output directory. 1307 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1308 | 1309 | CHM_FILE = 1310 | 1311 | # The HHC_LOCATION tag can be used to specify the location (absolute path 1312 | # including file name) of the HTML help compiler (hhc.exe). If non-empty, 1313 | # doxygen will try to run the HTML help compiler on the generated index.hhp. 1314 | # The file has to be specified with full path. 1315 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1316 | 1317 | HHC_LOCATION = 1318 | 1319 | # The GENERATE_CHI flag controls if a separate .chi index file is generated 1320 | # (YES) or that it should be included in the master .chm file (NO). 1321 | # The default value is: NO. 1322 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1323 | 1324 | GENERATE_CHI = NO 1325 | 1326 | # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) 1327 | # and project file content. 1328 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1329 | 1330 | CHM_INDEX_ENCODING = 1331 | 1332 | # The BINARY_TOC flag controls whether a binary table of contents is generated 1333 | # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it 1334 | # enables the Previous and Next buttons. 1335 | # The default value is: NO. 1336 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1337 | 1338 | BINARY_TOC = NO 1339 | 1340 | # The TOC_EXPAND flag can be set to YES to add extra items for group members to 1341 | # the table of contents of the HTML help documentation and to the tree view. 1342 | # The default value is: NO. 1343 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1344 | 1345 | TOC_EXPAND = NO 1346 | 1347 | # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and 1348 | # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that 1349 | # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help 1350 | # (.qch) of the generated HTML documentation. 1351 | # The default value is: NO. 1352 | # This tag requires that the tag GENERATE_HTML is set to YES. 1353 | 1354 | GENERATE_QHP = NO 1355 | 1356 | # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify 1357 | # the file name of the resulting .qch file. The path specified is relative to 1358 | # the HTML output folder. 1359 | # This tag requires that the tag GENERATE_QHP is set to YES. 1360 | 1361 | QCH_FILE = 1362 | 1363 | # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help 1364 | # Project output. For more information please see Qt Help Project / Namespace 1365 | # (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). 1366 | # The default value is: org.doxygen.Project. 1367 | # This tag requires that the tag GENERATE_QHP is set to YES. 1368 | 1369 | QHP_NAMESPACE = org.doxygen.Project 1370 | 1371 | # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt 1372 | # Help Project output. For more information please see Qt Help Project / Virtual 1373 | # Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- 1374 | # folders). 1375 | # The default value is: doc. 1376 | # This tag requires that the tag GENERATE_QHP is set to YES. 1377 | 1378 | QHP_VIRTUAL_FOLDER = doc 1379 | 1380 | # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom 1381 | # filter to add. For more information please see Qt Help Project / Custom 1382 | # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- 1383 | # filters). 1384 | # This tag requires that the tag GENERATE_QHP is set to YES. 1385 | 1386 | QHP_CUST_FILTER_NAME = 1387 | 1388 | # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the 1389 | # custom filter to add. For more information please see Qt Help Project / Custom 1390 | # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- 1391 | # filters). 1392 | # This tag requires that the tag GENERATE_QHP is set to YES. 1393 | 1394 | QHP_CUST_FILTER_ATTRS = 1395 | 1396 | # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this 1397 | # project's filter section matches. Qt Help Project / Filter Attributes (see: 1398 | # http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). 1399 | # This tag requires that the tag GENERATE_QHP is set to YES. 1400 | 1401 | QHP_SECT_FILTER_ATTRS = 1402 | 1403 | # The QHG_LOCATION tag can be used to specify the location of Qt's 1404 | # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the 1405 | # generated .qhp file. 1406 | # This tag requires that the tag GENERATE_QHP is set to YES. 1407 | 1408 | QHG_LOCATION = 1409 | 1410 | # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be 1411 | # generated, together with the HTML files, they form an Eclipse help plugin. To 1412 | # install this plugin and make it available under the help contents menu in 1413 | # Eclipse, the contents of the directory containing the HTML and XML files needs 1414 | # to be copied into the plugins directory of eclipse. The name of the directory 1415 | # within the plugins directory should be the same as the ECLIPSE_DOC_ID value. 1416 | # After copying Eclipse needs to be restarted before the help appears. 1417 | # The default value is: NO. 1418 | # This tag requires that the tag GENERATE_HTML is set to YES. 1419 | 1420 | GENERATE_ECLIPSEHELP = NO 1421 | 1422 | # A unique identifier for the Eclipse help plugin. When installing the plugin 1423 | # the directory name containing the HTML and XML files should also have this 1424 | # name. Each documentation set should have its own identifier. 1425 | # The default value is: org.doxygen.Project. 1426 | # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. 1427 | 1428 | ECLIPSE_DOC_ID = org.doxygen.Project 1429 | 1430 | # If you want full control over the layout of the generated HTML pages it might 1431 | # be necessary to disable the index and replace it with your own. The 1432 | # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top 1433 | # of each HTML page. A value of NO enables the index and the value YES disables 1434 | # it. Since the tabs in the index contain the same information as the navigation 1435 | # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. 1436 | # The default value is: NO. 1437 | # This tag requires that the tag GENERATE_HTML is set to YES. 1438 | 1439 | DISABLE_INDEX = NO 1440 | 1441 | # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 1442 | # structure should be generated to display hierarchical information. If the tag 1443 | # value is set to YES, a side panel will be generated containing a tree-like 1444 | # index structure (just like the one that is generated for HTML Help). For this 1445 | # to work a browser that supports JavaScript, DHTML, CSS and frames is required 1446 | # (i.e. any modern browser). Windows users are probably better off using the 1447 | # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can 1448 | # further fine-tune the look of the index. As an example, the default style 1449 | # sheet generated by doxygen has an example that shows how to put an image at 1450 | # the root of the tree instead of the PROJECT_NAME. Since the tree basically has 1451 | # the same information as the tab index, you could consider setting 1452 | # DISABLE_INDEX to YES when enabling this option. 1453 | # The default value is: NO. 1454 | # This tag requires that the tag GENERATE_HTML is set to YES. 1455 | 1456 | GENERATE_TREEVIEW = YES 1457 | 1458 | # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that 1459 | # doxygen will group on one line in the generated HTML documentation. 1460 | # 1461 | # Note that a value of 0 will completely suppress the enum values from appearing 1462 | # in the overview section. 1463 | # Minimum value: 0, maximum value: 20, default value: 4. 1464 | # This tag requires that the tag GENERATE_HTML is set to YES. 1465 | 1466 | ENUM_VALUES_PER_LINE = 4 1467 | 1468 | # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used 1469 | # to set the initial width (in pixels) of the frame in which the tree is shown. 1470 | # Minimum value: 0, maximum value: 1500, default value: 250. 1471 | # This tag requires that the tag GENERATE_HTML is set to YES. 1472 | 1473 | TREEVIEW_WIDTH = 250 1474 | 1475 | # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to 1476 | # external symbols imported via tag files in a separate window. 1477 | # The default value is: NO. 1478 | # This tag requires that the tag GENERATE_HTML is set to YES. 1479 | 1480 | EXT_LINKS_IN_WINDOW = NO 1481 | 1482 | # Use this tag to change the font size of LaTeX formulas included as images in 1483 | # the HTML documentation. When you change the font size after a successful 1484 | # doxygen run you need to manually remove any form_*.png images from the HTML 1485 | # output directory to force them to be regenerated. 1486 | # Minimum value: 8, maximum value: 50, default value: 10. 1487 | # This tag requires that the tag GENERATE_HTML is set to YES. 1488 | 1489 | FORMULA_FONTSIZE = 10 1490 | 1491 | # Use the FORMULA_TRANPARENT tag to determine whether or not the images 1492 | # generated for formulas are transparent PNGs. Transparent PNGs are not 1493 | # supported properly for IE 6.0, but are supported on all modern browsers. 1494 | # 1495 | # Note that when changing this option you need to delete any form_*.png files in 1496 | # the HTML output directory before the changes have effect. 1497 | # The default value is: YES. 1498 | # This tag requires that the tag GENERATE_HTML is set to YES. 1499 | 1500 | FORMULA_TRANSPARENT = YES 1501 | 1502 | # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see 1503 | # http://www.mathjax.org) which uses client side Javascript for the rendering 1504 | # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX 1505 | # installed or if you want to formulas look prettier in the HTML output. When 1506 | # enabled you may also need to install MathJax separately and configure the path 1507 | # to it using the MATHJAX_RELPATH option. 1508 | # The default value is: NO. 1509 | # This tag requires that the tag GENERATE_HTML is set to YES. 1510 | 1511 | USE_MATHJAX = YES 1512 | 1513 | # When MathJax is enabled you can set the default output format to be used for 1514 | # the MathJax output. See the MathJax site (see: 1515 | # http://docs.mathjax.org/en/latest/output.html) for more details. 1516 | # Possible values are: HTML-CSS (which is slower, but has the best 1517 | # compatibility), NativeMML (i.e. MathML) and SVG. 1518 | # The default value is: HTML-CSS. 1519 | # This tag requires that the tag USE_MATHJAX is set to YES. 1520 | 1521 | MATHJAX_FORMAT = HTML-CSS 1522 | 1523 | # When MathJax is enabled you need to specify the location relative to the HTML 1524 | # output directory using the MATHJAX_RELPATH option. The destination directory 1525 | # should contain the MathJax.js script. For instance, if the mathjax directory 1526 | # is located at the same level as the HTML output directory, then 1527 | # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax 1528 | # Content Delivery Network so you can quickly see the result without installing 1529 | # MathJax. However, it is strongly recommended to install a local copy of 1530 | # MathJax from http://www.mathjax.org before deployment. 1531 | # The default value is: http://cdn.mathjax.org/mathjax/latest. 1532 | # This tag requires that the tag USE_MATHJAX is set to YES. 1533 | 1534 | MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest 1535 | 1536 | # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax 1537 | # extension names that should be enabled during MathJax rendering. For example 1538 | # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols 1539 | # This tag requires that the tag USE_MATHJAX is set to YES. 1540 | 1541 | MATHJAX_EXTENSIONS = 1542 | 1543 | # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces 1544 | # of code that will be used on startup of the MathJax code. See the MathJax site 1545 | # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an 1546 | # example see the documentation. 1547 | # This tag requires that the tag USE_MATHJAX is set to YES. 1548 | 1549 | MATHJAX_CODEFILE = 1550 | 1551 | # When the SEARCHENGINE tag is enabled doxygen will generate a search box for 1552 | # the HTML output. The underlying search engine uses javascript and DHTML and 1553 | # should work on any modern browser. Note that when using HTML help 1554 | # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) 1555 | # there is already a search function so this one should typically be disabled. 1556 | # For large projects the javascript based search engine can be slow, then 1557 | # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to 1558 | # search using the keyboard; to jump to the search box use + S 1559 | # (what the is depends on the OS and browser, but it is typically 1560 | # , /