Fixed Doxygen warnings.

release/4.3a0
Summit Patel 2012-06-08 19:05:13 +00:00
parent c2c27b08d8
commit 533a7548dd
5 changed files with 6 additions and 6 deletions

View File

@ -226,7 +226,7 @@ public:
/** /**
* Calculate bearing to a landmark * Calculate bearing to a landmark
* @param point 2D location of 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, Rot2 bearing(const Point2& point,
boost::optional<Matrix&> H1=boost::none, boost::optional<Matrix&> H1=boost::none,
@ -235,7 +235,7 @@ public:
/** /**
* Calculate bearing to another pose * Calculate bearing to another pose
* @param point SO(2) location of other 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, Rot2 bearing(const Pose2& point,
boost::optional<Matrix&> H1=boost::none, boost::optional<Matrix&> H1=boost::none,

View File

@ -85,7 +85,7 @@ namespace gtsam {
* Calculate relative bearing to a landmark in local coordinate frame * Calculate relative bearing to a landmark in local coordinate frame
* @param d 2D location of landmark * @param d 2D location of landmark
* @param H optional reference for Jacobian * @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<Matrix&> H = static Rot2 relativeBearing(const Point2& d, boost::optional<Matrix&> H =
boost::none); boost::none);

View File

@ -130,7 +130,7 @@ namespace gtsam {
/** Construct shared_ptr from a FactorGraph<FACTOR>::EliminationResult. In this class /** Construct shared_ptr from a FactorGraph<FACTOR>::EliminationResult. In this class
* the conditional part is kept and the factor part is ignored, but in derived clique * 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. * types, such as ISAM2Clique, the factor part is kept as a cached factor.
* @param An elimination result, which is a pair<CONDITIONAL,FACTOR> * @param result An elimination result, which is a pair<CONDITIONAL,FACTOR>
*/ */
static derived_ptr Create(const std::pair<sharedConditional, boost::shared_ptr<typename ConditionalType::FactorType> >& result) { return boost::make_shared<DerivedType>(result); } static derived_ptr Create(const std::pair<sharedConditional, boost::shared_ptr<typename ConditionalType::FactorType> >& result) { return boost::make_shared<DerivedType>(result); }

View File

@ -108,7 +108,7 @@ namespace gtsam {
JunctionTree(const FG& factorGraph); JunctionTree(const FG& factorGraph);
/** Construct from a factor graph and pre-computed variable index. /** 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 * @param structure The set of factors involving each variable. If this is not
* precomputed, you can call the JunctionTree(const FG&) * precomputed, you can call the JunctionTree(const FG&)
* constructor instead. * constructor instead.

View File

@ -91,7 +91,7 @@ struct ISAM2::Impl {
/** /**
* Apply expmap to the given values, but only for indices appearing in * Apply expmap to the given values, but only for indices appearing in
* \c markedRelinMask. Values are expmapped in-place. * \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 delta The linear delta with which to expmap
* \param ordering The ordering * \param ordering The ordering
* \param mask Mask on linear indices, only \c true entries are expmapped * \param mask Mask on linear indices, only \c true entries are expmapped