From 8a296512595225235e1f156e891f123f068590e6 Mon Sep 17 00:00:00 2001
From: Rainer Kartmann <rainer.kartmann@kit.edu>
Date: Mon, 29 Nov 2021 15:18:52 +0100
Subject: [PATCH] Clean up doxygen group
---
etc/doxygen/mainpage.dox | 20 +++++++++----------
etc/doxygen/pages/Components.dox | 4 ++--
etc/doxygen/pages/FAQ.dox | 4 ++--
etc/doxygen/pages/GuiPlugins.dox | 6 +++---
etc/doxygen/pages/HowTos.dox | 4 ++--
etc/doxygen/pages/Overview.dox | 6 +++---
etc/doxygen/pages/Tutorials.dox | 4 ++--
.../armarx/navigation/algorithms/algorithms.h | 2 +-
.../NavigationMemory/NavigationMemory.h | 2 +-
.../components/Navigator/Navigator.h | 2 +-
.../components/example_client/Component.h | 2 +-
.../armarx/navigation/global_planning/core.h | 2 +-
.../LocationGraphEditor/WidgetController.h | 2 +-
source/armarx/navigation/memory/memory.h | 2 +-
14 files changed, 31 insertions(+), 31 deletions(-)
diff --git a/etc/doxygen/mainpage.dox b/etc/doxygen/mainpage.dox
index 88851baf..a5f924dd 100644
--- a/etc/doxygen/mainpage.dox
+++ b/etc/doxygen/mainpage.dox
@@ -1,18 +1,18 @@
/**
\mainpage
-\image html simulation-a-star.png ""
+ \image html simulation-a-star.png ""
- Navigation provides
+ ArmarX Navigation provides
- \li \subpage Navigation-Overview "Navigation Overview"
- \li \subpage Navigation-Tutorials "Navigation Tutorials"
- \li \subpage Navigation-HowTos "Navigation Howtos"
- \li \subpage Navigation-FAQ "Navigation FAQ"
- \li \subpage Navigation-Components "Navigation Components"
- \li \subpage Navigation-GuiPlugins "Navigation Gui Plugins"
- \li \subpage Navigation-About "Navigation About"
- \li \subpage Navigation-License "Navigation License"
+ \li \subpage armarx_navigation-Overview "armarx_navigation Overview"
+ \li \subpage armarx_navigation-Tutorials "armarx_navigation Tutorials"
+ \li \subpage armarx_navigation-HowTos "armarx_navigation Howtos"
+ \li \subpage armarx_navigation-FAQ "armarx_navigation FAQ"
+ \li \subpage armarx_navigation-Components "armarx_navigation Components"
+ \li \subpage armarx_navigation-GuiPlugins "armarx_navigation Gui Plugins"
+ \li \subpage armarx_navigation-About "armarx_navigation About"
+ \li \subpage armarx_navigation-License "armarx_navigation License"
*/
diff --git a/etc/doxygen/pages/Components.dox b/etc/doxygen/pages/Components.dox
index 90c1d98b..3e942555 100644
--- a/etc/doxygen/pages/Components.dox
+++ b/etc/doxygen/pages/Components.dox
@@ -4,8 +4,8 @@ Components are the main building blocks of ArmarX and offer services for other a
Each component usually implements one Ice interface by which it offers its services.
They can be configured with \ref armarx-componentproperties via config files.
-\defgroup Navigation-Components Navigation Components
-\ingroup Navigation Components
+\defgroup armarx_navigation-Components armarx_navigation Components
+\ingroup armarx_navigation Components
*/
diff --git a/etc/doxygen/pages/FAQ.dox b/etc/doxygen/pages/FAQ.dox
index 3cf4a597..6d68a4b0 100644
--- a/etc/doxygen/pages/FAQ.dox
+++ b/etc/doxygen/pages/FAQ.dox
@@ -1,8 +1,8 @@
/**
-\page Navigation-FAQ Navigation FAQ
+\page armarx_navigation-FAQ armarx_navigation FAQ
-\section Navigation-FAQ-change_this FAQ Entry Title
+\section armarx_navigation-FAQ-change_this FAQ Entry Title
Description here
diff --git a/etc/doxygen/pages/GuiPlugins.dox b/etc/doxygen/pages/GuiPlugins.dox
index 60913c63..06b4c0b8 100644
--- a/etc/doxygen/pages/GuiPlugins.dox
+++ b/etc/doxygen/pages/GuiPlugins.dox
@@ -1,10 +1,10 @@
/**
-\page Navigation-GuiPlugins Navigation Gui Plugins
+\page armarx_navigation-GuiPlugins armarx_navigation Gui Plugins
-This is a list of Gui Plugins available in Navigation
+This is a list of Gui Plugins available in armarx_navigation
-\subpage Navigation-GuiPlugins-WidgetName The page for WidgetName is defined in the WidgetNameWidgetController header file
+\subpage armarx_navigation-GuiPlugins-LocationGraphEditor
*/
diff --git a/etc/doxygen/pages/HowTos.dox b/etc/doxygen/pages/HowTos.dox
index 0db1f046..78a15c4d 100644
--- a/etc/doxygen/pages/HowTos.dox
+++ b/etc/doxygen/pages/HowTos.dox
@@ -1,8 +1,8 @@
/**
-\page Navigation-HowTos Navigation HowTos
+\page armarx_navigation-HowTos armarx_navigation HowTos
-\section Navigation-HowTo-change_this HowTo Title
+\section armarx_navigation-HowTo-change_this HowTo Title
Description (the change_this part of the section identifier must be edited to be descriptive and unique)
diff --git a/etc/doxygen/pages/Overview.dox b/etc/doxygen/pages/Overview.dox
index 97aa2af7..2f9ca7d5 100644
--- a/etc/doxygen/pages/Overview.dox
+++ b/etc/doxygen/pages/Overview.dox
@@ -1,10 +1,10 @@
/**
-\page Navigation-Overview Navigation Overview
+\page armarx_navigation-Overview armarx_navigation Overview
-\section Navigation-Stack Navigation stack
+\section armarx_navigation-Stack armarx_navigation stack
It comprises four main layers:
@@ -17,7 +17,7 @@ It comprises four main layers:
-\addtogroup Navigation Navigation
+\addtogroup armarx_navigation armarx_navigation
*/
diff --git a/etc/doxygen/pages/Tutorials.dox b/etc/doxygen/pages/Tutorials.dox
index aedeb9c7..3b4b234c 100644
--- a/etc/doxygen/pages/Tutorials.dox
+++ b/etc/doxygen/pages/Tutorials.dox
@@ -1,9 +1,9 @@
/**
-\page Navigation-Tutorials Navigation Tutorials
+\page armarx_navigation-Tutorials armarx_navigation Tutorials
List of available tutorials:
- \li \subpage Navigation-Tutorials-change_this "Tutorial Title"
+ \li \subpage armarx_navigation-Tutorials-change_this "Tutorial Title"
*/
diff --git a/source/armarx/navigation/algorithms/algorithms.h b/source/armarx/navigation/algorithms/algorithms.h
index 0a0d7a21..e4ef97e7 100644
--- a/source/armarx/navigation/algorithms/algorithms.h
+++ b/source/armarx/navigation/algorithms/algorithms.h
@@ -27,7 +27,7 @@ namespace armarx
{
/**
* @defgroup Library-algorithms algorithms
- * @ingroup Navigation
+ * @ingroup armarx_navigation
* A description of the library algorithms.
*
* @class algorithms
diff --git a/source/armarx/navigation/components/NavigationMemory/NavigationMemory.h b/source/armarx/navigation/components/NavigationMemory/NavigationMemory.h
index a7e82251..11bd41fd 100644
--- a/source/armarx/navigation/components/NavigationMemory/NavigationMemory.h
+++ b/source/armarx/navigation/components/NavigationMemory/NavigationMemory.h
@@ -40,7 +40,7 @@ namespace armarx::navigation
/**
* @defgroup Component-NavigationMemory NavigationMemory
- * @ingroup Navigation-Components
+ * @ingroup armarx_navigation-Components
* A description of the component NavigationMemory.
*
* @class NavigationMemory
diff --git a/source/armarx/navigation/components/Navigator/Navigator.h b/source/armarx/navigation/components/Navigator/Navigator.h
index e557ffff..2d7411d8 100644
--- a/source/armarx/navigation/components/Navigator/Navigator.h
+++ b/source/armarx/navigation/components/Navigator/Navigator.h
@@ -68,7 +68,7 @@ namespace armarx::navigation::components
/**
* @defgroup Component-Navigator Navigator
- * @ingroup Navigation-Components
+ * @ingroup armarx_navigation-Components
* A description of the component Navigator.
*
* @class Navigator
diff --git a/source/armarx/navigation/components/example_client/Component.h b/source/armarx/navigation/components/example_client/Component.h
index 9f8ede9a..1864c62e 100644
--- a/source/armarx/navigation/components/example_client/Component.h
+++ b/source/armarx/navigation/components/example_client/Component.h
@@ -34,7 +34,7 @@ namespace armarx::navigation::components::example_client
/**
* @defgroup Component-ExampleClient ExampleClient
- * @ingroup Navigation-Components
+ * @ingroup armarx_navigation-Components
* A description of the component ExampleClient.
*
* @class ExampleClient
diff --git a/source/armarx/navigation/global_planning/core.h b/source/armarx/navigation/global_planning/core.h
index f94ca4aa..a5d5aa31 100644
--- a/source/armarx/navigation/global_planning/core.h
+++ b/source/armarx/navigation/global_planning/core.h
@@ -28,7 +28,7 @@ namespace armarx::navigation::glob_plan
{
/**
* @defgroup Library-GlobalPlanner GlobalPlanner
- * @ingroup Navigation
+ * @ingroup armarx_navigation
* A description of the library global_planner.
*/
diff --git a/source/armarx/navigation/gui-plugins/LocationGraphEditor/WidgetController.h b/source/armarx/navigation/gui-plugins/LocationGraphEditor/WidgetController.h
index 4e06004d..f06f0bde 100644
--- a/source/armarx/navigation/gui-plugins/LocationGraphEditor/WidgetController.h
+++ b/source/armarx/navigation/gui-plugins/LocationGraphEditor/WidgetController.h
@@ -64,7 +64,7 @@ namespace armarx::navigation::qt_plugins::location_graph_editor
/**
- \page Navigation-GuiPlugins-LocationGraphEditor LocationGraphEditor
+ \page armarx_navigation-GuiPlugins-LocationGraphEditor LocationGraphEditor
\brief The LocationGraphEditor allows visualizing ...
\image html LocationGraphEditor.png
diff --git a/source/armarx/navigation/memory/memory.h b/source/armarx/navigation/memory/memory.h
index 8d082c60..c8db6290 100644
--- a/source/armarx/navigation/memory/memory.h
+++ b/source/armarx/navigation/memory/memory.h
@@ -27,7 +27,7 @@ namespace armarx
{
/**
* @defgroup Library-memory memory
- * @ingroup Navigation
+ * @ingroup armarx_navigation
* A description of the library memory.
*
* @class memory
--
GitLab