├── .gitmodules ├── .editorconfig ├── .gitignore ├── .travis.yml ├── .gitbugtraq ├── include └── HTML │ ├── HTML.h │ ├── Document.h │ └── Element.h ├── appveyor.yml ├── LICENSE.txt ├── src └── Main.cpp ├── README.md ├── CMakeLists.txt └── Doxyfile /.gitmodules: -------------------------------------------------------------------------------- 1 | [submodule "cpplint"] 2 | path = cpplint 3 | url = https://github.com/SRombauts/cpplint.git 4 | -------------------------------------------------------------------------------- /.editorconfig: -------------------------------------------------------------------------------- 1 | root = true 2 | 3 | [*] 4 | charset = utf-8 5 | indent_style = space 6 | indent_size = 4 7 | insert_final_newline = true 8 | end_of_line = lf 9 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | Debug 2 | Release 3 | build 4 | 5 | CppSkeleton 6 | TestSkeleton 7 | 8 | CMakeFiles 9 | CMakeCache.txt 10 | *.cmake 11 | *.dir 12 | Testing/ 13 | 14 | Makefile 15 | *.sln 16 | *.ncb 17 | *.suo 18 | *.user 19 | *.vc* 20 | *sdf 21 | *ipch 22 | *~ 23 | doc 24 | core 25 | .settings/ 26 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | # Copyright (c) 2012-2021 Sebastien Rombauts (sebastien.rombauts@gmail.com) 2 | 3 | # Request Ubuntu 16.04 LTS 4 | dist: xenial 5 | 6 | language: cpp 7 | 8 | compiler: 9 | - gcc 10 | - clang 11 | 12 | before_script: 13 | - mkdir build 14 | - cd build 15 | - cmake .. 16 | 17 | script: make && ctest --output-on-failure 18 | -------------------------------------------------------------------------------- /.gitbugtraq: -------------------------------------------------------------------------------- 1 | # .gitbugtraq for Git GUIs (SmartGit/TortoiseGit) to show links to the Github issue tracker. 2 | # Instead of the repository root directory, it could be added as an additional section to $GIT_DIR/config. 3 | # (note that '\' need to be escaped). 4 | [bugtraq] 5 | url = https://github.com/SRombauts/HtmlBuilder/issues/%BUGID% 6 | loglinkregex = "#\\d+" 7 | logregex = \\d+ 8 | -------------------------------------------------------------------------------- /include/HTML/HTML.h: -------------------------------------------------------------------------------- 1 | /** 2 | * @file HTML.h 3 | * @ingroup HtmlBuilder 4 | * @brief A simple C++ HTML Generator library. 5 | * 6 | * Copyright (c) 2017-2021 Sebastien Rombauts (sebastien.rombauts@gmail.com) 7 | * 8 | * Distributed under the MIT License (MIT) (See accompanying file LICENSE.txt 9 | * or copy at http://opensource.org/licenses/MIT) 10 | */ 11 | #pragma once 12 | 13 | /** 14 | * @defgroup HtmlBuilder HtmlBuilder 15 | * @brief A simple C++ header-only HTML Generator library, using a Document Object Model (DOM). 16 | */ 17 | 18 | #include "Element.h" 19 | #include "Document.h" 20 | -------------------------------------------------------------------------------- /appveyor.yml: -------------------------------------------------------------------------------- 1 | # Copyright (c) 2012-2021 Sebastien Rombauts (sebastien.rombauts@gmail.com) 2 | 3 | # build format 4 | version: "{build}" 5 | 6 | # scripts that run after cloning repository 7 | install: 8 | - git submodule update --init --recursive 9 | 10 | image: 11 | - Visual Studio 2017 12 | - Visual Studio 2015 13 | 14 | configuration: 15 | - Debug 16 | - Release 17 | 18 | environment: 19 | matrix: 20 | - arch: Win32 21 | - arch: Win64 22 | 23 | init: 24 | - echo %APPVEYOR_BUILD_WORKER_IMAGE% - %configuration% - %arch% 25 | - if "%APPVEYOR_BUILD_WORKER_IMAGE%"=="Visual Studio 2017" (set vs=Visual Studio 15 2017) 26 | - if "%APPVEYOR_BUILD_WORKER_IMAGE%"=="Visual Studio 2015" (set vs=Visual Studio 14 2015) 27 | - if "%arch%"=="Win64" (set generator="%vs% Win64") 28 | - if "%arch%"=="Win32" (set generator="%vs%") 29 | - echo %generator% 30 | 31 | # scripts to run before build 32 | before_build: 33 | - mkdir build 34 | - cd build 35 | - cmake .. -G %generator% 36 | 37 | # build examples, and run tests (ie make & make test) 38 | build_script: 39 | - cmake --build . --config %configuration% 40 | - ctest --output-on-failure 41 | -------------------------------------------------------------------------------- /LICENSE.txt: -------------------------------------------------------------------------------- 1 | The MIT License (MIT) 2 | 3 | Copyright (c) 2017-2021 Sebastien Rombauts (sebastien.rombauts@gmail.com) 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 furnished 10 | 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 LIABILITY, 19 | WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR 20 | IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 21 | -------------------------------------------------------------------------------- /include/HTML/Document.h: -------------------------------------------------------------------------------- 1 | /** 2 | * @file Document.h 3 | * @ingroup HtmlBuilder 4 | * @brief Root Element of the HTML Document Object Model. 5 | * 6 | * Copyright (c) 2017-2021 Sebastien Rombauts (sebastien.rombauts@gmail.com) 7 | * 8 | * Distributed under the MIT License (MIT) (See accompanying file LICENSE.txt 9 | * or copy at http://opensource.org/licenses/MIT) 10 | */ 11 | #pragma once 12 | 13 | #include "Element.h" 14 | 15 | #include 16 | #include 17 | #include 18 | 19 | /// A simple C++ HTML Generator library. 20 | namespace HTML { 21 | 22 | // Note: to configure indentation & minification, define this at compile time before including HTML headers. 23 | #ifndef HTML_INDENTATION 24 | #define HTML_INDENTATION 2 25 | #endif 26 | #ifndef HTML_ENDLINE 27 | #define HTML_ENDLINE "\n" 28 | #endif 29 | 30 | /** 31 | * @brief Root Element \ of the HTML Document Object Model. 32 | * 33 | * The Document is a specialized Element with restriction on what can be done on it, 34 | * since many aspects of the \ root tag are well defined and constrained. 35 | */ 36 | class Document : public Element { 37 | public: 38 | Document() : 39 | Element(), mHead(*static_cast(&mChildren[0])), mBody(*static_cast(&mChildren[1])) { 40 | } 41 | explicit Document(const char* apTitle) : 42 | Element(), mHead(*static_cast(&mChildren[0])), mBody(*static_cast(&mChildren[1])) { 43 | mHead << HTML::Title(apTitle); 44 | } 45 | explicit Document(const std::string& aTitle) : 46 | Element(), mHead(*static_cast(&mChildren[0])), mBody(*static_cast(&mChildren[1])) { 47 | mHead << HTML::Title(aTitle); 48 | } 49 | Document(const char* apTitle, Style&& aStyle) : 50 | Element(), mHead(*static_cast(&mChildren[0])), mBody(*static_cast(&mChildren[1])) { 51 | mHead << HTML::Title(apTitle); 52 | mHead << std::move(aStyle); 53 | } 54 | Document(const char* apTitle, const Style& aStyle) : 55 | Element(), mHead(*static_cast(&mChildren[0])), mBody(*static_cast(&mChildren[1])) { 56 | mHead << HTML::Title(apTitle); 57 | mHead << Style(aStyle); 58 | } 59 | 60 | Document& operator<<(Element&& aElement) { 61 | mBody << std::move(aElement); 62 | return *this; 63 | } 64 | 65 | Element& head() { 66 | return mHead; 67 | } 68 | Element& body() { 69 | return mBody; 70 | } 71 | 72 | void lang(const char* apLang) { 73 | mHead.addAttribute("lang", apLang); 74 | } 75 | 76 | friend std::ostream& operator<< (std::ostream& aStream, const Document& aElement); 77 | 78 | std::string toString() const { 79 | std::ostringstream stream; 80 | stream << *this; 81 | return stream.str(); 82 | } 83 | 84 | operator std::string() const { 85 | return toString(); 86 | } 87 | 88 | private: 89 | std::ostream& toString(std::ostream& aStream) const { 90 | aStream << "" HTML_ENDLINE; 91 | Element::toString(aStream); 92 | return aStream; 93 | } 94 | 95 | private: 96 | Head& mHead; ///< Reference to the first child Element \ 97 | Body& mBody; ///< Reference to the second child Element \ 98 | }; 99 | 100 | inline std::ostream& operator<< (std::ostream& aStream, const Document& aDocument) { 101 | return aDocument.toString(aStream); 102 | } 103 | 104 | } // namespace HTML 105 | 106 | -------------------------------------------------------------------------------- /src/Main.cpp: -------------------------------------------------------------------------------- 1 | /** 2 | * @file Main.cpp 3 | * @ingroup HtmlBuilder 4 | * @brief A simple C++ HTML Generator library. 5 | * 6 | * Copyright (c) 2017-2021 Sebastien Rombauts (sebastien.rombauts@gmail.com) 7 | * 8 | * Distributed under the MIT License (MIT) (See accompanying file LICENSE.txt 9 | * or copy at http://opensource.org/licenses/MIT) 10 | */ 11 | 12 | // Note: to configure indentation & minification, define this at compile time before including HTML headers. 13 | #define HTML_INDENTATION 2 ///< Default indentation can be set to 0 to remove many spaces in generated HTML 14 | #define HTML_ENDLINE "\n" ///< End of lines can be removed to minimize even more the resulting generated HTML 15 | 16 | #include 17 | 18 | #include 19 | 20 | /** 21 | * @brief Entry-point of the application. 22 | */ 23 | int main() { 24 | HTML::Document document("Welcome to HTML"); 25 | document.addAttribute("lang", "en"); 26 | 27 | // Head 28 | document.head() << HTML::Meta("utf-8") 29 | << HTML::Meta("viewport", "width=device-width, initial-scale=1, shrink-to-fit=no"); 30 | document.head() << HTML::Rel("stylesheet", "https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/css/bootstrap.min.css") 31 | .integrity("sha384-ggOyR0iXCbMQv3Xipma34MD+dH/1fQ784/j6cY/iJTQUOhcWr7x9JvoRxT2MZw1T").crossorigin("anonymous"); 32 | document.head() << HTML::Style(".navbar{margin-bottom:20px;}"); 33 | 34 | // Body 35 | document.body().cls("bg-light"); 36 | 37 | // Navbar 38 | HTML::List navList(false, "navbar-nav mr-auto"); 39 | navList << std::move(HTML::ListItem().cls("nav-item active") << HTML::Link("Home", "#").cls("nav-link")); 40 | navList << std::move(HTML::ListItem().cls("nav-item") << HTML::Link("Link", "#").cls("nav-link")); 41 | navList << std::move(HTML::ListItem().cls("nav-item") << HTML::Link("Disabled", "#").cls("nav-link disabled")); 42 | navList << std::move(HTML::ListItem().cls("nav-item dropdown") 43 | << HTML::Link("Dropdown", "#").cls("nav-link dropdown-toggle").id("dropdown01").addAttribute("data-toggle", "dropdown").addAttribute("aria-haspopup", "true").addAttribute("aria-expanded", "false") 44 | << (HTML::Div("dropdown-menu").addAttribute("aria-labelledby", "dropdown01") 45 | << HTML::Link("Action", "#").cls("dropdown-item") 46 | << HTML::Link("Another", "#").cls("dropdown-item") 47 | ) 48 | ); 49 | document << (HTML::Nav("navbar navbar-expand navbar-dark bg-dark") << (HTML::Div("collapse navbar-collapse") << std::move(navList))); 50 | 51 | // Content in a container 52 | HTML::Div main("container"); 53 | main << HTML::Header1("Welcome to HTML").id("anchor_link_1"); 54 | main << "Text directly in the body."; 55 | main << HTML::Text("Text directly in the body. ") << HTML::Text("Text directly in the body.") << HTML::Break() 56 | << HTML::Text("Text directly in the body."); 57 | main << HTML::Paragraph("This is the way to go for a big text in a multi-line paragraph."); 58 | main << HTML::Link("Google", "http://google.com").cls("my_style"); 59 | main << (HTML::Paragraph("A paragraph. ").style("font-family:arial") 60 | << HTML::Text("Text child.") << HTML::Break() << HTML::Text("And more text.")); 61 | 62 | main << (HTML::List() 63 | << (HTML::ListItem("Text item")) 64 | << (HTML::ListItem() << HTML::Link("Github Link", "http://srombauts.github.io").title("SRombaut's Github home page")) 65 | << (HTML::ListItem() << (HTML::List() 66 | << HTML::ListItem("val1") 67 | << HTML::ListItem("val2")))); 68 | 69 | main << (HTML::Table().cls("table table-hover table-sm") 70 | << HTML::Caption("Table caption") 71 | << (HTML::Row() << HTML::ColHeader("A") << HTML::ColHeader("B")) 72 | << (HTML::Row() << HTML::Col("Cell_11") << HTML::Col("Cell_12")) 73 | << (HTML::Row() << HTML::Col("Cell_21") << (HTML::Col() << HTML::Link("Wikipedia", "https://www.wikipedia.org/"))) 74 | << (HTML::Row() << HTML::Col("") << HTML::Col("Cell_32"))); 75 | 76 | main << HTML::Small("Copyright Sebastien Rombauts @ 2017-2021"); 77 | 78 | main << HTML::Link().id("anchor_link_2"); 79 | 80 | // TODO HTML::Form(), InputCheckbox() etc 81 | 82 | document << std::move(main); 83 | 84 | // Javascript at the end of the body 85 | document << HTML::Script("https://code.jquery.com/jquery-3.3.1.slim.min.js") 86 | .integrity("sha384-q8i/X+965DzO0rT7abK41JStQIAqVgRVzpbzo5smXKp4YfRvH+8abtTE1Pi6jizo").crossorigin("anonymous"); 87 | document << HTML::Script("https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.14.7/umd/popper.min.js") 88 | .integrity("sha384-UO2eT0CpHqdSJQ6hJty5KVphtPhzWj9WO1clHTMGa3JDZwrnQq4sF86dIHNDz0W1").crossorigin("anonymous"); 89 | document << HTML::Script("https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/js/bootstrap.min.js") 90 | .integrity("sha384-JjSmVgyd0p3pXB1rRibZUAYoIIy6OrQ6VrjIEaFf/nJGzIxFDsf4x0xIM+B07jRM").crossorigin("anonymous"); 91 | 92 | std::cout << document; 93 | return 0; 94 | } 95 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | HtmlBuilder 2 | ----------- 3 | 4 | [![license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/SRombauts/HtmlBuilder/blob/master/LICENSE.txt) 5 | [![Travis CI Linux Build Status](https://travis-ci.org/SRombauts/HtmlBuilder.svg)](https://travis-ci.org/SRombauts/HtmlBuilder "Travis CI Linux Build Status") 6 | [![AppVeyor Windows Build status](https://ci.appveyor.com/api/projects/status/github/SRombauts/HtmlBuilder?svg=true)](https://ci.appveyor.com/project/SbastienRombauts/HtmlBuilder "AppVeyor Windows Build status") 7 | 8 | A simple C++ header-only HTML 5 Generator library, using a Document Object Model (DOM). 9 | 10 | ![HTML5 logo](https://upload.wikimedia.org/wikipedia/commons/thumb/6/61/HTML5_logo_and_wordmark.svg/260px-HTML5_logo_and_wordmark.svg.png) 11 | 12 | Copyright (c) 2017-2022 Sébastien Rombauts (sebastien.rombauts@gmail.com) 13 | 14 | ## Current status 15 | 16 | Deployed in production in a small application. 17 | 18 | ### Support 19 | 20 | - Windows 10 - VS2015 / 2017 / 2019 21 | - Linux Ubuntu 16.04 Clang 7 / GCC 5.4 22 | 23 | ### Features 24 | 25 | 1. DOM Model 26 | 2. Example featuring Bootstrap's navigation bar 27 | 28 | ### Missing features 29 | 30 | 1. [ ] Encoding of **HTML Entities** *(special chars)* 31 | 2. [ ] Support for HTML Comments 32 | 3. [ ] Support for CSS inline style (this is probably easy) 33 | 34 | Javascript inline script is currently out of scope. 35 | 36 | ## Example 37 | 38 | The following example is provided in src/Main.cpp. 39 | 40 | ### Source Code 41 | 42 | ```cpp 43 | HTML::Document document("Welcome to HTML"); 44 | document.addAttribute("lang", "en"); 45 | document << HTML::Header2("Generated HTML") << HTML::Break() << HTML::Break(); 46 | document.body() << "Which results in the following HTML page (truncated to fit in this README): "; 47 | document << HTML::Text("Text directly in the body. ") << HTML::Text("Text directly in the body.") << HTML::Break() 48 | << HTML::Text("Text directly in the body."); 49 | document << HTML::Paragraph("This is the way to go for a big text in a multi-line paragraph."); 50 | document << HTML::Link("Google", "http://google.com").cls("my_style"); 51 | document << (HTML::Paragraph("A paragraph. ").addAttribute("style", "font-family:arial") 52 | << HTML::Text("Text child.") << HTML::Break() << HTML::Text("And more text.")); 53 | 54 | document << (HTML::List() 55 | << (HTML::ListItem("Text item")) 56 | << (HTML::ListItem() << HTML::Link("Github Link", "http://srombauts.github.io").title("SRombaut's Github home page")) 57 | << (HTML::ListItem() << (HTML::List() 58 | << HTML::ListItem("val1") 59 | << HTML::ListItem("val2")))); 60 | 61 | document << (HTML::Table() 62 | << (HTML::Row() << HTML::ColHeader("A") << HTML::ColHeader("B")) 63 | << (HTML::Row() << HTML::Col("Cell_11") << HTML::Col("Cell_12")) 64 | << (HTML::Row() << HTML::Col("Cell_21") << HTML::Col("Cell_22")) 65 | << (HTML::Row() << HTML::Col("") << HTML::Col("Cell_32"))); 66 | ``` 67 | 68 | ### Generated HTML 69 | 70 | Which results in the following HTML page (truncated to fit in this README): 71 | 72 | Text directly in the body. Text directly in the body. 73 |
74 | Text directly in the body. 75 |

