Apply minor documentation suggestions

Signed-off-by: Nahuel Espinosa <[email protected]>

beluga/include/beluga/motion/differential_drive_model.hpp

@@ -146,7 +146,7 @@ class DifferentialDriveModel : public Mixin {
     last_pose_ = pose;
   }
 
-  /// recovers latest motion update.
+  /// Recovers latest motion update.
   [[nodiscard]] std::optional<update_type> latest_motion_update() const { return last_pose_; }
 
  private:

beluga/include/beluga/resampling_policies/resample_interval_policy.hpp

@@ -33,14 +33,16 @@ struct ResampleIntervalPolicyParam {
  * */
 struct ResampleIntervalPolicy {
  public:
-  /// Parameter type that the constructor uses to configure the policy
+  /// Parameter type that the constructor uses to configure the policy.
   using param_type = ResampleIntervalPolicyParam;
 
-  /// @brief Constructor
-  /// @param configuration Policy configuration data.
+  /// Constructs a ResampleIntervalPolicy instance.
+  /**
+   * \param configuration Policy configuration data.
+   */
   explicit ResampleIntervalPolicy(const param_type& configuration) : configuration_{configuration} {}
 
-  /// Vote whether resampling must be done according to this policy./
+  /// Vote whether resampling must be done according to this policy.
   /**
    * \tparam Concrete Type representing the concrete implementation of the filter.
    */

beluga/include/beluga/resampling_policies/resample_on_motion_policy.hpp

@@ -25,9 +25,9 @@ namespace beluga {
 
 /// Parameters used to construct a ResampleOnMotionPolicy instance.
 struct ResampleOnMotionPolicyParam {
-  /// distance threshold along x an y (independently) to trigger a resample
+  /// Distance threshold along x an y (independently) to trigger a resample.
   double update_min_d{0.};
-  /// angular threshold to trigger a resample
+  /// Angular threshold to trigger a resample.
   double update_min_a{0.};
 };
 
@@ -37,16 +37,18 @@ struct ResampleOnMotionPolicyParam {
  * */
 struct ResampleOnMotionPolicy {
  public:
-  /// Parameter type that the constructor uses to configure the policy
+  /// Parameter type that the constructor uses to configure the policy.
   using param_type = ResampleOnMotionPolicyParam;
-  /// Type used to exchange and store motion updates by the motion model
+  /// Type used to exchange and store motion updates by the motion model.
   using motion_event = Sophus::SE2d;
 
-  /// @brief Constructor
-  /// @param configuration Policy configuration data.
+  /// Constructs a ResampleOnMotionPolicy instance.
+  /**
+   * \param configuration Policy configuration data.
+   */
   explicit ResampleOnMotionPolicy(const param_type& configuration) : configuration_{configuration} {}
 
-  /// Vote whether resampling must be done according to this policy./
+  /// Vote whether resampling must be done according to this policy.
   /**
    * \tparam Concrete Type representing the concrete implementation of the filter.
    * It must satisfy the \ref MotionModelPage MotionModel requirements.

beluga/include/beluga/resampling_policies/resampling_policies_poller.hpp

@@ -23,15 +23,15 @@
 
 namespace beluga {
 
-/// Sampled odometry model for a differential drive.
+/// Resampling policy poller.
 /**
  * \tparam Mixin The mixed-in type.
- * \tparam Policies Zero or more resampling policies. The must satisfy the \ref ResamplingPolicyPage "ResamplingPolicy"
+ * \tparam Policies Zero or more resampling policies. They must satisfy the \ref ResamplingPolicyPage "ResamplingPolicy"
  * named requirements.
  */
 template <typename Mixin, typename... Policies>
 struct ResamplingPoliciesPoller : public Mixin {
-  /// Constructs a LikelihoodFieldModel instance.
+  /// Constructs a ResamplingPoliciesPoller instance.
   /**
    * \tparam ...Rest Arguments types for the remaining mixin constructors.
    * \param policy_configs Configuration parameters for each of the installed resampling policies.

beluga/include/beluga/resampling_policies/selective_resampling_policy.hpp

@@ -24,7 +24,7 @@ namespace beluga {
 
 /// Parameters used to construct a SelectiveResamplingPolicy instance.
 struct SelectiveResamplingPolicyParam {
-  /// Enable/disable the SelectiveResampling feature
+  /// Enable/disable the SelectiveResampling feature.
   bool enabled{false};
 };
 
@@ -34,18 +34,20 @@ struct SelectiveResamplingPolicyParam {
  * requirements.
  *
  * The algorithm is based in \cite grisetti2007selectiveresampling, according to the description given in
- * \cite tiacheng2015resamplingmethods
+ * \cite tiacheng2015resamplingmethods.
  * */
 struct SelectiveResamplingPolicy {
  public:
-  /// Parameter type that the constructor uses to configure the policy
+  /// Parameter type that the constructor uses to configure the policy.
   using param_type = SelectiveResamplingPolicyParam;
 
-  /// @brief Constructor
-  /// @param configuration Policy configuration data.
+  /// Constructs a SelectiveResamplingPolicy instance.
+  /**
+   * \param configuration Policy configuration data.
+   */
   explicit SelectiveResamplingPolicy(const param_type& configuration) : configuration_{configuration} {}
 
-  /// Vote whether resampling must be done according to this policy./
+  /// Vote whether resampling must be done according to this policy.
   /**
    * \tparam Concrete Type representing the concrete implementation of the filter.
    * It must satisfy the \ref BaseParticleFilterPage "BaseParticleFilter" named requirements.