From 533a7548ddf077b942a523a33a8e12d8c2b3b874 Mon Sep 17 00:00:00 2001 From: Summit Patel Date: Fri, 8 Jun 2012 19:05:13 +0000 Subject: [PATCH] Fixed Doxygen warnings. --- gtsam/geometry/Pose2.h | 4 ++-- gtsam/geometry/Rot2.h | 2 +- gtsam/inference/BayesTreeCliqueBase.h | 2 +- gtsam/inference/JunctionTree.h | 2 +- gtsam/nonlinear/ISAM2-impl.h | 2 +- 5 files changed, 6 insertions(+), 6 deletions(-) diff --git a/gtsam/geometry/Pose2.h b/gtsam/geometry/Pose2.h index d15ba045c..60c74e7cb 100644 --- a/gtsam/geometry/Pose2.h +++ b/gtsam/geometry/Pose2.h @@ -226,7 +226,7 @@ public: /** * Calculate bearing to a landmark * @param point 2D location of landmark - * @return 2D rotation \in SO(2) + * @return 2D rotation \f$ \in SO(2) \f$ */ Rot2 bearing(const Point2& point, boost::optional H1=boost::none, @@ -235,7 +235,7 @@ public: /** * Calculate bearing to another pose * @param point SO(2) location of other pose - * @return 2D rotation \in SO(2) + * @return 2D rotation \f$ \in SO(2) \f$ */ Rot2 bearing(const Pose2& point, boost::optional H1=boost::none, diff --git a/gtsam/geometry/Rot2.h b/gtsam/geometry/Rot2.h index d0f3e4c14..9e5e6fddc 100644 --- a/gtsam/geometry/Rot2.h +++ b/gtsam/geometry/Rot2.h @@ -85,7 +85,7 @@ namespace gtsam { * Calculate relative bearing to a landmark in local coordinate frame * @param d 2D location of landmark * @param H optional reference for Jacobian - * @return 2D rotation \in SO(2) + * @return 2D rotation \f$ \in SO(2) \f$ */ static Rot2 relativeBearing(const Point2& d, boost::optional H = boost::none); diff --git a/gtsam/inference/BayesTreeCliqueBase.h b/gtsam/inference/BayesTreeCliqueBase.h index 7ae2c15f9..e09454e86 100644 --- a/gtsam/inference/BayesTreeCliqueBase.h +++ b/gtsam/inference/BayesTreeCliqueBase.h @@ -130,7 +130,7 @@ namespace gtsam { /** Construct shared_ptr from a FactorGraph::EliminationResult. In this class * the conditional part is kept and the factor part is ignored, but in derived clique * types, such as ISAM2Clique, the factor part is kept as a cached factor. - * @param An elimination result, which is a pair + * @param result An elimination result, which is a pair */ static derived_ptr Create(const std::pair >& result) { return boost::make_shared(result); } diff --git a/gtsam/inference/JunctionTree.h b/gtsam/inference/JunctionTree.h index e8aceafe9..4ff55d19b 100644 --- a/gtsam/inference/JunctionTree.h +++ b/gtsam/inference/JunctionTree.h @@ -108,7 +108,7 @@ namespace gtsam { JunctionTree(const FG& factorGraph); /** Construct from a factor graph and pre-computed variable index. - * @param factorGraph The factor graph for which to build the junction tree + * @param fg The factor graph for which to build the junction tree * @param structure The set of factors involving each variable. If this is not * precomputed, you can call the JunctionTree(const FG&) * constructor instead. diff --git a/gtsam/nonlinear/ISAM2-impl.h b/gtsam/nonlinear/ISAM2-impl.h index 51b613b86..f2f03fb3a 100644 --- a/gtsam/nonlinear/ISAM2-impl.h +++ b/gtsam/nonlinear/ISAM2-impl.h @@ -91,7 +91,7 @@ struct ISAM2::Impl { /** * Apply expmap to the given values, but only for indices appearing in * \c markedRelinMask. Values are expmapped in-place. - * \param [in][out] values The value to expmap in-place + * \param [in, out] values The value to expmap in-place * \param delta The linear delta with which to expmap * \param ordering The ordering * \param mask Mask on linear indices, only \c true entries are expmapped