This is the way to go for a big text in a multi-line paragraph.

76 | Google 77 |

A paragraph. Text child. 78 |
79 | And more text. 80 |

81 |
    82 |
  • Text item
    • 83 |
  • 84 | Github Link 85 |
    • 86 |
  • 87 |
      88 |
    • val1
      • 89 |
    • val2
      • 90 |
    91 |
    • 92 |
93 | 94 | 95 | 96 | 97 | 98 | 99 | 100 | 101 | 102 | 103 | 104 | 105 | 106 | 107 | 108 | 109 | 110 |
AB
Cell_11Cell_12
Cell_21Cell_22
Cell_32
111 | 112 | 113 | ## Building with CMake 114 | 115 | This is a header only library, so just include the include folder and go on. 116 | 117 | ### Get cpplint submodule 118 | 119 | ```bash 120 | git submodule init 121 | git submodule update 122 | ``` 123 | 124 | ### Typical generic build (see also "build.bat" or "./build.sh") 125 | 126 | ```bash 127 | mkdir build 128 | cd build 129 | cmake .. # cmake .. -G "Visual Studio 10" # for Visual Studio 2010 130 | cmake --build . # make 131 | ``` 132 | 133 | ### Debug build for Unix Makefiles 134 | 135 | ```bash 136 | mkdir Debug 137 | cd Debug 138 | cmake .. -DCMAKE_BUILD_TYPE=Debug # -G "Unix Makefiles" 139 | cmake --build . # make 140 | ``` 141 | 142 | ### Release build 143 | 144 | ```bash 145 | mkdir Release 146 | cd Release 147 | cmake .. -DCMAKE_BUILD_TYPE=Release # -G "Unix Makefiles" 148 | cmake --build . # make 149 | ``` 150 | -------------------------------------------------------------------------------- /CMakeLists.txt: -------------------------------------------------------------------------------- 1 | # Copyright (c) 2017-2021 Sébastien Rombauts (sebastien.rombauts@gmail.com) 2 | # 3 | # Distributed under the MIT License (MIT) (See accompanying file LICENSE.txt 4 | # or copy at http://opensource.org/licenses/MIT) 5 | 6 | cmake_minimum_required(VERSION 2.8.12) # first version with add_compile_options() 7 | project(HtmlBuilder CXX) 8 | 9 | # Verbose Makefile 10 | #set (CMAKE_VERBOSE_MAKEFILE ON) 11 | 12 | # Print some standard CMake variables 13 | message(STATUS "CMake version: ${CMAKE_VERSION}") 14 | message(STATUS "CMAKE_SYSTEM_NAME/_VERSION '${CMAKE_SYSTEM_NAME}' '${CMAKE_SYSTEM_VERSION}'") 15 | message(STATUS "CMAKE_CXX_COMPILER_ID/_VERSION '${CMAKE_CXX_COMPILER_ID}' '${CMAKE_CXX_COMPILER_VERSION}'") 16 | if (NOT MSVC) 17 | message(STATUS "CMAKE_BUILD_TYPE '${CMAKE_BUILD_TYPE}'") 18 | endif (NOT MSVC) 19 | 20 | # Define useful variables to handle OS/Compiler differences 21 | if (MSVC) 22 | # Flags for linking with multithread static C++ runtime 23 | set(CMAKE_CXX_FLAGS_RELEASE "${CMAKE_CXX_FLAGS_RELEASE} /MT") 24 | set(CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG} /MTd") 25 | set(CPPLINT_ARG_OUTPUT "--output=vs7") 26 | set(CPPCHECK_ARG_TEMPLATE "--template=vs") 27 | set(DEV_NULL "NUL") 28 | set(SYSTEM_LIBRARIES "") 29 | add_definitions(/D_CRT_SECURE_NO_WARNINGS) 30 | # Set warning level to maximum (instead of default /W3) 31 | set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} /W4") 32 | set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /W4") 33 | else (MSVC) 34 | set(CPPLINT_ARG_OUTPUT "--output=eclipse") 35 | set(CPPCHECK_ARG_TEMPLATE "--template=gcc") 36 | set(DEV_NULL "/dev/null") 37 | set(SYSTEM_LIBRARIES "rt") 38 | 39 | # C++11 : 40 | add_compile_options(-std=c++0x) # equivalent to "-std=c++11" but backward compatible for GCC 4.6 on Travic-CI 41 | # Stack protection 42 | add_compile_options(-fstack-protector-all) 43 | 44 | if (CMAKE_COMPILER_IS_GNUCXX) 45 | # GCC flags 46 | # For stacktraces: 47 | add_compile_options(-rdynamic -fstack-protector-all) 48 | # Enable maximum of Warnings : 49 | add_compile_options(-Wall -Wextra -Wswitch-default -Wswitch-enum -Winit-self -Wformat-security -Wfloat-equal -Wcast-qual -Wconversion -Wlogical-op -Winline) 50 | if (CMAKE_CXX_COMPILER_VERSION VERSION_EQUAL "4.9" OR CMAKE_CXX_COMPILER_VERSION VERSION_GREATER "4.9") 51 | add_compile_options (-Wfloat-conversion) 52 | add_compile_options (-Wshadow) 53 | endif () 54 | elseif ("${CMAKE_CXX_COMPILER_ID}" STREQUAL "Clang") 55 | # Clang flags 56 | # Enable maximum of Warnings : 57 | add_compile_options(-Weverything) 58 | add_compile_options(-Wno-c++98-compat -Wno-c++98-compat-pedantic -Wno-padded -Wno-covered-switch-default -Wno-unreachable-code) 59 | endif (CMAKE_COMPILER_IS_GNUCXX) 60 | endif (MSVC) 61 | set(CPPLINT_ARG_LINELENGTH "--linelength=120") 62 | set(CPPLINT_ARG_VERBOSE "--verbose=1") 63 | 64 | # List all headers files 65 | set(headers_files 66 | ${CMAKE_SOURCE_DIR}/include/HTML/HTML.h 67 | ${CMAKE_SOURCE_DIR}/include/HTML/Element.h 68 | ${CMAKE_SOURCE_DIR}/include/HTML/Document.h 69 | ) 70 | source_group(headers FILES ${headers_files}) 71 | 72 | # List all example source files 73 | set(examples_files 74 | ${CMAKE_SOURCE_DIR}/src/Main.cpp 75 | ) 76 | source_group(example FILES ${examples_files}) 77 | 78 | # List script files 79 | set(script_files 80 | ${CMAKE_SOURCE_DIR}/.travis.yml 81 | ${CMAKE_SOURCE_DIR}/appveyor.yml 82 | ${CMAKE_SOURCE_DIR}/build.bat 83 | ${CMAKE_SOURCE_DIR}/build.sh 84 | ) 85 | source_group(scripts FILES ${script_files}) 86 | 87 | # List doc files 88 | set(doc_files 89 | ${CMAKE_SOURCE_DIR}/README.md 90 | ${CMAKE_SOURCE_DIR}/LICENSE.txt 91 | ) 92 | #source_group(doc FILES ${doc_files}) 93 | 94 | # All includes are relative to the "include" directory 95 | include_directories("${PROJECT_SOURCE_DIR}/include") 96 | 97 | # add the application executable 98 | add_executable(HtmlBuilder_example ${headers_files} ${doc_files} ${script_files} ${examples_files}) 99 | target_link_libraries(HtmlBuilder_example ${SYSTEM_LIBRARIES}) 100 | 101 | 102 | # Optional additional targets: 103 | 104 | option(RUN_CPPLINT "Run cpplint.py tool for Google C++ StyleGuide." ON) 105 | if (RUN_CPPLINT) 106 | find_package(PythonInterp) 107 | if (PYTHONINTERP_FOUND) 108 | # add a cpplint target to the "all" target 109 | add_custom_target(cpplint 110 | ALL 111 | COMMAND ${PYTHON_EXECUTABLE} ${PROJECT_SOURCE_DIR}/cpplint/cpplint.py ${CPPLINT_ARG_OUTPUT} ${CPPLINT_ARG_LINELENGTH} ${CPPLINT_ARG_VERBOSE} ${headers_files} 112 | ) 113 | else (PYTHONINTERP_FOUND) 114 | message(STATUS "Could NOT find Python") 115 | endif (PYTHONINTERP_FOUND) 116 | else (RUN_CPPLINT) 117 | message(STATUS "RUN_CPPLINT OFF") 118 | endif (RUN_CPPLINT) 119 | 120 | option(RUN_CPPCHECK "Run cppcheck C++ static analysis tool." ON) 121 | if (RUN_CPPCHECK) 122 | find_program(CPPCHECK_EXECUTABLE NAMES cppcheck) 123 | if (CPPCHECK_EXECUTABLE) 124 | # add a cppcheck target to the "all" target 125 | add_custom_target(cppcheck 126 | ALL 127 | COMMAND cppcheck -j 4 --enable=style --quiet ${CPPCHECK_ARG_TEMPLATE} ${PROJECT_SOURCE_DIR}/src 128 | ) 129 | else (CPPCHECK_EXECUTABLE) 130 | message(STATUS "Could NOT find cppcheck") 131 | endif (CPPCHECK_EXECUTABLE) 132 | else (RUN_CPPCHECK) 133 | message(STATUS "RUN_CPPCHECK OFF") 134 | endif (RUN_CPPCHECK) 135 | 136 | option(RUN_DOXYGEN "Run Doxygen C++ documentation tool." ON) 137 | if (RUN_DOXYGEN) 138 | find_package(Doxygen) 139 | if (DOXYGEN_FOUND) 140 | # add a Doxygen target to the "all" target 141 | add_custom_target(doxygen 142 | ALL 143 | COMMAND doxygen Doxyfile > ${DEV_NULL} 144 | WORKING_DIRECTORY ${PROJECT_SOURCE_DIR} 145 | ) 146 | endif (DOXYGEN_FOUND) 147 | else (RUN_DOXYGEN) 148 | message(STATUS "RUN_DOXYGEN OFF") 149 | endif (RUN_DOXYGEN) 150 | 151 | 152 | # add a "test" target: 153 | enable_testing() 154 | 155 | # does the example1 runs successfully? 156 | add_test(ExampleRun HtmlBuilder_example) 157 | -------------------------------------------------------------------------------- /include/HTML/Element.h: -------------------------------------------------------------------------------- 1 | /** 2 | * @file Element.h 3 | * @ingroup HtmlBuilder 4 | * @brief Definitions of an Element in the HTML Document Object Model, and various specialized Element types. 5 | * 6 | * Copyright (c) 2017-2021 Sebastien Rombauts (sebastien.rombauts@gmail.com) 7 | * 8 | * Distributed under the MIT License (MIT) (See accompanying file LICENSE.txt 9 | * or copy at http://opensource.org/licenses/MIT) 10 | */ 11 | #pragma once 12 | 13 | #include 14 | #include 15 | #include 16 | #include 17 | #include 18 | #include 19 | 20 | /// A simple C++ HTML Generator library. 21 | namespace HTML { 22 | 23 | // Note: to configure indentation & minification, define this at compile time before including HTML headers. 24 | #ifndef HTML_INDENTATION 25 | #define HTML_INDENTATION 2 26 | #endif 27 | #ifndef HTML_ENDLINE 28 | #define HTML_ENDLINE "\n" 29 | #endif 30 | 31 | /// Convert a boolean to string like std::boolalpha in a std::ostream 32 | constexpr const char* to_string(bool aBool) { 33 | return aBool ? "true" : "false"; 34 | } 35 | 36 | /** 37 | * @brief Definitions of an Element in the HTML Document Object Model, and various specialized Element types. 38 | * 39 | * An Element represents any HTML node in the Document Object Model. 40 | */ 41 | class Element { 42 | public: 43 | explicit Element(const char* apName, const char* apContent = nullptr) : 44 | mName(apName), mContent(apContent ? apContent : "") {} 45 | Element(const char* apName, std::string&& aContent) : 46 | mName(apName), mContent(aContent) {} 47 | Element(const char* apName, const std::string& aContent) : 48 | mName(apName), mContent(aContent) {} 49 | 50 | Element&& addAttribute(const char* apName, const char* apValue) { 51 | if (apName && apValue) { 52 | mAttributes.push_back({ apName, apValue }); 53 | } 54 | return std::move(*this); 55 | } 56 | Element&& addAttribute(const char* apName, const std::string& aValue) { 57 | mAttributes.push_back({apName, aValue}); 58 | return std::move(*this); 59 | } 60 | Element&& addAttribute(const char* apName, const unsigned int aValue) { 61 | mAttributes.push_back({apName, std::to_string(aValue)}); 62 | return std::move(*this); 63 | } 64 | Element&& operator<<(Element&& aElement) { 65 | mChildren.push_back(std::move(aElement)); 66 | return std::move(*this); 67 | } 68 | Element&& operator<<(const char* apContent); 69 | Element&& operator<<(std::string&& aContent); 70 | Element&& operator<<(const std::string& aContent); 71 | 72 | friend std::ostream& operator<<(std::ostream& aStream, const Element& aElement); 73 | std::string toString() const { 74 | std::ostringstream stream; 75 | stream << *this; 76 | return stream.str(); 77 | } 78 | 79 | Element&& id(const char* apValue) { 80 | return addAttribute("id", apValue); 81 | } 82 | Element&& id(const std::string& aValue) { 83 | return addAttribute("id", aValue); 84 | } 85 | 86 | Element&& cls(const char* apValue) { 87 | return addAttribute("class", apValue); 88 | } 89 | Element&& cls(const std::string& aValue) { 90 | return addAttribute("class", aValue); 91 | } 92 | 93 | Element&& title(const char* apValue) { 94 | return addAttribute("title", apValue); 95 | } 96 | Element&& title(const std::string& aValue) { 97 | return addAttribute("title", aValue); 98 | } 99 | 100 | Element&& style(const char* apValue) { 101 | return addAttribute("style", apValue); 102 | } 103 | Element&& style(const std::string& aValue) { 104 | return addAttribute("style", aValue); 105 | } 106 | 107 | struct Attribute { 108 | std::string Name; 109 | std::string Value; 110 | }; 111 | 112 | protected: 113 | /// Constructor reserved for the Root \ Element as well as the Empty 114 | Element(); 115 | 116 | std::ostream& toString(std::ostream& aStream, const size_t aIndentation = 0) const { 117 | toStringOpen(aStream, aIndentation); 118 | toStringContent(aStream, aIndentation); 119 | toStringClose(aStream, aIndentation); 120 | return aStream; 121 | } 122 | 123 | private: 124 | void toStringOpen(std::ostream& aStream, const size_t aIndentation) const { 125 | if (!mName.empty()) { 126 | std::fill_n(std::ostream_iterator(aStream), aIndentation, ' '); 127 | aStream << '<' << mName; 128 | 129 | for (const auto& attr : mAttributes) { 130 | aStream << ' ' << attr.Name; 131 | if (!attr.Value.empty()) { 132 | aStream << "=\"" << attr.Value << "\""; 133 | } 134 | } 135 | 136 | if (mContent.empty()) { 137 | // Note: using children for content is less efficient/breaking the assumption 138 | if (!mChildren.empty() || mbVoid) { 139 | aStream << ">" HTML_ENDLINE; 140 | } else { 141 | aStream << ">"; 142 | } 143 | } else { 144 | aStream << '>'; 145 | } 146 | } 147 | } 148 | void toStringContent(std::ostream& aStream, const size_t aIndentation) const { 149 | if (!mName.empty()) { 150 | aStream << mContent; 151 | for (auto& child : mChildren) { 152 | child.toString(aStream, aIndentation + HTML_INDENTATION); 153 | } 154 | } else { 155 | std::fill_n(std::ostream_iterator(aStream), aIndentation, ' '); 156 | aStream << mContent << HTML_ENDLINE; 157 | } 158 | } 159 | void toStringClose(std::ostream& aStream, const size_t aIndentation) const { 160 | if (!mName.empty()) { 161 | if (!mChildren.empty()) { 162 | std::fill_n(std::ostream_iterator(aStream), aIndentation, ' '); 163 | } 164 | // Note: using children for content is less efficient/breaking the assumption 165 | if (!mContent.empty() || !mChildren.empty() || !mbVoid) { 166 | aStream << "" HTML_ENDLINE; 167 | } 168 | } 169 | } 170 | 171 | protected: 172 | std::string mName; 173 | std::string mContent; 174 | std::vector mAttributes; 175 | std::vector mChildren; 176 | 177 | // Self-closing elements complete list: 178 | //
179 | // 180 | bool mbVoid = false; 181 | }; 182 | 183 | inline std::ostream& operator<<(std::ostream& aStream, const Element& aElement) { 184 | return aElement.toString(aStream); 185 | } 186 | 187 | /// Empty Element, useful as a default parameter for instance 188 | class Empty : public Element { 189 | public: 190 | Empty() : Element() {} 191 | }; 192 | 193 | /// Raw content text (unnamed Element) to use as text values between child Elements 194 | class Text : public Element { 195 | public: 196 | explicit Text(const char* apContent) : Element("", apContent) {} 197 | explicit Text(std::string&& aContent) : Element("", aContent) {} 198 | explicit Text(const std::string& aContent) : Element("", aContent) {} 199 | }; 200 | 201 | inline Element&& Element::operator<<(const char* apContent) { 202 | return *this << Text(apContent); 203 | } 204 | 205 | inline Element&& Element::operator<<(std::string&& aContent) { 206 | return *this << Text(std::move(aContent)); 207 | } 208 | 209 | inline Element&& Element::operator<<(const std::string& aContent) { 210 | return *this << Text(aContent); 211 | } 212 | 213 | /// \ Element required in \ 214 | class Title : public Element { 215 | public: 216 | explicit Title(const char* apContent) : Element("title", apContent) {} 217 | explicit Title(const std::string& aContent) : Element("title", aContent) {} 218 | }; 219 | 220 | /// \ Element for inline CSS in \ 221 | class Style : public Element { 222 | public: 223 | explicit Style(const char* apContent) : Element("style", apContent) {} 224 | explicit Style(const std::string& aContent) : Element("style", aContent) {} 225 | }; 226 | 227 | /// \ Element for inline Javascript in \ 228 | class Script : public Element { 229 | public: 230 | Script() : Element("script") {} 231 | explicit Script(const char* apSrc) : Element("script") { 232 | if (apSrc) { 233 | addAttribute("src", apSrc); 234 | } 235 | } 236 | explicit Script(const char* apSrc, const char* apContent) : Element("script", apContent) { 237 | if (apSrc) { 238 | addAttribute("src", apSrc); 239 | } 240 | } 241 | Script&& integrity(const std::string& aValue) { 242 | addAttribute("integrity", aValue); 243 | return std::move(*this); 244 | } 245 | Script&& crossorigin(const std::string& aValue) { 246 | addAttribute("crossorigin", aValue); 247 | return std::move(*this); 248 | } 249 | }; 250 | 251 | /// \ metadata about the Document in \ 252 | class Meta : public Element { 253 | public: 254 | Meta() : Element("meta") {} 255 | explicit Meta(const char* apCharset) : Element("meta") { 256 | addAttribute("charset", apCharset); 257 | mbVoid = true; 258 | } 259 | explicit Meta(const char* apName, const char* apContent) : Element("meta") { 260 | addAttribute("name", apName); 261 | addAttribute("content", apContent); 262 | mbVoid = true; 263 | } 264 | }; 265 | 266 | /// \ Element to reference external CSS or Javascript files 267 | class Rel : public Element { 268 | public: 269 | Rel(const char* apRel, const char* apUrl, const char* apType = nullptr) : Element("link") { 270 | addAttribute("rel", apRel); 271 | addAttribute("href", apUrl); 272 | if (apType) { 273 | addAttribute("type", apType); 274 | } 275 | mbVoid = true; 276 | } 277 | 278 | Rel&& integrity(const std::string& aValue) { 279 | addAttribute("integrity", aValue); 280 | return std::move(*this); 281 | } 282 | Rel&& crossorigin(const std::string& aValue) { 283 | addAttribute("crossorigin", aValue); 284 | return std::move(*this); 285 | } 286 | }; 287 | 288 | /// \ Element in \ 289 | class Base : public Element { 290 | public: 291 | Base(const std::string& aContent, const std::string& aUrl, const char* apTarget) : Element("base", aContent) { 292 | addAttribute("href", aUrl); 293 | if (apTarget) { 294 | addAttribute("target", apTarget); 295 | } 296 | } 297 | }; 298 | 299 | /// \ required as the first child Element in every HTML Document 300 | class Head : public Element { 301 | public: 302 | Head() : Element("head") {} 303 | 304 | Head&& operator<<(Element&& aElement) = delete; 305 | Head&& operator<<(Title&& aTitle) { 306 | mChildren.push_back(std::move(aTitle)); 307 | return std::move(*this); 308 | } 309 | Head&& operator<<(Style&& aStyle) { 310 | mChildren.push_back(std::move(aStyle)); 311 | return std::move(*this); 312 | } 313 | Head&& operator<<(Script&& aScript) { 314 | mChildren.push_back(std::move(aScript)); 315 | return std::move(*this); 316 | } 317 | Head&& operator<<(Meta&& aMeta) { 318 | mChildren.push_back(std::move(aMeta)); 319 | return std::move(*this); 320 | } 321 | Head&& operator<<(Rel&& aRel) { 322 | mChildren.push_back(std::move(aRel)); 323 | return std::move(*this); 324 | } 325 | Head&& operator<<(Base&& aBase) { 326 | mChildren.push_back(std::move(aBase)); 327 | return std::move(*this); 328 | } 329 | }; 330 | 331 | /// \ required as the second child Element in every HTML Document 332 | class Body : public Element { 333 | public: 334 | Body() : Element("body") {} 335 | }; 336 | 337 | // Constructor of the Root \ Element 338 | inline Element::Element() : mName("html"), mChildren{Head(), Body()} { 339 | } 340 | 341 | 342 | /// \ Line break Element 343 | class Break : public Element { 344 | public: 345 | Break() : Element("br") { 346 | mbVoid = true; 347 | } 348 | }; 349 | 350 | /// \ Table Header Column Element 351 | class ColHeader : public Element { 352 | public: 353 | explicit ColHeader(const char* apContent = nullptr) : Element("th", apContent) {} 354 | explicit ColHeader(std::string&& aContent) : Element("th", aContent) {} 355 | explicit ColHeader(const std::string& aContent) : Element("th", aContent) {} 356 | 357 | ColHeader&& operator<<(Element&& aElement) { 358 | mChildren.push_back(std::move(aElement)); 359 | return std::move(*this); 360 | } 361 | 362 | ColHeader&& rowSpan(const unsigned int aNbRow) { 363 | if (0 < aNbRow) { 364 | addAttribute("rowspan", aNbRow); 365 | } 366 | return std::move(*this); 367 | } 368 | ColHeader&& colSpan(const unsigned int aNbCol) { 369 | if (0 < aNbCol) { 370 | addAttribute("colspan", aNbCol); 371 | } 372 | return std::move(*this); 373 | } 374 | }; 375 | 376 | /// \ Table Column Element 377 | class Col : public Element { 378 | public: 379 | explicit Col(const char* apContent = nullptr) : Element("td", apContent) {} 380 | explicit Col(std::string&& aContent) : Element("td", aContent) {} 381 | explicit Col(const std::string& aContent) : Element("td", aContent) {} 382 | explicit Col(const bool abContent) : Element("td", to_string(abContent)) {} 383 | explicit Col(const int aContent) : Element("td", std::to_string(aContent)) {} 384 | explicit Col(const unsigned int aContent) : Element("td", std::to_string(aContent)) {} 385 | explicit Col(const long long aContent) : Element("td", std::to_string(aContent)) {} 386 | explicit Col(const unsigned long long aContent) : Element("td", std::to_string(aContent)) {} 387 | explicit Col(const float aContent) : Element("td", std::to_string(aContent)) {} 388 | explicit Col(const double aContent) : Element("td", std::to_string(aContent)) {} 389 | 390 | Col&& operator<<(Element&& aElement) { 391 | mChildren.push_back(std::move(aElement)); 392 | return std::move(*this); 393 | } 394 | 395 | Col&& rowSpan(const unsigned int aNbRow) { 396 | if (0 < aNbRow) { 397 | addAttribute("rowspan", aNbRow); 398 | } 399 | return std::move(*this); 400 | } 401 | Col&& colSpan(const unsigned int aNbCol) { 402 | if (0 < aNbCol) { 403 | addAttribute("colspan", aNbCol); 404 | } 405 | return std::move(*this); 406 | } 407 | Col&& style(const std::string& aValue) { 408 | Element::style(aValue); 409 | return std::move(*this); 410 | } 411 | }; 412 | 413 | /// \ Table Row Element 414 | class Row : public Element { 415 | public: 416 | Row() : Element("tr") {} 417 | 418 | Row&& operator<<(Element&& aElement) = delete; 419 | Row&& operator<<(ColHeader&& aCol) { 420 | mChildren.push_back(std::move(aCol)); 421 | return std::move(*this); 422 | } 423 | Row&& operator<<(Col&& aCol) { 424 | mChildren.push_back(std::move(aCol)); 425 | return std::move(*this); 426 | } 427 | Row&& style(const std::string& aValue) { 428 | Element::style(aValue); 429 | return std::move(*this); 430 | } 431 | }; 432 | 433 | /// \ Table Caption Element 434 | class Caption : public Element { 435 | public: 436 | explicit Caption(const char* apContent) : Element("caption", apContent) {} 437 | }; 438 | 439 | /// \ Element 440 | class Table : public Element { 441 | public: 442 | Table() : Element("table") {} 443 | 444 | Table&& operator<<(Element&& aElement) = delete; 445 | Table&& operator<<(Row&& aRow) { 446 | mChildren.push_back(std::move(aRow)); 447 | return std::move(*this); 448 | } 449 | Table&& operator<<(Caption&& aCaption) { 450 | mChildren.push_back(std::move(aCaption)); 451 | return std::move(*this); 452 | } 453 | }; 454 | 455 | /// \ List Item Element to put in List 456 | class ListItem : public Element { 457 | public: 458 | ListItem() : Element("li") {} 459 | explicit ListItem(const char* apContent) : Element("li", apContent) {} 460 | explicit ListItem(const std::string& aContent) : Element("li", aContent) {} 461 | 462 | ListItem&& operator<<(Element&& aElement) { 463 | mChildren.push_back(std::move(aElement)); 464 | return std::move(*this); 465 | } 466 | 467 | ListItem&& cls(const std::string& aValue) { 468 | addAttribute("class", aValue); 469 | return std::move(*this); 470 | } 471 | }; 472 | 473 | /// \ Ordered List or \ Unordered List Element to use with ListItem 474 | class List : public Element { 475 | public: 476 | explicit List(const bool abOrdered = false) : Element(abOrdered?"ol":"ul") {} 477 | List(const bool abOrdered, const char* apClass) : Element(abOrdered ?"ol":"ul") { 478 | cls(apClass); 479 | } 480 | 481 | List&& operator<<(Element&& aElement) = delete; 482 | List&& operator<<(ListItem&& aItem) { 483 | mChildren.push_back(std::move(aItem)); 484 | return std::move(*this); 485 | } 486 | }; 487 | 488 | /// \ Element 489 | class Form : public Element { 490 | public: 491 | explicit Form(const char* apAction = nullptr, const char* apMethod = nullptr) : Element("form") { 492 | if (apAction) { 493 | addAttribute("action", apAction); 494 | } 495 | if (apMethod) { 496 | addAttribute("method", apMethod); 497 | } 498 | } 499 | }; 500 | 501 | /// \ Element to use in Form 502 | class Input : public Element { 503 | public: 504 | explicit Input(const char* apType = nullptr, const char* apName = nullptr, 505 | const char* apValue = nullptr, const char* apContent = nullptr) : Element("input", apContent) { 506 | if (apType) { 507 | addAttribute("type", apType); 508 | } 509 | if (apName) { 510 | addAttribute("name", apName); 511 | } 512 | if (apValue) { 513 | addAttribute("value", apValue); 514 | } 515 | mbVoid = true; 516 | } 517 | 518 | Input&& addAttribute(const char* apName, const std::string& aValue) { 519 | Element::addAttribute(apName, aValue); 520 | return std::move(*this); 521 | } 522 | Input&& addAttribute(const char* apName, const unsigned int aValue) { 523 | Element::addAttribute(apName, aValue); 524 | return std::move(*this); 525 | } 526 | 527 | Input&& id(const std::string& aValue) { 528 | return addAttribute("id", aValue); 529 | } 530 | Input&& cls(const std::string& aValue) { 531 | return addAttribute("class", aValue); 532 | } 533 | Input&& title(const std::string& aValue) { 534 | return addAttribute("title", aValue); 535 | } 536 | Input&& style(const std::string& aValue) { 537 | return addAttribute("style", aValue); 538 | } 539 | 540 | Input&& size(const unsigned int aSize) { 541 | return addAttribute("size", aSize); 542 | } 543 | Input&& maxlength(const unsigned int aMaxlength) { 544 | return addAttribute("maxlength", aMaxlength); 545 | } 546 | Input&& placeholder(const std::string& aPlaceholder) { 547 | return addAttribute("placeholder", aPlaceholder); 548 | } 549 | Input&& min(const std::string& aMin) { 550 | return addAttribute("min", aMin); 551 | } 552 | Input&& min(const unsigned int aMin) { 553 | return addAttribute("min", aMin); 554 | } 555 | Input&& max(const std::string& aMax) { // NOLINT(build/include_what_you_use) false positive 556 | return addAttribute("max", aMax); 557 | } 558 | Input&& max(const unsigned int aMax) { // NOLINT(build/include_what_you_use) false positive 559 | return addAttribute("max", aMax); 560 | } 561 | 562 | Input&& checked(const bool abChecked = true) { 563 | if (abChecked) { 564 | addAttribute("checked", ""); 565 | } 566 | return std::move(*this); 567 | } 568 | Input&& autocomplete() { 569 | return addAttribute("autocomplete", ""); 570 | } 571 | Input&& autofocus() { 572 | return addAttribute("autofocus", ""); 573 | } 574 | Input&& disabled() { 575 | return addAttribute("disabled", ""); 576 | } 577 | Input&& readonly() { 578 | return addAttribute("readonly", ""); 579 | } 580 | Input&& required() { 581 | return addAttribute("required", ""); 582 | } 583 | }; 584 | 585 | /// \ Radio Element to use in Form 586 | class InputRadio : public Input { 587 | public: 588 | explicit InputRadio(const char* apName, const char* apValue = nullptr, const char* apContent = nullptr) : 589 | Input("radio", apName, apValue, apContent) { 590 | } 591 | }; 592 | 593 | /// \ Checkbox Element to use in Form 594 | class InputCheckbox : public Input { 595 | public: 596 | explicit InputCheckbox(const char* apName, const char* apValue = nullptr, const char* apContent = nullptr) : 597 | Input("checkbox", apName, apValue, apContent) { 598 | } 599 | }; 600 | 601 | /// \ hidden Element to use in Form 602 | class InputHidden : public Input { 603 | public: 604 | explicit InputHidden(const char* apName, const char* apValue = nullptr) : 605 | Input("hidden", apName, apValue) { 606 | } 607 | }; 608 | 609 | /// \ text Element to use in Form 610 | class InputText : public Input { 611 | public: 612 | explicit InputText(const char* apName, const char* apValue = nullptr) : 613 | Input("text", apName, apValue) { 614 | } 615 | }; 616 | 617 | /// \ Element to use in Form 618 | class TextArea : public Element { 619 | public: 620 | explicit TextArea(const char* apName, const unsigned int aCols = 0, const unsigned int aRows = 0) : 621 | Element("textarea") { 622 | addAttribute("name", apName); 623 | if (0 < aCols) { 624 | addAttribute("cols", aCols); 625 | } 626 | if (0 < aRows) { 627 | addAttribute("rows", aRows); 628 | } 629 | } 630 | TextArea&& maxlength(const unsigned int aMaxlength) { 631 | addAttribute("maxlength", aMaxlength); 632 | return std::move(*this); 633 | } 634 | }; 635 | 636 | /// \ Number Element to use in Form 637 | class InputNumber : public Input { 638 | public: 639 | explicit InputNumber(const char* apName, const char* apValue = nullptr) : 640 | Input("number", apName, apValue) { 641 | } 642 | }; 643 | 644 | /// \ Range Element to use in Form 645 | class InputRange : public Input { 646 | public: 647 | explicit InputRange(const char* apName, const char* apValue = nullptr) : 648 | Input("range", apName, apValue) { 649 | } 650 | }; 651 | 652 | /// \ Date Element to use in Form 653 | class InputDate : public Input { 654 | public: 655 | explicit InputDate(const char* apName, const char* apValue = nullptr) : 656 | Input("date", apName, apValue) { 657 | } 658 | }; 659 | 660 | /// \ Time Element to use in Form 661 | class InputTime : public Input { 662 | public: 663 | explicit InputTime(const char* apName, const char* apValue = nullptr) : 664 | Input("time", apName, apValue) { 665 | } 666 | }; 667 | 668 | /// \ E-mail Element to use in Form 669 | class InputEmail : public Input { 670 | public: 671 | explicit InputEmail(const char* apName, const char* apValue = nullptr) : 672 | Input("email", apName, apValue) { 673 | } 674 | }; 675 | 676 | /// \ URL Element to use in Form 677 | class InputUrl : public Input { 678 | public: 679 | explicit InputUrl(const char* apName, const char* apValue = nullptr) : 680 | Input("url", apName, apValue) { 681 | } 682 | }; 683 | 684 | /// \ Password Element to use in Form 685 | class InputPassword : public Input { 686 | public: 687 | explicit InputPassword(const char* apName) : 688 | Input("password", apName) { 689 | } 690 | }; 691 | 692 | /// \ Submit Button Element to use in Form 693 | class InputSubmit : public Input { 694 | public: 695 | explicit InputSubmit(const char* apValue = nullptr, const char* apName = nullptr) : 696 | Input("submit", apName, apValue) { 697 | } 698 | }; 699 | 700 | /// \ Reset Button Element to use in Form 701 | class InputReset : public Input { 702 | public: 703 | explicit InputReset(const char* apValue = nullptr) : 704 | Input("reset", nullptr, apValue) { 705 | } 706 | }; 707 | 708 | /// \ List Element to use in Form with DataList 709 | class InputList : public Input { 710 | public: 711 | explicit InputList(const char* apName, const char* apList) : Input(nullptr, apName) { 712 | addAttribute("list", apList); 713 | } 714 | }; 715 | 716 | /// \ Element for InputList, to use with Option Elements 717 | class DataList : public Element { 718 | public: 719 | explicit DataList(const char* apId) : Element("datalist") { 720 | addAttribute("id", apId); 721 | } 722 | }; 723 | 724 | /// \ Element to use with Option Elements 725 | class Select : public Element { 726 | public: 727 | explicit Select(const char* apName) : Element("select") { 728 | addAttribute("name", apName); 729 | } 730 | }; 731 | 732 | /// \ Element for Select and DataList 733 | class Option : public Element { 734 | public: 735 | explicit Option(const char* apValue, const char* apContent = nullptr) : Element("option", apContent) { 736 | addAttribute("value", apValue); 737 | } 738 | 739 | Option&& selected(const bool abSelected = true) { 740 | if (abSelected) { 741 | addAttribute("selected", ""); 742 | } 743 | return std::move(*this); 744 | } 745 | }; 746 | 747 | /// \ Element 748 | class Header1 : public Element { 749 | public: 750 | explicit Header1(const std::string& aContent) : Element("h1", aContent) {} 751 | }; 752 | 753 | /// \ Element 754 | class Header2 : public Element { 755 | public: 756 | explicit Header2(const std::string& aContent) : Element("h2", aContent) {} 757 | }; 758 | 759 | /// \ Element 760 | class Header3 : public Element { 761 | public: 762 | explicit Header3(const std::string& aContent) : Element("h3", aContent) {} 763 | }; 764 | 765 | /// \ bold Element 766 | class Bold : public Element { 767 | public: 768 | explicit Bold(const std::string& aContent) : Element("b", aContent) {} 769 | }; 770 | 771 | /// \ italic Element 772 | class Italic : public Element { 773 | public: 774 | explicit Italic(const std::string& aContent) : Element("i", aContent) {} 775 | }; 776 | 777 | /// \ Element for side-comment text and small print, including copyright and legal text 778 | class Small : public Element { 779 | public: 780 | Small() : Element("small") {} 781 | explicit Small(const char* apContent) : Element("small", apContent) {} 782 | explicit Small(std::string&& aContent) : Element("small", aContent) {} 783 | explicit Small(const std::string& aContent) : Element("small", aContent) {} 784 | }; 785 | 786 | /// \ Element for important text 787 | class Strong : public Element { 788 | public: 789 | Strong() : Element("strong") {} 790 | explicit Strong(const char* apContent) : Element("strong", apContent) {} 791 | explicit Strong(std::string&& aContent) : Element("strong", aContent) {} 792 | explicit Strong(const std::string& aContent) : Element("strong", aContent) {} 793 | }; 794 | 795 | /// \ paragraph Element 796 | class Paragraph : public Element { 797 | public: 798 | explicit Paragraph(const std::string& aContent) : Element("p", aContent) {} 799 | }; 800 | 801 | /// \ division Element to group elements in a rectangular block. 802 | class Div : public Element { 803 | public: 804 | Div() : Element("div") {} 805 | explicit Div(const char* apClass) : Element("div") { 806 | cls(apClass); 807 | } 808 | 809 | Div&& cls(const std::string& aValue) { 810 | addAttribute("class", aValue); 811 | return std::move(*this); 812 | } 813 | }; 814 | 815 | /// \ Element to group inline-elements in a document. 816 | class Span : public Element { 817 | public: 818 | explicit Span(const std::string& aContent) : Element("span", aContent) {} 819 | }; 820 | 821 | /// \ pre-formatted Element to display text in mono-space font. 822 | class Pre : public Element { 823 | public: 824 | explicit Pre(const std::string& aContent) : Element("pre", aContent) {} 825 | }; 826 | 827 | /// \ Hyper-Link Element 828 | class Link : public Element { 829 | public: 830 | Link() : Element("a") {} 831 | explicit Link(const char* apContent) : Element("a", apContent) {} 832 | explicit Link(const char* apContent, const char* apUrl = nullptr) : Element("a", apContent) { 833 | if (apUrl) { 834 | addAttribute("href", apUrl); 835 | } 836 | } 837 | Link(const std::string& aContent, const std::string& aUrl) : Element("a", aContent) { 838 | if (!aUrl.empty()) { 839 | addAttribute("href", aUrl); 840 | } 841 | } 842 | Link&& target(const char* apValue) { 843 | addAttribute("target", apValue); 844 | return std::move(*this); 845 | } 846 | }; 847 | 848 | /// \ Image Element 849 | class Image : public Element { 850 | public: 851 | Image(const std::string& aSrc, const std::string& aAlt, unsigned int aWidth = 0, unsigned int aHeight = 0) : 852 | Element("img") { 853 | addAttribute("src", aSrc); 854 | addAttribute("alt", aAlt); 855 | if (0 < aWidth) { 856 | addAttribute("width", aWidth); 857 | } 858 | if (0 < aHeight) { 859 | addAttribute("height", aHeight); 860 | } 861 | mbVoid = true; 862 | } 863 | }; 864 | 865 | /// \ Button Element 866 | class Button : public Element { 867 | public: 868 | Button(const char* apContent, const char* apType = "button") : 869 | Element("button", apContent) { 870 | addAttribute("type", apType); 871 | } 872 | }; 873 | 874 | /// \ Element 875 | class Progress : public Element { 876 | public: 877 | Progress(const unsigned int aValue, const unsigned int aMax) : Element("progress") { 878 | addAttribute("value", aValue); 879 | addAttribute("max", aMax); 880 | } 881 | }; 882 | 883 | /// \ gauge Element 884 | class Meter : public Element { 885 | public: 886 | Meter(const unsigned int aValue, const unsigned int aMin, const unsigned int aMax) : Element("meter") { 887 | addAttribute("value", aValue); 888 | addAttribute("min", aMin); 889 | addAttribute("max", aMax); 890 | } 891 | }; 892 | 893 | /// \ semantic Element 894 | class Mark : public Element { 895 | public: 896 | explicit Mark(const std::string& aContent) : Element("mark", aContent) {} 897 | }; 898 | 899 | /// \ semantic Element 900 | class Time : public Element { 901 | public: 902 | explicit Time(const std::string& aContent, const std::string& aDateTime) : Element("time", aContent) { 903 | addAttribute("datetime", aDateTime); 904 | } 905 | }; 906 | 907 | /// \ semantic Element 908 | class Header : public Element { 909 | public: 910 | Header() : Element("header") {} 911 | }; 912 | 913 | /// \ semantic Element 914 | class Footer : public Element { 915 | public: 916 | Footer() : Element("footer") {} 917 | }; 918 | 919 | /// \ semantic Element 920 | class Section : public Element { 921 | public: 922 | Section() : Element("section") {} 923 | }; 924 | 925 | /// \ semantic Element 926 | class Article : public Element { 927 | public: 928 | Article() : Element("article") {} 929 | }; 930 | 931 | /// \ semantic Element 932 | class Nav : public Element { 933 | public: 934 | Nav() : Element("nav") {} 935 | explicit Nav(const char* apClass) : Element("nav") { 936 | cls(apClass); 937 | } 938 | }; 939 | 940 | /// \ semantic Element 941 | class Aside : public Element { 942 | public: 943 | Aside() : Element("aside") {} 944 | }; 945 | 946 | /// \ semantic Element 947 | class Main : public Element { 948 | public: 949 | Main() : Element("main") {} 950 | }; 951 | 952 | /// \ semantic Element 953 | class Figure : public Element { 954 | public: 955 | Figure() : Element("figure") {} 956 | }; 957 | 958 | /// \ semantic Element to use with Figure 959 | class FigCaption : public Element { 960 | public: 961 | explicit FigCaption(const std::string& aContent) : Element("figcaption", aContent) {} 962 | }; 963 | 964 | /** @brief \ semantic Element containing detailed information to use with Summary. 965 | * 966 | * @verbatim 967 |
968 | Copyright 2017-2021. 969 |

