Fixed documentation generation.

ctu-vras · Dec 12, 2024 · 8274d53 · 8274d53
1 parent e503dcd
commit 8274d53
Show file tree

Hide file tree

Showing 6 changed files with 22 additions and 2 deletions.
diff --git a/compass_conversions/include/compass_conversions/message_filter.h b/compass_conversions/include/compass_conversions/message_filter.h
@@ -51,6 +51,7 @@ class UniversalAzimuthSubscriber :
   /**
    * \brief Constructor
    *
+   * \param log Logger.
    * \param nh The ros::NodeHandle to use for subscribing.
    * \param topic The topic to subscribe to.
    * \param queueSize Queue size of the subscription.
@@ -245,6 +246,7 @@ class CompassFilter : public message_filters::SimpleFilter<compass_msgs::Azimuth
    * \param[in] azimuthInput The message filter producing azimuth messages.
    * \param[in] unit The output azimuth unit.
    * \param[in] orientation The output azimuth orientation.
+   * \param[in] reference The output azimuth reference.
    */
   template<class AzimuthInput>
   CompassFilter(const cras::LogHelperPtr& log, const std::shared_ptr<CompassConverter>& converter,

diff --git a/magnetic_model/include/magnetic_model/magnetic_model.h b/magnetic_model/include/magnetic_model/magnetic_model.h
@@ -109,8 +109,8 @@ class MagneticModel : public cras::HasLogger
     const sensor_msgs::NavSatFix& fix, const ros::Time& stamp) const;
 
   /**
-   * \brief Get the magnetic field components on the provided place on Earth.
-   * \param[in] fix The place for which magnetic field components are queried. Timestamp from the message is ignored.
+   * \brief Get the components of the measured magnetic field.
+   * \param[in] field The measured magnetic field.
    * \param[in] stamp The time for which magnetic field components are queried.
    * \return The magnetic field components.
    */

diff --git a/magnetometer_compass/package.xml b/magnetometer_compass/package.xml
@@ -52,6 +52,7 @@
   <test_depend>rostest</test_depend>
 
   <export>
+    <rosdoc config="rosdoc.yaml" />
     <nodelet plugin="${prefix}/nodelets.xml" />
   </export>
 </package>
diff --git a/magnetometer_compass/rosdoc.yaml b/magnetometer_compass/rosdoc.yaml
@@ -0,0 +1,8 @@
+# SPDX-License-Identifier: BSD-3-Clause
+# SPDX-FileCopyrightText: Czech Technical University in Prague
+
+- builder: doxygen
+  required: True
+  file_patterns: '*.h *.hpp *.hh *.dox /README.md'
+  use_mdfile_as_mainpage: 'README.md'
+  generate_treeview: True
diff --git a/magnetometer_pipeline/package.xml b/magnetometer_pipeline/package.xml
@@ -43,6 +43,7 @@
   <test_depend>rostest</test_depend>
 
   <export>
+    <rosdoc config="rosdoc.yaml" />
     <nodelet plugin="${prefix}/nodelets.xml" />
   </export>
 </package>
diff --git a/magnetometer_pipeline/rosdoc.yaml b/magnetometer_pipeline/rosdoc.yaml
@@ -0,0 +1,8 @@
+# SPDX-License-Identifier: BSD-3-Clause
+# SPDX-FileCopyrightText: Czech Technical University in Prague
+
+- builder: doxygen
+  required: True
+  file_patterns: '*.h *.hpp *.hh *.dox /README.md'
+  use_mdfile_as_mainpage: 'README.md'
+  generate_treeview: True