├── .gitignore ├── src-dox ├── movement_mask.png ├── movement_frame.png ├── swirl_75x75_red.jpg ├── movement_with_bbox.png ├── movement_with_contour.png ├── movedetect_youtube_thumbnail.png ├── movement_with_contour_and_bbox.png ├── 03_license.dox ├── CMakeLists.txt ├── footer_doxygen.html ├── 01_mainpage.dox ├── footer_ccoderun.html ├── 02_summary.dox └── Doxyfile.in ├── other ├── movement_test_01.m4v └── movement_test_02.m4v ├── .editorconfig ├── src-lib ├── CMakeLists.txt ├── MoveDetect.cpp └── MoveDetect.hpp ├── src-test ├── CMakeLists.txt └── main.cpp ├── .github └── FUNDING.yml ├── license.txt ├── CMakeLists.txt └── readme.md /.gitignore: -------------------------------------------------------------------------------- 1 | *.kdev4 2 | build 3 | -------------------------------------------------------------------------------- /src-dox/movement_mask.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/stephanecharette/MoveDetect/HEAD/src-dox/movement_mask.png -------------------------------------------------------------------------------- /other/movement_test_01.m4v: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/stephanecharette/MoveDetect/HEAD/other/movement_test_01.m4v -------------------------------------------------------------------------------- /other/movement_test_02.m4v: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/stephanecharette/MoveDetect/HEAD/other/movement_test_02.m4v -------------------------------------------------------------------------------- /src-dox/movement_frame.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/stephanecharette/MoveDetect/HEAD/src-dox/movement_frame.png -------------------------------------------------------------------------------- /src-dox/swirl_75x75_red.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/stephanecharette/MoveDetect/HEAD/src-dox/swirl_75x75_red.jpg -------------------------------------------------------------------------------- /src-dox/movement_with_bbox.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/stephanecharette/MoveDetect/HEAD/src-dox/movement_with_bbox.png -------------------------------------------------------------------------------- /src-dox/movement_with_contour.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/stephanecharette/MoveDetect/HEAD/src-dox/movement_with_contour.png -------------------------------------------------------------------------------- /src-dox/movedetect_youtube_thumbnail.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/stephanecharette/MoveDetect/HEAD/src-dox/movedetect_youtube_thumbnail.png -------------------------------------------------------------------------------- /src-dox/movement_with_contour_and_bbox.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/stephanecharette/MoveDetect/HEAD/src-dox/movement_with_contour_and_bbox.png -------------------------------------------------------------------------------- /.editorconfig: -------------------------------------------------------------------------------- 1 | # https://EditorConfig.org 2 | 3 | # top-most EditorConfig file 4 | root = true 5 | 6 | # Unix-style newlines with a newline ending every file 7 | [*] 8 | end_of_line = lf 9 | charset = utf-8 10 | indent_style = tab 11 | indent_size = 4 12 | trim_trailing_whitespace = true 13 | insert_final_newline = true 14 | 15 | -------------------------------------------------------------------------------- /src-dox/03_license.dox: -------------------------------------------------------------------------------- 1 | /** @page License License 2 | 3 | A copy of the license file (MIT) is included with the @p %MoveDetect source code. The license is reproduced in its entirety here: 4 | 5 |
6 | @htmlinclude "../license.txt" 7 |
8 | 9 | */ 10 | -------------------------------------------------------------------------------- /src-lib/CMakeLists.txt: -------------------------------------------------------------------------------- 1 | # MoveDetect - C++ library to detect movement. 2 | # Copyright 2021 Stephane Charette 3 | # MIT license applies. See "license.txt" for details. 4 | 5 | # static library 6 | ADD_LIBRARY (movedetect STATIC MoveDetect.cpp) 7 | INSTALL (TARGETS movedetect DESTINATION lib) 8 | INSTALL (FILES MoveDetect.hpp DESTINATION include) 9 | -------------------------------------------------------------------------------- /src-test/CMakeLists.txt: -------------------------------------------------------------------------------- 1 | # MoveDetect - C++ library to detect movement. 2 | # Copyright 2021 Stephane Charette 3 | # MIT license applies. See "license.txt" for details. 4 | 5 | # test application 6 | ADD_EXECUTABLE (movement_detection main.cpp) 7 | TARGET_LINK_LIBRARIES (movement_detection PRIVATE Threads::Threads ${OpenCV_LIBS} movedetect) 8 | 9 | -------------------------------------------------------------------------------- /src-dox/CMakeLists.txt: -------------------------------------------------------------------------------- 1 | # MoveDetect - C++ library to detect movement. 2 | # Copyright 2021 Stephane Charette 3 | # MIT license applies. See "license.txt" for details. 4 | 5 | 6 | FIND_PACKAGE ( Doxygen QUIET ) 7 | 8 | IF ( Doxygen_FOUND ) 9 | 10 | CONFIGURE_FILE ( ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile ) 11 | 12 | ADD_CUSTOM_TARGET ( 13 | doc 14 | ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile 15 | WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR} 16 | COMMENT "Generating documentation with Doxygen" VERBATIM ) 17 | 18 | ENDIF ( Doxygen_FOUND ) 19 | -------------------------------------------------------------------------------- /.github/FUNDING.yml: -------------------------------------------------------------------------------- 1 | # These are supported funding model platforms 2 | 3 | github: stephanecharette # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2] 4 | patreon: # Replace with a single Patreon username 5 | open_collective: # Replace with a single Open Collective username 6 | ko_fi: # Replace with a single Ko-fi username 7 | tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel 8 | community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry 9 | liberapay: # Replace with a single Liberapay username 10 | issuehunt: # Replace with a single IssueHunt username 11 | otechie: # Replace with a single Otechie username 12 | custom: ['paypal.me/ccoderun'] # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2'] 13 | -------------------------------------------------------------------------------- /src-dox/footer_doxygen.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 12 | 13 | 14 |
15 | $generatedby   16 | doxygen 17 | $doxygenversion 18 |
19 | 20 | 21 | 22 | -------------------------------------------------------------------------------- /src-dox/01_mainpage.dox: -------------------------------------------------------------------------------- 1 | /** @mainpage %MoveDetect 2 | 3 | @htmlonly[block] 4 | 5 | @endhtmlonly 6 | 7 | This documentation is available here: 8 | @li http://www.ccoderun.ca/programming/doxygen/movedetect/ 9 | 10 | Source code for %MoveDetect is available at https://github.com/stephanecharette/MoveDetect/.
11 | 12 |
13 | %MoveDetect is written by Stéphane Charette d.b.a. C Code Run
14 | © 2021 Stéphane Charette
15 | http://www.ccoderun.ca/
16 | stephane@ccoderun.ca
17 | stephane.charette@gmail.com
18 | Tel. +1-250-769-2759   [Pacific Time, PST/PDT] 19 |
20 | 21 | */ 22 | -------------------------------------------------------------------------------- /license.txt: -------------------------------------------------------------------------------- 1 | Copyright 2021 Stephane Charette 2 | 3 | Permission is hereby granted, free of charge, to any person obtaining a copy 4 | of this software and associated documentation files (the "Software"), to deal 5 | in the Software without restriction, including without limitation the rights 6 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 7 | copies of the Software, and to permit persons to whom the Software is 8 | furnished to do so, subject to the following conditions: 9 | 10 | The above copyright notice and this permission notice shall be included in 11 | all copies or substantial portions of the Software. 12 | 13 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 14 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 15 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 16 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 17 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 18 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 19 | SOFTWARE. 20 | -------------------------------------------------------------------------------- /src-dox/footer_ccoderun.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 12 | 13 | 14 |
15 | $generatedby   16 | doxygen 17 | $doxygenversion 18 |
19 | 20 | 21 | 29 | 30 | 31 | 32 | 33 | -------------------------------------------------------------------------------- /CMakeLists.txt: -------------------------------------------------------------------------------- 1 | # MoveDetect - C++ library to detect movement. 2 | # Copyright 2021 Stephane Charette 3 | # MIT license applies. See "license.txt" for details. 4 | 5 | 6 | CMAKE_MINIMUM_REQUIRED (VERSION 3.0) 7 | 8 | PROJECT (MoveDetect C CXX) 9 | 10 | IF (NOT DEFINED CMAKE_BUILD_TYPE) 11 | SET (CMAKE_BUILD_TYPE Release) 12 | ENDIF () 13 | 14 | SET (CMAKE_CXX_STANDARD 17 ) 15 | SET (CMAKE_CXX_STANDARD_REQUIRED ON ) 16 | SET (CMAKE_CXX_EXTENSIONS OFF ) 17 | 18 | ADD_DEFINITIONS ("-Wall -Wextra -Werror -Wno-unused-parameter") 19 | 20 | FIND_PACKAGE (Threads REQUIRED) 21 | FIND_PACKAGE (OpenCV REQUIRED) 22 | 23 | INCLUDE_DIRECTORIES (${OpenCV_INCLUDE_DIRS}) 24 | INCLUDE_DIRECTORIES (src-lib) 25 | 26 | ADD_SUBDIRECTORY (src-dox) 27 | ADD_SUBDIRECTORY (src-lib) 28 | ADD_SUBDIRECTORY (src-test) 29 | 30 | # create .deb and source tarballs 31 | SET (CPACK_PACKAGE_VENDOR "Stephane Charette") 32 | SET (CPACK_PACKAGE_CONTACT "stephanecharette@gmail.com") 33 | SET (CPACK_PACKAGE_NAME "movedetect") 34 | SET (CPACK_PACKAGE_VERSION "0.0.1") 35 | SET (CPACK_PACKAGE_VERSION_MAJOR "0") 36 | SET (CPACK_PACKAGE_VERSION_MINOR "0") 37 | SET (CPACK_PACKAGE_VERSION_PATCH "1") 38 | SET (CPACK_PACKAGE_DESCRIPTION_SUMMARY "MoveDetect C++ library") 39 | SET (CPACK_PACKAGE_DESCRIPTION "MoveDetect C++ library") 40 | SET (CPACK_PACKAGE_HOMEPAGE_URL "https://www.ccoderun.ca/") 41 | SET (CPACK_GENERATOR "DEB") 42 | SET (CPACK_SOURCE_IGNORE_FILES ".svn" ".kdev4" "build/" "build_and_upload" ) 43 | SET (CPACK_SOURCE_GENERATOR "TGZ;ZIP") 44 | INCLUDE( CPack ) 45 | -------------------------------------------------------------------------------- /src-dox/02_summary.dox: -------------------------------------------------------------------------------- 1 | /** @page Summary Summary 2 | 3 | %MoveDetect uses the standard image processing library OpenCV. You'll need to link against OpenCV to use %MoveDetect. 4 | 5 | To detect movement, you instantiate a @ref MoveDetect::Handler object, and then repeatedly call @ref MoveDetect::Handler::detect() when you have frames to be analyzed. 6 | 7 | The @p detect() method will compare the last few frames and return either @p true or @p false to indicate whether movement was detected. 8 | 9 | Your code would look similar to this: 10 | 11 | ~~~~{.cpp} 12 | #include 13 | 14 | void process_video() 15 | { 16 | MoveDetect::Handler handler; 17 | cv::VideoCapture video("movie.m4v"); 18 | while (true) 19 | { 20 | cv::Mat frame; 21 | video >> frame; 22 | if (frame.emtpy()) 23 | { 24 | break; 25 | } 26 | 27 | const bool movement_detected = handler.detect(frame); 28 | if (movement_detected) 29 | { 30 | do_something_movement_detected(frame); 31 | } 32 | else 33 | { 34 | do_something_no_movement(frame); 35 | } 36 | } 37 | } 38 | ~~~~ 39 | 40 | There are many options, including thresholds for the amount of movement required, as well as generating a mask, bounding boxes, and contours. 41 | 42 | Several key options to look into: 43 | 44 | Configuration Item | Image 45 | ------------------------------------------------------------------------------------|------ 46 | @ref MoveDetect::Handler::psnr_threshold |   47 | @ref MoveDetect::Handler::key_frame_frequency |   48 | @ref MoveDetect::Handler::number_of_control_frames |   49 | original video frame | @image html movement_frame.png 50 | @ref MoveDetect::Handler::mask_enabled
@ref MoveDetect::Handler::mask | @image html movement_mask.png 51 | @ref MoveDetect::Handler::bbox_enabled
@ref MoveDetect::Handler::output | @image html movement_with_bbox.png 52 | @ref MoveDetect::Handler::contours_enabled
@ref MoveDetect::Handler::output | @image html movement_with_contour.png 53 | 54 | */ 55 | -------------------------------------------------------------------------------- /readme.md: -------------------------------------------------------------------------------- 1 | # What is MoveDetect? 2 | 3 | MoveDetect is a C++ library that detects movement in video frames and returns a "true" or "false" value. 4 | 5 | [![MoveDetect introduction](src-dox/movedetect_youtube_thumbnail.png)](https://www.youtube.com/watch?v=XBnYu5SL8Oo) 6 | 7 | # License 8 | 9 | MoveDetect is open source and published using the MIT license. Meaning you can use it in your commercial application. See license.txt for details. 10 | 11 | # How to Build MoveDetect 12 | 13 | MoveDetect requires OpenCV. On Ubuntu: 14 | 15 | sudo apt-get install cmake build-essential libopencv-dev 16 | cd ~/src 17 | git clone https://github.com/stephanecharette/MoveDetect.git 18 | cd MoveDetect 19 | mkdir build 20 | cd build 21 | cmake -DCMAKE_BUILD_TYPE=Release .. 22 | make 23 | make package 24 | 25 | # Example Code 26 | 27 | MoveDetect has many configuration settings to modify the detection threshold, and optionally draw the mask output, bounding boxes, and and contour lines. 28 | 29 | ![MoveDetect with bounding boxes and contours](src-dox/movement_with_contour_and_bbox.png) 30 | 31 | This is how to use it: 32 | 33 | // include MoveDetect.hpp and link against MoveDetect and OpenCV 34 | // 35 | MoveDetect::Handler handler; 36 | cv::VideoCapture video("movie.m4v"); 37 | while (true) 38 | { 39 | cv::Mat frame; 40 | video >> frame; 41 | if (frame.empty()) 42 | { 43 | break; 44 | } 45 | // 46 | const bool movement_detected = handler.detect(frame); 47 | if (movement_detected) 48 | { 49 | // ... 50 | } 51 | } 52 | 53 | # C++ API Doxygen Output 54 | 55 | The official MoveDetect documentation and web site is at . 56 | 57 | Some links to specific useful pages: 58 | 59 | - [`MoveDetect::Handler::detect()`](https://www.ccoderun.ca/programming/doxygen/movedetect/classMoveDetect_1_1Handler.html#a73d4d0c87f860a688bd1af02f40bd6e0) 60 | - [`MoveDetect::Handler::mask`](https://www.ccoderun.ca/programming/doxygen/movedetect/classMoveDetect_1_1Handler.html#a6f999f42ec318f0ec6e94414a9aecc73) 61 | - [`MoveDetect::Handler::output`](https://www.ccoderun.ca/programming/doxygen/movedetect/classMoveDetect_1_1Handler.html#aa581c0e65fd8bece68e15feaadeaea6c) 62 | -------------------------------------------------------------------------------- /src-test/main.cpp: -------------------------------------------------------------------------------- 1 | // MoveDetect - C++ library to detect movement. 2 | // Copyright 2021 Stephane Charette 3 | // MIT license applies. See "license.txt" for details. 4 | 5 | #include "MoveDetect.hpp" 6 | 7 | 8 | int main(int argc, char *argv[]) 9 | { 10 | std::cout << "Simple test application for the Movement Detection library." << std::endl; 11 | 12 | if (argc < 2) 13 | { 14 | std::cout 15 | << "Usage:" << std::endl 16 | << "\t" << argv[0] << " [ ...]" << std::endl; 17 | return 1; 18 | } 19 | 20 | for (int video_index = 1; video_index < argc; video_index ++) 21 | { 22 | cv::VideoCapture video_input(argv[video_index]); 23 | if (video_input.isOpened() == false) 24 | { 25 | std::cout << "ERROR: failed to open " << argv[video_index] << std::endl; 26 | continue; 27 | } 28 | 29 | const bool save_output_video = false; 30 | const double zoom_factor = 0.85; 31 | const double input_fps = video_input.get(cv::VideoCaptureProperties::CAP_PROP_FPS ); 32 | const double original_width = video_input.get(cv::VideoCaptureProperties::CAP_PROP_FRAME_WIDTH ); 33 | const double original_height = video_input.get(cv::VideoCaptureProperties::CAP_PROP_FRAME_HEIGHT ); 34 | const double total_frames = video_input.get(cv::VideoCaptureProperties::CAP_PROP_FRAME_COUNT ); 35 | const double length_in_seconds = total_frames / input_fps; 36 | const int desired_width = std::round(zoom_factor * original_width); 37 | const int desired_height = std::round(zoom_factor * original_height); 38 | const size_t frame_length_ns = std::round(1000000000.0 / input_fps); 39 | const auto desired_frame_size = cv::Size(desired_width, desired_height); 40 | 41 | std::cout 42 | << "" << std::endl 43 | << "Input video .......... " << argv[video_index] << std::endl 44 | << "Number of frames ..... " << total_frames << std::endl 45 | << "Length of video ...... " << length_in_seconds << " seconds" << std::endl 46 | << "Zoom factor .......... " << zoom_factor << std::endl 47 | << "Original dimensions .. " << original_width << "x" << original_height << std::endl 48 | << "Desired dimensions ... " << desired_width << "x" << desired_height << std::endl 49 | << "Frame rate ........... " << input_fps << " FPS" << std::endl 50 | << "Frame interval ....... " << frame_length_ns << " nanoseconds" << std::endl 51 | << "Frame interval ....... " << (frame_length_ns / 1000000.0) << " milliseconds" << std::endl; 52 | 53 | MoveDetect::Handler movement_detection; 54 | movement_detection.mask_enabled = true; 55 | movement_detection.bbox_enabled = true; 56 | movement_detection.contours_enabled = true; 57 | movement_detection.contours_size = 4; 58 | 59 | // If you are generating either the contours or the bounding boxes, 60 | // then you'll want to increase the frequency and keep more frames. 61 | movement_detection.key_frame_frequency = 1; 62 | movement_detection.number_of_control_frames = 10; 63 | 64 | // Larger "thumbnails" improves precision, but takes longer to process each frame. 65 | movement_detection.thumbnail_ratio = 0.25; 66 | 67 | // More expensive but slightly prettier anti-aliased lines. 68 | movement_detection.line_type = cv::LINE_AA; 69 | 70 | // Lower threshold ignore smaller changes, while higher threshold will trigger on smaller movement changes. 71 | // movement_detection.psnr_threshold = 28.0; 72 | 73 | // Create a single large mat. This will be used to combine the 3 images (original frame, mask, output). 74 | cv::Mat mat(desired_height, 3 * desired_width, CV_8UC3); 75 | 76 | // create 3 RoI which we'll use to copy the specific images into the large mat defined on the line above 77 | cv::Mat frame = mat(cv::Rect({desired_width * 0, 0}, desired_frame_size)); 78 | cv::Mat mask = mat(cv::Rect({desired_width * 1, 0}, desired_frame_size)); 79 | cv::Mat output = mat(cv::Rect({desired_width * 2, 0}, desired_frame_size)); 80 | 81 | cv::VideoWriter video_output; 82 | if (save_output_video) 83 | { 84 | video_output.open("output_" + std::to_string(std::time(nullptr)) + ".mp4", cv::VideoWriter::fourcc('m', 'p', '4', 'v'), input_fps, mat.size()); 85 | } 86 | 87 | const std::chrono::high_resolution_clock::duration duration = std::chrono::nanoseconds(frame_length_ns); 88 | const std::chrono::high_resolution_clock::time_point start_time = std::chrono::high_resolution_clock::now(); 89 | std::chrono::high_resolution_clock::time_point next_frame_time_point = start_time + duration; 90 | 91 | size_t frame_index = 0; 92 | while (true) 93 | { 94 | cv::Mat tmp; 95 | video_input >> tmp; 96 | if (tmp.empty()) 97 | { 98 | break; 99 | } 100 | 101 | cv::resize(tmp, frame, desired_frame_size, 0, 0, cv::INTER_LINEAR); 102 | 103 | const bool moved = movement_detection.detect(frame); 104 | if (movement_detection.transition_detected) 105 | { 106 | std::cout << "-> starting at index #" << frame_index << ": moved=" << (moved ? "TRUE" : "FALSE") << std::endl; 107 | } 108 | 109 | // The mask is a binary image. We need to convert it to BGR so 110 | // we can combine it with our large mat that we'll then display. 111 | cv::cvtColor(movement_detection.mask, tmp, cv::COLOR_GRAY2BGR); 112 | tmp.copyTo(mask); 113 | 114 | movement_detection.output.copyTo(output); 115 | 116 | cv::imshow("MoveDetect", mat); 117 | 118 | if (video_output.isOpened()) 119 | { 120 | video_output.write(mat); 121 | } 122 | 123 | // cv::imwrite("frame_" + std::to_string(frame_index) + ".png", mat, {cv::ImwriteFlags::IMWRITE_PNG_COMPRESSION, 7}); 124 | // cv::imwrite("frame_" + std::to_string(frame_index) + ".jpg", mat, {cv::ImwriteFlags::IMWRITE_JPEG_QUALITY, 70}); 125 | 126 | // wait for the right amount of time so the video is played back at the right FPS 127 | const std::chrono::high_resolution_clock::time_point now = std::chrono::high_resolution_clock::now(); 128 | const int milliseconds_to_wait = std::chrono::duration_cast(next_frame_time_point - now).count(); 129 | if (milliseconds_to_wait > 0) 130 | { 131 | cv::waitKey(milliseconds_to_wait); 132 | } 133 | next_frame_time_point += duration; 134 | 135 | if (now > next_frame_time_point) 136 | { 137 | // we've fallen too far behind, reset the time we need to show the next frame 138 | next_frame_time_point = now + duration; 139 | } 140 | 141 | frame_index ++; 142 | } 143 | 144 | const std::chrono::high_resolution_clock::time_point end_time = std::chrono::high_resolution_clock::now(); 145 | 146 | std::cout 147 | << "-> processed " << frame_index << " frames" << std::endl 148 | << "-> time elapsed: " << std::chrono::duration_cast(end_time - start_time).count() << " milliseconds" << std::endl; 149 | } 150 | 151 | return 0; 152 | } 153 | -------------------------------------------------------------------------------- /src-lib/MoveDetect.cpp: -------------------------------------------------------------------------------- 1 | // MoveDetect - C++ library to detect movement. 2 | // Copyright 2021 Stephane Charette 3 | // MIT license applies. See "license.txt" for details. 4 | 5 | #include "MoveDetect.hpp" 6 | #include 7 | 8 | 9 | double MoveDetect::psnr(const cv::Mat & src, const cv::Mat & dst) 10 | { 11 | if (src.empty() || dst.empty()) 12 | { 13 | throw std::invalid_argument("cannot calculate psnr using empty image"); 14 | } 15 | 16 | if (src.type() != dst.type() || 17 | src.cols != dst.cols || 18 | src.rows != dst.rows) 19 | { 20 | throw std::invalid_argument("src and dst images cannot be compared"); 21 | } 22 | 23 | cv::Mat s1; 24 | cv::absdiff(src, dst, s1); // |src - dst| 25 | s1.convertTo(s1, CV_32F); // cannot make a square on 8 bits 26 | s1 = s1.mul(s1); // |src - dst|^2 27 | cv::Scalar s = sum(s1); // sum elements per channel 28 | const double sse = s.val[0] + s.val[1] + s.val[2]; // sum channels 29 | 30 | if (sse <= 1e-10) // for small values return zero 31 | { 32 | return 0.0; 33 | } 34 | 35 | const double mse = sse / static_cast(src.channels() * src.total()); 36 | const double psnr = 10.0 * std::log10((255 * 255) / mse); 37 | 38 | return psnr; 39 | } 40 | 41 | 42 | cv::Mat MoveDetect::simple_colour_balance(const cv::Mat & src) 43 | { 44 | if (src.empty() || src.channels() != 3) 45 | { 46 | throw std::invalid_argument("cannot colour balance the given image"); 47 | } 48 | 49 | const float full_percent = 1.0; 50 | const float half_percent = full_percent / 200.0f; 51 | 52 | std::vector tmpsplit; 53 | cv::split(src, tmpsplit); 54 | 55 | for(size_t idx = 0; idx < 3; idx ++) 56 | { 57 | // find the low and high precentile values (based on the input percentile) 58 | cv::Mat flat; 59 | tmpsplit[idx].reshape(1,1).copyTo(flat); 60 | cv::sort(flat, flat, cv::SORT_EVERY_ROW + cv::SORT_ASCENDING); 61 | const int lo = flat.at(cvFloor(((float)flat.cols) * (0.0 + half_percent))); 62 | const int hi = flat.at( cvCeil(((float)flat.cols) * (1.0 - half_percent))); 63 | 64 | // saturate below the low percentile and above the high percentile 65 | tmpsplit[idx].setTo(lo, tmpsplit[idx] < lo); 66 | tmpsplit[idx].setTo(hi, tmpsplit[idx] > hi); 67 | 68 | // scale the channel 69 | cv::normalize(tmpsplit[idx], tmpsplit[idx], 0, 255, cv::NORM_MINMAX); 70 | } 71 | 72 | cv::Mat output; 73 | cv::merge(tmpsplit, output); 74 | 75 | return output; 76 | } 77 | 78 | 79 | MoveDetect::Handler::Handler() 80 | { 81 | clear(); 82 | 83 | return; 84 | } 85 | 86 | 87 | MoveDetect::Handler::~Handler() 88 | { 89 | return; 90 | } 91 | 92 | 93 | bool MoveDetect::Handler::empty() const 94 | { 95 | return control.empty(); 96 | } 97 | 98 | 99 | MoveDetect::Handler & MoveDetect::Handler::clear() 100 | { 101 | control.clear(); 102 | movement_detected = false; 103 | transition_detected = false; 104 | next_frame_index = 0; 105 | next_key_frame = 0; 106 | key_frame_frequency = 10; 107 | number_of_control_frames = 4; 108 | psnr_threshold = 32.0; 109 | most_recent_psnr_score = 0.0; 110 | thumbnail_ratio = 0.05; 111 | thumbnail_size = cv::Size(0, 0); 112 | frame_index_with_movement = 0; 113 | movement_last_detected = std::chrono::high_resolution_clock::time_point(); 114 | mask_enabled = false; 115 | mask = cv::Mat(); 116 | line_type = cv::LINE_4; 117 | contours_enabled = false; 118 | contours_size = 1; 119 | bbox_enabled = false; 120 | bbox_size = 1; 121 | output = cv::Mat(); 122 | 123 | return *this; 124 | } 125 | 126 | 127 | bool MoveDetect::Handler::detect(cv::Mat & next_image) 128 | { 129 | return detect(next_frame_index, next_image); 130 | } 131 | 132 | 133 | bool MoveDetect::Handler::detect(const size_t frame_index, cv::Mat & image) 134 | { 135 | if (image.empty()) 136 | { 137 | throw std::invalid_argument("cannot detect using an empty image"); 138 | } 139 | 140 | if (thumbnail_size.area() <= 1) 141 | { 142 | // we need to figure out a decent width and height to use for the thumbnails 143 | thumbnail_ratio = std::clamp(thumbnail_ratio, 0.01, 1.0); 144 | thumbnail_size.width = image.cols * thumbnail_ratio; 145 | thumbnail_size.height = image.rows * thumbnail_ratio; 146 | } 147 | 148 | if (contours_enabled or bbox_enabled) 149 | { 150 | // bounding box requires the mask to be created 151 | mask_enabled = true; 152 | } 153 | 154 | cv::Mat scb = image; //simple_colour_balance(image); 155 | cv::Mat thumbnail; 156 | cv::resize(scb, thumbnail, thumbnail_size, 0, 0, cv::INTER_AREA); 157 | 158 | // Now compare this image against all the other control images we've kept. 159 | // 160 | // Do the comparison in reverse order, starting with the most recent thumbnail 161 | // since if there was movement, that would be the first place we'd detect it. 162 | const bool previous_movement_detected = movement_detected; 163 | movement_detected = false; 164 | for (auto iter = control.rbegin(); iter != control.rend(); iter ++) 165 | { 166 | // const auto & key = iter->first; // the index value 167 | const auto & val = iter->second; // the stored thumbnail for the given index 168 | 169 | most_recent_psnr_score = psnr(val, thumbnail); 170 | if (most_recent_psnr_score < psnr_threshold) 171 | { 172 | movement_detected = true; 173 | movement_last_detected = std::chrono::high_resolution_clock::now(); 174 | frame_index_with_movement = frame_index; 175 | 176 | if (mask_enabled) 177 | { 178 | cv::Mat differences; 179 | cv::absdiff(val, thumbnail, differences); 180 | 181 | // This gives us a very tiny 3-channel image. 182 | // Now resize it to match the original image size. 183 | 184 | cv::Mat differences_resized; 185 | cv::resize(differences, differences_resized, image.size(), 0, 0, cv::INTER_CUBIC); 186 | 187 | // We'd like to generate a binary threshold, but that requires us to convert 188 | // the image to greyscale first. 189 | cv::Mat greyscale; 190 | cv::cvtColor(differences_resized, greyscale, cv::COLOR_BGR2GRAY); 191 | cv::Mat threshold; 192 | cv::threshold(greyscale, threshold, 0.0, 255.0, cv::THRESH_BINARY | cv::THRESH_OTSU); 193 | 194 | // And finally we dilate + erode the results to combine regions. 195 | cv::Mat dilated; 196 | cv::dilate(threshold, dilated, cv::Mat(), cv::Point(-1, -1), 10); 197 | cv::Mat eroded; 198 | cv::erode(dilated, eroded, cv::Mat(), cv::Point(-1, -1), 10); 199 | 200 | mask = eroded; 201 | } 202 | 203 | break; 204 | } 205 | } 206 | 207 | transition_detected = (previous_movement_detected != movement_detected); 208 | 209 | if (mask_enabled) 210 | { 211 | // if the caller is expecting a mask, but we have no movement then reset the mask to a "blank" image 212 | if (mask.empty() or (transition_detected and movement_detected == false)) 213 | { 214 | mask = cv::Mat(image.size(), CV_8UC1, {0, 0, 0}); 215 | } 216 | 217 | if (contours_enabled or bbox_enabled) 218 | { 219 | output = image.clone(); 220 | 221 | if (contours_enabled) 222 | { 223 | typedef std::vector Contour; 224 | typedef std::vector VContours; 225 | typedef std::vector Hierarchy; 226 | 227 | VContours contours; 228 | Hierarchy hierarchy; 229 | cv::findContours(mask, contours, hierarchy, cv::RETR_EXTERNAL, cv::CHAIN_APPROX_SIMPLE); 230 | for (auto & contour : contours) 231 | { 232 | cv::polylines(output, contour, true, {0, 0, 255}, contours_size, line_type); 233 | } 234 | 235 | } 236 | 237 | if (bbox_enabled) 238 | { 239 | cv::rectangle(output, cv::boundingRect(mask), {0, 255, 255}, bbox_size, line_type); 240 | } 241 | } 242 | } 243 | 244 | // see if we need to keep this image as a "key" frame 245 | if (frame_index >= next_key_frame or control.size() < number_of_control_frames) 246 | { 247 | control[frame_index] = thumbnail; 248 | while (control.size() > number_of_control_frames) 249 | { 250 | auto iter = control.begin(); 251 | control.erase(iter); 252 | } 253 | next_key_frame = frame_index + key_frame_frequency; 254 | } 255 | 256 | next_frame_index = frame_index + 1; 257 | 258 | return movement_detected; 259 | } 260 | -------------------------------------------------------------------------------- /src-lib/MoveDetect.hpp: -------------------------------------------------------------------------------- 1 | // MoveDetect -- Library to detect whether movement can be detected between two images or video frames. 2 | // Copyright 2021 Stephane Charette 3 | // MIT license applies. See "license.txt" for details. 4 | 5 | #pragma once 6 | 7 | #include 8 | #include 9 | #include 10 | 11 | 12 | namespace MoveDetect 13 | { 14 | /** Peak Signal To Noise is an algorithm which as a side effect can be used to compare two similar images. 15 | * 16 | * Source: https://docs.opencv.org/master/d5/dc4/tutorial_video_input_psnr_ssim.html 17 | * 18 | * @return Values higher than 30 indicate very similar images. Values < 30 indicate changes were detected. 19 | * The closer to zero, the more changes have been detected. 20 | */ 21 | double psnr(const cv::Mat & src, const cv::Mat & dst); 22 | 23 | 24 | /** Simple colour balancing. 25 | * 26 | * @li Source: https://stackoverflow.com/a/49481583/13022 27 | * @li Source: http://web.stanford.edu/~sujason/ColorBalancing/simplestcb.html 28 | * @li Source: http://www.morethantechnical.com/2015/01/14/simplest-color-balance-with-opencv-wcode/ 29 | */ 30 | cv::Mat simple_colour_balance(const cv::Mat & src); 31 | 32 | 33 | /** We keep several control thumbnail images to compare against. This typedef defines the map that tracks these 34 | * thumbnails. The key is the frame index, the value is the thumbnail itself. 35 | */ 36 | typedef std::map ControlMap; 37 | 38 | /** This class is used to store some image thumbnails, configuration settings, and also contains the @ref detect() 39 | * method which is used to determine if a video frame has movement. @see @ref Summary 40 | */ 41 | class Handler 42 | { 43 | public: 44 | 45 | /// Constructor. 46 | Handler(); 47 | 48 | /// Destructor. 49 | virtual ~Handler(); 50 | 51 | /// Determine if this handler has any images against which to check for movement. 52 | bool empty() const; 53 | 54 | /** Clear out the object and get it ready to be reused. This will reset all the configuration settings to their 55 | * default values. 56 | */ 57 | Handler & clear(); 58 | 59 | /** Detect whether there is any movement in this next image. This assumes the images or frames are sequential. 60 | * If the image provided is not the next sequential image, then use the other @ref detect() where a frame index 61 | * is provided. 62 | * 63 | * @return @p true if movement is detected, otherwise returns @p false. 64 | * 65 | * @warning This method adds and removes image thumbnails from a @p std::map, so it must not be called simultaneously 66 | * from multiple threads. 67 | * 68 | * @see @ref movement_detected 69 | * @see @ref transition_detected 70 | * 71 | * Given this video frame of someone walking across a parking lot: 72 | * 73 | * @image html movement_frame.png 74 | * 75 | * When @ref contours_enabled and/or @ref bbox_enabled have been enabled, in addition to returning @p true to indicate 76 | * that movement was detected, the @ref output will be similar to this: 77 | * 78 | * @image html movement_with_contour_and_bbox.png 79 | */ 80 | bool detect(cv::Mat & next_image); 81 | 82 | /** Detect whether there is any movement in an arbritrary image frame. 83 | * The frame index must be greater than or equal to @ref next_frame_index. 84 | * 85 | * @warning This method adds and removes image thumbnails from a @p std::map, so it must not be called simultaneously 86 | * from multiple threads. 87 | * 88 | * @return @p true if movement is detected, otherwise returns @p false. 89 | * 90 | * @see @ref movement_detected 91 | * @see @ref transition_detected 92 | */ 93 | bool detect(const size_t frame_index, cv::Mat & image); 94 | 95 | /// This is the same as the value returne by @ref detect() and indicates whether the last image seen showed movement. 96 | bool movement_detected; 97 | 98 | /** When @ref movement_detected is toggled between @p true and @p false, the @p transition_detected variable will be 99 | * set to @p true. Callers can use this to determine when a video experiences a significant state change. 100 | */ 101 | bool transition_detected; 102 | 103 | /// The index of the next frame expected to be seen by @ref detect(). 104 | size_t next_frame_index; 105 | 106 | /** The next index when this library will store a thumbnail in the @ref control object. This is handled internally, 107 | * and users of the library shouldn't have to modify or reference this value. @see @ref key_frame_frequency 108 | */ 109 | size_t next_key_frame; 110 | 111 | /** This determines how often new frames are inserted into @ref control. Default value is @p 10, which for videos 112 | * recorded at 30 FPS means 3 key frames per second. If masking is enabled (@ref mask_enabled) and the mask is 113 | * displayed or used to show bounding boxes, then this value should be small to record many key frames per second. 114 | * If masking is disabled, then this value may be set to a much higher value, such as the same as the original FPS. 115 | * 116 | * @see @ref number_of_control_frames 117 | */ 118 | size_t key_frame_frequency; 119 | 120 | /** The number of frames to which we want to hold on to in @ref control. Images will be compared against all these 121 | * control frames to determine if there was any movement, so you'll want to keep it short. Default value is @p 4. 122 | */ 123 | size_t number_of_control_frames; 124 | 125 | /** The threshold value below which it is assumed that movement has been detected. 126 | * Default value is @p 32.0. @see @ref psnr() 127 | */ 128 | double psnr_threshold; 129 | 130 | /// The PSNR value received from the most recent call to @ref detect(). @see @ref psnr() 131 | double most_recent_psnr_score; 132 | 133 | /** How much the image will be reduced to generate the thumbnails. The larger the thumbnail, the more precise the 134 | * detection, but the more processing needs to be done for every frame. And if it is made too large, the library 135 | * will pick up image artifacts or subtle tiny changes and think that movement was detected. 136 | * Default value is @p 0.05, meaning the width and height will be reduced to 5% of the original image size. 137 | */ 138 | double thumbnail_ratio; 139 | 140 | /// The size of the thumbnail that will be generated. Instead of modifying this value, see @ref thumbnail_ratio. 141 | cv::Size thumbnail_size; 142 | 143 | /// The most recent frame index where movement was detected. @see @ref movement_last_detected 144 | size_t frame_index_with_movement; 145 | 146 | /// The timestamp when @ref detect() last returned @p true. 147 | std::chrono::high_resolution_clock::time_point movement_last_detected; 148 | 149 | /** All of the key control thumbnail images are stored in this map. When calling @ref detect(), the images are 150 | * compared against the thumbnails stored within. 151 | */ 152 | ControlMap control; 153 | 154 | /** Set to @p true to get the library to create a mask showing where movement was detected. 155 | * The default value for @p mask_enabled is @p false. @see @ref mask 156 | */ 157 | bool mask_enabled; 158 | 159 | /** When @ref mask_enabled is enabled, the result is saved to @p mask. This is a binary 1-channel image, 160 | * OpenCV type @p CV_8UC1, where @p 0 is the background and @p 1 is where movement is detected. 161 | * 162 | * Given this video frame of someone walking across a parking lot: 163 | * 164 | * @image html movement_frame.png 165 | * 166 | * When @p mask_enabled has been set, in addition to @ref detect() returning @p true when movement is detected 167 | * the @p mask will look similar to this: 168 | * 169 | * @image html movement_mask.png 170 | */ 171 | cv::Mat mask; 172 | 173 | /** The type of line type drawing OpenCV will use if @ref contours_enabled or @ref bbox_enabled have been set. 174 | * Set this to @p cv::LINE_AA to get prettier anti-alised lines. Default is @p cv::LINE_4. 175 | */ 176 | cv::LineTypes line_type; 177 | 178 | /** Set to @p true to get the library to draw the mask contours onto the output image. If enabled, 179 | * this will also enable @ref mask_enabled as it requires the @ref mask. @see @ref output 180 | * 181 | * Given this video frame of someone walking across a parking lot: 182 | * 183 | * @image html movement_frame.png 184 | * 185 | * When @p contours_enabled has been set, in addition to @ref detect() returning @p true when movement is detected 186 | * the output image will look similar to this: 187 | * 188 | * @image html movement_with_contour.png 189 | */ 190 | bool contours_enabled; 191 | 192 | /** The width of the line to use when drawing contours. This is only used when @ref contours_enabled has been set. 193 | * The default contours size is @p 1. @see @ref output 194 | */ 195 | int contours_size; 196 | 197 | /** Set to @p true to get the library to draw a bounding box around any detected movement. If enabled, 198 | * this will also enable @ref mask_enabled as it requires the @ref mask. @see @ref output 199 | * 200 | * Given this video frame of someone walking across a parking lot: 201 | * 202 | * @image html movement_frame.png 203 | * 204 | * When @p bbox_enabled has been set, in addition to @ref detect() returning @p true when movement is detected the 205 | * output image will look similar to this: 206 | * 207 | * @image html movement_with_bbox.png 208 | */ 209 | bool bbox_enabled; 210 | 211 | /** The width of the line to use when drawing the bounding box. This is only used when @ref bbox_enabled has been 212 | * set. The default line size is @p 1. @see @ref output 213 | */ 214 | int bbox_size; 215 | 216 | /** When either @ref contours_enabled or @ref bbox_enabled is enabled, the resulting image is stored in @p output. 217 | * 218 | * Given this video frame of someone walking across a parking lot: 219 | * 220 | * @image html movement_frame.png 221 | * 222 | * When both @ref contours_enabled and @ref bbox_enabled have been set, in addition to @ref detect() returning 223 | * @p true when movement is detected the output image will look similar to this: 224 | * 225 | * @image html movement_with_contour_and_bbox.png 226 | */ 227 | cv::Mat output; 228 | }; 229 | } 230 | -------------------------------------------------------------------------------- /src-dox/Doxyfile.in: -------------------------------------------------------------------------------- 1 | # Doxyfile 1.8.17 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 configuration 21 | # file that follow. The default is UTF-8 which is also the encoding used for all 22 | # text before the first occurrence of this tag. Doxygen uses libiconv (or the 23 | # iconv built into libc) for the transcoding. See 24 | # https://www.gnu.org/software/libiconv/ 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 = "MoveDetect" 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 = v0.0.1 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 = "C++ library to detect movement in video frames" 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 = ${CMAKE_CURRENT_SOURCE_DIR}/swirl_75x75_red.jpg 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 = 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 = YES 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 | # The OUTPUT_TEXT_DIRECTION tag is used to specify the direction in which all 97 | # documentation generated by doxygen is written. Doxygen will use this 98 | # information to generate all generated output in the proper direction. 99 | # Possible values are: None, LTR, RTL and Context. 100 | # The default value is: None. 101 | 102 | OUTPUT_TEXT_DIRECTION = None 103 | 104 | # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member 105 | # descriptions after the members that are listed in the file and class 106 | # documentation (similar to Javadoc). Set to NO to disable this. 107 | # The default value is: YES. 108 | 109 | BRIEF_MEMBER_DESC = YES 110 | 111 | # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief 112 | # description of a member or function before the detailed description 113 | # 114 | # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the 115 | # brief descriptions will be completely suppressed. 116 | # The default value is: YES. 117 | 118 | REPEAT_BRIEF = YES 119 | 120 | # This tag implements a quasi-intelligent brief description abbreviator that is 121 | # used to form the text in various listings. Each string in this list, if found 122 | # as the leading text of the brief description, will be stripped from the text 123 | # and the result, after processing the whole list, is used as the annotated 124 | # text. Otherwise, the brief description is used as-is. If left blank, the 125 | # following values are used ($name is automatically replaced with the name of 126 | # the entity):The $name class, The $name widget, The $name file, is, provides, 127 | # specifies, contains, represents, a, an and the. 128 | 129 | ABBREVIATE_BRIEF = "The $name class" \ 130 | "The $name widget" \ 131 | "The $name file" \ 132 | is \ 133 | provides \ 134 | specifies \ 135 | contains \ 136 | represents \ 137 | a \ 138 | an \ 139 | the 140 | 141 | # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then 142 | # doxygen will generate a detailed section even if there is only a brief 143 | # description. 144 | # The default value is: NO. 145 | 146 | ALWAYS_DETAILED_SEC = YES 147 | 148 | # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all 149 | # inherited members of a class in the documentation of that class as if those 150 | # members were ordinary class members. Constructors, destructors and assignment 151 | # operators of the base classes will not be shown. 152 | # The default value is: NO. 153 | 154 | INLINE_INHERITED_MEMB = YES 155 | 156 | # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path 157 | # before files name in the file list and in the header files. If set to NO the 158 | # shortest path that makes the file name unique will be used 159 | # The default value is: YES. 160 | 161 | FULL_PATH_NAMES = NO 162 | 163 | # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. 164 | # Stripping is only done if one of the specified strings matches the left-hand 165 | # part of the path. The tag can be used to show relative paths in the file list. 166 | # If left blank the directory from which doxygen is run is used as the path to 167 | # strip. 168 | # 169 | # Note that you can specify absolute paths here, but also relative paths, which 170 | # will be relative from the directory where doxygen is started. 171 | # This tag requires that the tag FULL_PATH_NAMES is set to YES. 172 | 173 | STRIP_FROM_PATH = ${CMAKE_HOME_DIRECTORY} 174 | 175 | # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the 176 | # path mentioned in the documentation of a class, which tells the reader which 177 | # header file to include in order to use a class. If left blank only the name of 178 | # the header file containing the class definition is used. Otherwise one should 179 | # specify the list of include paths that are normally passed to the compiler 180 | # using the -I flag. 181 | 182 | STRIP_FROM_INC_PATH = 183 | 184 | # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but 185 | # less readable) file names. This can be useful is your file systems doesn't 186 | # support long names like on DOS, Mac, or CD-ROM. 187 | # The default value is: NO. 188 | 189 | SHORT_NAMES = NO 190 | 191 | # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the 192 | # first line (until the first dot) of a Javadoc-style comment as the brief 193 | # description. If set to NO, the Javadoc-style will behave just like regular Qt- 194 | # style comments (thus requiring an explicit @brief command for a brief 195 | # description.) 196 | # The default value is: NO. 197 | 198 | JAVADOC_AUTOBRIEF = YES 199 | 200 | # If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line 201 | # such as 202 | # /*************** 203 | # as being the beginning of a Javadoc-style comment "banner". If set to NO, the 204 | # Javadoc-style will behave just like regular comments and it will not be 205 | # interpreted by doxygen. 206 | # The default value is: NO. 207 | 208 | JAVADOC_BANNER = NO 209 | 210 | # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first 211 | # line (until the first dot) of a Qt-style comment as the brief description. If 212 | # set to NO, the Qt-style will behave just like regular Qt-style comments (thus 213 | # requiring an explicit \brief command for a brief description.) 214 | # The default value is: NO. 215 | 216 | QT_AUTOBRIEF = NO 217 | 218 | # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a 219 | # multi-line C++ special comment block (i.e. a block of //! or /// comments) as 220 | # a brief description. This used to be the default behavior. The new default is 221 | # to treat a multi-line C++ comment block as a detailed description. Set this 222 | # tag to YES if you prefer the old behavior instead. 223 | # 224 | # Note that setting this tag to YES also means that rational rose comments are 225 | # not recognized any more. 226 | # The default value is: NO. 227 | 228 | MULTILINE_CPP_IS_BRIEF = NO 229 | 230 | # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the 231 | # documentation from any documented member that it re-implements. 232 | # The default value is: YES. 233 | 234 | INHERIT_DOCS = YES 235 | 236 | # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new 237 | # page for each member. If set to NO, the documentation of a member will be part 238 | # of the file/class/namespace that contains it. 239 | # The default value is: NO. 240 | 241 | SEPARATE_MEMBER_PAGES = NO 242 | 243 | # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen 244 | # uses this value to replace tabs by spaces in code fragments. 245 | # Minimum value: 1, maximum value: 16, default value: 4. 246 | 247 | TAB_SIZE = 4 248 | 249 | # This tag can be used to specify a number of aliases that act as commands in 250 | # the documentation. An alias has the form: 251 | # name=value 252 | # For example adding 253 | # "sideeffect=@par Side Effects:\n" 254 | # will allow you to put the command \sideeffect (or @sideeffect) in the 255 | # documentation, which will result in a user-defined paragraph with heading 256 | # "Side Effects:". You can put \n's in the value part of an alias to insert 257 | # newlines (in the resulting output). You can put ^^ in the value part of an 258 | # alias to insert a newline as if a physical newline was in the original file. 259 | # When you need a literal { or } or , in the value part of an alias you have to 260 | # escape them by means of a backslash (\), this can lead to conflicts with the 261 | # commands \{ and \} for these it is advised to use the version @{ and @} or use 262 | # a double escape (\\{ and \\}) 263 | 264 | ALIASES = 265 | 266 | # This tag can be used to specify a number of word-keyword mappings (TCL only). 267 | # A mapping has the form "name=value". For example adding "class=itcl::class" 268 | # will allow you to use the command class in the itcl::class meaning. 269 | 270 | TCL_SUBST = 271 | 272 | # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources 273 | # only. Doxygen will then generate output that is more tailored for C. For 274 | # instance, some of the names that are used will be different. The list of all 275 | # members will be omitted, etc. 276 | # The default value is: NO. 277 | 278 | OPTIMIZE_OUTPUT_FOR_C = NO 279 | 280 | # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or 281 | # Python sources only. Doxygen will then generate output that is more tailored 282 | # for that language. For instance, namespaces will be presented as packages, 283 | # qualified scopes will look different, etc. 284 | # The default value is: NO. 285 | 286 | OPTIMIZE_OUTPUT_JAVA = NO 287 | 288 | # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran 289 | # sources. Doxygen will then generate output that is tailored for Fortran. 290 | # The default value is: NO. 291 | 292 | OPTIMIZE_FOR_FORTRAN = NO 293 | 294 | # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL 295 | # sources. Doxygen will then generate output that is tailored for VHDL. 296 | # The default value is: NO. 297 | 298 | OPTIMIZE_OUTPUT_VHDL = NO 299 | 300 | # Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice 301 | # sources only. Doxygen will then generate output that is more tailored for that 302 | # language. For instance, namespaces will be presented as modules, types will be 303 | # separated into more groups, etc. 304 | # The default value is: NO. 305 | 306 | OPTIMIZE_OUTPUT_SLICE = NO 307 | 308 | # Doxygen selects the parser to use depending on the extension of the files it 309 | # parses. With this tag you can assign which parser to use for a given 310 | # extension. Doxygen has a built-in mapping, but you can override or extend it 311 | # using this tag. The format is ext=language, where ext is a file extension, and 312 | # language is one of the parsers supported by doxygen: IDL, Java, JavaScript, 313 | # Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice, 314 | # Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: 315 | # FortranFree, unknown formatted Fortran: Fortran. In the later case the parser 316 | # tries to guess whether the code is fixed or free formatted code, this is the 317 | # default for Fortran type files), VHDL, tcl. For instance to make doxygen treat 318 | # .inc files as Fortran files (default is PHP), and .f files as C (default is 319 | # Fortran), use: inc=Fortran f=C. 320 | # 321 | # Note: For files without extension you can use no_extension as a placeholder. 322 | # 323 | # Note that for custom extensions you also need to set FILE_PATTERNS otherwise 324 | # the files are not read by doxygen. 325 | 326 | EXTENSION_MAPPING = 327 | 328 | # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments 329 | # according to the Markdown format, which allows for more readable 330 | # documentation. See https://daringfireball.net/projects/markdown/ for details. 331 | # The output of markdown processing is further processed by doxygen, so you can 332 | # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in 333 | # case of backward compatibilities issues. 334 | # The default value is: YES. 335 | 336 | MARKDOWN_SUPPORT = YES 337 | 338 | # When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up 339 | # to that level are automatically included in the table of contents, even if 340 | # they do not have an id attribute. 341 | # Note: This feature currently applies only to Markdown headings. 342 | # Minimum value: 0, maximum value: 99, default value: 5. 343 | # This tag requires that the tag MARKDOWN_SUPPORT is set to YES. 344 | 345 | TOC_INCLUDE_HEADINGS = 0 346 | 347 | # When enabled doxygen tries to link words that correspond to documented 348 | # classes, or namespaces to their corresponding documentation. Such a link can 349 | # be prevented in individual cases by putting a % sign in front of the word or 350 | # globally by setting AUTOLINK_SUPPORT to NO. 351 | # The default value is: YES. 352 | 353 | AUTOLINK_SUPPORT = YES 354 | 355 | # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want 356 | # to include (a tag file for) the STL sources as input, then you should set this 357 | # tag to YES in order to let doxygen match functions declarations and 358 | # definitions whose arguments contain STL classes (e.g. func(std::string); 359 | # versus func(std::string) {}). This also make the inheritance and collaboration 360 | # diagrams that involve STL classes more complete and accurate. 361 | # The default value is: NO. 362 | 363 | BUILTIN_STL_SUPPORT = YES 364 | 365 | # If you use Microsoft's C++/CLI language, you should set this option to YES to 366 | # enable parsing support. 367 | # The default value is: NO. 368 | 369 | CPP_CLI_SUPPORT = NO 370 | 371 | # Set the SIP_SUPPORT tag to YES if your project consists of sip (see: 372 | # https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen 373 | # will parse them like normal C++ but will assume all classes use public instead 374 | # of private inheritance when no explicit protection keyword is present. 375 | # The default value is: NO. 376 | 377 | SIP_SUPPORT = NO 378 | 379 | # For Microsoft's IDL there are propget and propput attributes to indicate 380 | # getter and setter methods for a property. Setting this option to YES will make 381 | # doxygen to replace the get and set methods by a property in the documentation. 382 | # This will only work if the methods are indeed getting or setting a simple 383 | # type. If this is not the case, or you want to show the methods anyway, you 384 | # should set this option to NO. 385 | # The default value is: YES. 386 | 387 | IDL_PROPERTY_SUPPORT = YES 388 | 389 | # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC 390 | # tag is set to YES then doxygen will reuse the documentation of the first 391 | # member in the group (if any) for the other members of the group. By default 392 | # all members of a group must be documented explicitly. 393 | # The default value is: NO. 394 | 395 | DISTRIBUTE_GROUP_DOC = YES 396 | 397 | # If one adds a struct or class to a group and this option is enabled, then also 398 | # any nested class or struct is added to the same group. By default this option 399 | # is disabled and one has to add nested compounds explicitly via \ingroup. 400 | # The default value is: NO. 401 | 402 | GROUP_NESTED_COMPOUNDS = NO 403 | 404 | # Set the SUBGROUPING tag to YES to allow class member groups of the same type 405 | # (for instance a group of public functions) to be put as a subgroup of that 406 | # type (e.g. under the Public Functions section). Set it to NO to prevent 407 | # subgrouping. Alternatively, this can be done per class using the 408 | # \nosubgrouping command. 409 | # The default value is: YES. 410 | 411 | SUBGROUPING = YES 412 | 413 | # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions 414 | # are shown inside the group in which they are included (e.g. using \ingroup) 415 | # instead of on a separate page (for HTML and Man pages) or section (for LaTeX 416 | # and RTF). 417 | # 418 | # Note that this feature does not work in combination with 419 | # SEPARATE_MEMBER_PAGES. 420 | # The default value is: NO. 421 | 422 | INLINE_GROUPED_CLASSES = NO 423 | 424 | # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions 425 | # with only public data fields or simple typedef fields will be shown inline in 426 | # the documentation of the scope in which they are defined (i.e. file, 427 | # namespace, or group documentation), provided this scope is documented. If set 428 | # to NO, structs, classes, and unions are shown on a separate page (for HTML and 429 | # Man pages) or section (for LaTeX and RTF). 430 | # The default value is: NO. 431 | 432 | INLINE_SIMPLE_STRUCTS = NO 433 | 434 | # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or 435 | # enum is documented as struct, union, or enum with the name of the typedef. So 436 | # typedef struct TypeS {} TypeT, will appear in the documentation as a struct 437 | # with name TypeT. When disabled the typedef will appear as a member of a file, 438 | # namespace, or class. And the struct will be named TypeS. This can typically be 439 | # useful for C code in case the coding convention dictates that all compound 440 | # types are typedef'ed and only the typedef is referenced, never the tag name. 441 | # The default value is: NO. 442 | 443 | TYPEDEF_HIDES_STRUCT = NO 444 | 445 | # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This 446 | # cache is used to resolve symbols given their name and scope. Since this can be 447 | # an expensive process and often the same symbol appears multiple times in the 448 | # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small 449 | # doxygen will become slower. If the cache is too large, memory is wasted. The 450 | # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range 451 | # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 452 | # symbols. At the end of a run doxygen will report the cache usage and suggest 453 | # the optimal cache size from a speed point of view. 454 | # Minimum value: 0, maximum value: 9, default value: 0. 455 | 456 | LOOKUP_CACHE_SIZE = 0 457 | 458 | #--------------------------------------------------------------------------- 459 | # Build related configuration options 460 | #--------------------------------------------------------------------------- 461 | 462 | # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in 463 | # documentation are documented, even if no documentation was available. Private 464 | # class members and static file members will be hidden unless the 465 | # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. 466 | # Note: This will also disable the warnings about undocumented members that are 467 | # normally produced when WARNINGS is set to YES. 468 | # The default value is: NO. 469 | 470 | EXTRACT_ALL = YES 471 | 472 | # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will 473 | # be included in the documentation. 474 | # The default value is: NO. 475 | 476 | EXTRACT_PRIVATE = YES 477 | 478 | # If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual 479 | # methods of a class will be included in the documentation. 480 | # The default value is: NO. 481 | 482 | EXTRACT_PRIV_VIRTUAL = NO 483 | 484 | # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal 485 | # scope will be included in the documentation. 486 | # The default value is: NO. 487 | 488 | EXTRACT_PACKAGE = NO 489 | 490 | # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be 491 | # included in the documentation. 492 | # The default value is: NO. 493 | 494 | EXTRACT_STATIC = YES 495 | 496 | # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined 497 | # locally in source files will be included in the documentation. If set to NO, 498 | # only classes defined in header files are included. Does not have any effect 499 | # for Java sources. 500 | # The default value is: YES. 501 | 502 | EXTRACT_LOCAL_CLASSES = YES 503 | 504 | # This flag is only useful for Objective-C code. If set to YES, local methods, 505 | # which are defined in the implementation section but not in the interface are 506 | # included in the documentation. If set to NO, only methods in the interface are 507 | # included. 508 | # The default value is: NO. 509 | 510 | EXTRACT_LOCAL_METHODS = NO 511 | 512 | # If this flag is set to YES, the members of anonymous namespaces will be 513 | # extracted and appear in the documentation as a namespace called 514 | # 'anonymous_namespace{file}', where file will be replaced with the base name of 515 | # the file that contains the anonymous namespace. By default anonymous namespace 516 | # are hidden. 517 | # The default value is: NO. 518 | 519 | EXTRACT_ANON_NSPACES = NO 520 | 521 | # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all 522 | # undocumented members inside documented classes or files. If set to NO these 523 | # members will be included in the various overviews, but no documentation 524 | # section is generated. This option has no effect if EXTRACT_ALL is enabled. 525 | # The default value is: NO. 526 | 527 | HIDE_UNDOC_MEMBERS = NO 528 | 529 | # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all 530 | # undocumented classes that are normally visible in the class hierarchy. If set 531 | # to NO, these classes will be included in the various overviews. This option 532 | # has no effect if EXTRACT_ALL is enabled. 533 | # The default value is: NO. 534 | 535 | HIDE_UNDOC_CLASSES = NO 536 | 537 | # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend 538 | # declarations. If set to NO, these declarations will be included in the 539 | # documentation. 540 | # The default value is: NO. 541 | 542 | HIDE_FRIEND_COMPOUNDS = NO 543 | 544 | # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any 545 | # documentation blocks found inside the body of a function. If set to NO, these 546 | # blocks will be appended to the function's detailed documentation block. 547 | # The default value is: NO. 548 | 549 | HIDE_IN_BODY_DOCS = NO 550 | 551 | # The INTERNAL_DOCS tag determines if documentation that is typed after a 552 | # \internal command is included. If the tag is set to NO then the documentation 553 | # will be excluded. Set it to YES to include the internal documentation. 554 | # The default value is: NO. 555 | 556 | INTERNAL_DOCS = NO 557 | 558 | # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file 559 | # names in lower-case letters. If set to YES, upper-case letters are also 560 | # allowed. This is useful if you have classes or files whose names only differ 561 | # in case and if your file system supports case sensitive file names. Windows 562 | # (including Cygwin) ands Mac users are advised to set this option to NO. 563 | # The default value is: system dependent. 564 | 565 | CASE_SENSE_NAMES = YES 566 | 567 | # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with 568 | # their full class and namespace scopes in the documentation. If set to YES, the 569 | # scope will be hidden. 570 | # The default value is: NO. 571 | 572 | HIDE_SCOPE_NAMES = NO 573 | 574 | # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will 575 | # append additional text to a page's title, such as Class Reference. If set to 576 | # YES the compound reference will be hidden. 577 | # The default value is: NO. 578 | 579 | HIDE_COMPOUND_REFERENCE= NO 580 | 581 | # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of 582 | # the files that are included by a file in the documentation of that file. 583 | # The default value is: YES. 584 | 585 | SHOW_INCLUDE_FILES = NO 586 | 587 | # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each 588 | # grouped member an include statement to the documentation, telling the reader 589 | # which file to include in order to use the member. 590 | # The default value is: NO. 591 | 592 | SHOW_GROUPED_MEMB_INC = NO 593 | 594 | # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include 595 | # files with double quotes in the documentation rather than with sharp brackets. 596 | # The default value is: NO. 597 | 598 | FORCE_LOCAL_INCLUDES = YES 599 | 600 | # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the 601 | # documentation for inline members. 602 | # The default value is: YES. 603 | 604 | INLINE_INFO = YES 605 | 606 | # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the 607 | # (detailed) documentation of file and class members alphabetically by member 608 | # name. If set to NO, the members will appear in declaration order. 609 | # The default value is: YES. 610 | 611 | SORT_MEMBER_DOCS = NO 612 | 613 | # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief 614 | # descriptions of file, namespace and class members alphabetically by member 615 | # name. If set to NO, the members will appear in declaration order. Note that 616 | # this will also influence the order of the classes in the class list. 617 | # The default value is: NO. 618 | 619 | SORT_BRIEF_DOCS = NO 620 | 621 | # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the 622 | # (brief and detailed) documentation of class members so that constructors and 623 | # destructors are listed first. If set to NO the constructors will appear in the 624 | # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. 625 | # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief 626 | # member documentation. 627 | # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting 628 | # detailed member documentation. 629 | # The default value is: NO. 630 | 631 | SORT_MEMBERS_CTORS_1ST = YES 632 | 633 | # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy 634 | # of group names into alphabetical order. If set to NO the group names will 635 | # appear in their defined order. 636 | # The default value is: NO. 637 | 638 | SORT_GROUP_NAMES = NO 639 | 640 | # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by 641 | # fully-qualified names, including namespaces. If set to NO, the class list will 642 | # be sorted only by class name, not including the namespace part. 643 | # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. 644 | # Note: This option applies only to the class list, not to the alphabetical 645 | # list. 646 | # The default value is: NO. 647 | 648 | SORT_BY_SCOPE_NAME = NO 649 | 650 | # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper 651 | # type resolution of all parameters of a function it will reject a match between 652 | # the prototype and the implementation of a member function even if there is 653 | # only one candidate or it is obvious which candidate to choose by doing a 654 | # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still 655 | # accept a match between prototype and implementation in such cases. 656 | # The default value is: NO. 657 | 658 | STRICT_PROTO_MATCHING = NO 659 | 660 | # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo 661 | # list. This list is created by putting \todo commands in the documentation. 662 | # The default value is: YES. 663 | 664 | GENERATE_TODOLIST = YES 665 | 666 | # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test 667 | # list. This list is created by putting \test commands in the documentation. 668 | # The default value is: YES. 669 | 670 | GENERATE_TESTLIST = YES 671 | 672 | # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug 673 | # list. This list is created by putting \bug commands in the documentation. 674 | # The default value is: YES. 675 | 676 | GENERATE_BUGLIST = YES 677 | 678 | # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) 679 | # the deprecated list. This list is created by putting \deprecated commands in 680 | # the documentation. 681 | # The default value is: YES. 682 | 683 | GENERATE_DEPRECATEDLIST= YES 684 | 685 | # The ENABLED_SECTIONS tag can be used to enable conditional documentation 686 | # sections, marked by \if ... \endif and \cond 687 | # ... \endcond blocks. 688 | 689 | ENABLED_SECTIONS = 690 | 691 | # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the 692 | # initial value of a variable or macro / define can have for it to appear in the 693 | # documentation. If the initializer consists of more lines than specified here 694 | # it will be hidden. Use a value of 0 to hide initializers completely. The 695 | # appearance of the value of individual variables and macros / defines can be 696 | # controlled using \showinitializer or \hideinitializer command in the 697 | # documentation regardless of this setting. 698 | # Minimum value: 0, maximum value: 10000, default value: 30. 699 | 700 | MAX_INITIALIZER_LINES = 30 701 | 702 | # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at 703 | # the bottom of the documentation of classes and structs. If set to YES, the 704 | # list will mention the files that were used to generate the documentation. 705 | # The default value is: YES. 706 | 707 | SHOW_USED_FILES = YES 708 | 709 | # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This 710 | # will remove the Files entry from the Quick Index and from the Folder Tree View 711 | # (if specified). 712 | # The default value is: YES. 713 | 714 | SHOW_FILES = NO 715 | 716 | # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces 717 | # page. This will remove the Namespaces entry from the Quick Index and from the 718 | # Folder Tree View (if specified). 719 | # The default value is: YES. 720 | 721 | SHOW_NAMESPACES = YES 722 | 723 | # The FILE_VERSION_FILTER tag can be used to specify a program or script that 724 | # doxygen should invoke to get the current version for each file (typically from 725 | # the version control system). Doxygen will invoke the program by executing (via 726 | # popen()) the command command input-file, where command is the value of the 727 | # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided 728 | # by doxygen. Whatever the program writes to standard output is used as the file 729 | # version. For an example see the documentation. 730 | 731 | FILE_VERSION_FILTER = 732 | 733 | # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed 734 | # by doxygen. The layout file controls the global structure of the generated 735 | # output files in an output format independent way. To create the layout file 736 | # that represents doxygen's defaults, run doxygen with the -l option. You can 737 | # optionally specify a file name after the option, if omitted DoxygenLayout.xml 738 | # will be used as the name of the layout file. 739 | # 740 | # Note that if you run doxygen from a directory containing a file called 741 | # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE 742 | # tag is left empty. 743 | 744 | LAYOUT_FILE = 745 | 746 | # The CITE_BIB_FILES tag can be used to specify one or more bib files containing 747 | # the reference definitions. This must be a list of .bib files. The .bib 748 | # extension is automatically appended if omitted. This requires the bibtex tool 749 | # to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info. 750 | # For LaTeX the style of the bibliography can be controlled using 751 | # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the 752 | # search path. See also \cite for info how to create references. 753 | 754 | CITE_BIB_FILES = 755 | 756 | #--------------------------------------------------------------------------- 757 | # Configuration options related to warning and progress messages 758 | #--------------------------------------------------------------------------- 759 | 760 | # The QUIET tag can be used to turn on/off the messages that are generated to 761 | # standard output by doxygen. If QUIET is set to YES this implies that the 762 | # messages are off. 763 | # The default value is: NO. 764 | 765 | QUIET = NO 766 | 767 | # The WARNINGS tag can be used to turn on/off the warning messages that are 768 | # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES 769 | # this implies that the warnings are on. 770 | # 771 | # Tip: Turn warnings on while writing the documentation. 772 | # The default value is: YES. 773 | 774 | WARNINGS = YES 775 | 776 | # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate 777 | # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag 778 | # will automatically be disabled. 779 | # The default value is: YES. 780 | 781 | WARN_IF_UNDOCUMENTED = YES 782 | 783 | # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for 784 | # potential errors in the documentation, such as not documenting some parameters 785 | # in a documented function, or documenting parameters that don't exist or using 786 | # markup commands wrongly. 787 | # The default value is: YES. 788 | 789 | WARN_IF_DOC_ERROR = YES 790 | 791 | # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that 792 | # are documented, but have no documentation for their parameters or return 793 | # value. If set to NO, doxygen will only warn about wrong or incomplete 794 | # parameter documentation, but not about the absence of documentation. If 795 | # EXTRACT_ALL is set to YES then this flag will automatically be disabled. 796 | # The default value is: NO. 797 | 798 | WARN_NO_PARAMDOC = YES 799 | 800 | # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when 801 | # a warning is encountered. 802 | # The default value is: NO. 803 | 804 | WARN_AS_ERROR = NO 805 | 806 | # The WARN_FORMAT tag determines the format of the warning messages that doxygen 807 | # can produce. The string should contain the $file, $line, and $text tags, which 808 | # will be replaced by the file and line number from which the warning originated 809 | # and the warning text. Optionally the format may contain $version, which will 810 | # be replaced by the version of the file (if it could be obtained via 811 | # FILE_VERSION_FILTER) 812 | # The default value is: $file:$line: $text. 813 | 814 | WARN_FORMAT = "$file:$line: $text" 815 | 816 | # The WARN_LOGFILE tag can be used to specify a file to which warning and error 817 | # messages should be written. If left blank the output is written to standard 818 | # error (stderr). 819 | 820 | WARN_LOGFILE = 821 | 822 | #--------------------------------------------------------------------------- 823 | # Configuration options related to the input files 824 | #--------------------------------------------------------------------------- 825 | 826 | # The INPUT tag is used to specify the files and/or directories that contain 827 | # documented source files. You may enter file names like myfile.cpp or 828 | # directories like /usr/src/myproject. Separate the files or directories with 829 | # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING 830 | # Note: If this tag is empty the current directory is searched. 831 | 832 | INPUT = ${CMAKE_HOME_DIRECTORY}/src-dox \ 833 | ${CMAKE_HOME_DIRECTORY}/src-lib \ 834 | ${CMAKE_HOME_DIRECTORY}/src-test 835 | 836 | # This tag can be used to specify the character encoding of the source files 837 | # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses 838 | # libiconv (or the iconv built into libc) for the transcoding. See the libiconv 839 | # documentation (see: https://www.gnu.org/software/libiconv/) for the list of 840 | # possible encodings. 841 | # The default value is: UTF-8. 842 | 843 | INPUT_ENCODING = UTF-8 844 | 845 | # If the value of the INPUT tag contains directories, you can use the 846 | # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and 847 | # *.h) to filter out the source-files in the directories. 848 | # 849 | # Note that for custom extensions or not directly supported extensions you also 850 | # need to set EXTENSION_MAPPING for the extension otherwise the files are not 851 | # read by doxygen. 852 | # 853 | # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, 854 | # *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, 855 | # *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, 856 | # *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C comment), 857 | # *.doc (to be provided as doxygen C comment), *.txt (to be provided as doxygen 858 | # C comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f, *.for, *.tcl, *.vhd, 859 | # *.vhdl, *.ucf, *.qsf and *.ice. 860 | 861 | FILE_PATTERNS = *.c \ 862 | *.cc \ 863 | *.cxx \ 864 | *.cpp \ 865 | *.c++ \ 866 | *.java \ 867 | *.ii \ 868 | *.ixx \ 869 | *.ipp \ 870 | *.i++ \ 871 | *.inl \ 872 | *.idl \ 873 | *.ddl \ 874 | *.odl \ 875 | *.h \ 876 | *.hh \ 877 | *.hxx \ 878 | *.hpp \ 879 | *.h++ \ 880 | *.cs \ 881 | *.d \ 882 | *.php \ 883 | *.php4 \ 884 | *.php5 \ 885 | *.phtml \ 886 | *.inc \ 887 | *.m \ 888 | *.markdown \ 889 | *.md \ 890 | *.mm \ 891 | *.dox \ 892 | *.py \ 893 | *.pyw \ 894 | *.f90 \ 895 | *.f95 \ 896 | *.f03 \ 897 | *.f08 \ 898 | *.f \ 899 | *.for \ 900 | *.tcl \ 901 | *.vhd \ 902 | *.vhdl \ 903 | *.ucf \ 904 | *.qsf 905 | 906 | # The RECURSIVE tag can be used to specify whether or not subdirectories should 907 | # be searched for input files as well. 908 | # The default value is: NO. 909 | 910 | RECURSIVE = YES 911 | 912 | # The EXCLUDE tag can be used to specify files and/or directories that should be 913 | # excluded from the INPUT source files. This way you can easily exclude a 914 | # subdirectory from a directory tree whose root is specified with the INPUT tag. 915 | # 916 | # Note that relative paths are relative to the directory from which doxygen is 917 | # run. 918 | 919 | EXCLUDE = 920 | 921 | # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or 922 | # directories that are symbolic links (a Unix file system feature) are excluded 923 | # from the input. 924 | # The default value is: NO. 925 | 926 | EXCLUDE_SYMLINKS = NO 927 | 928 | # If the value of the INPUT tag contains directories, you can use the 929 | # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude 930 | # certain files from those directories. 931 | # 932 | # Note that the wildcards are matched against the file with absolute path, so to 933 | # exclude all test directories for example use the pattern */test/* 934 | 935 | EXCLUDE_PATTERNS = build 936 | 937 | # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names 938 | # (namespaces, classes, functions, etc.) that should be excluded from the 939 | # output. The symbol name can be a fully qualified name, a word, or if the 940 | # wildcard * is used, a substring. Examples: ANamespace, AClass, 941 | # AClass::ANamespace, ANamespace::*Test 942 | # 943 | # Note that the wildcards are matched against the file with absolute path, so to 944 | # exclude all test directories use the pattern */test/* 945 | 946 | EXCLUDE_SYMBOLS = 947 | 948 | # The EXAMPLE_PATH tag can be used to specify one or more files or directories 949 | # that contain example code fragments that are included (see the \include 950 | # command). 951 | 952 | EXAMPLE_PATH = ${CMAKE_CURRENT_SOURCE_DIR} 953 | 954 | # If the value of the EXAMPLE_PATH tag contains directories, you can use the 955 | # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and 956 | # *.h) to filter out the source-files in the directories. If left blank all 957 | # files are included. 958 | 959 | EXAMPLE_PATTERNS = * 960 | 961 | # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be 962 | # searched for input files to be used with the \include or \dontinclude commands 963 | # irrespective of the value of the RECURSIVE tag. 964 | # The default value is: NO. 965 | 966 | EXAMPLE_RECURSIVE = NO 967 | 968 | # The IMAGE_PATH tag can be used to specify one or more files or directories 969 | # that contain images that are to be included in the documentation (see the 970 | # \image command). 971 | 972 | IMAGE_PATH = ${CMAKE_CURRENT_SOURCE_DIR} 973 | 974 | # The INPUT_FILTER tag can be used to specify a program that doxygen should 975 | # invoke to filter for each input file. Doxygen will invoke the filter program 976 | # by executing (via popen()) the command: 977 | # 978 | # 979 | # 980 | # where is the value of the INPUT_FILTER tag, and is the 981 | # name of an input file. Doxygen will then use the output that the filter 982 | # program writes to standard output. If FILTER_PATTERNS is specified, this tag 983 | # will be ignored. 984 | # 985 | # Note that the filter must not add or remove lines; it is applied before the 986 | # code is scanned, but not when the output code is generated. If lines are added 987 | # or removed, the anchors will not be placed correctly. 988 | # 989 | # Note that for custom extensions or not directly supported extensions you also 990 | # need to set EXTENSION_MAPPING for the extension otherwise the files are not 991 | # properly processed by doxygen. 992 | 993 | INPUT_FILTER = 994 | 995 | # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern 996 | # basis. Doxygen will compare the file name with each pattern and apply the 997 | # filter if there is a match. The filters are a list of the form: pattern=filter 998 | # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how 999 | # filters are used. If the FILTER_PATTERNS tag is empty or if none of the 1000 | # patterns match the file name, INPUT_FILTER is applied. 1001 | # 1002 | # Note that for custom extensions or not directly supported extensions you also 1003 | # need to set EXTENSION_MAPPING for the extension otherwise the files are not 1004 | # properly processed by doxygen. 1005 | 1006 | FILTER_PATTERNS = 1007 | 1008 | # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using 1009 | # INPUT_FILTER) will also be used to filter the input files that are used for 1010 | # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). 1011 | # The default value is: NO. 1012 | 1013 | FILTER_SOURCE_FILES = NO 1014 | 1015 | # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file 1016 | # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and 1017 | # it is also possible to disable source filtering for a specific pattern using 1018 | # *.ext= (so without naming a filter). 1019 | # This tag requires that the tag FILTER_SOURCE_FILES is set to YES. 1020 | 1021 | FILTER_SOURCE_PATTERNS = 1022 | 1023 | # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that 1024 | # is part of the input, its contents will be placed on the main page 1025 | # (index.html). This can be useful if you have a project on for instance GitHub 1026 | # and want to reuse the introduction page also for the doxygen output. 1027 | 1028 | USE_MDFILE_AS_MAINPAGE = 1029 | 1030 | #--------------------------------------------------------------------------- 1031 | # Configuration options related to source browsing 1032 | #--------------------------------------------------------------------------- 1033 | 1034 | # If the SOURCE_BROWSER tag is set to YES then a list of source files will be 1035 | # generated. Documented entities will be cross-referenced with these sources. 1036 | # 1037 | # Note: To get rid of all source code in the generated output, make sure that 1038 | # also VERBATIM_HEADERS is set to NO. 1039 | # The default value is: NO. 1040 | 1041 | SOURCE_BROWSER = NO 1042 | 1043 | # Setting the INLINE_SOURCES tag to YES will include the body of functions, 1044 | # classes and enums directly into the documentation. 1045 | # The default value is: NO. 1046 | 1047 | INLINE_SOURCES = NO 1048 | 1049 | # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any 1050 | # special comment blocks from generated source code fragments. Normal C, C++ and 1051 | # Fortran comments will always remain visible. 1052 | # The default value is: YES. 1053 | 1054 | STRIP_CODE_COMMENTS = YES 1055 | 1056 | # If the REFERENCED_BY_RELATION tag is set to YES then for each documented 1057 | # entity all documented functions referencing it will be listed. 1058 | # The default value is: NO. 1059 | 1060 | REFERENCED_BY_RELATION = NO 1061 | 1062 | # If the REFERENCES_RELATION tag is set to YES then for each documented function 1063 | # all documented entities called/used by that function will be listed. 1064 | # The default value is: NO. 1065 | 1066 | REFERENCES_RELATION = NO 1067 | 1068 | # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set 1069 | # to YES then the hyperlinks from functions in REFERENCES_RELATION and 1070 | # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will 1071 | # link to the documentation. 1072 | # The default value is: YES. 1073 | 1074 | REFERENCES_LINK_SOURCE = NO 1075 | 1076 | # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the 1077 | # source code will show a tooltip with additional information such as prototype, 1078 | # brief description and links to the definition and documentation. Since this 1079 | # will make the HTML file larger and loading of large files a bit slower, you 1080 | # can opt to disable this feature. 1081 | # The default value is: YES. 1082 | # This tag requires that the tag SOURCE_BROWSER is set to YES. 1083 | 1084 | SOURCE_TOOLTIPS = YES 1085 | 1086 | # If the USE_HTAGS tag is set to YES then the references to source code will 1087 | # point to the HTML generated by the htags(1) tool instead of doxygen built-in 1088 | # source browser. The htags tool is part of GNU's global source tagging system 1089 | # (see https://www.gnu.org/software/global/global.html). You will need version 1090 | # 4.8.6 or higher. 1091 | # 1092 | # To use it do the following: 1093 | # - Install the latest version of global 1094 | # - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file 1095 | # - Make sure the INPUT points to the root of the source tree 1096 | # - Run doxygen as normal 1097 | # 1098 | # Doxygen will invoke htags (and that will in turn invoke gtags), so these 1099 | # tools must be available from the command line (i.e. in the search path). 1100 | # 1101 | # The result: instead of the source browser generated by doxygen, the links to 1102 | # source code will now point to the output of htags. 1103 | # The default value is: NO. 1104 | # This tag requires that the tag SOURCE_BROWSER is set to YES. 1105 | 1106 | USE_HTAGS = NO 1107 | 1108 | # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a 1109 | # verbatim copy of the header file for each class for which an include is 1110 | # specified. Set to NO to disable this. 1111 | # See also: Section \class. 1112 | # The default value is: YES. 1113 | 1114 | VERBATIM_HEADERS = NO 1115 | 1116 | # If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the 1117 | # clang parser (see: http://clang.llvm.org/) for more accurate parsing at the 1118 | # cost of reduced performance. This can be particularly helpful with template 1119 | # rich C++ code for which doxygen's built-in parser lacks the necessary type 1120 | # information. 1121 | # Note: The availability of this option depends on whether or not doxygen was 1122 | # generated with the -Duse_libclang=ON option for CMake. 1123 | # The default value is: NO. 1124 | 1125 | CLANG_ASSISTED_PARSING = NO 1126 | 1127 | # If clang assisted parsing is enabled you can provide the compiler with command 1128 | # line options that you would normally use when invoking the compiler. Note that 1129 | # the include paths will already be set by doxygen for the files and directories 1130 | # specified with INPUT and INCLUDE_PATH. 1131 | # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. 1132 | 1133 | CLANG_OPTIONS = 1134 | 1135 | # If clang assisted parsing is enabled you can provide the clang parser with the 1136 | # path to the compilation database (see: 1137 | # http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) used when the files 1138 | # were built. This is equivalent to specifying the "-p" option to a clang tool, 1139 | # such as clang-check. These options will then be passed to the parser. 1140 | # Note: The availability of this option depends on whether or not doxygen was 1141 | # generated with the -Duse_libclang=ON option for CMake. 1142 | 1143 | CLANG_DATABASE_PATH = 1144 | 1145 | #--------------------------------------------------------------------------- 1146 | # Configuration options related to the alphabetical class index 1147 | #--------------------------------------------------------------------------- 1148 | 1149 | # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all 1150 | # compounds will be generated. Enable this if the project contains a lot of 1151 | # classes, structs, unions or interfaces. 1152 | # The default value is: YES. 1153 | 1154 | ALPHABETICAL_INDEX = YES 1155 | 1156 | # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in 1157 | # which the alphabetical index list will be split. 1158 | # Minimum value: 1, maximum value: 20, default value: 5. 1159 | # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 1160 | 1161 | COLS_IN_ALPHA_INDEX = 1 1162 | 1163 | # In case all classes in a project start with a common prefix, all classes will 1164 | # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag 1165 | # can be used to specify a prefix (or a list of prefixes) that should be ignored 1166 | # while generating the index headers. 1167 | # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. 1168 | 1169 | IGNORE_PREFIX = 1170 | 1171 | #--------------------------------------------------------------------------- 1172 | # Configuration options related to the HTML output 1173 | #--------------------------------------------------------------------------- 1174 | 1175 | # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output 1176 | # The default value is: YES. 1177 | 1178 | GENERATE_HTML = YES 1179 | 1180 | # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a 1181 | # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of 1182 | # it. 1183 | # The default directory is: html. 1184 | # This tag requires that the tag GENERATE_HTML is set to YES. 1185 | 1186 | HTML_OUTPUT = html 1187 | 1188 | # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each 1189 | # generated HTML page (for example: .htm, .php, .asp). 1190 | # The default value is: .html. 1191 | # This tag requires that the tag GENERATE_HTML is set to YES. 1192 | 1193 | HTML_FILE_EXTENSION = .html 1194 | 1195 | # The HTML_HEADER tag can be used to specify a user-defined HTML header file for 1196 | # each generated HTML page. If the tag is left blank doxygen will generate a 1197 | # standard header. 1198 | # 1199 | # To get valid HTML the header file that includes any scripts and style sheets 1200 | # that doxygen needs, which is dependent on the configuration options used (e.g. 1201 | # the setting GENERATE_TREEVIEW). It is highly recommended to start with a 1202 | # default header using 1203 | # doxygen -w html new_header.html new_footer.html new_stylesheet.css 1204 | # YourConfigFile 1205 | # and then modify the file new_header.html. See also section "Doxygen usage" 1206 | # for information on how to generate the default header that doxygen normally 1207 | # uses. 1208 | # Note: The header is subject to change so you typically have to regenerate the 1209 | # default header when upgrading to a newer version of doxygen. For a description 1210 | # of the possible markers and block names see the documentation. 1211 | # This tag requires that the tag GENERATE_HTML is set to YES. 1212 | 1213 | HTML_HEADER = 1214 | 1215 | # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each 1216 | # generated HTML page. If the tag is left blank doxygen will generate a standard 1217 | # footer. See HTML_HEADER for more information on how to generate a default 1218 | # footer and what special commands can be used inside the footer. See also 1219 | # section "Doxygen usage" for information on how to generate the default footer 1220 | # that doxygen normally uses. 1221 | # This tag requires that the tag GENERATE_HTML is set to YES. 1222 | 1223 | HTML_FOOTER = ${CMAKE_CURRENT_SOURCE_DIR}/footer_ccoderun.html 1224 | 1225 | # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style 1226 | # sheet that is used by each HTML page. It can be used to fine-tune the look of 1227 | # the HTML output. If left blank doxygen will generate a default style sheet. 1228 | # See also section "Doxygen usage" for information on how to generate the style 1229 | # sheet that doxygen normally uses. 1230 | # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as 1231 | # it is more robust and this tag (HTML_STYLESHEET) will in the future become 1232 | # obsolete. 1233 | # This tag requires that the tag GENERATE_HTML is set to YES. 1234 | 1235 | HTML_STYLESHEET = 1236 | 1237 | # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined 1238 | # cascading style sheets that are included after the standard style sheets 1239 | # created by doxygen. Using this option one can overrule certain style aspects. 1240 | # This is preferred over using HTML_STYLESHEET since it does not replace the 1241 | # standard style sheet and is therefore more robust against future updates. 1242 | # Doxygen will copy the style sheet files to the output directory. 1243 | # Note: The order of the extra style sheet files is of importance (e.g. the last 1244 | # style sheet in the list overrules the setting of the previous ones in the 1245 | # list). For an example see the documentation. 1246 | # This tag requires that the tag GENERATE_HTML is set to YES. 1247 | 1248 | HTML_EXTRA_STYLESHEET = 1249 | 1250 | # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or 1251 | # other source files which should be copied to the HTML output directory. Note 1252 | # that these files will be copied to the base HTML output directory. Use the 1253 | # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these 1254 | # files. In the HTML_STYLESHEET file, use the file name only. Also note that the 1255 | # files will be copied as-is; there are no commands or markers available. 1256 | # This tag requires that the tag GENERATE_HTML is set to YES. 1257 | 1258 | HTML_EXTRA_FILES = 1259 | 1260 | # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen 1261 | # will adjust the colors in the style sheet and background images according to 1262 | # this color. Hue is specified as an angle on a colorwheel, see 1263 | # https://en.wikipedia.org/wiki/Hue for more information. For instance the value 1264 | # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 1265 | # purple, and 360 is red again. 1266 | # Minimum value: 0, maximum value: 359, default value: 220. 1267 | # This tag requires that the tag GENERATE_HTML is set to YES. 1268 | 1269 | HTML_COLORSTYLE_HUE = 0 1270 | 1271 | # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors 1272 | # in the HTML output. For a value of 0 the output will use grayscales only. A 1273 | # value of 255 will produce the most vivid colors. 1274 | # Minimum value: 0, maximum value: 255, default value: 100. 1275 | # This tag requires that the tag GENERATE_HTML is set to YES. 1276 | 1277 | HTML_COLORSTYLE_SAT = 155 1278 | 1279 | # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the 1280 | # luminance component of the colors in the HTML output. Values below 100 1281 | # gradually make the output lighter, whereas values above 100 make the output 1282 | # darker. The value divided by 100 is the actual gamma applied, so 80 represents 1283 | # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not 1284 | # change the gamma. 1285 | # Minimum value: 40, maximum value: 240, default value: 80. 1286 | # This tag requires that the tag GENERATE_HTML is set to YES. 1287 | 1288 | HTML_COLORSTYLE_GAMMA = 80 1289 | 1290 | # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML 1291 | # page will contain the date and time when the page was generated. Setting this 1292 | # to YES can help to show when doxygen was last run and thus if the 1293 | # documentation is up to date. 1294 | # The default value is: NO. 1295 | # This tag requires that the tag GENERATE_HTML is set to YES. 1296 | 1297 | HTML_TIMESTAMP = YES 1298 | 1299 | # If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML 1300 | # documentation will contain a main index with vertical navigation menus that 1301 | # are dynamically created via JavaScript. If disabled, the navigation index will 1302 | # consists of multiple levels of tabs that are statically embedded in every HTML 1303 | # page. Disable this option to support browsers that do not have JavaScript, 1304 | # like the Qt help browser. 1305 | # The default value is: YES. 1306 | # This tag requires that the tag GENERATE_HTML is set to YES. 1307 | 1308 | HTML_DYNAMIC_MENUS = YES 1309 | 1310 | # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML 1311 | # documentation will contain sections that can be hidden and shown after the 1312 | # page has loaded. 1313 | # The default value is: NO. 1314 | # This tag requires that the tag GENERATE_HTML is set to YES. 1315 | 1316 | HTML_DYNAMIC_SECTIONS = NO 1317 | 1318 | # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries 1319 | # shown in the various tree structured indices initially; the user can expand 1320 | # and collapse entries dynamically later on. Doxygen will expand the tree to 1321 | # such a level that at most the specified number of entries are visible (unless 1322 | # a fully collapsed tree already exceeds this amount). So setting the number of 1323 | # entries 1 will produce a full collapsed tree by default. 0 is a special value 1324 | # representing an infinite number of entries and will result in a full expanded 1325 | # tree by default. 1326 | # Minimum value: 0, maximum value: 9999, default value: 100. 1327 | # This tag requires that the tag GENERATE_HTML is set to YES. 1328 | 1329 | HTML_INDEX_NUM_ENTRIES = 100 1330 | 1331 | # If the GENERATE_DOCSET tag is set to YES, additional index files will be 1332 | # generated that can be used as input for Apple's Xcode 3 integrated development 1333 | # environment (see: https://developer.apple.com/xcode/), introduced with OSX 1334 | # 10.5 (Leopard). To create a documentation set, doxygen will generate a 1335 | # Makefile in the HTML output directory. Running make will produce the docset in 1336 | # that directory and running make install will install the docset in 1337 | # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at 1338 | # startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy 1339 | # genXcode/_index.html for more information. 1340 | # The default value is: NO. 1341 | # This tag requires that the tag GENERATE_HTML is set to YES. 1342 | 1343 | GENERATE_DOCSET = NO 1344 | 1345 | # This tag determines the name of the docset feed. A documentation feed provides 1346 | # an umbrella under which multiple documentation sets from a single provider 1347 | # (such as a company or product suite) can be grouped. 1348 | # The default value is: Doxygen generated docs. 1349 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1350 | 1351 | DOCSET_FEEDNAME = "Doxygen generated docs" 1352 | 1353 | # This tag specifies a string that should uniquely identify the documentation 1354 | # set bundle. This should be a reverse domain-name style string, e.g. 1355 | # com.mycompany.MyDocSet. Doxygen will append .docset to the name. 1356 | # The default value is: org.doxygen.Project. 1357 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1358 | 1359 | DOCSET_BUNDLE_ID = org.doxygen.Project 1360 | 1361 | # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify 1362 | # the documentation publisher. This should be a reverse domain-name style 1363 | # string, e.g. com.mycompany.MyDocSet.documentation. 1364 | # The default value is: org.doxygen.Publisher. 1365 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1366 | 1367 | DOCSET_PUBLISHER_ID = org.doxygen.Publisher 1368 | 1369 | # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. 1370 | # The default value is: Publisher. 1371 | # This tag requires that the tag GENERATE_DOCSET is set to YES. 1372 | 1373 | DOCSET_PUBLISHER_NAME = Publisher 1374 | 1375 | # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three 1376 | # additional HTML index files: index.hhp, index.hhc, and index.hhk. The 1377 | # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop 1378 | # (see: https://www.microsoft.com/en-us/download/details.aspx?id=21138) on 1379 | # Windows. 1380 | # 1381 | # The HTML Help Workshop contains a compiler that can convert all HTML output 1382 | # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML 1383 | # files are now used as the Windows 98 help format, and will replace the old 1384 | # Windows help format (.hlp) on all Windows platforms in the future. Compressed 1385 | # HTML files also contain an index, a table of contents, and you can search for 1386 | # words in the documentation. The HTML workshop also contains a viewer for 1387 | # compressed HTML files. 1388 | # The default value is: NO. 1389 | # This tag requires that the tag GENERATE_HTML is set to YES. 1390 | 1391 | GENERATE_HTMLHELP = NO 1392 | 1393 | # The CHM_FILE tag can be used to specify the file name of the resulting .chm 1394 | # file. You can add a path in front of the file if the result should not be 1395 | # written to the html output directory. 1396 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1397 | 1398 | CHM_FILE = 1399 | 1400 | # The HHC_LOCATION tag can be used to specify the location (absolute path 1401 | # including file name) of the HTML help compiler (hhc.exe). If non-empty, 1402 | # doxygen will try to run the HTML help compiler on the generated index.hhp. 1403 | # The file has to be specified with full path. 1404 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1405 | 1406 | HHC_LOCATION = 1407 | 1408 | # The GENERATE_CHI flag controls if a separate .chi index file is generated 1409 | # (YES) or that it should be included in the master .chm file (NO). 1410 | # The default value is: NO. 1411 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1412 | 1413 | GENERATE_CHI = NO 1414 | 1415 | # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) 1416 | # and project file content. 1417 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1418 | 1419 | CHM_INDEX_ENCODING = 1420 | 1421 | # The BINARY_TOC flag controls whether a binary table of contents is generated 1422 | # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it 1423 | # enables the Previous and Next buttons. 1424 | # The default value is: NO. 1425 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1426 | 1427 | BINARY_TOC = NO 1428 | 1429 | # The TOC_EXPAND flag can be set to YES to add extra items for group members to 1430 | # the table of contents of the HTML help documentation and to the tree view. 1431 | # The default value is: NO. 1432 | # This tag requires that the tag GENERATE_HTMLHELP is set to YES. 1433 | 1434 | TOC_EXPAND = YES 1435 | 1436 | # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and 1437 | # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that 1438 | # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help 1439 | # (.qch) of the generated HTML documentation. 1440 | # The default value is: NO. 1441 | # This tag requires that the tag GENERATE_HTML is set to YES. 1442 | 1443 | GENERATE_QHP = NO 1444 | 1445 | # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify 1446 | # the file name of the resulting .qch file. The path specified is relative to 1447 | # the HTML output folder. 1448 | # This tag requires that the tag GENERATE_QHP is set to YES. 1449 | 1450 | QCH_FILE = 1451 | 1452 | # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help 1453 | # Project output. For more information please see Qt Help Project / Namespace 1454 | # (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace). 1455 | # The default value is: org.doxygen.Project. 1456 | # This tag requires that the tag GENERATE_QHP is set to YES. 1457 | 1458 | QHP_NAMESPACE = org.doxygen.Project 1459 | 1460 | # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt 1461 | # Help Project output. For more information please see Qt Help Project / Virtual 1462 | # Folders (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual- 1463 | # folders). 1464 | # The default value is: doc. 1465 | # This tag requires that the tag GENERATE_QHP is set to YES. 1466 | 1467 | QHP_VIRTUAL_FOLDER = doc 1468 | 1469 | # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom 1470 | # filter to add. For more information please see Qt Help Project / Custom 1471 | # Filters (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom- 1472 | # filters). 1473 | # This tag requires that the tag GENERATE_QHP is set to YES. 1474 | 1475 | QHP_CUST_FILTER_NAME = 1476 | 1477 | # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the 1478 | # custom filter to add. For more information please see Qt Help Project / Custom 1479 | # Filters (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom- 1480 | # filters). 1481 | # This tag requires that the tag GENERATE_QHP is set to YES. 1482 | 1483 | QHP_CUST_FILTER_ATTRS = 1484 | 1485 | # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this 1486 | # project's filter section matches. Qt Help Project / Filter Attributes (see: 1487 | # https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes). 1488 | # This tag requires that the tag GENERATE_QHP is set to YES. 1489 | 1490 | QHP_SECT_FILTER_ATTRS = 1491 | 1492 | # The QHG_LOCATION tag can be used to specify the location of Qt's 1493 | # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the 1494 | # generated .qhp file. 1495 | # This tag requires that the tag GENERATE_QHP is set to YES. 1496 | 1497 | QHG_LOCATION = 1498 | 1499 | # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be 1500 | # generated, together with the HTML files, they form an Eclipse help plugin. To 1501 | # install this plugin and make it available under the help contents menu in 1502 | # Eclipse, the contents of the directory containing the HTML and XML files needs 1503 | # to be copied into the plugins directory of eclipse. The name of the directory 1504 | # within the plugins directory should be the same as the ECLIPSE_DOC_ID value. 1505 | # After copying Eclipse needs to be restarted before the help appears. 1506 | # The default value is: NO. 1507 | # This tag requires that the tag GENERATE_HTML is set to YES. 1508 | 1509 | GENERATE_ECLIPSEHELP = NO 1510 | 1511 | # A unique identifier for the Eclipse help plugin. When installing the plugin 1512 | # the directory name containing the HTML and XML files should also have this 1513 | # name. Each documentation set should have its own identifier. 1514 | # The default value is: org.doxygen.Project. 1515 | # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. 1516 | 1517 | ECLIPSE_DOC_ID = org.doxygen.Project 1518 | 1519 | # If you want full control over the layout of the generated HTML pages it might 1520 | # be necessary to disable the index and replace it with your own. The 1521 | # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top 1522 | # of each HTML page. A value of NO enables the index and the value YES disables 1523 | # it. Since the tabs in the index contain the same information as the navigation 1524 | # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. 1525 | # The default value is: NO. 1526 | # This tag requires that the tag GENERATE_HTML is set to YES. 1527 | 1528 | DISABLE_INDEX = YES 1529 | 1530 | # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index 1531 | # structure should be generated to display hierarchical information. If the tag 1532 | # value is set to YES, a side panel will be generated containing a tree-like 1533 | # index structure (just like the one that is generated for HTML Help). For this 1534 | # to work a browser that supports JavaScript, DHTML, CSS and frames is required 1535 | # (i.e. any modern browser). Windows users are probably better off using the 1536 | # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can 1537 | # further fine-tune the look of the index. As an example, the default style 1538 | # sheet generated by doxygen has an example that shows how to put an image at 1539 | # the root of the tree instead of the PROJECT_NAME. Since the tree basically has 1540 | # the same information as the tab index, you could consider setting 1541 | # DISABLE_INDEX to YES when enabling this option. 1542 | # The default value is: NO. 1543 | # This tag requires that the tag GENERATE_HTML is set to YES. 1544 | 1545 | GENERATE_TREEVIEW = YES 1546 | 1547 | # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that 1548 | # doxygen will group on one line in the generated HTML documentation. 1549 | # 1550 | # Note that a value of 0 will completely suppress the enum values from appearing 1551 | # in the overview section. 1552 | # Minimum value: 0, maximum value: 20, default value: 4. 1553 | # This tag requires that the tag GENERATE_HTML is set to YES. 1554 | 1555 | ENUM_VALUES_PER_LINE = 1 1556 | 1557 | # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used 1558 | # to set the initial width (in pixels) of the frame in which the tree is shown. 1559 | # Minimum value: 0, maximum value: 1500, default value: 250. 1560 | # This tag requires that the tag GENERATE_HTML is set to YES. 1561 | 1562 | TREEVIEW_WIDTH = 250 1563 | 1564 | # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to 1565 | # external symbols imported via tag files in a separate window. 1566 | # The default value is: NO. 1567 | # This tag requires that the tag GENERATE_HTML is set to YES. 1568 | 1569 | EXT_LINKS_IN_WINDOW = NO 1570 | 1571 | # Use this tag to change the font size of LaTeX formulas included as images in 1572 | # the HTML documentation. When you change the font size after a successful 1573 | # doxygen run you need to manually remove any form_*.png images from the HTML 1574 | # output directory to force them to be regenerated. 1575 | # Minimum value: 8, maximum value: 50, default value: 10. 1576 | # This tag requires that the tag GENERATE_HTML is set to YES. 1577 | 1578 | FORMULA_FONTSIZE = 10 1579 | 1580 | # Use the FORMULA_TRANSPARENT tag to determine whether or not the images 1581 | # generated for formulas are transparent PNGs. Transparent PNGs are not 1582 | # supported properly for IE 6.0, but are supported on all modern browsers. 1583 | # 1584 | # Note that when changing this option you need to delete any form_*.png files in 1585 | # the HTML output directory before the changes have effect. 1586 | # The default value is: YES. 1587 | # This tag requires that the tag GENERATE_HTML is set to YES. 1588 | 1589 | FORMULA_TRANSPARENT = YES 1590 | 1591 | # The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands 1592 | # to create new LaTeX commands to be used in formulas as building blocks. See 1593 | # the section "Including formulas" for details. 1594 | 1595 | FORMULA_MACROFILE = 1596 | 1597 | # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see 1598 | # https://www.mathjax.org) which uses client side JavaScript for the rendering 1599 | # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX 1600 | # installed or if you want to formulas look prettier in the HTML output. When 1601 | # enabled you may also need to install MathJax separately and configure the path 1602 | # to it using the MATHJAX_RELPATH option. 1603 | # The default value is: NO. 1604 | # This tag requires that the tag GENERATE_HTML is set to YES. 1605 | 1606 | USE_MATHJAX = NO 1607 | 1608 | # When MathJax is enabled you can set the default output format to be used for 1609 | # the MathJax output. See the MathJax site (see: 1610 | # http://docs.mathjax.org/en/latest/output.html) for more details. 1611 | # Possible values are: HTML-CSS (which is slower, but has the best 1612 | # compatibility), NativeMML (i.e. MathML) and SVG. 1613 | # The default value is: HTML-CSS. 1614 | # This tag requires that the tag USE_MATHJAX is set to YES. 1615 | 1616 | MATHJAX_FORMAT = HTML-CSS 1617 | 1618 | # When MathJax is enabled you need to specify the location relative to the HTML 1619 | # output directory using the MATHJAX_RELPATH option. The destination directory 1620 | # should contain the MathJax.js script. For instance, if the mathjax directory 1621 | # is located at the same level as the HTML output directory, then 1622 | # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax 1623 | # Content Delivery Network so you can quickly see the result without installing 1624 | # MathJax. However, it is strongly recommended to install a local copy of 1625 | # MathJax from https://www.mathjax.org before deployment. 1626 | # The default value is: https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/. 1627 | # This tag requires that the tag USE_MATHJAX is set to YES. 1628 | 1629 | MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest 1630 | 1631 | # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax 1632 | # extension names that should be enabled during MathJax rendering. For example 1633 | # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols 1634 | # This tag requires that the tag USE_MATHJAX is set to YES. 1635 | 1636 | MATHJAX_EXTENSIONS = 1637 | 1638 | # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces 1639 | # of code that will be used on startup of the MathJax code. See the MathJax site 1640 | # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an 1641 | # example see the documentation. 1642 | # This tag requires that the tag USE_MATHJAX is set to YES. 1643 | 1644 | MATHJAX_CODEFILE = 1645 | 1646 | # When the SEARCHENGINE tag is enabled doxygen will generate a search box for 1647 | # the HTML output. The underlying search engine uses javascript and DHTML and 1648 | # should work on any modern browser. Note that when using HTML help 1649 | # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) 1650 | # there is already a search function so this one should typically be disabled. 1651 | # For large projects the javascript based search engine can be slow, then 1652 | # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to 1653 | # search using the keyboard; to jump to the search box use + S 1654 | # (what the is depends on the OS and browser, but it is typically 1655 | # , /