Fixing documentation warnings

Author: ayrton04

doc/state_estimation_nodes.rst

@@ -98,7 +98,7 @@ For each of the sensor messages defined above, users must specify what variables
 
 The order of the boolean values are :math:`X, Y, Z, roll, pitch, yaw, \dot{X}, \dot{Y}, \dot{Z}, \dot{roll}, \dot{pitch}, \dot{yaw}, \ddot{X}, \ddot{Y}, \ddot{Z}`. In this example, we are fusing :math:`X` and :math:`Y` position, :math:`yaw`, :math:`\dot{X}`, and :math:`\dot{yaw}`.
 
-.. note:: The specification is done in the ``frame_id`` of the **sensor**, *not* in the ``world_frame`` or ``base_link_frame``. Please see the :doc:`sensor integration tutorial <sensor_integration_tutorial>` for more information.
+.. note:: The specification is done in the ``frame_id`` of the **sensor**, *not* in the ``world_frame`` or ``base_link_frame``. Please see the :doc:`coniguration tutorial <configuring_robot_localization>` for more information.
 
 ~[sensor]_queue_size
 ^^^^^^^^^^^^^^^^^^^^

include/robot_localization/filter_utilities.h

@@ -61,7 +61,7 @@ namespace FilterUtilities
 
   //! @brief Utility method for appending tf2 prefixes cleanly
   //! @param[in] tfPrefix - the tf2 prefix to append
-  //! @paramp[in, out] frameId - the resulting frame_id value
+  //! @param[in, out] frameId - the resulting frame_id value
   //!
   void appendPrefix(std::string tfPrefix, std::string &frameId);
 

include/robot_localization/ros_filter.h

@@ -227,9 +227,9 @@ template<class T> class RosFilter
     void setPoseCallback(const geometry_msgs::PoseWithCovarianceStamped::ConstPtr &msg);
 
     //! @brief Service callback for manually setting/resetting the internal pose estimate
+    //!
     //! @param[in] request - Custom service request with pose information
-    //! @param[out] response - N/A
-    //! @return boolean true if successful, false if not
+    //! @return true if successful, false if not
     bool setPoseSrvCallback(robot_localization::SetPose::Request& request,
                             robot_localization::SetPose::Response&);
 
@@ -252,14 +252,16 @@ template<class T> class RosFilter
     //!
     //! This method also inserts all measurements between the older filter timestamp and now into the measurements
     //! queue.
+    //!
+    //! @param[in] time - The time to which the filter state should revert
     //! @return True if restoring the filter succeeded. False if not.
     //!
     bool revertTo(const double time);
 
     //! @brief Saves the current filter state in the queue of previous filter states
     //!
     //! These measurements will be used in backwards smoothing in the event that older measurements come in.
-    //! @param[in] The filter base object whose state we want to save
+    //! @param[in] filter - The filter base object whose state we want to save
     //!
     void saveFilterState(FilterBase &filter);
 
@@ -272,6 +274,7 @@ template<class T> class RosFilter
     //! @param[in] errLevel - The error level of the diagnostic
     //! @param[in] topicAndClass - The sensor topic (if relevant) and class of diagnostic
     //! @param[in] message - Details of the diagnostic
+    //! @param[in] staticDiag - Whether or not this diagnostic information is static
     //!
     void addDiagnostic(const int errLevel,
                        const std::string &topicAndClass,

rosdoc.yaml

@@ -3,3 +3,4 @@
  - builder: doxygen
    output_dir: api
    file_patterns: '*.cpp *.h *.dox *.md'
+   exclude_patterns: '*/test/*'