From 61b786a0510714a348ddee4a1d38998ed179533d Mon Sep 17 00:00:00 2001 From: Marti Vilella <22547158+martivilella@users.noreply.github.com> Date: Mon, 10 May 2021 22:45:48 +0200 Subject: [PATCH 01/27] Link dependencies in octovis-static library (#340) --- octovis/CMakeLists_src.txt | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/octovis/CMakeLists_src.txt b/octovis/CMakeLists_src.txt index 4ce0903c..35bc1f20 100644 --- a/octovis/CMakeLists_src.txt +++ b/octovis/CMakeLists_src.txt @@ -100,7 +100,12 @@ include_directories(${CMAKE_CURRENT_BINARY_DIR} ${CMAKE_BINARY_DIR}) # Library target add_library(octovis-static STATIC ${viewerlib_SRCS}) -target_link_libraries(octovis-static) +target_link_libraries(octovis-static + ${OPENGL_gl_LIBRARY} + ${OPENGL_glu_LIBRARY} + ${OCTOMAP_LIBRARIES} + ${QGLViewer_LIBRARIES} +) set_target_properties(octovis-static PROPERTIES OUTPUT_NAME octovis) add_library(octovis-shared SHARED ${viewerlib_SRCS}) From bdb1c3757e370db93457d710772ab85e8bd44dd4 Mon Sep 17 00:00:00 2001 From: Marti Vilella <22547158+martivilella@users.noreply.github.com> Date: Mon, 10 May 2021 23:00:31 +0200 Subject: [PATCH 02/27] octovis: Implement volume selection features (#339) * Add selected node center coords to status bar * Support select fcn in Qt4 * Hegemonise selectedOctreeVolumes UI toggle to ON * Implement methods for drawing selected volumes --- octovis/include/octovis/ViewerGui.h | 6 ++- octovis/include/octovis/ViewerWidget.h | 1 + octovis/src/OcTreeDrawer.cpp | 10 ++-- octovis/src/ViewerGui.cpp | 67 ++++++++++++++++++++------ 4 files changed, 64 insertions(+), 20 deletions(-) diff --git a/octovis/include/octovis/ViewerGui.h b/octovis/include/octovis/ViewerGui.h index 829d851e..00c14f2d 100644 --- a/octovis/include/octovis/ViewerGui.h +++ b/octovis/include/octovis/ViewerGui.h @@ -27,9 +27,9 @@ #include #if QT_VERSION >= QT_VERSION_CHECK(5, 0, 0) -#include +#include #else // QT_VERSION >= QT_VERSION_CHECK(5, 0, 0) -#include +#include #endif // QT_VERSION >= QT_VERSION_CHECK(5, 0, 0) #include #include @@ -113,6 +113,7 @@ namespace octomap { void on_actionHideBackground_toggled(bool checked); void on_actionAlternateRendering_toggled(bool checked); void on_actionClear_triggered(); + void voxelSelected(const QMouseEvent* e); void on_action_bg_black_triggered(); void on_action_bg_white_triggered(); @@ -213,6 +214,7 @@ namespace octomap { unsigned int m_max_tree_depth; unsigned int m_laserType; // SICK or Hokuyo /URG bool m_cameraStored; + QLabel* m_nodeSelected; QLabel* m_mapSizeStatus; QLabel* m_mapMemoryStatus; diff --git a/octovis/include/octovis/ViewerWidget.h b/octovis/include/octovis/ViewerWidget.h index 5159689c..6788d3e1 100644 --- a/octovis/include/octovis/ViewerWidget.h +++ b/octovis/include/octovis/ViewerWidget.h @@ -86,6 +86,7 @@ private slots: signals: void cameraPathStopped(int id); void cameraPathFrameChanged(int id, int current_camera_frame); + void select(const QMouseEvent* e); protected: diff --git a/octovis/src/OcTreeDrawer.cpp b/octovis/src/OcTreeDrawer.cpp index 33393b6e..8b6e6a94 100644 --- a/octovis/src/OcTreeDrawer.cpp +++ b/octovis/src/OcTreeDrawer.cpp @@ -100,14 +100,14 @@ namespace octomap { glEnableClientState(GL_VERTEX_ARRAY); + if (m_drawSelection) // Drawing voxels in descending alpha-channel magnitude avoids (most) artifacts + drawSelection(); if (m_drawOccupied) drawOccupiedVoxels(); if (m_drawFree) drawFreeVoxels(); if (m_drawOcTreeGrid) drawOctreeGrid(); - if (m_drawSelection) - drawSelection(); if (m_displayAxes) { drawAxes(); @@ -239,6 +239,10 @@ namespace octomap { void OcTreeDrawer::setOcTreeSelection(const std::list& selectedVoxels){ m_update = true; + + // init selectedVoxels GLarray + initGLArrays(selectedVoxels.size(), m_selectionSize, &m_selectionArray, NULL); + generateCubes(selectedVoxels, &m_selectionArray, m_selectionSize, this->origin); } @@ -739,7 +743,7 @@ namespace octomap { void OcTreeDrawer::drawSelection() const { if (m_selectionSize != 0) { - glColor4f(1.0, 0.0, 0.0, 0.5); + glColor4f(1.0, 0.0, 0.0, 1.0); drawCubes(m_selectionArray, m_selectionSize); } } diff --git a/octovis/src/ViewerGui.cpp b/octovis/src/ViewerGui.cpp index 53a581e8..3534b26b 100644 --- a/octovis/src/ViewerGui.cpp +++ b/octovis/src/ViewerGui.cpp @@ -71,10 +71,13 @@ ViewerGui::ViewerGui(const std::string& filename, QWidget *parent, unsigned int ui.menuShow->addAction(settingsCameraDock->toggleViewAction()); // status bar + m_nodeSelected = new QLabel("Selected node coordinates", this); m_mapSizeStatus = new QLabel("Map size", this); m_mapMemoryStatus = new QLabel("Memory consumption", this); + m_nodeSelected->setFrameStyle(QFrame::Panel | QFrame::Sunken); m_mapSizeStatus->setFrameStyle(QFrame::Panel | QFrame::Sunken); m_mapMemoryStatus->setFrameStyle(QFrame::Panel | QFrame::Sunken); + statusBar()->addPermanentWidget(m_nodeSelected); statusBar()->addPermanentWidget(m_mapSizeStatus); statusBar()->addPermanentWidget(m_mapMemoryStatus); @@ -123,6 +126,7 @@ ViewerGui::ViewerGui(const std::string& filename, QWidget *parent, unsigned int m_glwidget, SLOT(setCamPose(const octomath::Pose6D&))); connect(ui.actionReset_view, SIGNAL(triggered()), m_glwidget, SLOT(resetView())); + connect(m_glwidget, SIGNAL(select(const QMouseEvent*)), this, SLOT(voxelSelected(const QMouseEvent*))); if (filename != ""){ m_filename = filename; @@ -476,6 +480,8 @@ void ViewerGui::setOcTreeUISwitches() { ui.actionConvert_ml_tree->setEnabled(true); ui.actionReload_Octree->setEnabled(true); ui.actionSettings->setEnabled(false); + ui.actionSelected->setChecked(true); + ui.actionSelected->setEnabled(true); } void ViewerGui::openTree(){ @@ -1070,6 +1076,47 @@ void ViewerGui::on_actionClear_triggered() { showOcTree(); } +void ViewerGui::voxelSelected(const QMouseEvent* e){ + QPoint pixel_coord = e->pos(); + qglviewer::Vec origin; + qglviewer::Vec direction; + m_glwidget->camera()->convertClickToLine(pixel_coord, origin, direction); + const point3d origin3d{(float)origin.x,(float)origin.y,(float)origin.z}; + const point3d direction3d{(float)direction.x,(float)direction.y,(float)direction.z}; + point3d end3d; // voxel coords hit by ray + QString message = QString("--, --, -- m"); + std::list selection; + + for (std::map::iterator it = m_octrees.begin(); it != m_octrees.end(); ++it) + { + AbstractOcTree* tree = it->second.octree; + bool ray_hit = false; + if (OcTree* occupancytree = dynamic_cast(tree)) + { + ray_hit = occupancytree->castRay(origin3d, direction3d, end3d, true); // ? append ray distance arg to avoid raycast to inf warnings + } + else if (ColorOcTree* occupancytree = dynamic_cast(tree)) + { + ray_hit = occupancytree->castRay(origin3d, direction3d, end3d, true); + } + else + { + OCTOMAP_ERROR("Could not select nodes of this tree type %s\n", tree->getTreeType().c_str()); + continue; + } + if (ray_hit) + { + message = QString("%L1, %L2, %L3 m").arg(end3d.x()).arg(end3d.y()).arg(end3d.z()); + OcTreeVolume voxel = OcTreeVolume(end3d, tree->getResolution()); + selection.push_back(voxel); + it->second.octree_drawer->setOcTreeSelection(selection); + } + else it->second.octree_drawer->clearOcTreeSelection(); + } + m_nodeSelected->setText(message); + m_glwidget->update(); +} + void ViewerGui::on_actionTest_triggered(){ } @@ -1163,21 +1210,11 @@ void ViewerGui::on_actionFree_toggled(bool enabled) { } void ViewerGui::on_actionSelected_toggled(bool enabled) { - // if(m_octreeDrawer) { - // m_octreeDrawer->enableSelection(enabled); - - // // just for testing, you should set the selection somewhere else and only enable it here: - // if (enabled){ - // std::list selection; - // std::pair volume(octomath::Vector3(0.0, 0.0, 0.0), 0.2); - // selection.push_back(volume); - // m_octreeDrawer->setOcTreeSelection(selection); - - // } else{ - // m_octreeDrawer->clearOcTreeSelection(); - // } - // m_glwidget->update(); - // } + for (std::map::iterator it = m_octrees.begin(); + it != m_octrees.end(); ++it) { + if(it->second.octree_drawer) + it->second.octree_drawer->enableSelection(enabled); + } } From d68cd0c570b83ca132bb83e0856fe64ae3243b82 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Steven!=20Ragnaro=CC=88k?= Date: Thu, 20 May 2021 15:57:15 -0700 Subject: [PATCH 03/27] Remove unused ament_cmake dependency. REP-136 recommends that third-party (non-ROS) packages add a runtime dependency on catkin so that the setup scripts provided by the catkin package which set up a ROS environment are installed along with that package. In ROS 2, those scripts are provided by the ros_workspace package and bloom transparently injects a dependency on ros_workspace into every released package. It would be possible to use ament_cmake (or more likely the individual ament_cmake_core package to optionally provide the package.xml and ament resource index registration but since what you have is working fine I think just removing the unecessary dependency is a good next step. As mentioned in https://github.com/flexible-collision-library/fcl/pull/536#issuecomment-845533649 we haven't produced a definitive recommendation for third party packages in ROS 2 but I've added it to a meeting agenda and we'll document the conclusions of that discussion and share them as well. --- dynamicEDT3D/package.xml | 1 - octomap/package.xml | 1 - octovis/package.xml | 3 +-- 3 files changed, 1 insertion(+), 4 deletions(-) diff --git a/dynamicEDT3D/package.xml b/dynamicEDT3D/package.xml index e20ef7cd..62a55d92 100644 --- a/dynamicEDT3D/package.xml +++ b/dynamicEDT3D/package.xml @@ -15,7 +15,6 @@ catkin - ament_cmake cmake diff --git a/octomap/package.xml b/octomap/package.xml index 9c71c855..98ed2fea 100644 --- a/octomap/package.xml +++ b/octomap/package.xml @@ -15,7 +15,6 @@ catkin - ament_cmake cmake diff --git a/octovis/package.xml b/octovis/package.xml index a1836289..3dcafd95 100644 --- a/octovis/package.xml +++ b/octovis/package.xml @@ -15,13 +15,12 @@ catkin - ament_cmake cmake cmake - + octomap From 129cec062452dc405736dcf1ef88ca6c8af63402 Mon Sep 17 00:00:00 2001 From: Wolfgang Merkt Date: Mon, 14 Jun 2021 15:33:19 +0100 Subject: [PATCH 04/27] Fix URL to documentation in README, resolves #345 Fixes #345 --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 20962316..94ccfbdb 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ Download the latest releases: https://github.com/octomap/octomap/releases API documentation: - http://octomap.github.com/octomap/doc/ + https://octomap.github.io/octomap/doc/ Build status: [![Build Status](https://travis-ci.org/OctoMap/octomap.png?branch=devel)](https://travis-ci.org/OctoMap/octomap) From 2b8385e5398a79924bc39e5dac5622f07b8b12f0 Mon Sep 17 00:00:00 2001 From: Armin Hornung Date: Tue, 15 Jun 2021 18:58:17 +0200 Subject: [PATCH 05/27] Fix some links in Doxygen --- octomap/doxygen.h | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/octomap/doxygen.h b/octomap/doxygen.h index 3519214b..7eb95e04 100644 --- a/octomap/doxygen.h +++ b/octomap/doxygen.h @@ -15,7 +15,7 @@ \section intro_sec Introduction - The OctoMap library + The OctoMap library implements a 3D occupancy grid mapping approach. It provides data structures and mapping algorithms. The map is implemented using an \ref octomap::OcTree "Octree". It is designed to meet the following @@ -59,10 +59,10 @@ convenient exchange between robots even under bandwidth constraints.

Octomap was developed by Kai M. Wurm and -Armin +Armin Hornung, and is currently maintained by Armin Hornung. A tracker for bug reports and feature requests is available available on GitHub. -You can find an overview at http://octomap.github.com/ and the code repository at +You can find an overview at https://octomap.github.io/ and the code repository at https://github.com/OctoMap/octomap.

\section install_sec Installation From 9318b176fa55f88104f88ee2929079a46a59d0e9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Michael=20G=C3=B6rner?= Date: Sun, 12 Sep 2021 22:12:15 +0200 Subject: [PATCH 06/27] make setBBXMin/Max parameters const (#348) --- octomap/include/octomap/OccupancyOcTreeBase.h | 4 ++-- octomap/include/octomap/OccupancyOcTreeBase.hxx | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/octomap/include/octomap/OccupancyOcTreeBase.h b/octomap/include/octomap/OccupancyOcTreeBase.h index a8532143..a2646c39 100644 --- a/octomap/include/octomap/OccupancyOcTreeBase.h +++ b/octomap/include/octomap/OccupancyOcTreeBase.h @@ -334,9 +334,9 @@ namespace octomap { void useBBXLimit(bool enable) { use_bbx_limit = enable; } bool bbxSet() const { return use_bbx_limit; } /// sets the minimum for a query bounding box to use - void setBBXMin (point3d& min); + void setBBXMin (const point3d& min); /// sets the maximum for a query bounding box to use - void setBBXMax (point3d& max); + void setBBXMax (const point3d& max); /// @return the currently set minimum for bounding box queries, if set point3d getBBXMin () const { return bbx_min; } /// @return the currently set maximum for bounding box queries, if set diff --git a/octomap/include/octomap/OccupancyOcTreeBase.hxx b/octomap/include/octomap/OccupancyOcTreeBase.hxx index 8e3b312c..241c2e7f 100644 --- a/octomap/include/octomap/OccupancyOcTreeBase.hxx +++ b/octomap/include/octomap/OccupancyOcTreeBase.hxx @@ -882,7 +882,7 @@ namespace octomap { } template - void OccupancyOcTreeBase::setBBXMin (point3d& min) { + void OccupancyOcTreeBase::setBBXMin (const point3d& min) { bbx_min = min; if (!this->coordToKeyChecked(bbx_min, bbx_min_key)) { OCTOMAP_ERROR("ERROR while generating bbx min key.\n"); @@ -890,7 +890,7 @@ namespace octomap { } template - void OccupancyOcTreeBase::setBBXMax (point3d& max) { + void OccupancyOcTreeBase::setBBXMax (const point3d& max) { bbx_max = max; if (!this->coordToKeyChecked(bbx_max, bbx_max_key)) { OCTOMAP_ERROR("ERROR while generating bbx max key.\n"); From 10dc9f444605027dbc2cced322607dc805fde24d Mon Sep 17 00:00:00 2001 From: lauralindzey <65185744+lauralindzey@users.noreply.github.com> Date: Tue, 28 Sep 2021 12:55:50 -0700 Subject: [PATCH 07/27] Update all URLs to use github.io (#352) At some point, Github pages switched from being octomap.github.com to being at octomap.github.io. This commit simply updates documentation in the code to reflect that. --- octomap/README.md | 4 ++-- octomap/include/octomap/AbstractOcTree.h | 2 +- octomap/include/octomap/AbstractOccupancyOcTree.h | 2 +- octomap/include/octomap/ColorOcTree.h | 2 +- octomap/include/octomap/CountingOcTree.h | 2 +- octomap/include/octomap/MCTables.h | 2 +- octomap/include/octomap/MapCollection.h | 2 +- octomap/include/octomap/MapCollection.hxx | 2 +- octomap/include/octomap/MapNode.h | 2 +- octomap/include/octomap/MapNode.hxx | 2 +- octomap/include/octomap/OcTree.h | 2 +- octomap/include/octomap/OcTreeBase.h | 2 +- octomap/include/octomap/OcTreeBaseImpl.h | 2 +- octomap/include/octomap/OcTreeBaseImpl.hxx | 2 +- octomap/include/octomap/OcTreeDataNode.h | 2 +- octomap/include/octomap/OcTreeDataNode.hxx | 2 +- octomap/include/octomap/OcTreeIterator.hxx | 2 +- octomap/include/octomap/OcTreeKey.h | 2 +- octomap/include/octomap/OcTreeNode.h | 2 +- octomap/include/octomap/OcTreeStamped.h | 2 +- octomap/include/octomap/OccupancyOcTreeBase.h | 2 +- octomap/include/octomap/OccupancyOcTreeBase.hxx | 2 +- octomap/include/octomap/Pointcloud.h | 2 +- octomap/include/octomap/ScanGraph.h | 2 +- octomap/include/octomap/math/Pose6D.h | 2 +- octomap/include/octomap/math/Quaternion.h | 2 +- octomap/include/octomap/math/Utils.h | 2 +- octomap/include/octomap/math/Vector3.h | 2 +- octomap/include/octomap/octomap.h | 2 +- octomap/include/octomap/octomap_deprecated.h | 2 +- octomap/include/octomap/octomap_timing.h | 2 +- octomap/include/octomap/octomap_types.h | 2 +- octomap/include/octomap/octomap_utils.h | 2 +- octomap/src/AbstractOcTree.cpp | 2 +- octomap/src/AbstractOccupancyOcTree.cpp | 2 +- octomap/src/ColorOcTree.cpp | 2 +- octomap/src/CountingOcTree.cpp | 2 +- octomap/src/OcTree.cpp | 2 +- octomap/src/OcTreeNode.cpp | 2 +- octomap/src/OcTreeStamped.cpp | 2 +- octomap/src/Pointcloud.cpp | 2 +- octomap/src/ScanGraph.cpp | 2 +- octomap/src/binvox2bt.cpp | 2 +- octomap/src/bt2vrml.cpp | 2 +- octomap/src/compare_octrees.cpp | 2 +- octomap/src/convert_octree.cpp | 2 +- octomap/src/edit_octree.cpp | 2 +- octomap/src/eval_octree_accuracy.cpp | 2 +- octomap/src/graph2tree.cpp | 2 +- octomap/src/intersection_example.cpp | 2 +- octomap/src/log2graph.cpp | 2 +- octomap/src/math/Pose6D.cpp | 2 +- octomap/src/math/Quaternion.cpp | 2 +- octomap/src/math/Vector3.cpp | 2 +- octomap/src/normals_example.cpp | 2 +- octomap/src/octree2pointcloud.cpp | 2 +- octomap/src/offset_graph.cpp | 2 +- octomap/src/simple_example.cpp | 2 +- octovis/README.md | 2 +- octovis/src/ViewerWidget.cpp | 2 +- 60 files changed, 61 insertions(+), 61 deletions(-) diff --git a/octomap/README.md b/octomap/README.md index 0fde043e..8f8e6a48 100644 --- a/octomap/README.md +++ b/octomap/README.md @@ -2,7 +2,7 @@ Octomap - A probabilistic, flexible, and compact 3D mapping library for robotic ======================================================================================= Authors: Kai M. Wurm and Armin Hornung, University of Freiburg, Copyright (C) 2009-2013. -http://octomap.github.com +https://octomap.github.io See the [list of contributors](AUTHORS.txt) for further authors. @@ -58,7 +58,7 @@ DOCUMENTATION ------------- The documentation for the latest stable release is available online: - http://octomap.github.com/octomap/doc/index.html + https://octomap.github.io/octomap/doc/index.html You can build the most current HTML-Documentation for your current source with Doxygen by running `make docs` diff --git a/octomap/include/octomap/AbstractOcTree.h b/octomap/include/octomap/AbstractOcTree.h index 75b392b9..e396d28a 100644 --- a/octomap/include/octomap/AbstractOcTree.h +++ b/octomap/include/octomap/AbstractOcTree.h @@ -1,6 +1,6 @@ /* * OctoMap - An Efficient Probabilistic 3D Mapping Framework Based on Octrees - * http://octomap.github.com/ + * https://octomap.github.io/ * * Copyright (c) 2009-2013, K.M. Wurm and A. Hornung, University of Freiburg * All rights reserved. diff --git a/octomap/include/octomap/AbstractOccupancyOcTree.h b/octomap/include/octomap/AbstractOccupancyOcTree.h index 5671a2fd..240aedec 100644 --- a/octomap/include/octomap/AbstractOccupancyOcTree.h +++ b/octomap/include/octomap/AbstractOccupancyOcTree.h @@ -1,6 +1,6 @@ /* * OctoMap - An Efficient Probabilistic 3D Mapping Framework Based on Octrees - * http://octomap.github.com/ + * https://octomap.github.io/ * * Copyright (c) 2009-2013, K.M. Wurm and A. Hornung, University of Freiburg * All rights reserved. diff --git a/octomap/include/octomap/ColorOcTree.h b/octomap/include/octomap/ColorOcTree.h index 2d59643f..03f8b904 100644 --- a/octomap/include/octomap/ColorOcTree.h +++ b/octomap/include/octomap/ColorOcTree.h @@ -1,6 +1,6 @@ /* * OctoMap - An Efficient Probabilistic 3D Mapping Framework Based on Octrees - * http://octomap.github.com/ + * https://octomap.github.io/ * * Copyright (c) 2009-2013, K.M. Wurm and A. Hornung, University of Freiburg * All rights reserved. diff --git a/octomap/include/octomap/CountingOcTree.h b/octomap/include/octomap/CountingOcTree.h index e37ac81d..f7ab115c 100644 --- a/octomap/include/octomap/CountingOcTree.h +++ b/octomap/include/octomap/CountingOcTree.h @@ -1,6 +1,6 @@ /* * OctoMap - An Efficient Probabilistic 3D Mapping Framework Based on Octrees - * http://octomap.github.com/ + * https://octomap.github.io/ * * Copyright (c) 2009-2013, K.M. Wurm and A. Hornung, University of Freiburg * All rights reserved. diff --git a/octomap/include/octomap/MCTables.h b/octomap/include/octomap/MCTables.h index 73e85d22..3399c29d 100644 --- a/octomap/include/octomap/MCTables.h +++ b/octomap/include/octomap/MCTables.h @@ -1,6 +1,6 @@ /* * OctoMap - An Efficient Probabilistic 3D Mapping Framework Based on Octrees - * http://octomap.github.com/ + * https://octomap.github.io/ * * Copyright (c) 2013, F-M. De Rainville, P. Bourke * All rights reserved. diff --git a/octomap/include/octomap/MapCollection.h b/octomap/include/octomap/MapCollection.h index d75a8c74..d1789ce7 100644 --- a/octomap/include/octomap/MapCollection.h +++ b/octomap/include/octomap/MapCollection.h @@ -1,6 +1,6 @@ /* * OctoMap - An Efficient Probabilistic 3D Mapping Framework Based on Octrees - * http://octomap.github.com/ + * https://octomap.github.io/ * * Copyright (c) 2009-2013, K.M. Wurm and A. Hornung, University of Freiburg * All rights reserved. diff --git a/octomap/include/octomap/MapCollection.hxx b/octomap/include/octomap/MapCollection.hxx index 63dbf2db..ff35d49c 100644 --- a/octomap/include/octomap/MapCollection.hxx +++ b/octomap/include/octomap/MapCollection.hxx @@ -1,6 +1,6 @@ /* * OctoMap - An Efficient Probabilistic 3D Mapping Framework Based on Octrees - * http://octomap.github.com/ + * https://octomap.github.io/ * * Copyright (c) 2009-2013, K.M. Wurm and A. Hornung, University of Freiburg * All rights reserved. diff --git a/octomap/include/octomap/MapNode.h b/octomap/include/octomap/MapNode.h index c6c076f0..f48d70e8 100644 --- a/octomap/include/octomap/MapNode.h +++ b/octomap/include/octomap/MapNode.h @@ -1,6 +1,6 @@ /* * OctoMap - An Efficient Probabilistic 3D Mapping Framework Based on Octrees - * http://octomap.github.com/ + * https://octomap.github.io/ * * Copyright (c) 2009-2013, K.M. Wurm and A. Hornung, University of Freiburg * All rights reserved. diff --git a/octomap/include/octomap/MapNode.hxx b/octomap/include/octomap/MapNode.hxx index c62c6342..8e08b6c6 100644 --- a/octomap/include/octomap/MapNode.hxx +++ b/octomap/include/octomap/MapNode.hxx @@ -1,6 +1,6 @@ /* * OctoMap - An Efficient Probabilistic 3D Mapping Framework Based on Octrees - * http://octomap.github.com/ + * https://octomap.github.io/ * * Copyright (c) 2009-2013, K.M. Wurm and A. Hornung, University of Freiburg * All rights reserved. diff --git a/octomap/include/octomap/OcTree.h b/octomap/include/octomap/OcTree.h index 85cc0502..dcd5ac79 100644 --- a/octomap/include/octomap/OcTree.h +++ b/octomap/include/octomap/OcTree.h @@ -1,6 +1,6 @@ /* * OctoMap - An Efficient Probabilistic 3D Mapping Framework Based on Octrees - * http://octomap.github.com/ + * https://octomap.github.io/ * * Copyright (c) 2009-2013, K.M. Wurm and A. Hornung, University of Freiburg * All rights reserved. diff --git a/octomap/include/octomap/OcTreeBase.h b/octomap/include/octomap/OcTreeBase.h index 2679baa0..d53b4056 100644 --- a/octomap/include/octomap/OcTreeBase.h +++ b/octomap/include/octomap/OcTreeBase.h @@ -1,6 +1,6 @@ /* * OctoMap - An Efficient Probabilistic 3D Mapping Framework Based on Octrees - * http://octomap.github.com/ + * https://octomap.github.io/ * * Copyright (c) 2009-2013, K.M. Wurm and A. Hornung, University of Freiburg * All rights reserved. diff --git a/octomap/include/octomap/OcTreeBaseImpl.h b/octomap/include/octomap/OcTreeBaseImpl.h index fe71aeee..74711c2d 100644 --- a/octomap/include/octomap/OcTreeBaseImpl.h +++ b/octomap/include/octomap/OcTreeBaseImpl.h @@ -1,6 +1,6 @@ /* * OctoMap - An Efficient Probabilistic 3D Mapping Framework Based on Octrees - * http://octomap.github.com/ + * https://octomap.github.io/ * * Copyright (c) 2009-2013, K.M. Wurm and A. Hornung, University of Freiburg * All rights reserved. diff --git a/octomap/include/octomap/OcTreeBaseImpl.hxx b/octomap/include/octomap/OcTreeBaseImpl.hxx index abcd30b6..1da3a278 100644 --- a/octomap/include/octomap/OcTreeBaseImpl.hxx +++ b/octomap/include/octomap/OcTreeBaseImpl.hxx @@ -1,6 +1,6 @@ /* * OctoMap - An Efficient Probabilistic 3D Mapping Framework Based on Octrees - * http://octomap.github.com/ + * https://octomap.github.io/ * * Copyright (c) 2009-2013, K.M. Wurm and A. Hornung, University of Freiburg * All rights reserved. diff --git a/octomap/include/octomap/OcTreeDataNode.h b/octomap/include/octomap/OcTreeDataNode.h index 8c92c392..febe0384 100644 --- a/octomap/include/octomap/OcTreeDataNode.h +++ b/octomap/include/octomap/OcTreeDataNode.h @@ -1,6 +1,6 @@ /* * OctoMap - An Efficient Probabilistic 3D Mapping Framework Based on Octrees - * http://octomap.github.com/ + * https://octomap.github.io/ * * Copyright (c) 2009-2013, K.M. Wurm and A. Hornung, University of Freiburg * All rights reserved. diff --git a/octomap/include/octomap/OcTreeDataNode.hxx b/octomap/include/octomap/OcTreeDataNode.hxx index 38256bf3..be884084 100644 --- a/octomap/include/octomap/OcTreeDataNode.hxx +++ b/octomap/include/octomap/OcTreeDataNode.hxx @@ -1,6 +1,6 @@ /* * OctoMap - An Efficient Probabilistic 3D Mapping Framework Based on Octrees - * http://octomap.github.com/ + * https://octomap.github.io/ * * Copyright (c) 2009-2013, K.M. Wurm and A. Hornung, University of Freiburg * All rights reserved. diff --git a/octomap/include/octomap/OcTreeIterator.hxx b/octomap/include/octomap/OcTreeIterator.hxx index fb5d9acf..fabcad82 100644 --- a/octomap/include/octomap/OcTreeIterator.hxx +++ b/octomap/include/octomap/OcTreeIterator.hxx @@ -1,6 +1,6 @@ /* * OctoMap - An Efficient Probabilistic 3D Mapping Framework Based on Octrees - * http://octomap.github.com/ + * https://octomap.github.io/ * * Copyright (c) 2009-2013, K.M. Wurm and A. Hornung, University of Freiburg * All rights reserved. diff --git a/octomap/include/octomap/OcTreeKey.h b/octomap/include/octomap/OcTreeKey.h index b48956d8..2ce78a62 100644 --- a/octomap/include/octomap/OcTreeKey.h +++ b/octomap/include/octomap/OcTreeKey.h @@ -1,6 +1,6 @@ /* * OctoMap - An Efficient Probabilistic 3D Mapping Framework Based on Octrees - * http://octomap.github.com/ + * https://octomap.github.io/ * * Copyright (c) 2009-2013, K.M. Wurm and A. Hornung, University of Freiburg * All rights reserved. diff --git a/octomap/include/octomap/OcTreeNode.h b/octomap/include/octomap/OcTreeNode.h index 39fff598..b51cfa65 100644 --- a/octomap/include/octomap/OcTreeNode.h +++ b/octomap/include/octomap/OcTreeNode.h @@ -1,6 +1,6 @@ /* * OctoMap - An Efficient Probabilistic 3D Mapping Framework Based on Octrees - * http://octomap.github.com/ + * https://octomap.github.io/ * * Copyright (c) 2009-2013, K.M. Wurm and A. Hornung, University of Freiburg * All rights reserved. diff --git a/octomap/include/octomap/OcTreeStamped.h b/octomap/include/octomap/OcTreeStamped.h index 471f239c..21cf6463 100644 --- a/octomap/include/octomap/OcTreeStamped.h +++ b/octomap/include/octomap/OcTreeStamped.h @@ -1,6 +1,6 @@ /* * OctoMap - An Efficient Probabilistic 3D Mapping Framework Based on Octrees - * http://octomap.github.com/ + * https://octomap.github.io/ * * Copyright (c) 2009-2013, K.M. Wurm and A. Hornung, University of Freiburg * All rights reserved. diff --git a/octomap/include/octomap/OccupancyOcTreeBase.h b/octomap/include/octomap/OccupancyOcTreeBase.h index a2646c39..f10b1ee0 100644 --- a/octomap/include/octomap/OccupancyOcTreeBase.h +++ b/octomap/include/octomap/OccupancyOcTreeBase.h @@ -1,6 +1,6 @@ /* * OctoMap - An Efficient Probabilistic 3D Mapping Framework Based on Octrees - * http://octomap.github.com/ + * https://octomap.github.io/ * * Copyright (c) 2009-2013, K.M. Wurm and A. Hornung, University of Freiburg * All rights reserved. diff --git a/octomap/include/octomap/OccupancyOcTreeBase.hxx b/octomap/include/octomap/OccupancyOcTreeBase.hxx index 241c2e7f..4e980c6e 100644 --- a/octomap/include/octomap/OccupancyOcTreeBase.hxx +++ b/octomap/include/octomap/OccupancyOcTreeBase.hxx @@ -1,6 +1,6 @@ /* * OctoMap - An Efficient Probabilistic 3D Mapping Framework Based on Octrees - * http://octomap.github.com/ + * https://octomap.github.io/ * * Copyright (c) 2009-2013, K.M. Wurm and A. Hornung, University of Freiburg * All rights reserved. diff --git a/octomap/include/octomap/Pointcloud.h b/octomap/include/octomap/Pointcloud.h index fbd6dfc3..5aff94a0 100644 --- a/octomap/include/octomap/Pointcloud.h +++ b/octomap/include/octomap/Pointcloud.h @@ -1,6 +1,6 @@ /* * OctoMap - An Efficient Probabilistic 3D Mapping Framework Based on Octrees - * http://octomap.github.com/ + * https://octomap.github.io/ * * Copyright (c) 2009-2013, K.M. Wurm and A. Hornung, University of Freiburg * All rights reserved. diff --git a/octomap/include/octomap/ScanGraph.h b/octomap/include/octomap/ScanGraph.h index 07c74360..91c26719 100644 --- a/octomap/include/octomap/ScanGraph.h +++ b/octomap/include/octomap/ScanGraph.h @@ -1,6 +1,6 @@ /* * OctoMap - An Efficient Probabilistic 3D Mapping Framework Based on Octrees - * http://octomap.github.com/ + * https://octomap.github.io/ * * Copyright (c) 2009-2013, K.M. Wurm and A. Hornung, University of Freiburg * All rights reserved. diff --git a/octomap/include/octomap/math/Pose6D.h b/octomap/include/octomap/math/Pose6D.h index b9cf393f..9618b6e8 100644 --- a/octomap/include/octomap/math/Pose6D.h +++ b/octomap/include/octomap/math/Pose6D.h @@ -1,6 +1,6 @@ /* * OctoMap - An Efficient Probabilistic 3D Mapping Framework Based on Octrees - * http://octomap.github.com/ + * https://octomap.github.io/ * * Copyright (c) 2009-2013, K.M. Wurm and A. Hornung, University of Freiburg * All rights reserved. diff --git a/octomap/include/octomap/math/Quaternion.h b/octomap/include/octomap/math/Quaternion.h index 7ed1985b..79b02bd7 100644 --- a/octomap/include/octomap/math/Quaternion.h +++ b/octomap/include/octomap/math/Quaternion.h @@ -1,6 +1,6 @@ /* * OctoMap - An Efficient Probabilistic 3D Mapping Framework Based on Octrees - * http://octomap.github.com/ + * https://octomap.github.io/ * * Copyright (c) 2009-2013, K.M. Wurm and A. Hornung, University of Freiburg * All rights reserved. diff --git a/octomap/include/octomap/math/Utils.h b/octomap/include/octomap/math/Utils.h index 6e92990f..3b07e1d8 100644 --- a/octomap/include/octomap/math/Utils.h +++ b/octomap/include/octomap/math/Utils.h @@ -1,6 +1,6 @@ /* * OctoMap - An Efficient Probabilistic 3D Mapping Framework Based on Octrees - * http://octomap.github.com/ + * https://octomap.github.io/ * * Copyright (c) 2009-2013, K.M. Wurm and A. Hornung, University of Freiburg * All rights reserved. diff --git a/octomap/include/octomap/math/Vector3.h b/octomap/include/octomap/math/Vector3.h index 49a4a73b..8bc4546e 100644 --- a/octomap/include/octomap/math/Vector3.h +++ b/octomap/include/octomap/math/Vector3.h @@ -1,6 +1,6 @@ /* * OctoMap - An Efficient Probabilistic 3D Mapping Framework Based on Octrees - * http://octomap.github.com/ + * https://octomap.github.io/ * * Copyright (c) 2009-2013, K.M. Wurm and A. Hornung, University of Freiburg * All rights reserved. diff --git a/octomap/include/octomap/octomap.h b/octomap/include/octomap/octomap.h index ffaed5b4..6481c2f0 100644 --- a/octomap/include/octomap/octomap.h +++ b/octomap/include/octomap/octomap.h @@ -1,6 +1,6 @@ /* * OctoMap - An Efficient Probabilistic 3D Mapping Framework Based on Octrees - * http://octomap.github.com/ + * https://octomap.github.io/ * * Copyright (c) 2009-2013, K.M. Wurm and A. Hornung, University of Freiburg * All rights reserved. diff --git a/octomap/include/octomap/octomap_deprecated.h b/octomap/include/octomap/octomap_deprecated.h index 2e7fc1e2..e58df818 100644 --- a/octomap/include/octomap/octomap_deprecated.h +++ b/octomap/include/octomap/octomap_deprecated.h @@ -1,6 +1,6 @@ /* * OctoMap - An Efficient Probabilistic 3D Mapping Framework Based on Octrees - * http://octomap.github.com/ + * https://octomap.github.io/ * * Copyright (c) 2009-2013, K.M. Wurm and A. Hornung, University of Freiburg * All rights reserved. diff --git a/octomap/include/octomap/octomap_timing.h b/octomap/include/octomap/octomap_timing.h index 6c18938c..2860e1c3 100644 --- a/octomap/include/octomap/octomap_timing.h +++ b/octomap/include/octomap/octomap_timing.h @@ -1,6 +1,6 @@ /* * OctoMap - An Efficient Probabilistic 3D Mapping Framework Based on Octrees - * http://octomap.github.com/ + * https://octomap.github.io/ * * Copyright (c) 2009-2013, K.M. Wurm and A. Hornung, University of Freiburg * All rights reserved. diff --git a/octomap/include/octomap/octomap_types.h b/octomap/include/octomap/octomap_types.h index 2ae7fedc..d6ceba96 100644 --- a/octomap/include/octomap/octomap_types.h +++ b/octomap/include/octomap/octomap_types.h @@ -1,6 +1,6 @@ /* * OctoMap - An Efficient Probabilistic 3D Mapping Framework Based on Octrees - * http://octomap.github.com/ + * https://octomap.github.io/ * * Copyright (c) 2009-2013, K.M. Wurm and A. Hornung, University of Freiburg * All rights reserved. diff --git a/octomap/include/octomap/octomap_utils.h b/octomap/include/octomap/octomap_utils.h index 949d78c9..452ba629 100644 --- a/octomap/include/octomap/octomap_utils.h +++ b/octomap/include/octomap/octomap_utils.h @@ -1,6 +1,6 @@ /* * OctoMap - An Efficient Probabilistic 3D Mapping Framework Based on Octrees - * http://octomap.github.com/ + * https://octomap.github.io/ * * Copyright (c) 2009-2013, K.M. Wurm and A. Hornung, University of Freiburg * All rights reserved. diff --git a/octomap/src/AbstractOcTree.cpp b/octomap/src/AbstractOcTree.cpp index d1d7f627..3cdc6235 100644 --- a/octomap/src/AbstractOcTree.cpp +++ b/octomap/src/AbstractOcTree.cpp @@ -1,6 +1,6 @@ /* * OctoMap - An Efficient Probabilistic 3D Mapping Framework Based on Octrees - * http://octomap.github.com/ + * https://octomap.github.io/ * * Copyright (c) 2009-2013, K.M. Wurm and A. Hornung, University of Freiburg * All rights reserved. diff --git a/octomap/src/AbstractOccupancyOcTree.cpp b/octomap/src/AbstractOccupancyOcTree.cpp index ee01b341..10f4da39 100644 --- a/octomap/src/AbstractOccupancyOcTree.cpp +++ b/octomap/src/AbstractOccupancyOcTree.cpp @@ -1,6 +1,6 @@ /* * OctoMap - An Efficient Probabilistic 3D Mapping Framework Based on Octrees - * http://octomap.github.com/ + * https://octomap.github.io/ * * Copyright (c) 2009-2013, K.M. Wurm and A. Hornung, University of Freiburg * All rights reserved. diff --git a/octomap/src/ColorOcTree.cpp b/octomap/src/ColorOcTree.cpp index 5760218f..6e969a93 100644 --- a/octomap/src/ColorOcTree.cpp +++ b/octomap/src/ColorOcTree.cpp @@ -1,6 +1,6 @@ /* * OctoMap - An Efficient Probabilistic 3D Mapping Framework Based on Octrees - * http://octomap.github.com/ + * https://octomap.github.io/ * * Copyright (c) 2009-2013, K.M. Wurm and A. Hornung, University of Freiburg * All rights reserved. diff --git a/octomap/src/CountingOcTree.cpp b/octomap/src/CountingOcTree.cpp index 941476d5..c0ec7278 100644 --- a/octomap/src/CountingOcTree.cpp +++ b/octomap/src/CountingOcTree.cpp @@ -1,6 +1,6 @@ /* * OctoMap - An Efficient Probabilistic 3D Mapping Framework Based on Octrees - * http://octomap.github.com/ + * https://octomap.github.io/ * * Copyright (c) 2009-2013, K.M. Wurm and A. Hornung, University of Freiburg * All rights reserved. diff --git a/octomap/src/OcTree.cpp b/octomap/src/OcTree.cpp index 69e34c25..855ad163 100644 --- a/octomap/src/OcTree.cpp +++ b/octomap/src/OcTree.cpp @@ -1,6 +1,6 @@ /* * OctoMap - An Efficient Probabilistic 3D Mapping Framework Based on Octrees - * http://octomap.github.com/ + * https://octomap.github.io/ * * Copyright (c) 2009-2013, K.M. Wurm and A. Hornung, University of Freiburg * All rights reserved. diff --git a/octomap/src/OcTreeNode.cpp b/octomap/src/OcTreeNode.cpp index dfeb5490..6e8dec85 100644 --- a/octomap/src/OcTreeNode.cpp +++ b/octomap/src/OcTreeNode.cpp @@ -1,6 +1,6 @@ /* * OctoMap - An Efficient Probabilistic 3D Mapping Framework Based on Octrees - * http://octomap.github.com/ + * https://octomap.github.io/ * * Copyright (c) 2009-2013, K.M. Wurm and A. Hornung, University of Freiburg * All rights reserved. diff --git a/octomap/src/OcTreeStamped.cpp b/octomap/src/OcTreeStamped.cpp index 8483f10c..c4564452 100644 --- a/octomap/src/OcTreeStamped.cpp +++ b/octomap/src/OcTreeStamped.cpp @@ -1,6 +1,6 @@ /* * OctoMap - An Efficient Probabilistic 3D Mapping Framework Based on Octrees - * http://octomap.github.com/ + * https://octomap.github.io/ * * Copyright (c) 2009-2013, K.M. Wurm and A. Hornung, University of Freiburg * All rights reserved. diff --git a/octomap/src/Pointcloud.cpp b/octomap/src/Pointcloud.cpp index 74127399..a6d4a745 100644 --- a/octomap/src/Pointcloud.cpp +++ b/octomap/src/Pointcloud.cpp @@ -1,6 +1,6 @@ /* * OctoMap - An Efficient Probabilistic 3D Mapping Framework Based on Octrees - * http://octomap.github.com/ + * https://octomap.github.io/ * * Copyright (c) 2009-2013, K.M. Wurm and A. Hornung, University of Freiburg * All rights reserved. diff --git a/octomap/src/ScanGraph.cpp b/octomap/src/ScanGraph.cpp index f3a0aeb0..370c9fb9 100644 --- a/octomap/src/ScanGraph.cpp +++ b/octomap/src/ScanGraph.cpp @@ -1,6 +1,6 @@ /* * OctoMap - An Efficient Probabilistic 3D Mapping Framework Based on Octrees - * http://octomap.github.com/ + * https://octomap.github.io/ * * Copyright (c) 2009-2013, K.M. Wurm and A. Hornung, University of Freiburg * All rights reserved. diff --git a/octomap/src/binvox2bt.cpp b/octomap/src/binvox2bt.cpp index 74ad151a..52aa1c49 100644 --- a/octomap/src/binvox2bt.cpp +++ b/octomap/src/binvox2bt.cpp @@ -1,6 +1,6 @@ /* * OctoMap - An Efficient Probabilistic 3D Mapping Framework Based on Octrees - * http://octomap.github.com/ + * https://octomap.github.io/ * * Copyright (c) 2009-2013, K.M. Wurm and A. Hornung, University of Freiburg * All rights reserved. diff --git a/octomap/src/bt2vrml.cpp b/octomap/src/bt2vrml.cpp index eb86ec1f..b06f8f21 100644 --- a/octomap/src/bt2vrml.cpp +++ b/octomap/src/bt2vrml.cpp @@ -1,6 +1,6 @@ /* * OctoMap - An Efficient Probabilistic 3D Mapping Framework Based on Octrees - * http://octomap.github.com/ + * https://octomap.github.io/ * * Copyright (c) 2009-2013, K.M. Wurm and A. Hornung, University of Freiburg * All rights reserved. diff --git a/octomap/src/compare_octrees.cpp b/octomap/src/compare_octrees.cpp index 78e03b8c..0ab8c26b 100644 --- a/octomap/src/compare_octrees.cpp +++ b/octomap/src/compare_octrees.cpp @@ -1,6 +1,6 @@ /* * OctoMap - An Efficient Probabilistic 3D Mapping Framework Based on Octrees - * http://octomap.github.com/ + * https://octomap.github.io/ * * Copyright (c) 2009-2013, K.M. Wurm and A. Hornung, University of Freiburg * All rights reserved. diff --git a/octomap/src/convert_octree.cpp b/octomap/src/convert_octree.cpp index 8616b8bc..acf42473 100644 --- a/octomap/src/convert_octree.cpp +++ b/octomap/src/convert_octree.cpp @@ -1,6 +1,6 @@ /* * OctoMap - An Efficient Probabilistic 3D Mapping Framework Based on Octrees - * http://octomap.github.com/ + * https://octomap.github.io/ * * Copyright (c) 2009-2013, K.M. Wurm and A. Hornung, University of Freiburg * All rights reserved. diff --git a/octomap/src/edit_octree.cpp b/octomap/src/edit_octree.cpp index 77cc3b23..5b354f30 100644 --- a/octomap/src/edit_octree.cpp +++ b/octomap/src/edit_octree.cpp @@ -1,6 +1,6 @@ /* * OctoMap - An Efficient Probabilistic 3D Mapping Framework Based on Octrees - * http://octomap.github.com/ + * https://octomap.github.io/ * * Copyright (c) 2009-2013, K.M. Wurm and A. Hornung, University of Freiburg * All rights reserved. diff --git a/octomap/src/eval_octree_accuracy.cpp b/octomap/src/eval_octree_accuracy.cpp index eddcf7ed..fbf79d76 100644 --- a/octomap/src/eval_octree_accuracy.cpp +++ b/octomap/src/eval_octree_accuracy.cpp @@ -1,6 +1,6 @@ /* * OctoMap - An Efficient Probabilistic 3D Mapping Framework Based on Octrees - * http://octomap.github.com/ + * https://octomap.github.io/ * * Copyright (c) 2009-2013, K.M. Wurm and A. Hornung, University of Freiburg * All rights reserved. diff --git a/octomap/src/graph2tree.cpp b/octomap/src/graph2tree.cpp index 90df1905..a0abbead 100644 --- a/octomap/src/graph2tree.cpp +++ b/octomap/src/graph2tree.cpp @@ -1,6 +1,6 @@ /* * OctoMap - An Efficient Probabilistic 3D Mapping Framework Based on Octrees - * http://octomap.github.com/ + * https://octomap.github.io/ * * Copyright (c) 2009-2013, K.M. Wurm and A. Hornung, University of Freiburg * All rights reserved. diff --git a/octomap/src/intersection_example.cpp b/octomap/src/intersection_example.cpp index 033915e8..191597e6 100644 --- a/octomap/src/intersection_example.cpp +++ b/octomap/src/intersection_example.cpp @@ -1,6 +1,6 @@ /* * OctoMap - An Efficient Probabilistic 3D Mapping Framework Based on Octrees - * http://octomap.github.com/ + * https://octomap.github.io/ * * Copyright (c) 2009-2013, K.M. Wurm and A. Hornung, University of Freiburg * All rights reserved. diff --git a/octomap/src/log2graph.cpp b/octomap/src/log2graph.cpp index 0dc55513..0a5ccd53 100644 --- a/octomap/src/log2graph.cpp +++ b/octomap/src/log2graph.cpp @@ -1,6 +1,6 @@ /* * OctoMap - An Efficient Probabilistic 3D Mapping Framework Based on Octrees - * http://octomap.github.com/ + * https://octomap.github.io/ * * Copyright (c) 2009-2013, K.M. Wurm and A. Hornung, University of Freiburg * All rights reserved. diff --git a/octomap/src/math/Pose6D.cpp b/octomap/src/math/Pose6D.cpp index 8d6a7aeb..c7c00342 100644 --- a/octomap/src/math/Pose6D.cpp +++ b/octomap/src/math/Pose6D.cpp @@ -1,6 +1,6 @@ /* * OctoMap - An Efficient Probabilistic 3D Mapping Framework Based on Octrees - * http://octomap.github.com/ + * https://octomap.github.io/ * * Copyright (c) 2009-2013, K.M. Wurm and A. Hornung, University of Freiburg * All rights reserved. diff --git a/octomap/src/math/Quaternion.cpp b/octomap/src/math/Quaternion.cpp index d3f07baf..992ef7a4 100644 --- a/octomap/src/math/Quaternion.cpp +++ b/octomap/src/math/Quaternion.cpp @@ -1,6 +1,6 @@ /* * OctoMap - An Efficient Probabilistic 3D Mapping Framework Based on Octrees - * http://octomap.github.com/ + * https://octomap.github.io/ * * Copyright (c) 2009-2013, K.M. Wurm and A. Hornung, University of Freiburg * All rights reserved. diff --git a/octomap/src/math/Vector3.cpp b/octomap/src/math/Vector3.cpp index d1de3f2d..6844d419 100644 --- a/octomap/src/math/Vector3.cpp +++ b/octomap/src/math/Vector3.cpp @@ -1,6 +1,6 @@ /* * OctoMap - An Efficient Probabilistic 3D Mapping Framework Based on Octrees - * http://octomap.github.com/ + * https://octomap.github.io/ * * Copyright (c) 2009-2013, K.M. Wurm and A. Hornung, University of Freiburg * All rights reserved. diff --git a/octomap/src/normals_example.cpp b/octomap/src/normals_example.cpp index 6a3abab0..cec574d5 100644 --- a/octomap/src/normals_example.cpp +++ b/octomap/src/normals_example.cpp @@ -1,6 +1,6 @@ /* * OctoMap - An Efficient Probabilistic 3D Mapping Framework Based on Octrees - * http://octomap.github.com/ + * https://octomap.github.io/ * * Copyright (c) 2009-2013, K.M. Wurm and A. Hornung, University of Freiburg * All rights reserved. diff --git a/octomap/src/octree2pointcloud.cpp b/octomap/src/octree2pointcloud.cpp index c74bbcd4..ec9578a9 100644 --- a/octomap/src/octree2pointcloud.cpp +++ b/octomap/src/octree2pointcloud.cpp @@ -1,6 +1,6 @@ /* * OctoMap - An Efficient Probabilistic 3D Mapping Framework Based on Octrees - * http://octomap.github.com/ + * https://octomap.github.io/ * * Copyright (c) 2009-2013, K.M. Wurm and A. Hornung, University of Freiburg * All rights reserved. diff --git a/octomap/src/offset_graph.cpp b/octomap/src/offset_graph.cpp index eb893f92..9e2fd3cc 100644 --- a/octomap/src/offset_graph.cpp +++ b/octomap/src/offset_graph.cpp @@ -1,6 +1,6 @@ /* * OctoMap - An Efficient Probabilistic 3D Mapping Framework Based on Octrees - * http://octomap.github.com/ + * https://octomap.github.io/ * * Copyright (c) 2009-2013, K.M. Wurm and A. Hornung, University of Freiburg * All rights reserved. diff --git a/octomap/src/simple_example.cpp b/octomap/src/simple_example.cpp index 783f7b1a..61c30d59 100644 --- a/octomap/src/simple_example.cpp +++ b/octomap/src/simple_example.cpp @@ -1,6 +1,6 @@ /* * OctoMap - An Efficient Probabilistic 3D Mapping Framework Based on Octrees - * http://octomap.github.com/ + * https://octomap.github.io/ * * Copyright (c) 2009-2013, K.M. Wurm and A. Hornung, University of Freiburg * All rights reserved. diff --git a/octovis/README.md b/octovis/README.md index 19c7e148..70e5bda4 100644 --- a/octovis/README.md +++ b/octovis/README.md @@ -2,7 +2,7 @@ Octomap - A probabilistic, flexible, and compact 3D mapping library for robotic ======================================================================================= Authors: K. M. Wurm, A. Hornung, University of Freiburg, Copyright (C) 2009-2013. -http://octomap.github.com +https://octomap.github.io Octovis is a visualization tool and library for OctoMap. It is distributed under the GPL license (see "LICENSE.txt"). diff --git a/octovis/src/ViewerWidget.cpp b/octovis/src/ViewerWidget.cpp index 8bfe7867..29377377 100644 --- a/octovis/src/ViewerWidget.cpp +++ b/octovis/src/ViewerWidget.cpp @@ -83,7 +83,7 @@ QString ViewerWidget::helpString() const{ "It provides data structures and mapping algorithms. The map is implemented " "using an octree. 3D maps can be viewed an built using this 3D viewer." "

" - "Octomap is available at http://octomap.github.com, and is actively " + "Octomap is available at https://octomap.github.io, and is actively " "maintained by Kai M. Wurm and Armin Hornung. This 3D viewer is based on " "libQGLViewer, available at http://www.libqglviewer.com/." "

" From 948048b39986b7c585c0f8e9ae6bfebc89073636 Mon Sep 17 00:00:00 2001 From: Wolfgang Merkt Date: Tue, 9 Nov 2021 19:55:15 +0000 Subject: [PATCH 08/27] Update Doxygen (#354) * [octomap] Update doxygen config * [octomap] Fix links in README * [octomap] Fix doxygen warnings --- octomap/README.md | 8 +- octomap/include/octomap/OcTreeIterator.hxx | 10 +- octomap/include/octomap/OccupancyOcTreeBase.h | 6 +- octomap/octomap.dox.in | 2602 +++++++++++------ 4 files changed, 1684 insertions(+), 942 deletions(-) diff --git a/octomap/README.md b/octomap/README.md index 8f8e6a48..cd16fbbf 100644 --- a/octomap/README.md +++ b/octomap/README.md @@ -4,9 +4,9 @@ Octomap - A probabilistic, flexible, and compact 3D mapping library for robotic Authors: Kai M. Wurm and Armin Hornung, University of Freiburg, Copyright (C) 2009-2013. https://octomap.github.io -See the [list of contributors](AUTHORS.txt) for further authors. +See the [list of contributors](https://github.com/OctoMap/octomap/blob/devel/octomap/AUTHORS.txt) for further authors. -License for octomap: [New BSD License](LICENSE.txt) +License for octomap: [New BSD License](https://github.com/OctoMap/octomap/blob/devel/octomap/LICENSE.txt) REQUIREMENTS @@ -104,7 +104,7 @@ ECLIPSE PROJECT FILES --------------------- Eclipse project files can be generated (with some limitations, see: -http://www.vtk.org/Wiki/Eclipse_CDT4_Generator) by running: +https://gitlab.kitware.com/cmake/community/-/wikis/doc/editors/Eclipse-CDT4-Generator) by running: cmake -G"Eclipse CDT4 - Unix Makefiles" .. @@ -121,7 +121,7 @@ The octomap library and tools can be compiled and used under Windows although this has not been tested in-depth. Feedback is welcome. -To compile the library you need cmake (http://www.cmake.org) +To compile the library you need cmake (https://www.cmake.org) and either MinGW or Visual Studio. ### MinGW ### diff --git a/octomap/include/octomap/OcTreeIterator.hxx b/octomap/include/octomap/OcTreeIterator.hxx index fabcad82..66ae63f8 100644 --- a/octomap/include/octomap/OcTreeIterator.hxx +++ b/octomap/include/octomap/OcTreeIterator.hxx @@ -49,7 +49,7 @@ * Constructor of the iterator. Initializes the iterator with the default * constructor (= end() iterator) if tree is empty or NULL. * - * @param tree OcTreeBaseImpl on which the iterator is used on + * @param ptree OcTreeBaseImpl on which the iterator is used on * @param depth Maximum depth to traverse the tree. 0 (default): unlimited */ iterator_base(OcTreeBaseImpl const* ptree, uint8_t depth=0) @@ -210,7 +210,7 @@ /** * Constructor of the iterator. * - * @param tree OcTreeBaseImpl on which the iterator is used on + * @param ptree OcTreeBaseImpl on which the iterator is used on * @param depth Maximum depth to traverse the tree. 0 (default): unlimited */ tree_iterator(OcTreeBaseImpl const* ptree, uint8_t depth=0) : iterator_base(ptree, depth) {}; @@ -267,7 +267,7 @@ /** * Constructor of the iterator. * - * @param tree OcTreeBaseImpl on which the iterator is used on + * @param ptree OcTreeBaseImpl on which the iterator is used on * @param depth Maximum depth to traverse the tree. 0 (default): unlimited */ leaf_iterator(OcTreeBaseImpl const* ptree, uint8_t depth=0) : iterator_base(ptree, depth) { @@ -345,7 +345,7 @@ * will include the bounding box coordinate. For a more exact control, use * the constructor with OcTreeKeys instead. * - * @param tree OcTreeBaseImpl on which the iterator is used on + * @param ptree OcTreeBaseImpl on which the iterator is used on * @param min Minimum point3d of the axis-aligned boundingbox * @param max Maximum point3d of the axis-aligned boundingbox * @param depth Maximum depth to traverse the tree. 0 (default): unlimited @@ -373,7 +373,7 @@ * Constructor of the iterator. This version uses the exact keys as axis-aligned * bounding box (including min and max). * - * @param tree OcTreeBaseImpl on which the iterator is used on + * @param ptree OcTreeBaseImpl on which the iterator is used on * @param min Minimum OcTreeKey to be included in the axis-aligned boundingbox * @param max Maximum OcTreeKey to be included in the axis-aligned boundingbox * @param depth Maximum depth to traverse the tree. 0 (default): unlimited diff --git a/octomap/include/octomap/OccupancyOcTreeBase.h b/octomap/include/octomap/OccupancyOcTreeBase.h index f10b1ee0..488fa5f9 100644 --- a/octomap/include/octomap/OccupancyOcTreeBase.h +++ b/octomap/include/octomap/OccupancyOcTreeBase.h @@ -318,11 +318,11 @@ namespace octomap { /** * Performs a step of the marching cubes surface reconstruction algorithm - * to retreive the normal of the triangles that fall in the cube + * to retrieve the normal of the triangles that fall in the cube * formed by the voxels located at the vertex of a given voxel. * - * @param[in] voxel for which retreive the normals - * @param[out] triangles normals + * @param[in] point voxel for which retrieve the normals + * @param[out] normals normals of the triangles * @param[in] unknownStatus consider unknown cells as free (false) or occupied (default, true). * @return True if the input voxel is known in the occupancy grid, and false if it is unknown. */ diff --git a/octomap/octomap.dox.in b/octomap/octomap.dox.in index d4ac3da4..2ef56191 100644 --- a/octomap/octomap.dox.in +++ b/octomap/octomap.dox.in @@ -1,110 +1,137 @@ -# Doxyfile 1.7.6.1 +# Doxyfile 1.8.17 # This file describes the settings to be used by the documentation system # doxygen (www.doxygen.org) for a project. # -# All text after a hash (#) is considered a comment and will be ignored. +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ignored. # The format is: -# TAG = value [value, ...] -# For lists items can also be appended using: -# TAG += value [value, ...] -# Values that contain spaces should be placed between quotes (" "). +# TAG = value [value, ...] +# For lists, items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). #--------------------------------------------------------------------------- # Project related configuration options #--------------------------------------------------------------------------- -# This tag specifies the encoding used for all characters in the config file -# that follow. The default is UTF-8 which is also the encoding used for all +# This tag specifies the encoding used for all characters in the configuration +# file that follow. The default is UTF-8 which is also the encoding used for all # text before the first occurrence of this tag. Doxygen uses libiconv (or the # iconv built into libc) for the transcoding. See -# http://www.gnu.org/software/libiconv for the list of possible encodings. +# https://www.gnu.org/software/libiconv/ for the list of possible encodings. +# The default value is: UTF-8. DOXYFILE_ENCODING = UTF-8 -# The PROJECT_NAME tag is a single word (or sequence of words) that should -# identify the project. Note that if you do not use Doxywizard you need -# to put quotes around the project name if it contains spaces. +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. PROJECT_NAME = "octomap" -# The PROJECT_NUMBER tag can be used to enter a project or revision number. -# This could be handy for archiving the generated documentation or -# if some version control system is used. +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This +# could be handy for archiving the generated documentation or if some version +# control system is used. PROJECT_NUMBER = @OCTOMAP_VERSION@ # Using the PROJECT_BRIEF tag one can provide an optional one line description -# for a project that appears at the top of each page and should give viewer -# a quick idea about the purpose of the project. Keep the description short. +# for a project that appears at the top of each page and should give viewer a +# quick idea about the purpose of the project. Keep the description short. -PROJECT_BRIEF = +PROJECT_BRIEF = -# With the PROJECT_LOGO tag one can specify an logo or icon that is -# included in the documentation. The maximum height of the logo should not -# exceed 55 pixels and the maximum width should not exceed 200 pixels. -# Doxygen will copy the logo to the output directory. +# With the PROJECT_LOGO tag one can specify a logo or an icon that is included +# in the documentation. The maximum height of the logo should not exceed 55 +# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy +# the logo to the output directory. PROJECT_LOGO = -# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) -# base path where the generated documentation will be put. -# If a relative path is entered, it will be relative to the location -# where doxygen was started. If left blank the current directory will be used. +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path +# into which the generated documentation will be written. If a relative path is +# entered, it will be relative to the location where doxygen was started. If +# left blank the current directory will be used. OUTPUT_DIRECTORY = doc -# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create -# 4096 sub-directories (in 2 levels) under the output directory of each output -# format and will distribute the generated files over these directories. -# Enabling this option can be useful when feeding doxygen a huge amount of -# source files, where putting all generated files in the same directory would -# otherwise cause performance problems for the file system. +# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- +# directories (in 2 levels) under the output directory of each output format and +# will distribute the generated files over these directories. Enabling this +# option can be useful when feeding doxygen a huge amount of source files, where +# putting all generated files in the same directory would otherwise causes +# performance problems for the file system. +# The default value is: NO. CREATE_SUBDIRS = NO +# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII +# characters to appear in the names of generated files. If set to NO, non-ASCII +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode +# U+3044. +# The default value is: NO. + +ALLOW_UNICODE_NAMES = NO + # The OUTPUT_LANGUAGE tag is used to specify the language in which all # documentation generated by doxygen is written. Doxygen will use this # information to generate all constant output in the proper language. -# The default language is English, other supported languages are: -# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, -# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, -# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English -# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, -# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, -# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, +# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), +# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, +# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, +# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, +# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, +# Ukrainian and Vietnamese. +# The default value is: English. OUTPUT_LANGUAGE = English -# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will -# include brief member descriptions after the members that are listed in -# the file and class documentation (similar to JavaDoc). -# Set to NO to disable this. +# The OUTPUT_TEXT_DIRECTION tag is used to specify the direction in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all generated output in the proper direction. +# Possible values are: None, LTR, RTL and Context. +# The default value is: None. + +OUTPUT_TEXT_DIRECTION = None + +# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. BRIEF_MEMBER_DESC = YES -# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend -# the brief description of a member or function before the detailed description. -# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the # brief descriptions will be completely suppressed. +# The default value is: YES. REPEAT_BRIEF = YES -# This tag implements a quasi-intelligent brief description abbreviator -# that is used to form the text in various listings. Each string -# in this list, if found as the leading text of the brief description, will be -# stripped from the text and the result after processing the whole list, is -# used as the annotated text. Otherwise, the brief description is used as-is. -# If left blank, the following values are used ("$name" is automatically -# replaced with the name of the entity): "The $name class" "The $name widget" -# "The $name file" "is" "provides" "specifies" "contains" -# "represents" "a" "an" "the" +# This tag implements a quasi-intelligent brief description abbreviator that is +# used to form the text in various listings. Each string in this list, if found +# as the leading text of the brief description, will be stripped from the text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name of +# the entity):The $name class, The $name widget, The $name file, is, provides, +# specifies, contains, represents, a, an and the. ABBREVIATE_BRIEF = # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then -# Doxygen will generate a detailed section even if there is only a brief +# doxygen will generate a detailed section even if there is only a brief # description. +# The default value is: NO. ALWAYS_DETAILED_SEC = NO @@ -112,228 +139,309 @@ ALWAYS_DETAILED_SEC = NO # inherited members of a class in the documentation of that class as if those # members were ordinary class members. Constructors, destructors and assignment # operators of the base classes will not be shown. +# The default value is: NO. INLINE_INHERITED_MEMB = YES -# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full -# path before files name in the file list and in the header files. If set -# to NO the shortest path that makes the file name unique will be used. +# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path +# before files name in the file list and in the header files. If set to NO the +# shortest path that makes the file name unique will be used +# The default value is: YES. FULL_PATH_NAMES = YES -# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag -# can be used to strip a user-defined part of the path. Stripping is -# only done if one of the specified strings matches the left-hand part of -# the path. The tag can be used to show relative paths in the file list. -# If left blank the directory from which doxygen is run is used as the -# path to strip. +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. STRIP_FROM_PATH = -# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of -# the path mentioned in the documentation of a class, which tells -# the reader which header file to include in order to use a class. -# If left blank only the name of the header file containing the class -# definition is used. Otherwise one should specify the include paths that -# are normally passed to the compiler using the -I flag. +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the +# path mentioned in the documentation of a class, which tells the reader which +# header file to include in order to use a class. If left blank only the name of +# the header file containing the class definition is used. Otherwise one should +# specify the list of include paths that are normally passed to the compiler +# using the -I flag. STRIP_FROM_INC_PATH = -# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter -# (but less readable) file names. This can be useful if your file system -# doesn't support long names like on DOS, Mac, or CD-ROM. +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but +# less readable) file names. This can be useful is your file systems doesn't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. SHORT_NAMES = NO -# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen -# will interpret the first line (until the first dot) of a JavaDoc-style -# comment as the brief description. If set to NO, the JavaDoc -# comments will behave just like regular Qt-style comments -# (thus requiring an explicit @brief command for a brief description.) +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the +# first line (until the first dot) of a Javadoc-style comment as the brief +# description. If set to NO, the Javadoc-style will behave just like regular Qt- +# style comments (thus requiring an explicit @brief command for a brief +# description.) +# The default value is: NO. JAVADOC_AUTOBRIEF = YES -# If the QT_AUTOBRIEF tag is set to YES then Doxygen will -# interpret the first line (until the first dot) of a Qt-style -# comment as the brief description. If set to NO, the comments -# will behave just like regular Qt-style comments (thus requiring -# an explicit \brief command for a brief description.) +# If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line +# such as +# /*************** +# as being the beginning of a Javadoc-style comment "banner". If set to NO, the +# Javadoc-style will behave just like regular comments and it will not be +# interpreted by doxygen. +# The default value is: NO. + +JAVADOC_BANNER = NO + +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first +# line (until the first dot) of a Qt-style comment as the brief description. If +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. QT_AUTOBRIEF = YES -# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen -# treat a multi-line C++ special comment block (i.e. a block of //! or /// -# comments) as a brief description. This used to be the default behaviour. -# The new default is to treat a multi-line C++ comment block as a detailed -# description. Set this tag to YES if you prefer the old behaviour instead. +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. MULTILINE_CPP_IS_BRIEF = YES -# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented -# member inherits the documentation from any documented member that it -# re-implements. +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. INHERIT_DOCS = YES -# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce -# a new page for each member. If set to NO, the documentation of a member will -# be part of the file/class/namespace that contains it. +# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new +# page for each member. If set to NO, the documentation of a member will be part +# of the file/class/namespace that contains it. +# The default value is: NO. SEPARATE_MEMBER_PAGES = NO -# The TAB_SIZE tag can be used to set the number of spaces in a tab. -# Doxygen uses this value to replace tabs by spaces in code fragments. +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen +# uses this value to replace tabs by spaces in code fragments. +# Minimum value: 1, maximum value: 16, default value: 4. TAB_SIZE = 2 -# This tag can be used to specify a number of aliases that acts -# as commands in the documentation. An alias has the form "name=value". -# For example adding "sideeffect=\par Side Effects:\n" will allow you to -# put the command \sideeffect (or @sideeffect) in the documentation, which -# will result in a user-defined paragraph with heading "Side Effects:". -# You can put \n's in the value part of an alias to insert newlines. +# This tag can be used to specify a number of aliases that act as commands in +# the documentation. An alias has the form: +# name=value +# For example adding +# "sideeffect=@par Side Effects:\n" +# will allow you to put the command \sideeffect (or @sideeffect) in the +# documentation, which will result in a user-defined paragraph with heading +# "Side Effects:". You can put \n's in the value part of an alias to insert +# newlines (in the resulting output). You can put ^^ in the value part of an +# alias to insert a newline as if a physical newline was in the original file. +# When you need a literal { or } or , in the value part of an alias you have to +# escape them by means of a backslash (\), this can lead to conflicts with the +# commands \{ and \} for these it is advised to use the version @{ and @} or use +# a double escape (\\{ and \\}) ALIASES = # This tag can be used to specify a number of word-keyword mappings (TCL only). -# A mapping has the form "name=value". For example adding -# "class=itcl::class" will allow you to use the command class in the -# itcl::class meaning. +# A mapping has the form "name=value". For example adding "class=itcl::class" +# will allow you to use the command class in the itcl::class meaning. TCL_SUBST = -# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C -# sources only. Doxygen will then generate output that is more tailored for C. -# For instance, some of the names that are used will be different. The list -# of all members will be omitted, etc. +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. OPTIMIZE_OUTPUT_FOR_C = YES -# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java -# sources only. Doxygen will then generate output that is more tailored for -# Java. For instance, namespaces will be presented as packages, qualified -# scopes will look different, etc. +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. OPTIMIZE_OUTPUT_JAVA = NO # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran -# sources only. Doxygen will then generate output that is more tailored for -# Fortran. +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. OPTIMIZE_FOR_FORTRAN = NO # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL -# sources. Doxygen will then generate output that is tailored for -# VHDL. +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. OPTIMIZE_OUTPUT_VHDL = NO +# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice +# sources only. Doxygen will then generate output that is more tailored for that +# language. For instance, namespaces will be presented as modules, types will be +# separated into more groups, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_SLICE = NO + # Doxygen selects the parser to use depending on the extension of the files it -# parses. With this tag you can assign which parser to use for a given extension. -# Doxygen has a built-in mapping, but you can override or extend it using this -# tag. The format is ext=language, where ext is a file extension, and language -# is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C, -# C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make -# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C -# (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions -# you also need to set FILE_PATTERNS otherwise the files are not read by doxygen. +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by doxygen: IDL, Java, JavaScript, +# Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice, +# Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: +# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser +# tries to guess whether the code is fixed or free formatted code, this is the +# default for Fortran type files), VHDL, tcl. For instance to make doxygen treat +# .inc files as Fortran files (default is PHP), and .f files as C (default is +# Fortran), use: inc=Fortran f=C. +# +# Note: For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. EXTENSION_MAPPING = +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See https://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up +# to that level are automatically included in the table of contents, even if +# they do not have an id attribute. +# Note: This feature currently applies only to Markdown headings. +# Minimum value: 0, maximum value: 99, default value: 5. +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. + +TOC_INCLUDE_HEADINGS = 5 + +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by putting a % sign in front of the word or +# globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want -# to include (a tag file for) the STL sources as input, then you should -# set this tag to YES in order to let doxygen match functions declarations and -# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. -# func(std::string) {}). This also makes the inheritance and collaboration +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also make the inheritance and collaboration # diagrams that involve STL classes more complete and accurate. +# The default value is: NO. BUILTIN_STL_SUPPORT = YES # If you use Microsoft's C++/CLI language, you should set this option to YES to # enable parsing support. +# The default value is: NO. CPP_CLI_SUPPORT = NO -# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. -# Doxygen will parse them like normal C++ but will assume all classes use public -# instead of private inheritance when no explicit protection keyword is present. +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen +# will parse them like normal C++ but will assume all classes use public instead +# of private inheritance when no explicit protection keyword is present. +# The default value is: NO. SIP_SUPPORT = NO -# For Microsoft's IDL there are propget and propput attributes to indicate getter -# and setter methods for a property. Setting this option to YES (the default) -# will make doxygen replace the get and set methods by a property in the -# documentation. This will only work if the methods are indeed getting or -# setting a simple type. If this is not the case, or you want to show the -# methods anyway, you should set this option to NO. +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES will make +# doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. IDL_PROPERTY_SUPPORT = YES # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC -# tag is set to YES, then doxygen will reuse the documentation of the first +# tag is set to YES then doxygen will reuse the documentation of the first # member in the group (if any) for the other members of the group. By default # all members of a group must be documented explicitly. +# The default value is: NO. DISTRIBUTE_GROUP_DOC = NO -# Set the SUBGROUPING tag to YES (the default) to allow class member groups of -# the same type (for instance a group of public functions) to be put as a -# subgroup of that type (e.g. under the Public Functions section). Set it to -# NO to prevent subgrouping. Alternatively, this can be done per class using -# the \nosubgrouping command. +# If one adds a struct or class to a group and this option is enabled, then also +# any nested class or struct is added to the same group. By default this option +# is disabled and one has to add nested compounds explicitly via \ingroup. +# The default value is: NO. + +GROUP_NESTED_COMPOUNDS = NO + +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. SUBGROUPING = YES -# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and -# unions are shown inside the group in which they are included (e.g. using -# @ingroup) instead of on a separate page (for HTML and Man pages) or -# section (for LaTeX and RTF). +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. INLINE_GROUPED_CLASSES = NO -# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and -# unions with only public data fields will be shown inline in the documentation -# of the scope in which they are defined (i.e. file, namespace, or group -# documentation), provided this scope is documented. If set to NO (the default), -# structs, classes, and unions are shown on a separate page (for HTML and Man -# pages) or section (for LaTeX and RTF). +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. INLINE_SIMPLE_STRUCTS = NO -# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum -# is documented as struct, union, or enum with the name of the typedef. So +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So # typedef struct TypeS {} TypeT, will appear in the documentation as a struct # with name TypeT. When disabled the typedef will appear as a member of a file, -# namespace, or class. And the struct will be named TypeS. This can typically -# be useful for C code in case the coding convention dictates that all compound +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound # types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. TYPEDEF_HIDES_STRUCT = NO -# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to -# determine which symbols to keep in memory and which to flush to disk. -# When the cache is full, less often used symbols will be written to disk. -# For small to medium size projects (<1000 input files) the default value is -# probably good enough. For larger projects a too small cache size can cause -# doxygen to be busy swapping symbols to and from disk most of the time -# causing a significant performance penalty. -# If the system has enough physical memory increasing the cache will improve the -# performance by keeping more symbols in memory. Note that the value works on -# a logarithmic scale so increasing the size by one will roughly double the -# memory usage. The cache size is given by this formula: -# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, -# corresponding to a cache size of 2^16 = 65536 symbols. - -SYMBOL_CACHE_SIZE = 0 - -# Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be -# set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given -# their name and scope. Since this can be an expensive process and often the -# same symbol appear multiple times in the code, doxygen keeps a cache of -# pre-resolved symbols. If the cache is too small doxygen will become slower. -# If the cache is too large, memory is wasted. The cache size is given by this -# formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0, -# corresponding to a cache size of 2^16 = 65536 symbols. +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. LOOKUP_CACHE_SIZE = 0 @@ -341,342 +449,415 @@ LOOKUP_CACHE_SIZE = 0 # Build related configuration options #--------------------------------------------------------------------------- -# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in -# documentation are documented, even if no documentation was available. -# Private class members and static file members will be hidden unless -# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES +# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. EXTRACT_ALL = YES -# If the EXTRACT_PRIVATE tag is set to YES all private members of a class -# will be included in the documentation. +# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will +# be included in the documentation. +# The default value is: NO. EXTRACT_PRIVATE = NO -# If the EXTRACT_STATIC tag is set to YES all static members of a file -# will be included in the documentation. +# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual +# methods of a class will be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIV_VIRTUAL = NO + +# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be +# included in the documentation. +# The default value is: NO. EXTRACT_STATIC = YES -# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) -# defined locally in source files will be included in the documentation. -# If set to NO only classes defined in header files are included. +# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO, +# only classes defined in header files are included. Does not have any effect +# for Java sources. +# The default value is: YES. EXTRACT_LOCAL_CLASSES = YES -# This flag is only useful for Objective-C code. When set to YES local -# methods, which are defined in the implementation section but not in -# the interface are included in the documentation. -# If set to NO (the default) only methods in the interface are included. +# This flag is only useful for Objective-C code. If set to YES, local methods, +# which are defined in the implementation section but not in the interface are +# included in the documentation. If set to NO, only methods in the interface are +# included. +# The default value is: NO. EXTRACT_LOCAL_METHODS = NO # If this flag is set to YES, the members of anonymous namespaces will be # extracted and appear in the documentation as a namespace called -# 'anonymous_namespace{file}', where file will be replaced with the base -# name of the file that contains the anonymous namespace. By default -# anonymous namespaces are hidden. +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. EXTRACT_ANON_NSPACES = NO -# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all -# undocumented members of documented classes, files or namespaces. -# If set to NO (the default) these members will be included in the -# various overviews, but no documentation section is generated. -# This option has no effect if EXTRACT_ALL is enabled. +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. HIDE_UNDOC_MEMBERS = NO -# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all -# undocumented classes that are normally visible in the class hierarchy. -# If set to NO (the default) these classes will be included in the various -# overviews. This option has no effect if EXTRACT_ALL is enabled. +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO, these classes will be included in the various overviews. This option +# has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. HIDE_UNDOC_CLASSES = NO -# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all -# friend (class|struct|union) declarations. -# If set to NO (the default) these declarations will be included in the +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# declarations. If set to NO, these declarations will be included in the # documentation. +# The default value is: NO. HIDE_FRIEND_COMPOUNDS = NO -# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any -# documentation blocks found inside the body of a function. -# If set to NO (the default) these blocks will be appended to the -# function's detailed documentation block. +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO, these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. HIDE_IN_BODY_DOCS = NO -# The INTERNAL_DOCS tag determines if documentation -# that is typed after a \internal command is included. If the tag is set -# to NO (the default) then the documentation will be excluded. -# Set it to YES to include the internal documentation. +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. INTERNAL_DOCS = NO -# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate -# file names in lower-case letters. If set to YES upper-case letters are also +# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file +# names in lower-case letters. If set to YES, upper-case letters are also # allowed. This is useful if you have classes or files whose names only differ # in case and if your file system supports case sensitive file names. Windows -# and Mac users are advised to set this option to NO. +# (including Cygwin) ands Mac users are advised to set this option to NO. +# The default value is: system dependent. CASE_SENSE_NAMES = YES -# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen -# will show members with their full class and namespace scopes in the -# documentation. If set to YES the scope will be hidden. +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES, the +# scope will be hidden. +# The default value is: NO. HIDE_SCOPE_NAMES = NO -# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen -# will put a list of the files that are included by a file in the documentation -# of that file. +# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will +# append additional text to a page's title, such as Class Reference. If set to +# YES the compound reference will be hidden. +# The default value is: NO. + +HIDE_COMPOUND_REFERENCE= NO + +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. SHOW_INCLUDE_FILES = NO -# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen -# will list include files with double quotes in the documentation -# rather than with sharp brackets. +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each +# grouped member an include statement to the documentation, telling the reader +# which file to include in order to use the member. +# The default value is: NO. + +SHOW_GROUPED_MEMB_INC = NO + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include +# files with double quotes in the documentation rather than with sharp brackets. +# The default value is: NO. FORCE_LOCAL_INCLUDES = NO -# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] -# is inserted in the documentation for inline members. +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. INLINE_INFO = YES -# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen -# will sort the (detailed) documentation of file and class members -# alphabetically by member name. If set to NO the members will appear in -# declaration order. +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the +# (detailed) documentation of file and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. +# The default value is: YES. SORT_MEMBER_DOCS = YES -# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the -# brief documentation of file, namespace and class members alphabetically -# by member name. If set to NO (the default) the members will appear in -# declaration order. +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. Note that +# this will also influence the order of the classes in the class list. +# The default value is: NO. SORT_BRIEF_DOCS = YES -# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen -# will sort the (brief and detailed) documentation of class members so that -# constructors and destructors are listed first. If set to NO (the default) -# the constructors will appear in the respective orders defined by -# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. -# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO -# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the +# (brief and detailed) documentation of class members so that constructors and +# destructors are listed first. If set to NO the constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: NO. SORT_MEMBERS_CTORS_1ST = NO -# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the -# hierarchy of group names into alphabetical order. If set to NO (the default) -# the group names will appear in their defined order. +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy +# of group names into alphabetical order. If set to NO the group names will +# appear in their defined order. +# The default value is: NO. SORT_GROUP_NAMES = NO -# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be -# sorted by fully-qualified names, including namespaces. If set to -# NO (the default), the class list will be sorted only by class name, -# not including the namespace part. +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by +# fully-qualified names, including namespaces. If set to NO, the class list will +# be sorted only by class name, not including the namespace part. # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. -# Note: This option applies only to the class list, not to the -# alphabetical list. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. SORT_BY_SCOPE_NAME = NO -# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to -# do proper type resolution of all parameters of a function it will reject a -# match between the prototype and the implementation of a member function even -# if there is only one candidate or it is obvious which candidate to choose -# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen -# will still accept a match between prototype and implementation in such cases. +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper +# type resolution of all parameters of a function it will reject a match between +# the prototype and the implementation of a member function even if there is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still +# accept a match between prototype and implementation in such cases. +# The default value is: NO. STRICT_PROTO_MATCHING = NO -# The GENERATE_TODOLIST tag can be used to enable (YES) or -# disable (NO) the todo list. This list is created by putting \todo -# commands in the documentation. +# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo +# list. This list is created by putting \todo commands in the documentation. +# The default value is: YES. GENERATE_TODOLIST = NO -# The GENERATE_TESTLIST tag can be used to enable (YES) or -# disable (NO) the test list. This list is created by putting \test -# commands in the documentation. +# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test +# list. This list is created by putting \test commands in the documentation. +# The default value is: YES. GENERATE_TESTLIST = YES -# The GENERATE_BUGLIST tag can be used to enable (YES) or -# disable (NO) the bug list. This list is created by putting \bug -# commands in the documentation. +# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug +# list. This list is created by putting \bug commands in the documentation. +# The default value is: YES. GENERATE_BUGLIST = NO -# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or -# disable (NO) the deprecated list. This list is created by putting -# \deprecated commands in the documentation. +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) +# the deprecated list. This list is created by putting \deprecated commands in +# the documentation. +# The default value is: YES. GENERATE_DEPRECATEDLIST= NO -# The ENABLED_SECTIONS tag can be used to enable conditional -# documentation sections, marked by \if sectionname ... \endif. +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if ... \endif and \cond +# ... \endcond blocks. ENABLED_SECTIONS = -# The MAX_INITIALIZER_LINES tag determines the maximum number of lines -# the initial value of a variable or macro consists of for it to appear in -# the documentation. If the initializer consists of more lines than specified -# here it will be hidden. Use a value of 0 to hide initializers completely. -# The appearance of the initializer of individual variables and macros in the -# documentation can be controlled using \showinitializer or \hideinitializer -# command in the documentation regardless of this setting. +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have for it to appear in the +# documentation. If the initializer consists of more lines than specified here +# it will be hidden. Use a value of 0 to hide initializers completely. The +# appearance of the value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. MAX_INITIALIZER_LINES = 30 -# Set the SHOW_USED_FILES tag to NO to disable the list of files generated -# at the bottom of the documentation of classes and structs. If set to YES the +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at +# the bottom of the documentation of classes and structs. If set to YES, the # list will mention the files that were used to generate the documentation. +# The default value is: YES. SHOW_USED_FILES = YES -# If the sources in your project are distributed over multiple directories -# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy -# in the documentation. The default is NO. - -SHOW_DIRECTORIES = NO - -# Set the SHOW_FILES tag to NO to disable the generation of the Files page. -# This will remove the Files entry from the Quick Index and from the -# Folder Tree View (if specified). The default is YES. +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This +# will remove the Files entry from the Quick Index and from the Folder Tree View +# (if specified). +# The default value is: YES. SHOW_FILES = YES -# Set the SHOW_NAMESPACES tag to NO to disable the generation of the -# Namespaces page. -# This will remove the Namespaces entry from the Quick Index -# and from the Folder Tree View (if specified). The default is YES. +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. SHOW_NAMESPACES = YES # The FILE_VERSION_FILTER tag can be used to specify a program or script that # doxygen should invoke to get the current version for each file (typically from # the version control system). Doxygen will invoke the program by executing (via -# popen()) the command , where is the value of -# the FILE_VERSION_FILTER tag, and is the name of an input file -# provided by doxygen. Whatever the program writes to standard output -# is used as the file version. See the manual for examples. +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. FILE_VERSION_FILTER = # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed # by doxygen. The layout file controls the global structure of the generated -# output files in an output format independent way. The create the layout file -# that represents doxygen's defaults, run doxygen with the -l option. -# You can optionally specify a file name after the option, if omitted -# DoxygenLayout.xml will be used as the name of the layout file. +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. LAYOUT_FILE = -# The CITE_BIB_FILES tag can be used to specify one or more bib files -# containing the references data. This must be a list of .bib files. The -# .bib extension is automatically appended if omitted. Using this command -# requires the bibtex tool to be installed. See also -# http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style -# of the bibliography can be controlled using LATEX_BIB_STYLE. To use this -# feature you need bibtex and perl available in the search path. +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. See also \cite for info how to create references. CITE_BIB_FILES = #--------------------------------------------------------------------------- -# configuration options related to warning and progress messages +# Configuration options related to warning and progress messages #--------------------------------------------------------------------------- -# The QUIET tag can be used to turn on/off the messages that are generated -# by doxygen. Possible values are YES and NO. If left blank NO is used. +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. QUIET = YES # The WARNINGS tag can be used to turn on/off the warning messages that are -# generated by doxygen. Possible values are YES and NO. If left blank -# NO is used. +# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. WARNINGS = NO -# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings -# for undocumented members. If EXTRACT_ALL is set to YES then this flag will -# automatically be disabled. +# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. WARN_IF_UNDOCUMENTED = YES -# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for -# potential errors in the documentation, such as not documenting some -# parameters in a documented function, or documenting parameters that -# don't exist or using markup commands wrongly. +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some parameters +# in a documented function, or documenting parameters that don't exist or using +# markup commands wrongly. +# The default value is: YES. WARN_IF_DOC_ERROR = YES -# The WARN_NO_PARAMDOC option can be enabled to get warnings for -# functions that are documented, but have no documentation for their parameters -# or return value. If set to NO (the default) doxygen will only warn about -# wrong or incomplete parameter documentation, but not about the absence of -# documentation. +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO, doxygen will only warn about wrong or incomplete +# parameter documentation, but not about the absence of documentation. If +# EXTRACT_ALL is set to YES then this flag will automatically be disabled. +# The default value is: NO. WARN_NO_PARAMDOC = NO -# The WARN_FORMAT tag determines the format of the warning messages that -# doxygen can produce. The string should contain the $file, $line, and $text -# tags, which will be replaced by the file and line number from which the -# warning originated and the warning text. Optionally the format may contain -# $version, which will be replaced by the version of the file (if it could -# be obtained via FILE_VERSION_FILTER) +# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when +# a warning is encountered. +# The default value is: NO. + +WARN_AS_ERROR = NO + +# The WARN_FORMAT tag determines the format of the warning messages that doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# The default value is: $file:$line: $text. WARN_FORMAT = "$file:$line: $text" -# The WARN_LOGFILE tag can be used to specify a file to which warning -# and error messages should be written. If left blank the output is written -# to stderr. +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). WARN_LOGFILE = "@CMAKE_CURRENT_BINARY_DIR@/doxygen_warnings.log" #--------------------------------------------------------------------------- -# configuration options related to the input files +# Configuration options related to the input files #--------------------------------------------------------------------------- -# The INPUT tag can be used to specify the files and/or directories that contain -# documented source files. You may enter file names like "myfile.cpp" or -# directories like "/usr/src/myproject". Separate the files or directories -# with spaces. +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING +# Note: If this tag is empty the current directory is searched. INPUT = # This tag can be used to specify the character encoding of the source files -# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is -# also the default input encoding. Doxygen uses libiconv (or the iconv built -# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for -# the list of possible encodings. +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: https://www.gnu.org/software/libiconv/) for the list of +# possible encodings. +# The default value is: UTF-8. INPUT_ENCODING = UTF-8 # If the value of the INPUT tag contains directories, you can use the -# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp -# and *.h) to filter out the source-files in the directories. If left -# blank the following patterns are tested: -# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh -# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py -# *.f90 *.f *.for *.vhd *.vhdl +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# read by doxygen. +# +# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, +# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, +# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, +# *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C comment), +# *.doc (to be provided as doxygen C comment), *.txt (to be provided as doxygen +# C comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f, *.for, *.tcl, *.vhd, +# *.vhdl, *.ucf, *.qsf and *.ice. FILE_PATTERNS = -# The RECURSIVE tag can be used to turn specify whether or not subdirectories -# should be searched for input files as well. Possible values are YES and NO. -# If left blank NO is used. +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. RECURSIVE = YES # The EXCLUDE tag can be used to specify files and/or directories that should be # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. +# # Note that relative paths are relative to the directory from which doxygen is # run. @@ -685,14 +866,16 @@ EXCLUDE = # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or # directories that are symbolic links (a Unix file system feature) are excluded # from the input. +# The default value is: NO. EXCLUDE_SYMLINKS = NO # If the value of the INPUT tag contains directories, you can use the # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude -# certain files from those directories. Note that the wildcards are matched -# against the file with absolute path, so to exclude all test directories -# for example use the pattern */test/* +# certain files from those directories. +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories for example use the pattern */test/* EXCLUDE_PATTERNS = */.svn/* \ */extern/* \ @@ -706,758 +889,1207 @@ EXCLUDE_PATTERNS = */.svn/* \ # output. The symbol name can be a fully qualified name, a word, or if the # wildcard * is used, a substring. Examples: ANamespace, AClass, # AClass::ANamespace, ANamespace::*Test +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories use the pattern */test/* EXCLUDE_SYMBOLS = GridData \ OcTreeNodeLight \ OcTreeNodeEightPointers -# The EXAMPLE_PATH tag can be used to specify one or more files or -# directories that contain example code fragments that are included (see -# the \include command). +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). EXAMPLE_PATH = # If the value of the EXAMPLE_PATH tag contains directories, you can use the -# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp -# and *.h) to filter out the source-files in the directories. If left -# blank all files are included. +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. EXAMPLE_PATTERNS = # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be -# searched for input files to be used with the \include or \dontinclude -# commands irrespective of the value of the RECURSIVE tag. -# Possible values are YES and NO. If left blank NO is used. +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. EXAMPLE_RECURSIVE = NO -# The IMAGE_PATH tag can be used to specify one or more files or -# directories that contain image that are included in the documentation (see -# the \image command). +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). IMAGE_PATH = share/images # The INPUT_FILTER tag can be used to specify a program that doxygen should # invoke to filter for each input file. Doxygen will invoke the filter program -# by executing (via popen()) the command , where -# is the value of the INPUT_FILTER tag, and is the name of an -# input file. Doxygen will then use the output that the filter program writes -# to standard output. -# If FILTER_PATTERNS is specified, this tag will be -# ignored. +# by executing (via popen()) the command: +# +# +# +# where is the value of the INPUT_FILTER tag, and is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. INPUT_FILTER = # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern -# basis. -# Doxygen will compare the file name with each pattern and apply the -# filter if there is a match. -# The filters are a list of the form: -# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further -# info on how filters are used. If FILTER_PATTERNS is empty or if -# non of the patterns match the file name, INPUT_FILTER is applied. +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. FILTER_PATTERNS = # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using -# INPUT_FILTER) will be used to filter the input files when producing source -# files to browse (i.e. when SOURCE_BROWSER is set to YES). +# INPUT_FILTER) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. FILTER_SOURCE_FILES = NO # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file -# pattern. A pattern will override the setting for FILTER_PATTERN (if any) -# and it is also possible to disable source filtering for a specific pattern -# using *.ext= (so without naming a filter). This option only has effect when -# FILTER_SOURCE_FILES is enabled. +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. FILTER_SOURCE_PATTERNS = +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = + #--------------------------------------------------------------------------- -# configuration options related to source browsing +# Configuration options related to source browsing #--------------------------------------------------------------------------- -# If the SOURCE_BROWSER tag is set to YES then a list of source files will -# be generated. Documented entities will be cross-referenced with these sources. -# Note: To get rid of all source code in the generated output, make sure also -# VERBATIM_HEADERS is set to NO. +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. SOURCE_BROWSER = NO -# Setting the INLINE_SOURCES tag to YES will include the body -# of functions and classes directly in the documentation. +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# classes and enums directly into the documentation. +# The default value is: NO. INLINE_SOURCES = NO -# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct -# doxygen to hide any special comment blocks from generated source code -# fragments. Normal C and C++ comments will always remain visible. +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. STRIP_CODE_COMMENTS = YES -# If the REFERENCED_BY_RELATION tag is set to YES -# then for each documented function all documented -# functions referencing it will be listed. +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# entity all documented functions referencing it will be listed. +# The default value is: NO. REFERENCED_BY_RELATION = YES -# If the REFERENCES_RELATION tag is set to YES -# then for each documented function all documented entities -# called/used by that function will be listed. +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. REFERENCES_RELATION = YES -# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) -# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from -# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will -# link to the source code. -# Otherwise they will link to the documentation. +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. REFERENCES_LINK_SOURCE = YES -# If the USE_HTAGS tag is set to YES then the references to source code -# will point to the HTML generated by the htags(1) tool instead of doxygen -# built-in source browser. The htags tool is part of GNU's global source -# tagging system (see http://www.gnu.org/software/global/global.html). You -# will need version 4.8.6 or higher. +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see https://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. USE_HTAGS = NO -# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen -# will generate a verbatim copy of the header file for each class for -# which an include is specified. Set to NO to disable this. +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. VERBATIM_HEADERS = YES +# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the +# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the +# cost of reduced performance. This can be particularly helpful with template +# rich C++ code for which doxygen's built-in parser lacks the necessary type +# information. +# Note: The availability of this option depends on whether or not doxygen was +# generated with the -Duse_libclang=ON option for CMake. +# The default value is: NO. + +CLANG_ASSISTED_PARSING = NO + +# If clang assisted parsing is enabled you can provide the compiler with command +# line options that you would normally use when invoking the compiler. Note that +# the include paths will already be set by doxygen for the files and directories +# specified with INPUT and INCLUDE_PATH. +# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. + +CLANG_OPTIONS = + +# If clang assisted parsing is enabled you can provide the clang parser with the +# path to the compilation database (see: +# http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) used when the files +# were built. This is equivalent to specifying the "-p" option to a clang tool, +# such as clang-check. These options will then be passed to the parser. +# Note: The availability of this option depends on whether or not doxygen was +# generated with the -Duse_libclang=ON option for CMake. + +CLANG_DATABASE_PATH = + #--------------------------------------------------------------------------- -# configuration options related to the alphabetical class index +# Configuration options related to the alphabetical class index #--------------------------------------------------------------------------- -# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index -# of all compounds will be generated. Enable this if the project -# contains a lot of classes, structs, unions or interfaces. +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. ALPHABETICAL_INDEX = NO -# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then -# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns -# in which this list will be split (can be a number in the range [1..20]) +# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in +# which the alphabetical index list will be split. +# Minimum value: 1, maximum value: 20, default value: 5. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. COLS_IN_ALPHA_INDEX = 5 -# In case all classes in a project start with a common prefix, all -# classes will be put under the same header in the alphabetical index. -# The IGNORE_PREFIX tag can be used to specify one or more prefixes that -# should be ignored while generating the index headers. +# In case all classes in a project start with a common prefix, all classes will +# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag +# can be used to specify a prefix (or a list of prefixes) that should be ignored +# while generating the index headers. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. IGNORE_PREFIX = #--------------------------------------------------------------------------- -# configuration options related to the HTML output +# Configuration options related to the HTML output #--------------------------------------------------------------------------- -# If the GENERATE_HTML tag is set to YES (the default) Doxygen will -# generate HTML output. +# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output +# The default value is: YES. GENERATE_HTML = YES -# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be -# put in front of it. If left blank `html' will be used as the default path. +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. HTML_OUTPUT = html -# The HTML_FILE_EXTENSION tag can be used to specify the file extension for -# each generated HTML page (for example: .htm,.php,.asp). If it is left blank -# doxygen will generate files with .html extension. +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. HTML_FILE_EXTENSION = .html -# The HTML_HEADER tag can be used to specify a personal HTML header for -# each generated HTML page. If it is left blank doxygen will generate a -# standard header. Note that when using a custom header you are responsible -# for the proper inclusion of any scripts and style sheets that doxygen -# needs, which is dependent on the configuration options used. -# It is advised to generate a default header using "doxygen -w html -# header.html footer.html stylesheet.css YourConfigFile" and then modify -# that header. Note that the header is subject to change so you typically -# have to redo this when upgrading to a newer version of doxygen or when -# changing the value of configuration settings such as GENERATE_TREEVIEW! +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. HTML_HEADER = -# The HTML_FOOTER tag can be used to specify a personal HTML footer for -# each generated HTML page. If it is left blank doxygen will generate a -# standard footer. +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. HTML_FOOTER = -# The HTML_STYLESHEET tag can be used to specify a user-defined cascading -# style sheet that is used by each HTML page. It can be used to -# fine-tune the look of the HTML output. If the tag is left blank doxygen -# will generate a default style sheet. Note that doxygen will try to copy -# the style sheet file to the HTML output directory, so don't put your own -# style sheet in the HTML output directory as well, or it will be erased! +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style +# sheet that is used by each HTML page. It can be used to fine-tune the look of +# the HTML output. If left blank doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. HTML_STYLESHEET = +# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined +# cascading style sheets that are included after the standard style sheets +# created by doxygen. Using this option one can overrule certain style aspects. +# This is preferred over using HTML_STYLESHEET since it does not replace the +# standard style sheet and is therefore more robust against future updates. +# Doxygen will copy the style sheet files to the output directory. +# Note: The order of the extra style sheet files is of importance (e.g. the last +# style sheet in the list overrules the setting of the previous ones in the +# list). For an example see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET = + # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or # other source files which should be copied to the HTML output directory. Note # that these files will be copied to the base HTML output directory. Use the -# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these -# files. In the HTML_STYLESHEET file, use the file name only. Also note that -# the files will be copied as-is; there are no commands or markers available. +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. HTML_EXTRA_FILES = -# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. -# Doxygen will adjust the colors in the style sheet and background images -# according to this color. Hue is specified as an angle on a colorwheel, -# see http://en.wikipedia.org/wiki/Hue for more information. -# For instance the value 0 represents red, 60 is yellow, 120 is green, -# 180 is cyan, 240 is blue, 300 purple, and 360 is red again. -# The allowed range is 0 to 359. +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the style sheet and background images according to +# this color. Hue is specified as an angle on a colorwheel, see +# https://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. HTML_COLORSTYLE_HUE = 220 -# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of -# the colors in the HTML output. For a value of 0 the output will use -# grayscales only. A value of 255 will produce the most vivid colors. +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors +# in the HTML output. For a value of 0 the output will use grayscales only. A +# value of 255 will produce the most vivid colors. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. HTML_COLORSTYLE_SAT = 100 -# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to -# the luminance component of the colors in the HTML output. Values below -# 100 gradually make the output lighter, whereas values above 100 make -# the output darker. The value divided by 100 is the actual gamma applied, -# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2, -# and 100 does not change the gamma. +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. HTML_COLORSTYLE_GAMMA = 80 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML -# page will contain the date and time when the page was generated. Setting -# this to NO can help when comparing the output of multiple runs. +# page will contain the date and time when the page was generated. Setting this +# to YES can help to show when doxygen was last run and thus if the +# documentation is up to date. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. HTML_TIMESTAMP = YES -# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, -# files or namespaces will be aligned in HTML using tables. If set to -# NO a bullet list will be used. +# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML +# documentation will contain a main index with vertical navigation menus that +# are dynamically created via JavaScript. If disabled, the navigation index will +# consists of multiple levels of tabs that are statically embedded in every HTML +# page. Disable this option to support browsers that do not have JavaScript, +# like the Qt help browser. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. -HTML_ALIGN_MEMBERS = YES +HTML_DYNAMIC_MENUS = YES # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML # documentation will contain sections that can be hidden and shown after the -# page has loaded. For this to work a browser that supports -# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox -# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). +# page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. HTML_DYNAMIC_SECTIONS = YES -# If the GENERATE_DOCSET tag is set to YES, additional index files -# will be generated that can be used as input for Apple's Xcode 3 -# integrated development environment, introduced with OSX 10.5 (Leopard). -# To create a documentation set, doxygen will generate a Makefile in the -# HTML output directory. Running make will produce the docset in that -# directory and running "make install" will install the docset in -# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find -# it at startup. -# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html -# for more information. +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated development +# environment (see: https://developer.apple.com/xcode/), introduced with OSX +# 10.5 (Leopard). To create a documentation set, doxygen will generate a +# Makefile in the HTML output directory. Running make will produce the docset in +# that directory and running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy +# genXcode/_index.html for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_DOCSET = NO -# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the -# feed. A documentation feed provides an umbrella under which multiple -# documentation sets from a single provider (such as a company or product suite) -# can be grouped. +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_FEEDNAME = "Doxygen generated docs" -# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that -# should uniquely identify the documentation set bundle. This should be a -# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen -# will append .docset to the name. +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_BUNDLE_ID = org.doxygen.Project -# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely identify +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify # the documentation publisher. This should be a reverse domain-name style # string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_PUBLISHER_ID = org.doxygen.Publisher -# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher. +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_PUBLISHER_NAME = Publisher -# If the GENERATE_HTMLHELP tag is set to YES, additional index files -# will be generated that can be used as input for tools like the -# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) -# of the generated HTML documentation. +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# (see: https://www.microsoft.com/en-us/download/details.aspx?id=21138) on +# Windows. +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_HTMLHELP = NO -# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can -# be used to specify the file name of the resulting .chm file. You -# can add a path in front of the file if the result should not be +# The CHM_FILE tag can be used to specify the file name of the resulting .chm +# file. You can add a path in front of the file if the result should not be # written to the html output directory. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. CHM_FILE = -# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can -# be used to specify the location (absolute path including file name) of -# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run -# the HTML help compiler on the generated index.hhp. +# The HHC_LOCATION tag can be used to specify the location (absolute path +# including file name) of the HTML help compiler (hhc.exe). If non-empty, +# doxygen will try to run the HTML help compiler on the generated index.hhp. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. HHC_LOCATION = -# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag -# controls if a separate .chi index file is generated (YES) or that -# it should be included in the master .chm file (NO). +# The GENERATE_CHI flag controls if a separate .chi index file is generated +# (YES) or that it should be included in the master .chm file (NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. GENERATE_CHI = NO -# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING -# is used to encode HtmlHelp index (hhk), content (hhc) and project file -# content. +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. CHM_INDEX_ENCODING = -# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag -# controls whether a binary table of contents is generated (YES) or a -# normal table of contents (NO) in the .chm file. +# The BINARY_TOC flag controls whether a binary table of contents is generated +# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it +# enables the Previous and Next buttons. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. BINARY_TOC = NO -# The TOC_EXPAND flag can be set to YES to add extra items for group members -# to the contents of the HTML help documentation and to the tree view. +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. TOC_EXPAND = NO # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and -# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated -# that can be used as input for Qt's qhelpgenerator to generate a -# Qt Compressed Help (.qch) of the generated HTML documentation. +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_QHP = NO -# If the QHG_LOCATION tag is specified, the QCH_FILE tag can -# be used to specify the file name of the resulting .qch file. -# The path specified is relative to the HTML output folder. +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. QCH_FILE = -# The QHP_NAMESPACE tag specifies the namespace to use when generating -# Qt Help Project output. For more information please see -# http://doc.trolltech.com/qthelpproject.html#namespace +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. QHP_NAMESPACE = org.doxygen.Project -# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating -# Qt Help Project output. For more information please see -# http://doc.trolltech.com/qthelpproject.html#virtual-folders +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual- +# folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. QHP_VIRTUAL_FOLDER = doc -# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to -# add. For more information please see -# http://doc.trolltech.com/qthelpproject.html#custom-filters +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. QHP_CUST_FILTER_NAME = -# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the -# custom filter to add. For more information please see -# -# Qt Help Project / Custom Filters. +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. QHP_CUST_FILTER_ATTRS = # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this -# project's -# filter section matches. -# -# Qt Help Project / Filter Attributes. +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. QHP_SECT_FILTER_ATTRS = -# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can -# be used to specify the location of Qt's qhelpgenerator. -# If non-empty doxygen will try to run qhelpgenerator on the generated -# .qhp file. +# The QHG_LOCATION tag can be used to specify the location of Qt's +# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the +# generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. QHG_LOCATION = -# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files -# will be generated, which together with the HTML files, form an Eclipse help -# plugin. To install this plugin and make it available under the help contents -# menu in Eclipse, the contents of the directory containing the HTML and XML -# files needs to be copied into the plugins directory of eclipse. The name of -# the directory within the plugins directory should be the same as -# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before -# the help appears. +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_ECLIPSEHELP = NO -# A unique identifier for the eclipse help plugin. When installing the plugin -# the directory name containing the HTML and XML files should also have -# this name. +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. ECLIPSE_DOC_ID = org.doxygen.Project -# The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) -# at top of each HTML page. The value NO (the default) enables the index and -# the value YES disables it. Since the tabs have the same information as the -# navigation tree you can set this option to NO if you already set -# GENERATE_TREEVIEW to YES. +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. DISABLE_INDEX = NO # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index -# structure should be generated to display hierarchical information. -# If the tag value is set to YES, a side panel will be generated -# containing a tree-like index structure (just like the one that -# is generated for HTML Help). For this to work a browser that supports -# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). -# Windows users are probably better off using the HTML help feature. -# Since the tree basically has the same information as the tab index you -# could consider to set DISABLE_INDEX to NO when enabling this option. +# structure should be generated to display hierarchical information. If the tag +# value is set to YES, a side panel will be generated containing a tree-like +# index structure (just like the one that is generated for HTML Help). For this +# to work a browser that supports JavaScript, DHTML, CSS and frames is required +# (i.e. any modern browser). Windows users are probably better off using the +# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can +# further fine-tune the look of the index. As an example, the default style +# sheet generated by doxygen has an example that shows how to put an image at +# the root of the tree instead of the PROJECT_NAME. Since the tree basically has +# the same information as the tab index, you could consider setting +# DISABLE_INDEX to YES when enabling this option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_TREEVIEW = YES -# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values -# (range [0,1..20]) that doxygen will group on one line in the generated HTML -# documentation. Note that a value of 0 will completely suppress the enum -# values from appearing in the overview section. +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that +# doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. ENUM_VALUES_PER_LINE = 4 -# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories, -# and Class Hierarchy pages using a tree view instead of an ordered list. - -USE_INLINE_TREES = NO - -# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be -# used to set the initial width (in pixels) of the frame in which the tree -# is shown. +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. TREEVIEW_WIDTH = 250 -# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open -# links to external symbols imported via tag files in a separate window. +# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. EXT_LINKS_IN_WINDOW = NO -# Use this tag to change the font size of Latex formulas included -# as images in the HTML documentation. The default is 10. Note that -# when you change the font size after a successful doxygen run you need -# to manually remove any form_*.png images from the HTML output directory -# to force them to be regenerated. +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. FORMULA_FONTSIZE = 10 -# Use the FORMULA_TRANPARENT tag to determine whether or not the images -# generated for formulas are transparent PNGs. Transparent PNGs are -# not supported properly for IE 6.0, but are supported on all modern browsers. -# Note that when changing this option you need to delete any form_*.png files -# in the HTML output before the changes have effect. +# Use the FORMULA_TRANSPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are not +# supported properly for IE 6.0, but are supported on all modern browsers. +# +# Note that when changing this option you need to delete any form_*.png files in +# the HTML output directory before the changes have effect. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. FORMULA_TRANSPARENT = YES -# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax -# (see http://www.mathjax.org) which uses client side Javascript for the -# rendering instead of using prerendered bitmaps. Use this if you do not -# have LaTeX installed or if you want to formulas look prettier in the HTML -# output. When enabled you also need to install MathJax separately and -# configure the path to it using the MATHJAX_RELPATH option. +# The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands +# to create new LaTeX commands to be used in formulas as building blocks. See +# the section "Including formulas" for details. + +FORMULA_MACROFILE = + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# https://www.mathjax.org) which uses client side JavaScript for the rendering +# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. USE_MATHJAX = NO -# When MathJax is enabled you need to specify the location relative to the -# HTML output directory using the MATHJAX_RELPATH option. The destination -# directory should contain the MathJax.js script. For instance, if the mathjax -# directory is located at the same level as the HTML output directory, then -# MATHJAX_RELPATH should be ../mathjax. The default value points to the -# mathjax.org site, so you can quickly see the result without installing -# MathJax, but it is strongly recommended to install a local copy of MathJax -# before deployment. +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. See the MathJax site (see: +# http://docs.mathjax.org/en/latest/output.html) for more details. +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility), NativeMML (i.e. MathML) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from https://www.mathjax.org before deployment. +# The default value is: https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/. +# This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_RELPATH = http://www.mathjax.org/mathjax -# The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension -# names that should be enabled during MathJax rendering. +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_EXTENSIONS = -# When the SEARCHENGINE tag is enabled doxygen will generate a search box -# for the HTML output. The underlying search engine uses javascript -# and DHTML and should work on any modern browser. Note that when using -# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets -# (GENERATE_DOCSET) there is already a search function so this one should -# typically be disabled. For large projects the javascript based search engine -# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution. +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces +# of code that will be used on startup of the MathJax code. See the MathJax site +# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for +# the HTML output. The underlying search engine uses javascript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the javascript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use + S +# (what the is depends on the OS and browser, but it is typically +# , / octomap + opengl libqglviewer-dev-qt5 @@ -34,6 +35,7 @@ libqt4-opengl-dev --> octomap + opengl libqglviewer2-qt5 From 0d51bcd83a33ef294c251036ec9bf27999112e72 Mon Sep 17 00:00:00 2001 From: Wolfgang Merkt Date: Sun, 17 Mar 2024 21:09:53 +0000 Subject: [PATCH 24/27] [CI] Remove ccache for ROS-Industrial CI yml (#413) * [CI] Remove ccache * [CI] Prerelease only for Noetic/Iron * [CI] Temporarily deactivate until transition to Ubuntu Noble is complete System dependency resolution fails despite packages supposedly available in Ubuntu repository --- .github/workflows/industrial_ci_action.yml | 16 +++++----------- 1 file changed, 5 insertions(+), 11 deletions(-) diff --git a/.github/workflows/industrial_ci_action.yml b/.github/workflows/industrial_ci_action.yml index 44ca9386..85e51ad0 100644 --- a/.github/workflows/industrial_ci_action.yml +++ b/.github/workflows/industrial_ci_action.yml @@ -1,7 +1,7 @@ # This config uses industrial_ci (https://github.com/ros-industrial/industrial_ci.git). # For troubleshooting, see readme (https://github.com/ros-industrial/industrial_ci/blob/master/README.rst) -name: CI +name: ROS-CI # This determines when this workflow is run on: [push, pull_request] # on all pushes and PRs @@ -11,19 +11,13 @@ jobs: strategy: matrix: env: - - {ROS_DISTRO: noetic} - - {ROS_DISTRO: rolling, PRERELEASE: true} + - {ROS_DISTRO: noetic, PRERELEASE: true} + - {ROS_DISTRO: iron, PRERELEASE: true} + #- {ROS_DISTRO: rolling} # 2024-03-12 temporarily deactivate until transitin to Ubuntu Noble is complete env: - CCACHE_DIR: /github/home/.ccache # Enable ccache BUILDER: colcon runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 - # This step will fetch/store the directory used by ccache before/after the ci run - - uses: actions/cache@v2 - with: - path: ${{ env.CCACHE_DIR }} - key: ccache-${{ matrix.env.ROS_DISTRO }}-${{ matrix.env.ROS_REPO }} - # Run industrial_ci + - uses: actions/checkout@v4 - uses: 'ros-industrial/industrial_ci@master' env: ${{ matrix.env }} From af240da1b2d8e9e43fdb9b967191d6a0bf2490d3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Wolfgang=20H=C3=B6nig?= Date: Sun, 17 Mar 2024 22:38:25 +0100 Subject: [PATCH 25/27] Octovis: fix issue with saving not showing any dialog (#414) See https://stackoverflow.com/questions/31983412/code-freezes-on-trying-to-open-qdialog --- octovis/src/ViewerGui.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/octovis/src/ViewerGui.cpp b/octovis/src/ViewerGui.cpp index 3943da7e..5fab2a0c 100644 --- a/octovis/src/ViewerGui.cpp +++ b/octovis/src/ViewerGui.cpp @@ -716,7 +716,7 @@ void ViewerGui::on_actionSave_file_triggered(){ } QString filename = QFileDialog::getSaveFileName(this, tr("Save octree file"), - "", tr("Full OcTree (*.ot);;Bonsai Tree file (*.bt);;")); + "", tr("Full OcTree (*.ot);;Bonsai Tree file (*.bt);;"), 0, QFileDialog::DontUseNativeDialog); if (filename != ""){ QApplication::setOverrideCursor(Qt::WaitCursor); From e5227fdb75074616d8c326706b729c9316b33360 Mon Sep 17 00:00:00 2001 From: Chris Lalancette Date: Sun, 17 Mar 2024 17:40:43 -0400 Subject: [PATCH 26/27] Updates to compile cleanly on ROS 2 Rolling on Ubuntu 24.04 (#415) * Update minimum to CMake 3.5. Newer CMake complains about anything older than that, and CMake 3.5 was released in 2016. Signed-off-by: Chris Lalancette * Cleanup stderr output from CMake. Calling message("mystring") in CMake, by default, outputs to stderr. Since these are generally informational messages, change this to message(STATUS "mystring"), which prints to stdout instead. This should quite down warnings when building with colcon (and on the ROS 2 buildfarm). Signed-off-by: Chris Lalancette * Add in a variable to control how OpenGL is found. Newer versions of CMake have changed how finding OpenGL works. If you don't specify anything at all, they will complain that you haven't told them how to find OpenGL. Work around this by explicitly setting OpenGL_GL_PREFERENCE to LEGACY, which tells CMake how you want to find OpenGL. This quiets the warning. Signed-off-by: Chris Lalancette * Switch away from 0 for Qt::WindowFlags. Apparently modern Qt has deprecated using an integer to initialize Qt::Flags objects. Instead, use the default constructor which should do the same thing. Signed-off-by: Chris Lalancette --------- Signed-off-by: Chris Lalancette --- dynamicEDT3D/CMakeLists.txt | 4 ++-- dynamicEDT3D/CMakeModules/CompilerSettings.cmake | 6 +++--- octomap/CMakeLists.txt | 4 ++-- octomap/CMakeModules/CompilerSettings.cmake | 2 +- octovis/CMakeLists.txt | 3 ++- octovis/CMakeModules/CompilerSettings.cmake | 4 ++-- octovis/src/extern/QGLViewer/qglviewer.h | 6 +++--- 7 files changed, 15 insertions(+), 14 deletions(-) diff --git a/dynamicEDT3D/CMakeLists.txt b/dynamicEDT3D/CMakeLists.txt index 0f899e4c..834a1d09 100644 --- a/dynamicEDT3D/CMakeLists.txt +++ b/dynamicEDT3D/CMakeLists.txt @@ -1,4 +1,4 @@ -CMAKE_MINIMUM_REQUIRED(VERSION 3.0.2) +CMAKE_MINIMUM_REQUIRED(VERSION 3.5) PROJECT(dynamicEDT3D) include(CTest) @@ -170,7 +170,7 @@ ENDIF(DOXYGEN_FOUND) INCLUDE(CPackSettings) # Finished: -MESSAGE ("\n") +MESSAGE (STATUS "\n") MESSAGE (STATUS "Compile dynamicEDT3D using: make") MESSAGE (STATUS "Install dynamicEDT3D using: make install") MESSAGE (STATUS " (be sure to set the correct CMAKE_INSTALL_PREFIX before)") diff --git a/dynamicEDT3D/CMakeModules/CompilerSettings.cmake b/dynamicEDT3D/CMakeModules/CompilerSettings.cmake index 51f1ebee..e2e6b4f5 100644 --- a/dynamicEDT3D/CMakeModules/CompilerSettings.cmake +++ b/dynamicEDT3D/CMakeModules/CompilerSettings.cmake @@ -4,13 +4,13 @@ IF(NOT CMAKE_CONFIGURATION_TYPES AND NOT CMAKE_BUILD_TYPE) SET(CMAKE_BUILD_TYPE Release) ENDIF(NOT CMAKE_CONFIGURATION_TYPES AND NOT CMAKE_BUILD_TYPE) -MESSAGE ("\n") +MESSAGE (STATUS "\n") MESSAGE (STATUS "${PROJECT_NAME} building as ${CMAKE_BUILD_TYPE}") # OCTOMAP_OMP = enable OpenMP # SET(OCTOMAP_OMP 1 CACHE BOOL "Enable/disable OpenMP") # IF($ENV{OCTOMAP_OMP}) -# SET(OCTOMAP_OMP $ENV{OCTOMAP_OMP}) +# SET(OCTOMAP_OMP $ENV{OCTOMAP_OMP}) # MESSAGE(STATUS "Found OCTOMAP_OMP=${OCTOMAP_OMP}") # ENDIF($ENV{OCTOMAP_OMP}) @@ -21,7 +21,7 @@ IF (CMAKE_COMPILER_IS_GNUCC) SET (CMAKE_CXX_FLAGS_RELEASE "-O3 -funroll-loops -DNDEBUG") SET (CMAKE_CXX_FLAGS_DEBUG "-O0 -g") # Shared object compilation under 64bit (vtable) - ADD_DEFINITIONS(-fPIC) + ADD_DEFINITIONS(-fPIC) # IF(OCTOMAP_OMP) # SET(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -fopenmp") # SET(CMAKE_CXX_FLAGS_RELEASE "${CMAKE_CXX_FLAGS} -fopenmp") diff --git a/octomap/CMakeLists.txt b/octomap/CMakeLists.txt index 12cb1f33..fc3bd6e7 100644 --- a/octomap/CMakeLists.txt +++ b/octomap/CMakeLists.txt @@ -1,4 +1,4 @@ -CMAKE_MINIMUM_REQUIRED(VERSION 3.0.2) +CMAKE_MINIMUM_REQUIRED(VERSION 3.5) PROJECT( octomap ) include(CTest) @@ -173,7 +173,7 @@ ENDIF(DOXYGEN_FOUND) INCLUDE(CPackSettings) # Finished: -MESSAGE ("\n") +MESSAGE (STATUS "\n") MESSAGE (STATUS "Compile octomap using: make") MESSAGE (STATUS "Install octomap using: make install") MESSAGE (STATUS " (be sure to set the correct CMAKE_INSTALL_PREFIX before)") diff --git a/octomap/CMakeModules/CompilerSettings.cmake b/octomap/CMakeModules/CompilerSettings.cmake index f4bab3e9..bae0cc48 100644 --- a/octomap/CMakeModules/CompilerSettings.cmake +++ b/octomap/CMakeModules/CompilerSettings.cmake @@ -4,7 +4,7 @@ IF(NOT CMAKE_CONFIGURATION_TYPES AND NOT CMAKE_BUILD_TYPE) SET(CMAKE_BUILD_TYPE Release) ENDIF(NOT CMAKE_CONFIGURATION_TYPES AND NOT CMAKE_BUILD_TYPE) -MESSAGE ("\n") +MESSAGE (STATUS "\n") MESSAGE (STATUS "${PROJECT_NAME} building as ${CMAKE_BUILD_TYPE}") # COMPILER FLAGS diff --git a/octovis/CMakeLists.txt b/octovis/CMakeLists.txt index e1e4f52a..892e29fa 100644 --- a/octovis/CMakeLists.txt +++ b/octovis/CMakeLists.txt @@ -1,4 +1,4 @@ -CMAKE_MINIMUM_REQUIRED(VERSION 3.0.2) +CMAKE_MINIMUM_REQUIRED(VERSION 3.5) PROJECT( octovis ) include(CTest) @@ -68,6 +68,7 @@ SET( BUILD_VIEWER 0) option(OCTOVIS_QT5 "Link Octovis against Qt5?" ON) # Look for required libraries: +set(OpenGL_GL_PREFERENCE LEGACY) FIND_PACKAGE(OpenGL) if(NOT OCTOVIS_QT5) FIND_PACKAGE(Qt4) diff --git a/octovis/CMakeModules/CompilerSettings.cmake b/octovis/CMakeModules/CompilerSettings.cmake index 759902f9..51f689b0 100644 --- a/octovis/CMakeModules/CompilerSettings.cmake +++ b/octovis/CMakeModules/CompilerSettings.cmake @@ -4,13 +4,13 @@ IF(NOT CMAKE_CONFIGURATION_TYPES AND NOT CMAKE_BUILD_TYPE) SET(CMAKE_BUILD_TYPE Release) ENDIF(NOT CMAKE_CONFIGURATION_TYPES AND NOT CMAKE_BUILD_TYPE) -MESSAGE ("\n") +MESSAGE (STATUS "\n") MESSAGE (STATUS "${PROJECT_NAME} building as ${CMAKE_BUILD_TYPE}") # OCTOMAP_OMP = enable OpenMP # SET(OCTOMAP_OMP 1 CACHE BOOL "Enable/disable OpenMP") # IF($ENV{OCTOMAP_OMP}) -# SET(OCTOMAP_OMP $ENV{OCTOMAP_OMP}) +# SET(OCTOMAP_OMP $ENV{OCTOMAP_OMP}) # MESSAGE(STATUS "Found OCTOMAP_OMP=${OCTOMAP_OMP}") # ENDIF($ENV{OCTOMAP_OMP}) diff --git a/octovis/src/extern/QGLViewer/qglviewer.h b/octovis/src/extern/QGLViewer/qglviewer.h index 561a1ea7..586ac457 100644 --- a/octovis/src/extern/QGLViewer/qglviewer.h +++ b/octovis/src/extern/QGLViewer/qglviewer.h @@ -81,9 +81,9 @@ class QGLVIEWER_EXPORT QGLViewer : public QGLWidget #else - explicit QGLViewer(QWidget* parent=0, const QGLWidget* shareWidget=0, Qt::WindowFlags flags=0); - explicit QGLViewer(QGLContext *context, QWidget* parent=0, const QGLWidget* shareWidget=0, Qt::WindowFlags flags=0); - explicit QGLViewer(const QGLFormat& format, QWidget* parent=0, const QGLWidget* shareWidget=0, Qt::WindowFlags flags=0); + explicit QGLViewer(QWidget* parent=0, const QGLWidget* shareWidget=0, Qt::WindowFlags flags=Qt::WindowFlags()); + explicit QGLViewer(QGLContext *context, QWidget* parent=0, const QGLWidget* shareWidget=0, Qt::WindowFlags flags=Qt::WindowFlags()); + explicit QGLViewer(const QGLFormat& format, QWidget* parent=0, const QGLWidget* shareWidget=0, Qt::WindowFlags flags=Qt::WindowFlags()); #endif virtual ~QGLViewer(); From 863e069489ef619d7179e3b21480dffb41b2af66 Mon Sep 17 00:00:00 2001 From: Armin Hornung Date: Tue, 19 Mar 2024 21:00:44 +0100 Subject: [PATCH 27/27] Version 1.10.0 release --- dynamicEDT3D/CMakeLists.txt | 4 ++-- dynamicEDT3D/package.xml | 2 +- octomap/CHANGELOG.txt | 18 ++++++++++++++++++ octomap/CMakeLists.txt | 4 ++-- octomap/package.xml | 2 +- octovis/CMakeLists.txt | 4 ++-- octovis/package.xml | 2 +- 7 files changed, 27 insertions(+), 9 deletions(-) diff --git a/dynamicEDT3D/CMakeLists.txt b/dynamicEDT3D/CMakeLists.txt index 834a1d09..7edfdde9 100644 --- a/dynamicEDT3D/CMakeLists.txt +++ b/dynamicEDT3D/CMakeLists.txt @@ -6,8 +6,8 @@ include(GNUInstallDirs) # version (e.g. for packaging) set(DYNAMICEDT3D_MAJOR_VERSION 1) -set(DYNAMICEDT3D_MINOR_VERSION 9) -set(DYNAMICEDT3D_PATCH_VERSION 8) +set(DYNAMICEDT3D_MINOR_VERSION 10) +set(DYNAMICEDT3D_PATCH_VERSION 0) set(DYNAMICEDT3D_VERSION ${DYNAMICEDT3D_MAJOR_VERSION}.${DYNAMICEDT3D_MINOR_VERSION}.${DYNAMICEDT3D_PATCH_VERSION}) set(DYNAMICEDT3D_SOVERSION ${DYNAMICEDT3D_MAJOR_VERSION}.${DYNAMICEDT3D_MINOR_VERSION}) diff --git a/dynamicEDT3D/package.xml b/dynamicEDT3D/package.xml index 346c5635..7c33a3eb 100644 --- a/dynamicEDT3D/package.xml +++ b/dynamicEDT3D/package.xml @@ -1,6 +1,6 @@ dynamic_edt_3d - 1.9.8 + 1.10.0 The dynamicEDT3D library implements an inrementally updatable Euclidean distance transform (EDT) in 3D. It comes with a wrapper to use the OctoMap 3D representation and hooks into the change detection of the OctoMap library to propagate changes to the EDT. Christoph Sprunk diff --git a/octomap/CHANGELOG.txt b/octomap/CHANGELOG.txt index 04ec13be..a5fca3e4 100644 --- a/octomap/CHANGELOG.txt +++ b/octomap/CHANGELOG.txt @@ -1,3 +1,21 @@ +v1.10.0: 2024-03-19 +=================== +- CMake: Fix duplicate uninstall target (#406) +- Fix errors with recent compilers and C++17/20 standard (#394) +- Fix ScanGraph.h c++20 compilation error (#398) +- Add smaller than operator for vectors (#330) +- Add vcpkg installation instructions to Readme (#382) +- Fix test dependencies in CMakeLists (#374) +- replace deprecated std::iterator by defining required types (#373) +- octovis: fix issue with saving not showing any dialog (#414) +- octovis: Fix deprecated QString and glext redefinition warning (#375) +- octovis: Declare missing dependency on opengl (#408) +- ROS: Updates to compile cleanly on ROS 2 Rolling on Ubuntu 24.04 (#415) +- ROS: Remove ccache for ROS-Industrial CI yml (#413) +- ROS: Remove EOL ROS distros from CI actions + + + v1.9.8: 2022-05-12 ================== - Also set lowercase octomap_* variables in CMake config (#369) diff --git a/octomap/CMakeLists.txt b/octomap/CMakeLists.txt index fc3bd6e7..87a78e9c 100644 --- a/octomap/CMakeLists.txt +++ b/octomap/CMakeLists.txt @@ -6,8 +6,8 @@ include(GNUInstallDirs) # version (e.g. for packaging) set(OCTOMAP_MAJOR_VERSION 1) -set(OCTOMAP_MINOR_VERSION 9) -set(OCTOMAP_PATCH_VERSION 8) +set(OCTOMAP_MINOR_VERSION 10) +set(OCTOMAP_PATCH_VERSION 0) set(OCTOMAP_VERSION ${OCTOMAP_MAJOR_VERSION}.${OCTOMAP_MINOR_VERSION}.${OCTOMAP_PATCH_VERSION}) set(OCTOMAP_SOVERSION ${OCTOMAP_MAJOR_VERSION}.${OCTOMAP_MINOR_VERSION}) if(COMMAND cmake_policy) diff --git a/octomap/package.xml b/octomap/package.xml index 900b6eb0..733ce768 100644 --- a/octomap/package.xml +++ b/octomap/package.xml @@ -1,6 +1,6 @@ octomap - 1.9.8 + 1.10.0 The OctoMap library implements a 3D occupancy grid mapping approach, providing data structures and mapping algorithms in C++. The map implementation is based on an octree. See http://octomap.github.io for details. diff --git a/octovis/CMakeLists.txt b/octovis/CMakeLists.txt index 892e29fa..84fa3675 100644 --- a/octovis/CMakeLists.txt +++ b/octovis/CMakeLists.txt @@ -6,8 +6,8 @@ include(GNUInstallDirs) # # version (e.g. for packaging) set(OCTOVIS_MAJOR_VERSION 1) -set(OCTOVIS_MINOR_VERSION 9) -set(OCTOVIS_PATCH_VERSION 8) +set(OCTOVIS_MINOR_VERSION 10) +set(OCTOVIS_PATCH_VERSION 0) set(OCTOVIS_VERSION ${OCTOVIS_MAJOR_VERSION}.${OCTOVIS_MINOR_VERSION}.${OCTOVIS_PATCH_VERSION}) set(OCTOVIS_SOVERSION ${OCTOVIS_MAJOR_VERSION}.${OCTOVIS_MINOR_VERSION}) # get rid of a useless warning: diff --git a/octovis/package.xml b/octovis/package.xml index c01f2523..4443bc26 100644 --- a/octovis/package.xml +++ b/octovis/package.xml @@ -1,6 +1,6 @@ octovis - 1.9.8 + 1.10.0 octovis is visualization tool for the OctoMap library based on Qt and libQGLViewer. See http://octomap.github.io for details.