Corrected some doxygen warnings

release/4.3a0
Frank Dellaert 2012-06-03 21:51:33 +00:00
parent 009907c347
commit 6bf036d3c1
16 changed files with 22 additions and 23 deletions

View File

@ -10,7 +10,7 @@
* -------------------------------------------------------------------------- */ * -------------------------------------------------------------------------- */
/** /**
* @file BayesNet * @file BayesNet.h
* @brief Bayes network * @brief Bayes network
* @author Frank Dellaert * @author Frank Dellaert
*/ */

View File

@ -10,7 +10,7 @@
* -------------------------------------------------------------------------- */ * -------------------------------------------------------------------------- */
/** /**
* @file BayesTree.cpp * @file BayesTree-inl.h
* @brief Bayes Tree is a tree of cliques of a Bayes Chain * @brief Bayes Tree is a tree of cliques of a Bayes Chain
* @author Frank Dellaert * @author Frank Dellaert
* @author Michael Kaess * @author Michael Kaess

View File

@ -10,7 +10,7 @@
* -------------------------------------------------------------------------- */ * -------------------------------------------------------------------------- */
/** /**
* @file BayesTree * @file BayesTree.h
* @brief Bayes Tree is a tree of cliques of a Bayes Chain * @brief Bayes Tree is a tree of cliques of a Bayes Chain
* @author Frank Dellaert * @author Frank Dellaert
*/ */

View File

@ -10,7 +10,7 @@
* -------------------------------------------------------------------------- */ * -------------------------------------------------------------------------- */
/** /**
* @file BayesTreeCliqueBase * @file BayesTreeCliqueBase-inl.h
* @brief Base class for cliques of a BayesTree * @brief Base class for cliques of a BayesTree
* @author Richard Roberts and Frank Dellaert * @author Richard Roberts and Frank Dellaert
*/ */

View File

@ -10,7 +10,7 @@
* -------------------------------------------------------------------------- */ * -------------------------------------------------------------------------- */
/** /**
* @file BayesTreeCliqueBase * @file BayesTreeCliqueBase.h
* @brief Base class for cliques of a BayesTree * @brief Base class for cliques of a BayesTree
* @author Richard Roberts and Frank Dellaert * @author Richard Roberts and Frank Dellaert
*/ */

View File

@ -10,7 +10,7 @@
* -------------------------------------------------------------------------- */ * -------------------------------------------------------------------------- */
/** /**
* @file EliminationTree.cpp * @file EliminationTree-inl.h
* @author Frank Dellaert * @author Frank Dellaert
* @date Oct 13, 2010 * @date Oct 13, 2010
*/ */

View File

@ -10,9 +10,9 @@
* -------------------------------------------------------------------------- */ * -------------------------------------------------------------------------- */
/* /*
* graph-inl.h * @file graph-inl.h
* @brief Graph algorithm using boost library * @brief Graph algorithm using boost library
* @author: Kai Ni * @author Kai Ni
*/ */
#pragma once #pragma once

View File

@ -10,9 +10,10 @@
* -------------------------------------------------------------------------- */ * -------------------------------------------------------------------------- */
/** /**
* @file inference-inl.h * @file inference.cpp
* @brief inference definitions * @brief inference definitions
* @author Frank Dellaert, Richard Roberts * @author Frank Dellaert
* @author Richard Roberts
*/ */
#include <gtsam/inference/inference.h> #include <gtsam/inference/inference.h>

View File

@ -13,7 +13,8 @@
* @file inference.h * @file inference.h
* @brief Contains *generic* inference algorithms that convert between templated * @brief Contains *generic* inference algorithms that convert between templated
* graphical models, i.e., factor graphs, Bayes nets, and Bayes trees * graphical models, i.e., factor graphs, Bayes nets, and Bayes trees
* @author Frank Dellaert, Richard Roberts * @author Frank Dellaert
* @author Richard Roberts
*/ */
#pragma once #pragma once

View File

@ -10,7 +10,7 @@
* -------------------------------------------------------------------------- */ * -------------------------------------------------------------------------- */
/** /**
* @file GaussianBayesTree.cpp * @file GaussianBayesTree-inl.h
* @brief Gaussian Bayes Tree, the result of eliminating a GaussianJunctionTree * @brief Gaussian Bayes Tree, the result of eliminating a GaussianJunctionTree
* @brief GaussianBayesTree * @brief GaussianBayesTree
* @author Frank Dellaert * @author Frank Dellaert

View File

@ -10,7 +10,7 @@
* -------------------------------------------------------------------------- */ * -------------------------------------------------------------------------- */
/** /**
* @file GaussianISAM * @file GaussianISAM.cpp
* @brief Linear ISAM only * @brief Linear ISAM only
* @author Michael Kaess * @author Michael Kaess
*/ */

View File

@ -10,7 +10,7 @@
* -------------------------------------------------------------------------- */ * -------------------------------------------------------------------------- */
/** /**
* @file GaussianISAM * @file GaussianISAM.h
* @brief Linear ISAM only * @brief Linear ISAM only
* @author Michael Kaess * @author Michael Kaess
*/ */

View File

@ -10,7 +10,7 @@
* -------------------------------------------------------------------------- */ * -------------------------------------------------------------------------- */
/** /**
* @file SequentialSolver.cpp * @file GaussianSequentialSolver.cpp
* @author Richard Roberts * @author Richard Roberts
* @date Oct 19, 2010 * @date Oct 19, 2010
*/ */

View File

@ -10,7 +10,7 @@
* -------------------------------------------------------------------------- */ * -------------------------------------------------------------------------- */
/** /**
* @file SequentialSolver.h * @file GaussianSequentialSolver.h
* @brief Solves a GaussianFactorGraph (i.e. a sparse linear system) using sequential variable elimination. * @brief Solves a GaussianFactorGraph (i.e. a sparse linear system) using sequential variable elimination.
* @author Richard Roberts * @author Richard Roberts
* @date Oct 19, 2010 * @date Oct 19, 2010

View File

@ -10,11 +10,8 @@
* -------------------------------------------------------------------------- */ * -------------------------------------------------------------------------- */
/** /**
* @file testKalmanFilter.cpp * @file KalmanFilter.h
* * @brief Simple linear Kalman filter. Implemented using factor graphs, i.e., does Cholesky-based SRIF, really.
* Simple linear Kalman filter.
* Implemented using factor graphs, i.e., does Cholesky-based SRIF, really.
*
* @date Sep 3, 2011 * @date Sep 3, 2011
* @author Stephen Williams * @author Stephen Williams
* @author Frank Dellaert * @author Frank Dellaert

View File

@ -10,8 +10,8 @@
* -------------------------------------------------------------------------- */ * -------------------------------------------------------------------------- */
/** /**
* @file NoiseModelFactor.h * @file NonlinearFactor.h
* @brief Non-linear factor class * @brief Non-linear factor base classes
* @author Frank Dellaert * @author Frank Dellaert
* @author Richard Roberts * @author Richard Roberts
*/ */