Improved doxygen (#996)

* Improved doxygen Signed-off-by: ahcorde <[email protected]> * Improved docs Signed-off-by: ahcorde <[email protected]>
gazebosim · Aug 26, 2021 · c625586 · c625586
1 parent d94d585
commit c625586
Show file tree

Hide file tree

Showing 33 changed files with 273 additions and 226 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -178,6 +178,7 @@ if (NOT APPLE)
     API_MAINPAGE_MD "${CMAKE_BINARY_DIR}/api.md"
     TUTORIALS_MAINPAGE_MD "${CMAKE_BINARY_DIR}/tutorials.md"
     ADDITIONAL_INPUT_DIRS "${CMAKE_SOURCE_DIR}/src/systems ${CMAKE_SOURCE_DIR}/src/gui/plugins"
+    IMAGE_PATH_DIRS "${CMAKE_SOURCE_DIR}/tutorials/files"
     TAGFILES
      "${IGNITION-MATH_DOXYGEN_TAGFILE} = ${IGNITION-MATH_API_URL}"
      "${IGNITION-MSGS_DOXYGEN_TAGFILE} = ${IGNITION-MSGS_API_URL}"

diff --git a/include/ignition/gazebo/Conversions.hh b/include/ignition/gazebo/Conversions.hh
@@ -88,8 +88,9 @@ namespace ignition
     /// \return Conversion result.
     /// \tparam Out Output type.
     template<class Out>
-    Out convert(const sdf::Geometry &/*_in*/)
+    Out convert(const sdf::Geometry &_in)
     {
+      (void)_in;
       Out::ConversionNotImplemented;
     }
 
@@ -105,8 +106,9 @@ namespace ignition
     /// \return Conversion result.
     /// \tparam Out Output type.
     template<class Out>
-    Out convert(const msgs::Pose &/*_in*/)
+    Out convert(const msgs::Pose &_in)
     {
+      (void)_in;
       Out::ConversionNotImplemented;
     }
 
@@ -121,8 +123,9 @@ namespace ignition
     /// \return Conversion result.
     /// \tparam Out Output type.
     template<class Out>
-    Out convert(const msgs::Geometry &/*_in*/)
+    Out convert(const msgs::Geometry &_in)
     {
+      (void)_in;
       Out::ConversionNotImplemented;
     }
 
@@ -138,8 +141,9 @@ namespace ignition
     /// \return Conversion result.
     /// \tparam Out Output type.
     template<class Out>
-    Out convert(const sdf::Material &/*_in*/)
+    Out convert(const sdf::Material &_in)
     {
+      (void)_in;
       Out::ConversionNotImplemented;
     }
 
@@ -155,8 +159,9 @@ namespace ignition
     /// \return Conversion result.
     /// \tparam Out Output type.
     template<class Out>
-    Out convert(const msgs::Material &/*_in*/)
+    Out convert(const msgs::Material &_in)
     {
+      (void)_in;
       Out::ConversionNotImplemented;
     }
 
@@ -172,8 +177,9 @@ namespace ignition
     /// \return Conversion result.
     /// \tparam Out Output type.
     template<class Out>
-    Out convert(const sdf::Actor &/*_in*/)
+    Out convert(const sdf::Actor &_in)
     {
+      (void)_in;
       Out::ConversionNotImplemented;
     }
 
@@ -189,8 +195,9 @@ namespace ignition
     /// \return Conversion result.
     /// \tparam Out Output type.
     template<class Out>
-    Out convert(const msgs::Actor& /*_in*/)
+    Out convert(const msgs::Actor& _in)
     {
+      (void)_in;
       Out::ConversionNotImplemented;
     }
 
@@ -206,8 +213,9 @@ namespace ignition
     /// \return Conversion result.
     /// \tparam Out Output type.
     template<class Out>
-    Out convert(const sdf::Light &/*_in*/)
+    Out convert(const sdf::Light &_in)
     {
+      (void)_in;
       Out::ConversionNotImplemented;
     }
 
@@ -224,8 +232,9 @@ namespace ignition
     /// \return Conversion result.
     /// \tparam Out Output type.
     template<class Out>
-    Out convert(const msgs::Light& /*_in*/)
+    Out convert(const msgs::Light& _in)
     {
+      (void)_in;
       Out::ConversionNotImplemented;
     }
 
@@ -241,8 +250,9 @@ namespace ignition
     /// \return Conversion result.
     /// \tparam Out Output type.
     template<class Out>
-    Out convert(const sdf::Gui &/*_in*/)
+    Out convert(const sdf::Gui &_in)
     {
+      (void)_in;
       Out::ConversionNotImplemented;
     }
 
@@ -257,8 +267,9 @@ namespace ignition
     /// \return Conversion result.
     /// \tparam Out Output type.
     template<class Out>
-    Out convert(const std::chrono::steady_clock::duration &/*_in*/)
+    Out convert(const std::chrono::steady_clock::duration &_in)
     {
+      (void)_in;
       Out::ConversionNotImplemented;
     }
 
@@ -274,8 +285,9 @@ namespace ignition
     /// \return Conversion result.
     /// \tparam Out Output type.
     template<class Out>
-    Out convert(const msgs::Time &/*_in*/)
+    Out convert(const msgs::Time &_in)
     {
+      (void)_in;
       Out::ConversionNotImplemented;
     }
 
@@ -291,8 +303,9 @@ namespace ignition
     /// \return Conversion result.
     /// \tparam Out Output type.
     template<class Out>
-    Out convert(const math::Inertiald &/*_in*/)
+    Out convert(const math::Inertiald &_in)
     {
+      (void)_in;
       Out::ConversionNotImplemented;
     }
 
@@ -308,8 +321,9 @@ namespace ignition
     /// \return Conversion result.
     /// \tparam Out Output type.
     template<class Out>
-    Out convert(const msgs::Inertial &/*_in*/)
+    Out convert(const msgs::Inertial &_in)
     {
+      (void)_in;
       Out::ConversionNotImplemented;
     }
 
@@ -325,8 +339,9 @@ namespace ignition
     /// \return Conversion result.
     /// \tparam Out Output type.
     template<class Out>
-    Out convert(const sdf::JointAxis &/*_in*/)
+    Out convert(const sdf::JointAxis &_in)
     {
+      (void)_in;
       Out::ConversionNotImplemented;
     }
 
@@ -342,8 +357,9 @@ namespace ignition
     /// \return Conversion result.
     /// \tparam Out Output type.
     template<class Out>
-    Out convert(const msgs::Axis &/*_in*/)
+    Out convert(const msgs::Axis &_in)
     {
+      (void)_in;
       Out::ConversionNotImplemented;
     }
 
@@ -359,8 +375,9 @@ namespace ignition
     /// \return Conversion result.
     /// \tparam Out Output type.
     template<class Out>
-    Out convert(const sdf::Scene &/*_in*/)
+    Out convert(const sdf::Scene &_in)
     {
+      (void)_in;
       Out::ConversionNotImplemented;
     }
 
@@ -375,8 +392,9 @@ namespace ignition
     /// \return Conversion result.
     /// \tparam Out Output type.
     template<class Out>
-    Out convert(const msgs::Scene &/*_in*/)
+    Out convert(const msgs::Scene &_in)
     {
+      (void)_in;
       Out::ConversionNotImplemented;
     }
 
@@ -392,8 +410,9 @@ namespace ignition
     /// \return Conversion result.
     /// \tparam Out Output type.
     template<class Out>
-    Out convert(const sdf::Atmosphere &/*_in*/)
+    Out convert(const sdf::Atmosphere &_in)
     {
+      (void)_in;
       Out::ConversionNotImplemented;
     }
 
@@ -409,8 +428,9 @@ namespace ignition
     /// \return Conversion result.
     /// \tparam Out Output type.
     template<class Out>
-    Out convert(const msgs::Atmosphere &/*_in*/)
+    Out convert(const msgs::Atmosphere &_in)
     {
+      (void)_in;
       Out::ConversionNotImplemented;
     }
 
@@ -427,8 +447,9 @@ namespace ignition
     /// \return Conversion result.
     /// \tparam Out Output type.
     template<class Out>
-    Out convert(const sdf::Physics &/*_in*/)
+    Out convert(const sdf::Physics &_in)
     {
+      (void)_in;
       Out::ConversionNotImplemented;
     }
 
@@ -444,8 +465,9 @@ namespace ignition
     /// \return Conversion result.
     /// \tparam Out Output type.
     template<class Out>
-    Out convert(const msgs::Physics &/*_in*/)
+    Out convert(const msgs::Physics &_in)
     {
+      (void)_in;
       Out::ConversionNotImplemented;
     }
 
@@ -462,8 +484,9 @@ namespace ignition
     /// \return Conversion result.
     /// \tparam Out Output type.
     template<class Out>
-    Out convert(const sdf::Sensor &/*_in*/)
+    Out convert(const sdf::Sensor &_in)
     {
+      (void)_in;
       Out::ConversionNotImplemented;
     }
 
@@ -479,8 +502,9 @@ namespace ignition
     /// \return Conversion result.
     /// \tparam Out Output type.
     template<class Out>
-    Out convert(const msgs::Sensor &/*_in*/)
+    Out convert(const msgs::Sensor &_in)
     {
+      (void)_in;
       Out::ConversionNotImplemented;
     }
 
@@ -496,8 +520,9 @@ namespace ignition
     /// \return Conversion result.
     /// \tparam Out Output type.
     template<class Out>
-    Out convert(const msgs::SensorNoise &/*_in*/)
+    Out convert(const msgs::SensorNoise &_in)
     {
+      (void)_in;
       Out::ConversionNotImplemented;
     }
 
@@ -514,8 +539,9 @@ namespace ignition
     /// \return Conversion result.
     /// \tparam Out Output type.
     template<class Out>
-    Out convert(const msgs::WorldStatistics &/*_in*/)
+    Out convert(const msgs::WorldStatistics &_in)
     {
+      (void)_in;
       Out::ConversionNotImplemented;
     }
 
@@ -531,8 +557,9 @@ namespace ignition
     /// \return Conversion result.
     /// \tparam Out Output type.
     template<class Out>
-    Out convert(const UpdateInfo &/*_in*/)
+    Out convert(const UpdateInfo &_in)
     {
+      (void)_in;
       Out::ConversionNotImplemented;
     }
 
@@ -548,8 +575,9 @@ namespace ignition
     /// \return Conversion result.
     /// \tparam Out Output type.
     template<class Out>
-    Out convert(const sdf::Collision &/*_in*/)
+    Out convert(const sdf::Collision &_in)
     {
+      (void)_in;
       Out::ConversionNotImplemented;
     }
 
@@ -565,8 +593,9 @@ namespace ignition
     /// \return Conversion result.
     /// \tparam Out Output type.
     template<class Out>
-    Out convert(const msgs::Collision &/*_in*/)
+    Out convert(const msgs::Collision &_in)
     {
+      (void)_in;
       Out::ConversionNotImplemented;
     }
 
@@ -582,8 +611,9 @@ namespace ignition
     /// \return Conversion result.
     /// \tparam Out Output type.
     template<class Out>
-    Out convert(const std::string &/*_in*/)
+    Out convert(const std::string &_in)
     {
+      (void)_in;
       Out::ConversionNotImplemented;
     }
 
@@ -598,8 +628,9 @@ namespace ignition
     /// \return Conversion result.
     /// \tparam Out Output type.
     template<class Out>
-    Out convert(const math::AxisAlignedBox &/*_in*/)
+    Out convert(const math::AxisAlignedBox &_in)
     {
+      (void)_in;
       Out::ConversionNotImplemented;
     }
 
@@ -616,8 +647,9 @@ namespace ignition
     /// \return Conversion result.
     /// \tparam Out Output type.
     template<class Out>
-    Out convert(const msgs::AxisAlignedBox &/*_in*/)
+    Out convert(const msgs::AxisAlignedBox &_in)
     {
+      (void)_in;
       Out::ConversionNotImplemented;
     }