From ce50219f9d11c95263831c7a7355a247f2e28b46 Mon Sep 17 00:00:00 2001 From: thduynguyen Date: Tue, 24 Feb 2015 22:15:41 -0500 Subject: [PATCH] fix comments for doxygen --- gtsam_unstable/linear/LinearEquality.h | 6 +++--- gtsam_unstable/linear/LinearEqualityFactorGraph.h | 4 ++-- gtsam_unstable/linear/LinearInequality.h | 8 ++++---- gtsam_unstable/linear/LinearInequalityFactorGraph.h | 4 ++-- 4 files changed, 11 insertions(+), 11 deletions(-) diff --git a/gtsam_unstable/linear/LinearEquality.h b/gtsam_unstable/linear/LinearEquality.h index 5d96d8d38..2b48b3cd2 100644 --- a/gtsam_unstable/linear/LinearEquality.h +++ b/gtsam_unstable/linear/LinearEquality.h @@ -9,11 +9,11 @@ * -------------------------------------------------------------------------- */ -/* +/** * LinearEquality.h * @brief: LinearEquality derived from Base with constrained noise model * @date: Nov 27, 2014 - * @author: thduynguyen + * @author: Duy-Nguyen Ta */ #pragma once @@ -23,7 +23,7 @@ namespace gtsam { /** - * This class defines Linear constraints by inherit Base + * This class defines a linear equality constraints, inheriting JacobianFactor * with the special Constrained noise model */ class LinearEquality: public JacobianFactor { diff --git a/gtsam_unstable/linear/LinearEqualityFactorGraph.h b/gtsam_unstable/linear/LinearEqualityFactorGraph.h index 9c067ae3d..619a707ed 100644 --- a/gtsam_unstable/linear/LinearEqualityFactorGraph.h +++ b/gtsam_unstable/linear/LinearEqualityFactorGraph.h @@ -9,11 +9,11 @@ * -------------------------------------------------------------------------- */ -/* +/** * LinearEqualityFactorGraph.h * @brief: Factor graph of all LinearEquality factors * @date: Dec 8, 2014 - * @author: thduynguyen + * @author: Duy-Nguyen Ta */ #pragma once diff --git a/gtsam_unstable/linear/LinearInequality.h b/gtsam_unstable/linear/LinearInequality.h index 7eac21903..bf5498ff7 100644 --- a/gtsam_unstable/linear/LinearInequality.h +++ b/gtsam_unstable/linear/LinearInequality.h @@ -9,11 +9,11 @@ * -------------------------------------------------------------------------- */ -/* +/** * LinearInequality.h * @brief: LinearInequality derived from Base with constrained noise model * @date: Nov 27, 2014 - * @author: thduynguyen + * @author: Duy-Nguyen Ta */ #pragma once @@ -25,8 +25,8 @@ namespace gtsam { typedef Eigen::RowVectorXd RowVector; /** - * This class defines Linear constraints by inherit Base - * with the special Constrained noise model + * This class defines a linear inequality constraint g(x)<=0, + * inheriting JacobianFactor with the special Constrained noise model */ class LinearInequality: public JacobianFactor { public: diff --git a/gtsam_unstable/linear/LinearInequalityFactorGraph.h b/gtsam_unstable/linear/LinearInequalityFactorGraph.h index eca271941..beb7ee43f 100644 --- a/gtsam_unstable/linear/LinearInequalityFactorGraph.h +++ b/gtsam_unstable/linear/LinearInequalityFactorGraph.h @@ -9,11 +9,11 @@ * -------------------------------------------------------------------------- */ -/* +/** * LinearInequalityFactorGraph.h * @brief: Factor graph of all LinearInequality factors * @date: Dec 8, 2014 - * @author: thduynguyen + * @author: Duy-Nguyen Ta */ #pragma once