By Sebastien Rombauts.

970 |

sebastien.rombauts@gmail.com.

971 |
@endverbatim 972 | */ 973 | class Details : public Element { 974 | public: 975 | explicit Details(const char* apOpen = nullptr) : Element("details") { 976 | if (apOpen) { 977 | addAttribute("open", apOpen); 978 | } 979 | } 980 | }; 981 | 982 | /// \ semantic Element to use inside a Details section to specify a visible heading 983 | class Summary : public Element { 984 | public: 985 | explicit Summary(const std::string& aContent) : Element("summary", aContent) {} 986 | }; 987 | 988 | 989 | } // namespace HTML 990 | -------------------------------------------------------------------------------- /Doxyfile: -------------------------------------------------------------------------------- 1 | # Doxyfile 1.8.9.1 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 = HtmlBuilder 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 = 0 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 = "A simple C++ HTML Builder DOM library." 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 = doc 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 = YES 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 = 8 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 = NO 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 | # Set the SUBGROUPING tag to YES to allow class member groups of the same type 357 | # (for instance a group of public functions) to be put as a subgroup of that 358 | # type (e.g. under the Public Functions section). Set it to NO to prevent 359 | # subgrouping. Alternatively, this can be done per class using the 360 | # \nosubgrouping command. 361 | # The default value is: YES. 362 | 363 | SUBGROUPING = YES 364 | 365 | # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions 366 | # are shown inside the group in which they are included (e.g. using \ingroup) 367 | # instead of on a separate page (for HTML and Man pages) or section (for LaTeX 368 | # and RTF). 369 | # 370 | # Note that this feature does not work in combination with 371 | # SEPARATE_MEMBER_PAGES. 372 | # The default value is: NO. 373 | 374 | INLINE_GROUPED_CLASSES = NO 375 | 376 | # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions 377 | # with only public data fields or simple typedef fields will be shown inline in 378 | # the documentation of the scope in which they are defined (i.e. file, 379 | # namespace, or group documentation), provided this scope is documented. If set 380 | # to NO, structs, classes, and unions are shown on a separate page (for HTML and 381 | # Man pages) or section (for LaTeX and RTF). 382 | # The default value is: NO. 383 | 384 | INLINE_SIMPLE_STRUCTS = NO 385 | 386 | # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or 387 | # enum is documented as struct, union, or enum with the name of the typedef. So 388 | # typedef struct TypeS {} TypeT, will appear in the documentation as a struct 389 | # with name TypeT. When disabled the typedef will appear as a member of a file, 390 | # namespace, or class. And the struct will be named TypeS. This can typically be 391 | # useful for C code in case the coding convention dictates that all compound 392 | # types are typedef'ed and only the typedef is referenced, never the tag name. 393 | # The default value is: NO. 394 | 395 | TYPEDEF_HIDES_STRUCT = NO 396 | 397 | # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This 398 | # cache is used to resolve symbols given their name and scope. Since this can be 399 | # an expensive process and often the same symbol appears multiple times in the 400 | # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small 401 | # doxygen will become slower. If the cache is too large, memory is wasted. The 402 | # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range 403 | # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 404 | # symbols. At the end of a run doxygen will report the cache usage and suggest 405 | # the optimal cache size from a speed point of view. 406 | # Minimum value: 0, maximum value: 9, default value: 0. 407 | 408 | LOOKUP_CACHE_SIZE = 0 409 | 410 | #--------------------------------------------------------------------------- 411 | # Build related configuration options 412 | #--------------------------------------------------------------------------- 413 | 414 | # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in 415 | # documentation are documented, even if no documentation was available. Private 416 | # class members and static file members will be hidden unless the 417 | # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. 418 | # Note: This will also disable the warnings about undocumented members that are 419 | # normally produced when WARNINGS is set to YES. 420 | # The default value is: NO. 421 | 422 | EXTRACT_ALL = NO 423 | 424 | # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will 425 | # be included in the documentation. 426 | # The default value is: NO. 427 | 428 | EXTRACT_PRIVATE = YES 429 | 430 | # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal 431 | # scope will be included in the documentation. 432 | # The default value is: NO. 433 | 434 | EXTRACT_PACKAGE = NO 435 | 436 | # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be 437 | # included in the documentation. 438 | # The default value is: NO. 439 | 440 | EXTRACT_STATIC = YES 441 | 442 | # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined 443 | # locally in source files will be included in the documentation. If set to NO, 444 | # only classes defined in header files are included. Does not have any effect 445 | # for Java sources. 446 | # The default value is: YES. 447 | 448 | EXTRACT_LOCAL_CLASSES = YES 449 | 450 | # This flag is only useful for Objective-C code. If set to YES, local methods, 451 | # which are defined in the implementation section but not in the interface are 452 | # included in the documentation. If set to NO, only methods in the interface are 453 | # included. 454 | # The default value is: NO. 455 | 456 | EXTRACT_LOCAL_METHODS = NO 457 | 458 | # If this flag is set to YES, the members of anonymous namespaces will be 459 | # extracted and appear in the documentation as a namespace called 460 | # 'anonymous_namespace{file}', where file will be replaced with the base name of 461 | # the file that contains the anonymous namespace. By default anonymous namespace 462 | # are hidden. 463 | # The default value is: NO. 464 | 465 | EXTRACT_ANON_NSPACES = NO 466 | 467 | # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all 468 | # undocumented members inside documented classes or files. If set to NO these 469 | # members will be included in the various overviews, but no documentation 470 | # section is generated. This option has no effect if EXTRACT_ALL is enabled. 471 | # The default value is: NO. 472 | 473 | HIDE_UNDOC_MEMBERS = NO 474 | 475 | # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all 476 | # undocumented classes that are normally visible in the class hierarchy. If set 477 | # to NO, these classes will be included in the various overviews. This option 478 | # has no effect if EXTRACT_ALL is enabled. 479 | # The default value is: NO. 480 | 481 | HIDE_UNDOC_CLASSES = NO 482 | 483 | # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend 484 | # (class|struct|union) declarations. If set to NO, these declarations will be 485 | # included in the documentation. 486 | # The default value is: NO. 487 | 488 | HIDE_FRIEND_COMPOUNDS = NO 489 | 490 | # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any 491 | # documentation blocks found inside the body of a function. If set to NO, these 492 | # blocks will be appended to the function's detailed documentation block. 493 | # The default value is: NO. 494 | 495 | HIDE_IN_BODY_DOCS = NO 496 | 497 | # The INTERNAL_DOCS tag determines if documentation that is typed after a 498 | # \internal command is included. If the tag is set to NO then the documentation 499 | # will be excluded. Set it to YES to include the internal documentation. 500 | # The default value is: NO. 501 | 502 | INTERNAL_DOCS = NO 503 | 504 | # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file 505 | # names in lower-case letters. If set to YES, upper-case letters are also 506 | # allowed. This is useful if you have classes or files whose names only differ 507 | # in case and if your file system supports case sensitive file names. Windows 508 | # and Mac users are advised to set this option to NO. 509 | # The default value is: system dependent. 510 | 511 | CASE_SENSE_NAMES = NO 512 | 513 | # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with 514 | # their full class and namespace scopes in the documentation. If set to YES, the 515 | # scope will be hidden. 516 | # The default value is: NO. 517 | 518 | HIDE_SCOPE_NAMES = NO 519 | 520 | # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will 521 | # append additional text to a page's title, such as Class Reference. If set to 522 | # YES the compound reference will be hidden. 523 | # The default value is: NO. 524 | 525 | HIDE_COMPOUND_REFERENCE= NO 526 | 527 | # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of 528 | # the files that are included by a file in the documentation of that file. 529 | # The default value is: YES. 530 | 531 | SHOW_INCLUDE_FILES = YES 532 | 533 | # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each 534 | # grouped member an include statement to the documentation, telling the reader 535 | # which file to include in order to use the member. 536 | # The default value is: NO. 537 | 538 | SHOW_GROUPED_MEMB_INC = NO 539 | 540 | # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include 541 | # files with double quotes in the documentation rather than with sharp brackets. 542 | # The default value is: NO. 543 | 544 | FORCE_LOCAL_INCLUDES = NO 545 | 546 | # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the 547 | # documentation for inline members. 548 | # The default value is: YES. 549 | 550 | INLINE_INFO = YES 551 | 552 | # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the 553 | # (detailed) documentation of file and class members alphabetically by member 554 | # name. If set to NO, the members will appear in declaration order. 555 | # The default value is: YES. 556 | 557 | SORT_MEMBER_DOCS = YES 558 | 559 | # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief 560 | # descriptions of file, namespace and class members alphabetically by member 561 | # name. If set to NO, the members will appear in declaration order. Note that 562 | # this will also influence the order of the classes in the class list. 563 | # The default value is: NO. 564 | 565 | SORT_BRIEF_DOCS = NO 566 | 567 | # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the 568 | # (brief and detailed) documentation of class members so that constructors and 569 | # destructors are listed first. If set to NO the constructors will appear in the 570 | # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. 571 | # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief 572 | # member documentation. 573 | # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting 574 | # detailed member documentation. 575 | # The default value is: NO. 576 | 577 | SORT_MEMBERS_CTORS_1ST = NO 578 | 579 | # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy 580 | # of group names into alphabetical order. If set to NO the group names will 581 | # appear in their defined order. 582 | # The default value is: NO. 583 | 584 | SORT_GROUP_NAMES = NO 585 | 586 | # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by 587 | # fully-qualified names, including namespaces. If set to NO, the class list will 588 | # be sorted only by class name, not including the namespace part. 589 | # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 590 | # Note: This option applies only to the class list, not to the alphabetical 591 | # list. 592 | # The default value is: NO. 593 | 594 | SORT_BY_SCOPE_NAME = NO 595 | 596 | # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper 597 | # type resolution of all parameters of a function it will reject a match between 598 | # the prototype and the implementation of a member function even if there is 599 | # only one candidate or it is obvious which candidate to choose by doing a 600 | # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still 601 | # accept a match between prototype and implementation in such cases. 602 | # The default value is: NO. 603 | 604 | STRICT_PROTO_MATCHING = NO 605 | 606 | # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo 607 | # list. This list is created by putting \todo commands in the documentation. 608 | # The default value is: YES. 609 | 610 | GENERATE_TODOLIST = YES 611 | 612 | # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test 613 | # list. This list is created by putting \test commands in the documentation. 614 | # The default value is: YES. 615 | 616 | GENERATE_TESTLIST = YES 617 | 618 | # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug 619 | # list. This list is created by putting \bug commands in the documentation. 620 | # The default value is: YES. 621 | 622 | GENERATE_BUGLIST = YES 623 | 624 | # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) 625 | # the deprecated list. This list is created by putting \deprecated commands in 626 | # the documentation. 627 | # The default value is: YES. 628 | 629 | GENERATE_DEPRECATEDLIST= YES 630 | 631 | # The ENABLED_SECTIONS tag can be used to enable conditional documentation 632 | # sections, marked by \if ... \endif and \cond 633 | # ... \endcond blocks. 634 | 635 | ENABLED_SECTIONS = 636 | 637 | # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the 638 | # initial value of a variable or macro / define can have for it to appear in the 639 | # documentation. If the initializer consists of more lines than specified here 640 | # it will be hidden. Use a value of 0 to hide initializers completely. The 641 | # appearance of the value of individual variables and macros / defines can be 642 | # controlled using \showinitializer or \hideinitializer command in the 643 | # documentation regardless of this setting. 644 | # Minimum value: 0, maximum value: 10000, default value: 30. 645 | 646 | MAX_INITIALIZER_LINES = 30 647 | 648 | # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at 649 | # the bottom of the documentation of classes and structs. If set to YES, the 650 | # list will mention the files that were used to generate the documentation. 651 | # The default value is: YES. 652 | 653 | SHOW_USED_FILES = YES 654 | 655 | # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This 656 | # will remove the Files entry from the Quick Index and from the Folder Tree View 657 | # (if specified). 658 | # The default value is: YES. 659 | 660 | SHOW_FILES = YES 661 | 662 | # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces 663 | # page. This will remove the Namespaces entry from the Quick Index and from the 664 | # Folder Tree View (if specified). 665 | # The default value is: YES. 666 | 667 | SHOW_NAMESPACES = YES 668 | 669 | # The FILE_VERSION_FILTER tag can be used to specify a program or script that 670 | # doxygen should invoke to get the current version for each file (typically from 671 | # the version control system). Doxygen will invoke the program by executing (via 672 | # popen()) the command command input-file, where command is the value of the 673 | # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided 674 | # by doxygen. Whatever the program writes to standard output is used as the file 675 | # version. For an example see the documentation. 676 | 677 | FILE_VERSION_FILTER = 678 | 679 | # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed 680 | # by doxygen. The layout file controls the global structure of the generated 681 | # output files in an output format independent way. To create the layout file 682 | # that represents doxygen's defaults, run doxygen with the -l option. You can 683 | # optionally specify a file name after the option, if omitted DoxygenLayout.xml 684 | # will be used as the name of the layout file. 685 | # 686 | # Note that if you run doxygen from a directory containing a file called 687 | # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE 688 | # tag is left empty. 689 | 690 | LAYOUT_FILE = 691 | 692 | # The CITE_BIB_FILES tag can be used to specify one or more bib files containing 693 | # the reference definitions. This must be a list of .bib files. The .bib 694 | # extension is automatically appended if omitted. This requires the bibtex tool 695 | # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. 696 | # For LaTeX the style of the bibliography can be controlled using 697 | # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the 698 | # search path. See also \cite for info how to create references. 699 | 700 | CITE_BIB_FILES = 701 | 702 | #--------------------------------------------------------------------------- 703 | # Configuration options related to warning and progress messages 704 | #--------------------------------------------------------------------------- 705 | 706 | # The QUIET tag can be used to turn on/off the messages that are generated to 707 | # standard output by doxygen. If QUIET is set to YES this implies that the 708 | # messages are off. 709 | # The default value is: NO. 710 | 711 | QUIET = NO 712 | 713 | # The WARNINGS tag can be used to turn on/off the warning messages that are 714 | # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES 715 | # this implies that the warnings are on. 716 | # 717 | # Tip: Turn warnings on while writing the documentation. 718 | # The default value is: YES. 719 | 720 | WARNINGS = YES 721 | 722 | # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate 723 | # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag 724 | # will automatically be disabled. 725 | # The default value is: YES. 726 | 727 | WARN_IF_UNDOCUMENTED = YES 728 | 729 | # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for 730 | # potential errors in the documentation, such as not documenting some parameters 731 | # in a documented function, or documenting parameters that don't exist or using 732 | # markup commands wrongly. 733 | # The default value is: YES. 734 | 735 | WARN_IF_DOC_ERROR = YES 736 | 737 | # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that 738 | # are documented, but have no documentation for their parameters or return 739 | # value. If set to NO, doxygen will only warn about wrong or incomplete 740 | # parameter documentation, but not about the absence of documentation. 741 | # The default value is: NO. 742 | 743 | WARN_NO_PARAMDOC = YES 744 | 745 | # The WARN_FORMAT tag determines the format of the warning messages that doxygen 746 | # can produce. The string should contain the $file, $line, and $text tags, which 747 | # will be replaced by the file and line number from which the warning originated 748 | # and the warning text. Optionally the format may contain $version, which will 749 | # be replaced by the version of the file (if it could be obtained via 750 | # FILE_VERSION_FILTER) 751 | # The default value is: $file:$line: $text. 752 | 753 | WARN_FORMAT = "$file:$line: $text" 754 | 755 | # The WARN_LOGFILE tag can be used to specify a file to which warning and error 756 | # messages should be written. If left blank the output is written to standard 757 | # error (stderr). 758 | 759 | WARN_LOGFILE = 760 | 761 | #--------------------------------------------------------------------------- 762 | # Configuration options related to the input files 763 | #--------------------------------------------------------------------------- 764 | 765 | # The INPUT tag is used to specify the files and/or directories that contain 766 | # documented source files. You may enter file names like myfile.cpp or 767 | # directories like /usr/src/myproject. Separate the files or directories with 768 | # spaces. 769 | # Note: If this tag is empty the current directory is searched. 770 | 771 | INPUT = src 772 | 773 | # This tag can be used to specify the character encoding of the source files 774 | # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses 775 | # libiconv (or the iconv built into libc) for the transcoding. See the libiconv 776 | # documentation (see: http://www.gnu.org/software/libiconv) for the list of 777 | # possible encodings. 778 | # The default value is: UTF-8. 779 | 780 | INPUT_ENCODING = UTF-8 781 | 782 | # If the value of the INPUT tag contains directories, you can use the 783 | # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and 784 | # *.h) to filter out the source-files in the directories. If left blank the 785 | # following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii, 786 | # *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, 787 | # *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, 788 | # *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, 789 | # *.qsf, *.as and *.js. 790 | 791 | FILE_PATTERNS = *.c \ 792 | *.cc \ 793 | *.cxx \ 794 | *.cpp \ 795 | *.c++ \ 796 | *.d \ 797 | *.java \ 798 | *.ii \ 799 | *.ixx \ 800 | *.ipp \ 801 | *.i++ \ 802 | *.inl \ 803 | *.h \ 804 | *.hh \ 805 | *.hxx \ 806 | *.hpp \ 807 | *.h++ \ 808 | *.idl \ 809 | *.odl \ 810 | *.cs \ 811 | *.php \ 812 | *.php3 \ 813 | *.inc \ 814 | *.m \ 815 | *.markdown \ 816 | *.md \ 817 | *.mm \ 818 | *.dox \ 819 | *.py \ 820 | *.f90 \ 821 | *.f \ 822 | *.for \ 823 | *.vhd \ 824 | *.vhdl 825 | 826 | # The RECURSIVE tag can be used to specify whether or not subdirectories should 827 | # be searched for input files as well. 828 | # The default value is: NO. 829 | 830 | RECURSIVE = YES 831 | 832 | # The EXCLUDE tag can be used to specify files and/or directories that should be 833 | # excluded from the INPUT source files. This way you can easily exclude a 834 | # subdirectory from a directory tree whose root is specified with the INPUT tag. 835 | # 836 | # Note that relative paths are relative to the directory from which doxygen is 837 | # run. 838 | 839 | EXCLUDE = 840 | 841 | # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or 842 | # directories that are symbolic links (a Unix file system feature) are excluded 843 | # from the input. 844 | # The default value is: NO. 845 | 846 | EXCLUDE_SYMLINKS = NO 847 | 848 | # If the value of the INPUT tag contains directories, you can use the 849 | # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 850 | # certain files from those directories. 851 | # 852 | # Note that the wildcards are matched against the file with absolute path, so to 853 | # exclude all test directories for example use the pattern */test/* 854 | 855 | EXCLUDE_PATTERNS = 856 | 857 | # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 858 | # (namespaces, classes, functions, etc.) that should be excluded from the 859 | # output. The symbol name can be a fully qualified name, a word, or if the 860 | # wildcard * is used, a substring. Examples: ANamespace, AClass, 861 | # AClass::ANamespace, ANamespace::*Test 862 | # 863 | # Note that the wildcards are matched against the file with absolute path, so to 864 | # exclude all test directories use the pattern */test/* 865 | 866 | EXCLUDE_SYMBOLS = 867 | 868 | # The EXAMPLE_PATH tag can be used to specify one or more files or directories 869 | # that contain example code fragments that are included (see the \include 870 | # command). 871 | 872 | EXAMPLE_PATH = 873 | 874 | # If the value of the EXAMPLE_PATH tag contains directories, you can use the 875 | # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and 876 | # *.h) to filter out the source-files in the directories. If left blank all 877 | # files are included. 878 | 879 | EXAMPLE_PATTERNS = * 880 | 881 | # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 882 | # searched for input files to be used with the \include or \dontinclude commands 883 | # irrespective of the value of the RECURSIVE tag. 884 | # The default value is: NO. 885 | 886 | EXAMPLE_RECURSIVE = NO 887 | 888 | # The IMAGE_PATH tag can be used to specify one or more files or directories 889 | # that contain images that are to be included in the documentation (see the 890 | # \image command). 891 | 892 | IMAGE_PATH = 893 | 894 | # The INPUT_FILTER tag can be used to specify a program that doxygen should 895 | # invoke to filter for each input file. Doxygen will invoke the filter program 896 | # by executing (via popen()) the command: 897 | # 898 | # 899 | # 900 | # where is the value of the INPUT_FILTER tag, and is the 901 | # name of an input file. Doxygen will then use the output that the filter 902 | # program writes to standard output. If FILTER_PATTERNS is specified, this tag 903 | # will be ignored. 904 | # 905 | # Note that the filter must not add or remove lines; it is applied before the 906 | # code is scanned, but not when the output code is generated. If lines are added 907 | # or removed, the anchors will not be placed correctly. 908 | 909 | INPUT_FILTER = 910 | 911 | # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 912 | # basis. Doxygen will compare the file name with each pattern and apply the 913 | # filter if there is a match. The filters are a list of the form: pattern=filter 914 | # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how 915 | # filters are used. If the FILTER_PATTERNS tag is empty or if none of the 916 | # patterns match the file name, INPUT_FILTER is applied. 917 | 918 | FILTER_PATTERNS = 919 | 920 | # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 921 | # INPUT_FILTER) will also be used to filter the input files that are used for 922 | # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). 923 | # The default value is: NO. 924 | 925 | FILTER_SOURCE_FILES = NO 926 | 927 | # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file 928 | # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and 929 | # it is also possible to disable source filtering for a specific pattern using 930 | # *.ext= (so without naming a filter). 931 | # This tag requires that the tag FILTER_SOURCE_FILES is set to YES. 932 | 933 | FILTER_SOURCE_PATTERNS = 934 | 935 | # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that 936 | # is part of the input, its contents will be placed on the main page 937 | # (index.html). This can be useful if you have a project on for instance GitHub 938 | # and want to reuse the introduction page also for the doxygen output. 939 | 940 | USE_MDFILE_AS_MAINPAGE = 941 | 942 | #--------------------------------------------------------------------------- 943 | # Configuration options related to source browsing 944 | #--------------------------------------------------------------------------- 945 | 946 | # If the SOURCE_BROWSER tag is set to YES then a list of source files will be 947 | # generated. Documented entities will be cross-referenced with these sources. 948 | # 949 | # Note: To get rid of all source code in the generated output, make sure that 950 | # also VERBATIM_HEADERS is set to NO. 951 | # The default value is: NO. 952 | 953 | SOURCE_BROWSER = YES 954 | 955 | # Setting the INLINE_SOURCES tag to YES will include the body of functions, 956 | # classes and enums directly into the documentation. 957 | # The default value is: NO. 958 | 959 | INLINE_SOURCES = NO 960 | 961 | # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any 962 | # special comment blocks from generated source code fragments. Normal C, C++ and 963 | # Fortran comments will always remain visible. 964 | # The default value is: YES. 965 | 966 | STRIP_CODE_COMMENTS = NO 967 | 968 | # If the REFERENCED_BY_RELATION tag is set to YES then for each documented 969 | # function all documented functions referencing it will be listed. 970 | # The default value is: NO. 971 | 972 | REFERENCED_BY_RELATION = NO 973 | 974 | # If the REFERENCES_RELATION tag is set to YES then for each documented function 975 | # all documented entities called/used by that function will be listed. 976 | # The default value is: NO. 977 | 978 | REFERENCES_RELATION = NO 979 | 980 | # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set 981 | # to YES then the hyperlinks from functions in REFERENCES_RELATION and 982 | # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will 983 | # link to the documentation. 984 | # The default value is: YES. 985 | 986 | REFERENCES_LINK_SOURCE = YES 987 | 988 | # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the 989 | # source code will show a tooltip with additional information such as prototype, 990 | # brief description and links to the definition and documentation. Since this 991 | # will make the HTML file larger and loading of large files a bit slower, you 992 | # can opt to disable this feature. 993 | # The default value is: YES. 994 | # This tag requires that the tag SOURCE_BROWSER is set to YES. 995 | 996 | SOURCE_TOOLTIPS = YES 997 | 998 | # If the USE_HTAGS tag is set to YES then the references to source code will 999 | # point to the HTML generated by the htags(1) tool instead of doxygen built-in 1000 | # source browser. The htags tool is part of GNU's global source tagging system 1001 | # (see http://www.gnu.org/software/global/global.html). You will need version 1002 | # 4.8.6 or higher. 1003 | # 1004 | # To use it do the following: 1005 | # - Install the latest version of global 1006 | # - Enable SOURCE_BROWSER and USE_HTAGS in the config file 1007 | # - Make sure the INPUT points to the root of the source tree 1008 | # - Run doxygen as normal 1009 | # 1010 | # Doxygen will invoke htags (and that will in turn invoke gtags), so these 1011 | # tools must be available from the command line (i.e. in the search path). 1012 | # 1013 | # The result: instead of the source browser generated by doxygen, the links to 1014 | # source code will now point to the output of htags. 1015 | # The default value is: NO. 1016 | # This tag requires that the tag SOURCE_BROWSER is set to YES. 1017 | 1018 | USE_HTAGS = NO 1019 | 1020 | # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a 1021 | # verbatim copy of the header file for each class for which an include is 1022 | # specified. Set to NO to disable this. 1023 | # See also: Section \class. 1024 | # The default value is: YES. 1025 | 1026 | VERBATIM_HEADERS = YES 1027 | 1028 | # If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the 1029 | # clang parser (see: http://clang.llvm.org/) for more accurate parsing at the 1030 | # cost of reduced performance. This can be particularly helpful with template 1031 | # rich C++ code for which doxygen's built-in parser lacks the necessary type 1032 | # information. 1033 | # Note: The availability of this option depends on whether or not doxygen was 1034 | # compiled with the --with-libclang option. 1035 | # The default value is: NO. 1036 | 1037 | CLANG_ASSISTED_PARSING = NO 1038 | 1039 | # If clang assisted parsing is enabled you can provide the compiler with command 1040 | # line options that you would normally use when invoking the compiler. Note that 1041 | # the include paths will already be set by doxygen for the files and directories 1042 | # specified with INPUT and INCLUDE_PATH. 1043 | # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. 1044 | 1045 | CLANG_OPTIONS = 1046 | 1047 | #--------------------------------------------------------------------------- 1048 | # Configuration options related to the alphabetical class index 1049 | #--------------------------------------------------------------------------- 1050 | 1051 | # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all 1052 | # compounds will be generated. Enable this if the project contains a lot of 1053 | # classes, structs, unions or interfaces. 1054 | # The default value is: YES. 1055 | 1056 | ALPHABETICAL_INDEX = YES 1057 | 1058 | # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in 1059 | # which the alphabetical index list will be split. 1060 | # Minimum value: 1, maximum value: 20, default value: 5. 1061 | # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 1062 | 1063 | COLS_IN_ALPHA_INDEX = 5 1064 | 1065 | # In case all classes in a project start with a common prefix, all classes will 1066 | # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag 1067 | # can be used to specify a prefix (or a list of prefixes) that should be ignored 1068 | # while generating the index headers. 1069 | # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 1070 | 1071 | IGNORE_PREFIX = 1072 | 1073 | #--------------------------------------------------------------------------- 1074 | # Configuration options related to the HTML output 1075 | #--------------------------------------------------------------------------- 1076 | 1077 | # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output 1078 | # The default value is: YES. 1079 | 1080 | GENERATE_HTML = YES 1081 | 1082 | # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a 1083 | # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 1084 | # it. 1085 | # The default directory is: html. 1086 | # This tag requires that the tag GENERATE_HTML is set to YES. 1087 | 1088 | HTML_OUTPUT = html 1089 | 1090 | # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each 1091 | # generated HTML page (for example: .htm, .php, .asp). 1092 | # The default value is: .html. 1093 | # This tag requires that the tag GENERATE_HTML is set to YES. 1094 | 1095 | HTML_FILE_EXTENSION = .html 1096 | 1097 | # The HTML_HEADER tag can be used to specify a user-defined HTML header file for 1098 | # each generated HTML page. If the tag is left blank doxygen will generate a 1099 | # standard header. 1100 | # 1101 | # To get valid HTML the header file that includes any scripts and style sheets 1102 | # that doxygen needs, which is dependent on the configuration options used (e.g. 1103 | # the setting GENERATE_TREEVIEW). It is highly recommended to start with a 1104 | # default header using 1105 | # doxygen -w html new_header.html new_footer.html new_stylesheet.css 1106 | # YourConfigFile 1107 | # and then modify the file new_header.html. See also section "Doxygen usage" 1108 | # for information on how to generate the default header that doxygen normally 1109 | # uses. 1110 | # Note: The header is subject to change so you typically have to regenerate the 1111 | # default header when upgrading to a newer version of doxygen. For a description 1112 | # of the possible markers and block names see the documentation. 1113 | # This tag requires that the tag GENERATE_HTML is set to YES. 1114 | 1115 | HTML_HEADER = 1116 | 1117 | # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each 1118 | # generated HTML page. If the tag is left blank doxygen will generate a standard 1119 | # footer. See HTML_HEADER for more information on how to generate a default 1120 | # footer and what special commands can be used inside the footer. See also 1121 | # section "Doxygen usage" for information on how to generate the default footer 1122 | # that doxygen normally uses. 1123 | # This tag requires that the tag GENERATE_HTML is set to YES. 1124 | 1125 | HTML_FOOTER = 1126 | 1127 | # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style 1128 | # sheet that is used by each HTML page. It can be used to fine-tune the look of 1129 | # the HTML output. If left blank doxygen will generate a default style sheet. 1130 | # See also section "Doxygen usage" for information on how to generate the style 1131 | # sheet that doxygen normally uses. 1132 | # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as 1133 | # it is more robust and this tag (HTML_STYLESHEET) will in the future become 1134 | # obsolete. 1135 | # This tag requires that the tag GENERATE_HTML is set to YES. 1136 | 1137 | HTML_STYLESHEET = 1138 | 1139 | # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined 1140 | # cascading style sheets that are included after the standard style sheets 1141 | # created by doxygen. Using this option one can overrule certain style aspects. 1142 | # This is preferred over using HTML_STYLESHEET since it does not replace the 1143 | # standard style sheet and is therefore more robust against future updates. 1144 | # Doxygen will copy the style sheet files to the output directory. 1145 | # Note: The order of the extra style sheet files is of importance (e.g. the last 1146 | # style sheet in the list overrules the setting of the previous ones in the 1147 | # list). For an example see the documentation. 1148 | # This tag requires that the tag GENERATE_HTML is set to YES. 1149 | 1150 | HTML_EXTRA_STYLESHEET = 1151 | 1152 | # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or 1153 | # other source files which should be copied to the HTML output directory. Note 1154 | # that these files will be copied to the base HTML output directory. Use the 1155 | # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these 1156 | # files. In the HTML_STYLESHEET file, use the file name only. Also note that the 1157 | # files will be copied as-is; there are no commands or markers available. 1158 | # This tag requires that the tag GENERATE_HTML is set to YES. 1159 | 1160 | HTML_EXTRA_FILES = 1161 | 1162 | # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen 1163 | # will adjust the colors in the style sheet and background images according to 1164 | # this color. Hue is specified as an angle on a colorwheel, see 1165 | # http://en.wikipedia.org/wiki/Hue for more information. For instance the value 1166 | # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 1167 | # purple, and 360 is red again. 1168 | # Minimum value: 0, maximum value: 359, default value: 220. 1169 | # This tag requires that the tag GENERATE_HTML is set to YES. 1170 | 1171 | HTML_COLORSTYLE_HUE = 220 1172 | 1173 | # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors 1174 | # in the HTML output. For a value of 0 the output will use grayscales only. A 1175 | # value of 255 will produce the most vivid colors. 1176 | # Minimum value: 0, maximum value: 255, default value: 100. 1177 | # This tag requires that the tag GENERATE_HTML is set to YES. 1178 | 1179 | HTML_COLORSTYLE_SAT = 100 1180 | 1181 | # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the 1182 | # luminance component of the colors in the HTML output. Values below 100 1183 | # gradually make the output lighter, whereas values above 100 make the output 1184 | # darker. The value divided by 100 is the actual gamma applied, so 80 represents 1185 | # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not 1186 | # change the gamma. 1187 | # Minimum value: 40, maximum value: 240, default value: 80. 1188 | # This tag requires that the tag GENERATE_HTML is set to YES. 1189 | 1190 | HTML_COLORSTYLE_GAMMA = 80 1191 | 1192 | # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML 1193 | # page will contain the date and time when the page was generated. Setting this 1194 | # to NO can help when comparing the output of multiple runs. 1195 | # The default value is: YES. 1196 | # This tag requires that the tag GENERATE_HTML is set to YES. 1197 | 1198 | HTML_TIMESTAMP = NO 1199 | 1200 | # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 1201 | # documentation will contain sections that can be hidden and shown after the 1202 | # page has loaded. 1203 | # The default value is: NO. 1204 | # This tag requires that the tag GENERATE_HTML is set to YES. 1205 | 1206 | HTML_DYNAMIC_SECTIONS = NO 1207 | 1208 | # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries 1209 | # shown in the various tree structured indices initially; the user can expand 1210 | # and collapse entries dynamically later on. Doxygen will expand the tree to 1211 | # such a level that at most the specified number of entries are visible (unless 1212 | # a fully collapsed tree already exceeds this amount). So setting the number of 1213 | # entries 1 will produce a full collapsed tree by default. 0 is a special value 1214 | # representing an infinite number of entries and will result in a full expanded 1215 | # tree by default. 1216 | # Minimum value: 0, maximum value: 9999, default value: 100. 1217 | # This tag requires that the tag GENERATE_HTML is set to YES. 1218 | 1219 | HTML_INDEX_NUM_ENTRIES = 100 1220 | 1221 | # If the GENERATE_DOCSET tag is set to YES, additional index files will be 1222 | # generated that can be used as input for Apple's Xcode 3 integrated development 1223 | # environment (see: http://developer.apple.com/tools/xcode/), introduced with 1224 | # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a 1225 | # Makefile in the HTML output directory. Running make will produce the docset in 1226 | # that directory and running make install will install the docset in 1227 | # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at 1228 | # startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html 1229 | # for more information. 1230 | # The default value is: NO. 1231 | # This tag requires that the tag GENERATE_HTML is set to YES. 1232 | 1233 | GENERATE_DOCSET = NO 1234 | 1235 | # This tag determines the name of the docset feed. A documentation feed provides 1236 | # an umbrella under which multiple documentation sets from a single provider 1237 | # (such as a company or product suite) can be grouped. 1238 | # The default value is: Doxygen generated docs. 1239 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1240 | 1241 | DOCSET_FEEDNAME = "Doxygen generated docs" 1242 | 1243 | # This tag specifies a string that should uniquely identify the documentation 1244 | # set bundle. This should be a reverse domain-name style string, e.g. 1245 | # com.mycompany.MyDocSet. Doxygen will append .docset to the name. 1246 | # The default value is: org.doxygen.Project. 1247 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1248 | 1249 | DOCSET_BUNDLE_ID = org.doxygen.Project 1250 | 1251 | # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify 1252 | # the documentation publisher. This should be a reverse domain-name style 1253 | # string, e.g. com.mycompany.MyDocSet.documentation. 1254 | # The default value is: org.doxygen.Publisher. 1255 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1256 | 1257 | DOCSET_PUBLISHER_ID = org.doxygen.Publisher 1258 | 1259 | # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. 1260 | # The default value is: Publisher. 1261 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1262 | 1263 | DOCSET_PUBLISHER_NAME = Publisher 1264 | 1265 | # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three 1266 | # additional HTML index files: index.hhp, index.hhc, and index.hhk. The 1267 | # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop 1268 | # (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on 1269 | # Windows. 1270 | # 1271 | # The HTML Help Workshop contains a compiler that can convert all HTML output 1272 | # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML 1273 | # files are now used as the Windows 98 help format, and will replace the old 1274 | # Windows help format (.hlp) on all Windows platforms in the future. Compressed 1275 | # HTML files also contain an index, a table of contents, and you can search for 1276 | # words in the documentation. The HTML workshop also contains a viewer for 1277 | # compressed HTML files. 1278 | # The default value is: NO. 1279 | # This tag requires that the tag GENERATE_HTML is set to YES. 1280 | 1281 | GENERATE_HTMLHELP = NO 1282 | 1283 | # The CHM_FILE tag can be used to specify the file name of the resulting .chm 1284 | # file. You can add a path in front of the file if the result should not be 1285 | # written to the html output directory. 1286 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1287 | 1288 | CHM_FILE = 1289 | 1290 | # The HHC_LOCATION tag can be used to specify the location (absolute path 1291 | # including file name) of the HTML help compiler (hhc.exe). If non-empty, 1292 | # doxygen will try to run the HTML help compiler on the generated index.hhp. 1293 | # The file has to be specified with full path. 1294 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1295 | 1296 | HHC_LOCATION = 1297 | 1298 | # The GENERATE_CHI flag controls if a separate .chi index file is generated 1299 | # (YES) or that it should be included in the master .chm file (NO). 1300 | # The default value is: NO. 1301 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1302 | 1303 | GENERATE_CHI = NO 1304 | 1305 | # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) 1306 | # and project file content. 1307 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1308 | 1309 | CHM_INDEX_ENCODING = 1310 | 1311 | # The BINARY_TOC flag controls whether a binary table of contents is generated 1312 | # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it 1313 | # enables the Previous and Next buttons. 1314 | # The default value is: NO. 1315 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1316 | 1317 | BINARY_TOC = NO 1318 | 1319 | # The TOC_EXPAND flag can be set to YES to add extra items for group members to 1320 | # the table of contents of the HTML help documentation and to the tree view. 1321 | # The default value is: NO. 1322 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1323 | 1324 | TOC_EXPAND = NO 1325 | 1326 | # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and 1327 | # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that 1328 | # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help 1329 | # (.qch) of the generated HTML documentation. 1330 | # The default value is: NO. 1331 | # This tag requires that the tag GENERATE_HTML is set to YES. 1332 | 1333 | GENERATE_QHP = NO 1334 | 1335 | # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify 1336 | # the file name of the resulting .qch file. The path specified is relative to 1337 | # the HTML output folder. 1338 | # This tag requires that the tag GENERATE_QHP is set to YES. 1339 | 1340 | QCH_FILE = 1341 | 1342 | # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help 1343 | # Project output. For more information please see Qt Help Project / Namespace 1344 | # (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). 1345 | # The default value is: org.doxygen.Project. 1346 | # This tag requires that the tag GENERATE_QHP is set to YES. 1347 | 1348 | QHP_NAMESPACE = org.doxygen.Project 1349 | 1350 | # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt 1351 | # Help Project output. For more information please see Qt Help Project / Virtual 1352 | # Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- 1353 | # folders). 1354 | # The default value is: doc. 1355 | # This tag requires that the tag GENERATE_QHP is set to YES. 1356 | 1357 | QHP_VIRTUAL_FOLDER = doc 1358 | 1359 | # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom 1360 | # filter to add. For more information please see Qt Help Project / Custom 1361 | # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- 1362 | # filters). 1363 | # This tag requires that the tag GENERATE_QHP is set to YES. 1364 | 1365 | QHP_CUST_FILTER_NAME = 1366 | 1367 | # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the 1368 | # custom filter to add. For more information please see Qt Help Project / Custom 1369 | # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- 1370 | # filters). 1371 | # This tag requires that the tag GENERATE_QHP is set to YES. 1372 | 1373 | QHP_CUST_FILTER_ATTRS = 1374 | 1375 | # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this 1376 | # project's filter section matches. Qt Help Project / Filter Attributes (see: 1377 | # http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). 1378 | # This tag requires that the tag GENERATE_QHP is set to YES. 1379 | 1380 | QHP_SECT_FILTER_ATTRS = 1381 | 1382 | # The QHG_LOCATION tag can be used to specify the location of Qt's 1383 | # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the 1384 | # generated .qhp file. 1385 | # This tag requires that the tag GENERATE_QHP is set to YES. 1386 | 1387 | QHG_LOCATION = 1388 | 1389 | # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be 1390 | # generated, together with the HTML files, they form an Eclipse help plugin. To 1391 | # install this plugin and make it available under the help contents menu in 1392 | # Eclipse, the contents of the directory containing the HTML and XML files needs 1393 | # to be copied into the plugins directory of eclipse. The name of the directory 1394 | # within the plugins directory should be the same as the ECLIPSE_DOC_ID value. 1395 | # After copying Eclipse needs to be restarted before the help appears. 1396 | # The default value is: NO. 1397 | # This tag requires that the tag GENERATE_HTML is set to YES. 1398 | 1399 | GENERATE_ECLIPSEHELP = NO 1400 | 1401 | # A unique identifier for the Eclipse help plugin. When installing the plugin 1402 | # the directory name containing the HTML and XML files should also have this 1403 | # name. Each documentation set should have its own identifier. 1404 | # The default value is: org.doxygen.Project. 1405 | # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. 1406 | 1407 | ECLIPSE_DOC_ID = org.doxygen.Project 1408 | 1409 | # If you want full control over the layout of the generated HTML pages it might 1410 | # be necessary to disable the index and replace it with your own. The 1411 | # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top 1412 | # of each HTML page. A value of NO enables the index and the value YES disables 1413 | # it. Since the tabs in the index contain the same information as the navigation 1414 | # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. 1415 | # The default value is: NO. 1416 | # This tag requires that the tag GENERATE_HTML is set to YES. 1417 | 1418 | DISABLE_INDEX = NO 1419 | 1420 | # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 1421 | # structure should be generated to display hierarchical information. If the tag 1422 | # value is set to YES, a side panel will be generated containing a tree-like 1423 | # index structure (just like the one that is generated for HTML Help). For this 1424 | # to work a browser that supports JavaScript, DHTML, CSS and frames is required 1425 | # (i.e. any modern browser). Windows users are probably better off using the 1426 | # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can 1427 | # further fine-tune the look of the index. As an example, the default style 1428 | # sheet generated by doxygen has an example that shows how to put an image at 1429 | # the root of the tree instead of the PROJECT_NAME. Since the tree basically has 1430 | # the same information as the tab index, you could consider setting 1431 | # DISABLE_INDEX to YES when enabling this option. 1432 | # The default value is: NO. 1433 | # This tag requires that the tag GENERATE_HTML is set to YES. 1434 | 1435 | GENERATE_TREEVIEW = YES 1436 | 1437 | # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that 1438 | # doxygen will group on one line in the generated HTML documentation. 1439 | # 1440 | # Note that a value of 0 will completely suppress the enum values from appearing 1441 | # in the overview section. 1442 | # Minimum value: 0, maximum value: 20, default value: 4. 1443 | # This tag requires that the tag GENERATE_HTML is set to YES. 1444 | 1445 | ENUM_VALUES_PER_LINE = 4 1446 | 1447 | # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used 1448 | # to set the initial width (in pixels) of the frame in which the tree is shown. 1449 | # Minimum value: 0, maximum value: 1500, default value: 250. 1450 | # This tag requires that the tag GENERATE_HTML is set to YES. 1451 | 1452 | TREEVIEW_WIDTH = 250 1453 | 1454 | # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to 1455 | # external symbols imported via tag files in a separate window. 1456 | # The default value is: NO. 1457 | # This tag requires that the tag GENERATE_HTML is set to YES. 1458 | 1459 | EXT_LINKS_IN_WINDOW = NO 1460 | 1461 | # Use this tag to change the font size of LaTeX formulas included as images in 1462 | # the HTML documentation. When you change the font size after a successful 1463 | # doxygen run you need to manually remove any form_*.png images from the HTML 1464 | # output directory to force them to be regenerated. 1465 | # Minimum value: 8, maximum value: 50, default value: 10. 1466 | # This tag requires that the tag GENERATE_HTML is set to YES. 1467 | 1468 | FORMULA_FONTSIZE = 10 1469 | 1470 | # Use the FORMULA_TRANPARENT tag to determine whether or not the images 1471 | # generated for formulas are transparent PNGs. Transparent PNGs are not 1472 | # supported properly for IE 6.0, but are supported on all modern browsers. 1473 | # 1474 | # Note that when changing this option you need to delete any form_*.png files in 1475 | # the HTML output directory before the changes have effect. 1476 | # The default value is: YES. 1477 | # This tag requires that the tag GENERATE_HTML is set to YES. 1478 | 1479 | FORMULA_TRANSPARENT = YES 1480 | 1481 | # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see 1482 | # http://www.mathjax.org) which uses client side Javascript for the rendering 1483 | # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX 1484 | # installed or if you want to formulas look prettier in the HTML output. When 1485 | # enabled you may also need to install MathJax separately and configure the path 1486 | # to it using the MATHJAX_RELPATH option. 1487 | # The default value is: NO. 1488 | # This tag requires that the tag GENERATE_HTML is set to YES. 1489 | 1490 | USE_MATHJAX = NO 1491 | 1492 | # When MathJax is enabled you can set the default output format to be used for 1493 | # the MathJax output. See the MathJax site (see: 1494 | # http://docs.mathjax.org/en/latest/output.html) for more details. 1495 | # Possible values are: HTML-CSS (which is slower, but has the best 1496 | # compatibility), NativeMML (i.e. MathML) and SVG. 1497 | # The default value is: HTML-CSS. 1498 | # This tag requires that the tag USE_MATHJAX is set to YES. 1499 | 1500 | MATHJAX_FORMAT = HTML-CSS 1501 | 1502 | # When MathJax is enabled you need to specify the location relative to the HTML 1503 | # output directory using the MATHJAX_RELPATH option. The destination directory 1504 | # should contain the MathJax.js script. For instance, if the mathjax directory 1505 | # is located at the same level as the HTML output directory, then 1506 | # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax 1507 | # Content Delivery Network so you can quickly see the result without installing 1508 | # MathJax. However, it is strongly recommended to install a local copy of 1509 | # MathJax from http://www.mathjax.org before deployment. 1510 | # The default value is: http://cdn.mathjax.org/mathjax/latest. 1511 | # This tag requires that the tag USE_MATHJAX is set to YES. 1512 | 1513 | MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest 1514 | 1515 | # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax 1516 | # extension names that should be enabled during MathJax rendering. For example 1517 | # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols 1518 | # This tag requires that the tag USE_MATHJAX is set to YES. 1519 | 1520 | MATHJAX_EXTENSIONS = 1521 | 1522 | # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces 1523 | # of code that will be used on startup of the MathJax code. See the MathJax site 1524 | # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an 1525 | # example see the documentation. 1526 | # This tag requires that the tag USE_MATHJAX is set to YES. 1527 | 1528 | MATHJAX_CODEFILE = 1529 | 1530 | # When the SEARCHENGINE tag is enabled doxygen will generate a search box for 1531 | # the HTML output. The underlying search engine uses javascript and DHTML and 1532 | # should work on any modern browser. Note that when using HTML help 1533 | # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) 1534 | # there is already a search function so this one should typically be disabled. 1535 | # For large projects the javascript based search engine can be slow, then 1536 | # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to 1537 | # search using the keyboard; to jump to the search box use + S 1538 | # (what the is depends on the OS and browser, but it is typically 1539 | # , /