From 56d1d6ae3401a4d0b374a713d3442c547c94a90a Mon Sep 17 00:00:00 2001 From: Frank Dellaert Date: Fri, 14 Oct 2011 03:23:14 +0000 Subject: [PATCH] Fixed some Doxygen problems with global replace --- examples/Pose2SLAMExample_easy.cpp | 8 ++++---- examples/SimpleRotation.cpp | 14 ++++++-------- examples/easyPoint2KalmanFilter.cpp | 10 +++++----- examples/elaboratePoint2KalmanFilter.cpp | 10 +++++----- gtsam/base/tests/testBTree.cpp | 9 ++++----- gtsam/base/tests/testDSF.cpp | 11 +++++------ gtsam/base/tests/testDSFVector.cpp | 11 +++++------ gtsam/geometry/Cal3Bundler.cpp | 9 ++++----- gtsam/geometry/Cal3DS2.cpp | 9 ++++----- gtsam/geometry/Rot2.cpp | 10 +++++----- gtsam/geometry/SimpleCamera.cpp | 9 ++++----- gtsam/geometry/StereoPoint2.cpp | 9 ++++----- gtsam/geometry/tensorInterface.cpp | 8 ++++---- gtsam/geometry/tests/testCalibratedCamera.cpp | 6 +++--- gtsam/geometry/tests/testFundamental.cpp | 6 +++--- gtsam/geometry/tests/testHomography2.cpp | 8 ++++---- gtsam/geometry/tests/testSimpleCamera.cpp | 6 +++--- gtsam/geometry/tests/testTensors.cpp | 8 ++++---- gtsam/inference/ClusterTree-inl.h | 6 +++--- gtsam/inference/ClusterTree.h | 6 +++--- gtsam/inference/JunctionTree-inl.h | 8 ++++---- gtsam/inference/JunctionTree.h | 6 +++--- gtsam/inference/SymbolicFactorGraph.cpp | 9 ++++----- gtsam/inference/SymbolicFactorGraph.h | 9 ++++----- gtsam/inference/graph.h | 6 +++--- gtsam/inference/tests/testPermutation.cpp | 9 ++++----- gtsam/inference/tests/timeSymbolMaps.cpp | 9 ++++----- gtsam/linear/GaussianJunctionTree.cpp | 4 ++-- gtsam/linear/GaussianJunctionTree.h | 4 ++-- gtsam/linear/IterativeOptimizationParameters.h | 9 ++++----- gtsam/linear/KalmanFilter.h | 10 +++++----- gtsam/linear/SharedDiagonal.h | 4 ++-- gtsam/linear/SharedGaussian.h | 4 ++-- gtsam/linear/SubgraphPreconditioner.cpp | 6 +++--- gtsam/linear/SubgraphPreconditioner.h | 8 ++++---- gtsam/linear/iterative-inl.h | 6 +++--- gtsam/linear/iterative.cpp | 6 +++--- gtsam/linear/iterative.h | 6 +++--- gtsam/linear/tests/testErrors.cpp | 9 ++++----- gtsam/linear/tests/testGaussianJunctionTree.cpp | 7 +++---- gtsam/linear/tests/testKalmanFilter.cpp | 14 ++++++-------- gtsam/linear/tests/testNoiseModel.cpp | 11 +++++------ gtsam/nonlinear/Key.h | 7 +++---- gtsam/nonlinear/NonlinearISAM-inl.h | 7 +++---- gtsam/nonlinear/NonlinearISAM.h | 9 ++++----- gtsam/nonlinear/NonlinearOptimization-inl.h | 11 +++++------ gtsam/nonlinear/NonlinearOptimization.h | 11 +++++------ gtsam/nonlinear/NonlinearOptimizer-inl.h | 4 ++-- gtsam/nonlinear/NonlinearOptimizer.cpp | 6 +++--- gtsam/nonlinear/NonlinearOptimizer.h | 6 +++--- gtsam/slam/BearingRangeFactor.h | 11 +++++------ gtsam/slam/Simulated2DMeasurement.h | 9 ++++----- gtsam/slam/Simulated2DOdometry.h | 9 ++++----- gtsam/slam/Simulated2DOrientedOdometry.h | 9 ++++----- gtsam/slam/Simulated2DOrientedPosePrior.h | 9 ++++----- gtsam/slam/Simulated2DOrientedValues.h | 9 ++++----- gtsam/slam/Simulated2DPointPrior.h | 9 ++++----- gtsam/slam/Simulated2DPosePrior.h | 9 ++++----- gtsam/slam/Simulated2DValues.h | 9 ++++----- gtsam/slam/dataset.cpp | 11 +++++------ gtsam/slam/dataset.h | 11 +++++------ gtsam/slam/tests/testGeneralSFMFactor.cpp | 11 +++++------ .../tests/testGeneralSFMFactor_Cal3Bundler.cpp | 11 +++++------ gtsam/slam/tests/testSimulated2DOriented.cpp | 11 +++++------ gtsam/slam/visualSLAM.cpp | 9 ++++----- tests/testGaussianJunctionTree.cpp | 10 ++++------ tests/testGraph.cpp | 11 +++++------ wrap/Argument.cpp | 4 ++-- wrap/Argument.h | 6 +++--- wrap/Class.cpp | 4 ++-- wrap/Class.h | 6 +++--- wrap/Constructor.cpp | 4 ++-- wrap/Constructor.h | 6 +++--- wrap/Method.cpp | 4 ++-- wrap/Method.h | 8 ++++---- wrap/Module.cpp | 4 ++-- wrap/Module.h | 6 +++--- wrap/tests/testSpirit.cpp | 5 +++-- wrap/tests/testWrap.cpp | 5 +++-- wrap/utilities.cpp | 4 ++-- wrap/utilities.h | 4 ++-- wrap/wrap.cpp | 6 +++--- 82 files changed, 301 insertions(+), 341 deletions(-) diff --git a/examples/Pose2SLAMExample_easy.cpp b/examples/Pose2SLAMExample_easy.cpp index 97a32014d..cf6a5613c 100644 --- a/examples/Pose2SLAMExample_easy.cpp +++ b/examples/Pose2SLAMExample_easy.cpp @@ -9,13 +9,13 @@ * -------------------------------------------------------------------------- */ -/* - * Pose2SLAMExample_easy.cpp +/** + * @file Pose2SLAMExample_easy.cpp * * A 2D Pose SLAM example using the predefined typedefs in gtsam/slam/pose2SLAM.h * - * Created on: Oct 21, 2010 - * Author: ydjian + * @date Oct 21, 2010 + * @author ydjian */ #include diff --git a/examples/SimpleRotation.cpp b/examples/SimpleRotation.cpp index 09385132a..0429a701d 100644 --- a/examples/SimpleRotation.cpp +++ b/examples/SimpleRotation.cpp @@ -9,14 +9,12 @@ * -------------------------------------------------------------------------- */ -/* - * SimpleRotation.cpp - * - * This is a super-simple example of optimizing a single rotation according to a single prior - * - * Created on: Jul 1, 2010 - * @author Frank Dellaert - * @author Alex Cunningham +/** + * @file SimpleRotation.cpp + * @brief This is a super-simple example of optimizing a single rotation according to a single prior + * @date Jul 1, 2010 + * @author Frank Dellaert + * @author Alex Cunningham */ #include diff --git a/examples/easyPoint2KalmanFilter.cpp b/examples/easyPoint2KalmanFilter.cpp index 075006c69..5081f6356 100644 --- a/examples/easyPoint2KalmanFilter.cpp +++ b/examples/easyPoint2KalmanFilter.cpp @@ -9,16 +9,16 @@ * -------------------------------------------------------------------------- */ -/* - * easyPoint2KalmanFilter.cpp +/** + * @file easyPoint2KalmanFilter.cpp * * simple linear Kalman filter on a moving 2D point, but done using factor graphs * This example uses the templated ExtendedKalmanFilter class to perform the same * operations as in elaboratePoint2KalmanFilter * - * Created on: Aug 19, 2011 - * @author Frank Dellaert - * @author Stephen Williams + * @date Aug 19, 2011 + * @author Frank Dellaert + * @author Stephen Williams */ #include diff --git a/examples/elaboratePoint2KalmanFilter.cpp b/examples/elaboratePoint2KalmanFilter.cpp index d46b1e0ba..23870a888 100644 --- a/examples/elaboratePoint2KalmanFilter.cpp +++ b/examples/elaboratePoint2KalmanFilter.cpp @@ -9,15 +9,15 @@ * -------------------------------------------------------------------------- */ -/* - * elaboratePoint2KalmanFilter.cpp +/** + * @file elaboratePoint2KalmanFilter.cpp * * simple linear Kalman filter on a moving 2D point, but done using factor graphs * This example manually creates all of the needed data structures * - * Created on: Aug 19, 2011 - * @author Frank Dellaert - * @author Stephen Williams + * @date Aug 19, 2011 + * @author Frank Dellaert + * @author Stephen Williams */ #include diff --git a/gtsam/base/tests/testBTree.cpp b/gtsam/base/tests/testBTree.cpp index e6b4c5e7c..da3003bb5 100644 --- a/gtsam/base/tests/testBTree.cpp +++ b/gtsam/base/tests/testBTree.cpp @@ -10,11 +10,10 @@ * -------------------------------------------------------------------------- */ /** - * testBTree.cpp - * - * Created on: Feb 3, 2010 - * @author Chris Beall - * @author Frank Dellaert + * @file testBTree.cpp + * @date Feb 3, 2010 + * @author Chris Beall + * @author Frank Dellaert */ #include diff --git a/gtsam/base/tests/testDSF.cpp b/gtsam/base/tests/testDSF.cpp index 39d8d447e..fd5ca6e84 100644 --- a/gtsam/base/tests/testDSF.cpp +++ b/gtsam/base/tests/testDSF.cpp @@ -9,12 +9,11 @@ * -------------------------------------------------------------------------- */ -/* - * testDSF.cpp - * - * Created on: Mar 26, 2010 - * Author: nikai - * Description: unit tests for DSF +/** + * @file testDSF.cpp + * @date Mar 26, 2010 + * @author nikai + * @brief unit tests for DSF */ #include diff --git a/gtsam/base/tests/testDSFVector.cpp b/gtsam/base/tests/testDSFVector.cpp index 81e4f3b07..c0b72f1a0 100644 --- a/gtsam/base/tests/testDSFVector.cpp +++ b/gtsam/base/tests/testDSFVector.cpp @@ -9,12 +9,11 @@ * -------------------------------------------------------------------------- */ -/* - * testDSF.cpp - * - * Created on: June 25, 2010 - * Author: nikai - * Description: unit tests for DSF +/** + * @file testDSF.cpp + * @date June 25, 2010 + * @author nikai + * @brief unit tests for DSF */ #include diff --git a/gtsam/geometry/Cal3Bundler.cpp b/gtsam/geometry/Cal3Bundler.cpp index d8bd2ad9b..6bdef025c 100644 --- a/gtsam/geometry/Cal3Bundler.cpp +++ b/gtsam/geometry/Cal3Bundler.cpp @@ -9,11 +9,10 @@ * -------------------------------------------------------------------------- */ -/* - * Cal3Bundler.cpp - * - * Created on: Sep 25, 2010 - * Author: ydjian +/** + * @file Cal3Bundler.cpp + * @date Sep 25, 2010 + * @author ydjian */ #include diff --git a/gtsam/geometry/Cal3DS2.cpp b/gtsam/geometry/Cal3DS2.cpp index ca4068f8e..069ec4efb 100644 --- a/gtsam/geometry/Cal3DS2.cpp +++ b/gtsam/geometry/Cal3DS2.cpp @@ -9,11 +9,10 @@ * -------------------------------------------------------------------------- */ -/* - * Cal3DS2.cpp - * - * Created on: Feb 28, 2010 - * Author: ydjian +/** + * @file Cal3DS2.cpp + * @date Feb 28, 2010 + * @author ydjian */ #include diff --git a/gtsam/geometry/Rot2.cpp b/gtsam/geometry/Rot2.cpp index e150af203..25c319345 100644 --- a/gtsam/geometry/Rot2.cpp +++ b/gtsam/geometry/Rot2.cpp @@ -9,11 +9,11 @@ * -------------------------------------------------------------------------- */ -/* - * Rot2.cpp - * - * Created on: Dec 9, 2009 - * Author: Frank Dellaert +/** + * @file Rot2.cpp + * @date Dec 9, 2009 + * @author Frank Dellaert + * @brief 2D Rotations */ #include diff --git a/gtsam/geometry/SimpleCamera.cpp b/gtsam/geometry/SimpleCamera.cpp index b82ff0f9a..c87f72e3e 100644 --- a/gtsam/geometry/SimpleCamera.cpp +++ b/gtsam/geometry/SimpleCamera.cpp @@ -9,11 +9,10 @@ * -------------------------------------------------------------------------- */ -/* - * SimpleCamera.cpp - * - * Created on: Aug 16, 2009 - * Author: dellaert +/** + * @file SimpleCamera.cpp + * @date Aug 16, 2009 + * @author dellaert */ #include diff --git a/gtsam/geometry/StereoPoint2.cpp b/gtsam/geometry/StereoPoint2.cpp index 8e84f0e23..6b0b0a684 100644 --- a/gtsam/geometry/StereoPoint2.cpp +++ b/gtsam/geometry/StereoPoint2.cpp @@ -9,11 +9,10 @@ * -------------------------------------------------------------------------- */ -/* - * StereoPoint2.cpp - * - * Created on: Jan 26, 2010 - * Author: dellaert +/** + * @file StereoPoint2.cpp + * @date Jan 26, 2010 + * @author dellaert */ #include diff --git a/gtsam/geometry/tensorInterface.cpp b/gtsam/geometry/tensorInterface.cpp index 276a6c3e0..683543e19 100644 --- a/gtsam/geometry/tensorInterface.cpp +++ b/gtsam/geometry/tensorInterface.cpp @@ -9,11 +9,11 @@ * -------------------------------------------------------------------------- */ -/* - * tensorInterface.cpp +/** + * @file tensorInterface.cpp * @brief Interfacing tensors template library and gtsam - * Created on: Feb 12, 2010 - * @author: Frank Dellaert + * @date Feb 12, 2010 + * @author Frank Dellaert */ #include diff --git a/gtsam/geometry/tests/testCalibratedCamera.cpp b/gtsam/geometry/tests/testCalibratedCamera.cpp index e9821029c..5e24b3eb6 100644 --- a/gtsam/geometry/tests/testCalibratedCamera.cpp +++ b/gtsam/geometry/tests/testCalibratedCamera.cpp @@ -10,9 +10,9 @@ * -------------------------------------------------------------------------- */ /** - * Frank Dellaert - * brief: test CalibratedCamera class - * based on testVSLAMFactor.cpp + * @file testCalibratedCamera.cpp + * @author Frank Dellaert + * @brief test CalibratedCamera class */ #include diff --git a/gtsam/geometry/tests/testFundamental.cpp b/gtsam/geometry/tests/testFundamental.cpp index f5dd88409..297b36036 100644 --- a/gtsam/geometry/tests/testFundamental.cpp +++ b/gtsam/geometry/tests/testFundamental.cpp @@ -9,10 +9,10 @@ * -------------------------------------------------------------------------- */ -/* - * testFundamental.cpp +/** + * @file testFundamental.cpp * @brief try tensor expressions based on http://www.gps.caltech.edu/~walter/FTensor/FTensor.pdf - * Created on: Feb 13, 2010 + * @date Feb 13, 2010 * @author: Frank Dellaert */ diff --git a/gtsam/geometry/tests/testHomography2.cpp b/gtsam/geometry/tests/testHomography2.cpp index bb5a70b51..639462955 100644 --- a/gtsam/geometry/tests/testHomography2.cpp +++ b/gtsam/geometry/tests/testHomography2.cpp @@ -9,11 +9,11 @@ * -------------------------------------------------------------------------- */ -/* - * testHomography2.cpp +/** + * @file testHomography2.cpp * @brief Test and estimate 2D homographies - * Created on: Feb 13, 2010 - * @author: Frank Dellaert + * @date Feb 13, 2010 + * @author Frank Dellaert */ #include diff --git a/gtsam/geometry/tests/testSimpleCamera.cpp b/gtsam/geometry/tests/testSimpleCamera.cpp index 4b68f0a02..ae29652d2 100644 --- a/gtsam/geometry/tests/testSimpleCamera.cpp +++ b/gtsam/geometry/tests/testSimpleCamera.cpp @@ -10,9 +10,9 @@ * -------------------------------------------------------------------------- */ /** - * Frank Dellaert - * brief: test SimpleCamera class - * based on testVSLAMFactor.cpp + * @file testSimpleCamera.cpp + * @author Frank Dellaert + * @brief test SimpleCamera class */ #include diff --git a/gtsam/geometry/tests/testTensors.cpp b/gtsam/geometry/tests/testTensors.cpp index dc96534ad..755b274a6 100644 --- a/gtsam/geometry/tests/testTensors.cpp +++ b/gtsam/geometry/tests/testTensors.cpp @@ -9,11 +9,11 @@ * -------------------------------------------------------------------------- */ -/* - * testTensors.cpp +/** + * @file testTensors.cpp * @brief try tensor expressions based on http://www.gps.caltech.edu/~walter/FTensor/FTensor.pdf - * Created on: Feb 9, 2010 - * @author: Frank Dellaert + * @date Feb 9, 2010 + * @author Frank Dellaert */ #include diff --git a/gtsam/inference/ClusterTree-inl.h b/gtsam/inference/ClusterTree-inl.h index 034aa46e5..0f1f823af 100644 --- a/gtsam/inference/ClusterTree-inl.h +++ b/gtsam/inference/ClusterTree-inl.h @@ -9,9 +9,9 @@ * -------------------------------------------------------------------------- */ -/* - * ClusterTree-inl.h - * Created on: July 13, 2010 +/** + * @file ClusterTree-inl.h + * @date July 13, 2010 * @author Kai Ni * @author Frank Dellaert * @brief: Collects factorgraph fragments defined on variable clusters, arranged in a tree diff --git a/gtsam/inference/ClusterTree.h b/gtsam/inference/ClusterTree.h index 965bbdc2b..2d79706e2 100644 --- a/gtsam/inference/ClusterTree.h +++ b/gtsam/inference/ClusterTree.h @@ -9,9 +9,9 @@ * -------------------------------------------------------------------------- */ -/* - * ClusterTree.h - * Created on: July 13, 2010 +/** + * @file ClusterTree.h + * @date July 13, 2010 * @author Kai Ni * @author Frank Dellaert * @brief: Collects factorgraph fragments defined on variable clusters, arranged in a tree diff --git a/gtsam/inference/JunctionTree-inl.h b/gtsam/inference/JunctionTree-inl.h index ed0033d91..6ca112c18 100644 --- a/gtsam/inference/JunctionTree-inl.h +++ b/gtsam/inference/JunctionTree-inl.h @@ -9,12 +9,12 @@ * -------------------------------------------------------------------------- */ -/* - * JunctionTree-inl.h - * Created on: Feb 4, 2010 +/** + * @file JunctionTree-inl.h + * @date Feb 4, 2010 * @author Kai Ni * @author Frank Dellaert - * @brief: The junction tree, template bodies + * @brief The junction tree, template bodies */ #pragma once diff --git a/gtsam/inference/JunctionTree.h b/gtsam/inference/JunctionTree.h index 33a5054d7..909cebc62 100644 --- a/gtsam/inference/JunctionTree.h +++ b/gtsam/inference/JunctionTree.h @@ -9,9 +9,9 @@ * -------------------------------------------------------------------------- */ -/* - * JunctionTree.h - * Created on: Feb 4, 2010 +/** + * @file JunctionTree.h + * @date Feb 4, 2010 * @author Kai Ni * @author Frank Dellaert * @brief: The junction tree diff --git a/gtsam/inference/SymbolicFactorGraph.cpp b/gtsam/inference/SymbolicFactorGraph.cpp index ace4dbade..5a008a192 100644 --- a/gtsam/inference/SymbolicFactorGraph.cpp +++ b/gtsam/inference/SymbolicFactorGraph.cpp @@ -9,11 +9,10 @@ * -------------------------------------------------------------------------- */ -/* - * SymbolicFactorGraph.cpp - * - * Created on: Oct 29, 2009 - * Author: Frank Dellaert +/** + * @file SymbolicFactorGraph.cpp + * @date Oct 29, 2009 + * @author Frank Dellaert */ #include diff --git a/gtsam/inference/SymbolicFactorGraph.h b/gtsam/inference/SymbolicFactorGraph.h index cf0b35c24..dd9932d74 100644 --- a/gtsam/inference/SymbolicFactorGraph.h +++ b/gtsam/inference/SymbolicFactorGraph.h @@ -9,11 +9,10 @@ * -------------------------------------------------------------------------- */ -/* - * SymbolicFactorGraph.h - * - * Created on: Oct 29, 2009 - * Author: Frank Dellaert +/** + * @file SymbolicFactorGraph.h + * @date Oct 29, 2009 + * @author Frank Dellaert */ #pragma once diff --git a/gtsam/inference/graph.h b/gtsam/inference/graph.h index 043e83ee2..7a34159ca 100644 --- a/gtsam/inference/graph.h +++ b/gtsam/inference/graph.h @@ -9,11 +9,11 @@ * -------------------------------------------------------------------------- */ -/* - * graph.h +/** + * @file graph.h * @brief Graph algorithm using boost library * @author: Kai Ni - * Created on: Jan 11, 2010 + * @date Jan 11, 2010 */ #pragma once diff --git a/gtsam/inference/tests/testPermutation.cpp b/gtsam/inference/tests/testPermutation.cpp index cd5705db3..c5f41c14f 100644 --- a/gtsam/inference/tests/testPermutation.cpp +++ b/gtsam/inference/tests/testPermutation.cpp @@ -1,8 +1,7 @@ -/* - * testPermutation.cpp - * - * Created on: Sep 22, 2011 - * Author: richard +/** + * @file testPermutation.cpp + * @date Sep 22, 2011 + * @author richard */ #include diff --git a/gtsam/inference/tests/timeSymbolMaps.cpp b/gtsam/inference/tests/timeSymbolMaps.cpp index d5efe5ca1..1bf83ca5d 100644 --- a/gtsam/inference/tests/timeSymbolMaps.cpp +++ b/gtsam/inference/tests/timeSymbolMaps.cpp @@ -9,11 +9,10 @@ * -------------------------------------------------------------------------- */ -/* - * timeSymbolMaps.cpp - * - * Created on: Jan 20, 2010 - * Author: richard +/** + * @file timeSymbolMaps.cpp + * @date Jan 20, 2010 + * @author richard */ #include diff --git a/gtsam/linear/GaussianJunctionTree.cpp b/gtsam/linear/GaussianJunctionTree.cpp index 78dcaf8e5..f539e1759 100644 --- a/gtsam/linear/GaussianJunctionTree.cpp +++ b/gtsam/linear/GaussianJunctionTree.cpp @@ -10,8 +10,8 @@ * -------------------------------------------------------------------------- */ /** - * GaussianJunctionTree.cpp - * Created on: Jul 12, 2010 + * @file GaussianJunctionTree.cpp + * @date Jul 12, 2010 * @author Kai Ni * @author Frank Dellaert * @brief: the Gaussian junction tree diff --git a/gtsam/linear/GaussianJunctionTree.h b/gtsam/linear/GaussianJunctionTree.h index 7e5972daa..0397a646b 100644 --- a/gtsam/linear/GaussianJunctionTree.h +++ b/gtsam/linear/GaussianJunctionTree.h @@ -10,8 +10,8 @@ * -------------------------------------------------------------------------- */ /** - * GaussianJunctionTree.h - * Created on: Jul 12, 2010 + * @file GaussianJunctionTree.h + * @date Jul 12, 2010 * @author Kai Ni * @author Frank Dellaert * @brief: the Gaussian junction tree diff --git a/gtsam/linear/IterativeOptimizationParameters.h b/gtsam/linear/IterativeOptimizationParameters.h index bc16c222d..dd421f394 100644 --- a/gtsam/linear/IterativeOptimizationParameters.h +++ b/gtsam/linear/IterativeOptimizationParameters.h @@ -1,8 +1,7 @@ -/* - * IterativeOptimizationParameters.h - * - * Created on: Oct 22, 2010 - * Author: Yong-Dian Jian +/** + * @file IterativeOptimizationParameters.h + * @date Oct 22, 2010 + * @author Yong-Dian Jian */ #pragma once diff --git a/gtsam/linear/KalmanFilter.h b/gtsam/linear/KalmanFilter.h index 34580104a..6e8206b5e 100644 --- a/gtsam/linear/KalmanFilter.h +++ b/gtsam/linear/KalmanFilter.h @@ -9,15 +9,15 @@ * -------------------------------------------------------------------------- */ -/* - * testKalmanFilter.cpp +/** + * @file testKalmanFilter.cpp * * Simple linear Kalman filter. * Implemented using factor graphs, i.e., does LDL-based SRIF, really. * - * Created on: Sep 3, 2011 - * @author Stephen Williams - * @author Frank Dellaert + * @date Sep 3, 2011 + * @author Stephen Williams + * @author Frank Dellaert */ #include diff --git a/gtsam/linear/SharedDiagonal.h b/gtsam/linear/SharedDiagonal.h index a81696256..13707393a 100644 --- a/gtsam/linear/SharedDiagonal.h +++ b/gtsam/linear/SharedDiagonal.h @@ -10,10 +10,10 @@ * -------------------------------------------------------------------------- */ /** - * SharedDiagonal.h + * @file SharedDiagonal.h * @brief Class that wraps a shared noise model with diagonal covariance * @author Frank Dellaert - * Created on: Jan 22, 2010 + * @date Jan 22, 2010 */ #pragma once diff --git a/gtsam/linear/SharedGaussian.h b/gtsam/linear/SharedGaussian.h index 520f3d858..e74a7a647 100644 --- a/gtsam/linear/SharedGaussian.h +++ b/gtsam/linear/SharedGaussian.h @@ -10,10 +10,10 @@ * -------------------------------------------------------------------------- */ /** - * SharedGaussian.h + * @file SharedGaussian.h * @brief Class that wraps a shared noise model with diagonal covariance * @author Frank Dellaert - * Created on: Jan 22, 2010 + * @date Jan 22, 2010 */ #pragma once diff --git a/gtsam/linear/SubgraphPreconditioner.cpp b/gtsam/linear/SubgraphPreconditioner.cpp index f94e07ced..3aa0f32c5 100644 --- a/gtsam/linear/SubgraphPreconditioner.cpp +++ b/gtsam/linear/SubgraphPreconditioner.cpp @@ -9,9 +9,9 @@ * -------------------------------------------------------------------------- */ -/* - * SubgraphPreconditioner.cpp - * Created on: Dec 31, 2009 +/** + * @file SubgraphPreconditioner.cpp + * @date Dec 31, 2009 * @author: Frank Dellaert */ diff --git a/gtsam/linear/SubgraphPreconditioner.h b/gtsam/linear/SubgraphPreconditioner.h index 608c765c4..aca2398e4 100644 --- a/gtsam/linear/SubgraphPreconditioner.h +++ b/gtsam/linear/SubgraphPreconditioner.h @@ -9,10 +9,10 @@ * -------------------------------------------------------------------------- */ -/* - * SubgraphPreconditioner.h - * Created on: Dec 31, 2009 - * @author: Frank Dellaert +/** + * @file SubgraphPreconditioner.h + * @date Dec 31, 2009 + * @author Frank Dellaert */ #pragma once diff --git a/gtsam/linear/iterative-inl.h b/gtsam/linear/iterative-inl.h index ba4eec0b0..59fd824bf 100644 --- a/gtsam/linear/iterative-inl.h +++ b/gtsam/linear/iterative-inl.h @@ -9,11 +9,11 @@ * -------------------------------------------------------------------------- */ -/* - * iterative-inl.h +/** + * @file iterative-inl.h * @brief Iterative methods, template implementation * @author Frank Dellaert - * Created on: Dec 28, 2009 + * @date Dec 28, 2009 */ #pragma once diff --git a/gtsam/linear/iterative.cpp b/gtsam/linear/iterative.cpp index cbc1a1402..c431e0c82 100644 --- a/gtsam/linear/iterative.cpp +++ b/gtsam/linear/iterative.cpp @@ -9,11 +9,11 @@ * -------------------------------------------------------------------------- */ -/* - * iterative.cpp +/** + * @file iterative.cpp * @brief Iterative methods, implementation * @author Frank Dellaert - * Created on: Dec 28, 2009 + * @date Dec 28, 2009 */ #include diff --git a/gtsam/linear/iterative.h b/gtsam/linear/iterative.h index 223d1c67f..2e6f77f10 100644 --- a/gtsam/linear/iterative.h +++ b/gtsam/linear/iterative.h @@ -9,11 +9,11 @@ * -------------------------------------------------------------------------- */ -/* - * iterative.h +/** + * @file iterative.h * @brief Iterative methods, implementation * @author Frank Dellaert - * Created on: Dec 28, 2009 + * @date Dec 28, 2009 */ #pragma once diff --git a/gtsam/linear/tests/testErrors.cpp b/gtsam/linear/tests/testErrors.cpp index a5e10d709..438ae3623 100644 --- a/gtsam/linear/tests/testErrors.cpp +++ b/gtsam/linear/tests/testErrors.cpp @@ -9,11 +9,10 @@ * -------------------------------------------------------------------------- */ -/* - * testErrors.cpp - * - * Created on: Feb 20, 2010 - * @author Frank Dellaert +/** + * @file testErrors.cpp + * @date Feb 20, 2010 + * @author Frank Dellaert */ #include // for += diff --git a/gtsam/linear/tests/testGaussianJunctionTree.cpp b/gtsam/linear/tests/testGaussianJunctionTree.cpp index 9575384b1..7a5358a4a 100644 --- a/gtsam/linear/tests/testGaussianJunctionTree.cpp +++ b/gtsam/linear/tests/testGaussianJunctionTree.cpp @@ -9,10 +9,9 @@ * -------------------------------------------------------------------------- */ -/* - * testGaussianJunctionTree.cpp - * - * Created on: Jul 8, 2010 +/** + * @file testGaussianJunctionTree.cpp + * @date Jul 8, 2010 * @author Kai Ni */ diff --git a/gtsam/linear/tests/testKalmanFilter.cpp b/gtsam/linear/tests/testKalmanFilter.cpp index 285f0d1b9..d873da83c 100644 --- a/gtsam/linear/tests/testKalmanFilter.cpp +++ b/gtsam/linear/tests/testKalmanFilter.cpp @@ -9,14 +9,12 @@ * -------------------------------------------------------------------------- */ -/* - * testKalmanFilter.cpp - * - * Test simple linear Kalman filter on a moving 2D point - * - * Created on: Sep 3, 2011 - * @author Stephen Williams - * @author Frank Dellaert +/** + * @file testKalmanFilter.cpp + * @brief Test simple linear Kalman filter on a moving 2D point + * @date Sep 3, 2011 + * @author Stephen Williams + * @author Frank Dellaert */ #include diff --git a/gtsam/linear/tests/testNoiseModel.cpp b/gtsam/linear/tests/testNoiseModel.cpp index f9f99586b..1f97c9eb1 100644 --- a/gtsam/linear/tests/testNoiseModel.cpp +++ b/gtsam/linear/tests/testNoiseModel.cpp @@ -9,12 +9,11 @@ * -------------------------------------------------------------------------- */ -/* - * testNoiseModel.cpp - * - * Created on: Jan 13, 2010 - * Author: Richard Roberts - * Author: Frank Dellaert +/** + * @file testNoiseModel.cpp + * @date Jan 13, 2010 + * @author Richard Roberts + * @author Frank Dellaert */ diff --git a/gtsam/nonlinear/Key.h b/gtsam/nonlinear/Key.h index fce8d9439..20416c337 100644 --- a/gtsam/nonlinear/Key.h +++ b/gtsam/nonlinear/Key.h @@ -11,10 +11,9 @@ /** * @file Key.h - * - * Created on: Jan 12, 2010 - * @author: Frank Dellaert - * @author: Richard Roberts + * @date Jan 12, 2010 + * @author: Frank Dellaert + * @author: Richard Roberts */ #pragma once diff --git a/gtsam/nonlinear/NonlinearISAM-inl.h b/gtsam/nonlinear/NonlinearISAM-inl.h index 29d79ce8b..eba64cf33 100644 --- a/gtsam/nonlinear/NonlinearISAM-inl.h +++ b/gtsam/nonlinear/NonlinearISAM-inl.h @@ -10,10 +10,9 @@ * -------------------------------------------------------------------------- */ /** - * NonlinearISAM-inl.h - * - * Created on: Jan 19, 2010 - * Author: Viorela Ila and Richard Roberts + * @file NonlinearISAM-inl.h + * @date Jan 19, 2010 + * @author Viorela Ila and Richard Roberts */ #pragma once diff --git a/gtsam/nonlinear/NonlinearISAM.h b/gtsam/nonlinear/NonlinearISAM.h index 76462c5f9..55bff857f 100644 --- a/gtsam/nonlinear/NonlinearISAM.h +++ b/gtsam/nonlinear/NonlinearISAM.h @@ -9,11 +9,10 @@ * -------------------------------------------------------------------------- */ -/* - * NonlinearISAM.h - * - * Created on: Jan 19, 2010 - * Author: Viorela Ila and Richard Roberts +/** + * @file NonlinearISAM.h + * @date Jan 19, 2010 + * @author Viorela Ila and Richard Roberts */ #pragma once diff --git a/gtsam/nonlinear/NonlinearOptimization-inl.h b/gtsam/nonlinear/NonlinearOptimization-inl.h index 1f8d0dc17..f04cdc04d 100644 --- a/gtsam/nonlinear/NonlinearOptimization-inl.h +++ b/gtsam/nonlinear/NonlinearOptimization-inl.h @@ -9,12 +9,11 @@ * -------------------------------------------------------------------------- */ -/* - * NonlinearOptimization-inl.h - * - * Created on: Oct 17, 2010 - * Author: Kai Ni - * Description: Easy interfaces for NonlinearOptimizer +/** + * @file NonlinearOptimization-inl.h + * @date Oct 17, 2010 + * @author Kai Ni + * @brief Easy interfaces for NonlinearOptimizer */ #pragma once diff --git a/gtsam/nonlinear/NonlinearOptimization.h b/gtsam/nonlinear/NonlinearOptimization.h index 448a66338..2d3416ef3 100644 --- a/gtsam/nonlinear/NonlinearOptimization.h +++ b/gtsam/nonlinear/NonlinearOptimization.h @@ -9,12 +9,11 @@ * -------------------------------------------------------------------------- */ -/* - * NonlinearOptimization.h - * - * Created on: Oct 14, 2010 - * Author: Kai Ni - * Description: Easy interfaces for NonlinearOptimizer +/** + * @file NonlinearOptimization.h + * @date Oct 14, 2010 + * @author Kai Ni + * @brief Easy interfaces for NonlinearOptimizer */ #pragma once diff --git a/gtsam/nonlinear/NonlinearOptimizer-inl.h b/gtsam/nonlinear/NonlinearOptimizer-inl.h index 4e633660a..c2380c672 100644 --- a/gtsam/nonlinear/NonlinearOptimizer-inl.h +++ b/gtsam/nonlinear/NonlinearOptimizer-inl.h @@ -10,12 +10,12 @@ * -------------------------------------------------------------------------- */ /** - * NonlinearOptimizer-inl.h + * @file NonlinearOptimizer-inl.h * This is a template definition file, include it where needed (only!) * so that the appropriate code is generated and link errors avoided. * @brief: Encapsulates nonlinear optimization state * @author Frank Dellaert - * Created on: Sep 7, 2009 + * @date Sep 7, 2009 */ #pragma once diff --git a/gtsam/nonlinear/NonlinearOptimizer.cpp b/gtsam/nonlinear/NonlinearOptimizer.cpp index f45278da4..5e0a6003e 100644 --- a/gtsam/nonlinear/NonlinearOptimizer.cpp +++ b/gtsam/nonlinear/NonlinearOptimizer.cpp @@ -10,10 +10,10 @@ * -------------------------------------------------------------------------- */ /** - * NonlinearOptimizer.cpp - * @brief: Convergence functions not dependent on graph types + * @file NonlinearOptimizer.cpp + * @brief Convergence functions not dependent on graph types * @author Frank Dellaert - * Created on: Jul 17, 2010 + * @date Jul 17, 2010 */ #include diff --git a/gtsam/nonlinear/NonlinearOptimizer.h b/gtsam/nonlinear/NonlinearOptimizer.h index f0f75d4db..6ad3ee3c7 100644 --- a/gtsam/nonlinear/NonlinearOptimizer.h +++ b/gtsam/nonlinear/NonlinearOptimizer.h @@ -10,10 +10,10 @@ * -------------------------------------------------------------------------- */ /** - * NonlinearOptimizer.h - * @brief: Encapsulates nonlinear optimization state + * @file NonlinearOptimizer.h + * @brief Encapsulates nonlinear optimization state * @author Frank Dellaert - * Created on: Sep 7, 2009 + * @date Sep 7, 2009 */ #pragma once diff --git a/gtsam/slam/BearingRangeFactor.h b/gtsam/slam/BearingRangeFactor.h index 9d5267777..59dd93ee1 100644 --- a/gtsam/slam/BearingRangeFactor.h +++ b/gtsam/slam/BearingRangeFactor.h @@ -9,12 +9,11 @@ * -------------------------------------------------------------------------- */ -/* - * BearingRangeFactor.h - * - * Created on: Apr 1, 2010 - * Author: Kai Ni - * Description: a single factor contains both the bearing and the range to prevent handle to pair bearing and range factors +/** + * @file BearingRangeFactor.h + * @date Apr 1, 2010 + * @author Kai Ni + * @brief a single factor contains both the bearing and the range to prevent handle to pair bearing and range factors */ #pragma once diff --git a/gtsam/slam/Simulated2DMeasurement.h b/gtsam/slam/Simulated2DMeasurement.h index b85351fc1..0ab661086 100644 --- a/gtsam/slam/Simulated2DMeasurement.h +++ b/gtsam/slam/Simulated2DMeasurement.h @@ -9,11 +9,10 @@ * -------------------------------------------------------------------------- */ -/* - * Simulated2DMeasurement.h - * - * Re-created on Feb 22, 2010 for compatibility with MATLAB - * Author: Frank Dellaert +/** + * @file Simulated2DMeasurement.h + * @brief Re-created on Feb 22, 2010 for compatibility with MATLAB + * @author Frank Dellaert */ #pragma once diff --git a/gtsam/slam/Simulated2DOdometry.h b/gtsam/slam/Simulated2DOdometry.h index 498e23fcc..5bd3afc14 100644 --- a/gtsam/slam/Simulated2DOdometry.h +++ b/gtsam/slam/Simulated2DOdometry.h @@ -9,11 +9,10 @@ * -------------------------------------------------------------------------- */ -/* - * Simulated2DOdometry.h - * - * Re-created on Feb 22, 2010 for compatibility with MATLAB - * Author: Frank Dellaert +/** + * @file Simulated2DOdometry.h + * @brief Re-created on Feb 22, 2010 for compatibility with MATLAB + * @author Frank Dellaert */ #pragma once diff --git a/gtsam/slam/Simulated2DOrientedOdometry.h b/gtsam/slam/Simulated2DOrientedOdometry.h index dd5afac7b..1a659c081 100644 --- a/gtsam/slam/Simulated2DOrientedOdometry.h +++ b/gtsam/slam/Simulated2DOrientedOdometry.h @@ -9,11 +9,10 @@ * -------------------------------------------------------------------------- */ -/* - * Simulated2DOrientedOdometry.h - * - * Re-created on Feb 22, 2010 for compatibility with MATLAB - * Author: Kai Ni +/** + * @file Simulated2DOrientedOdometry.h + * @brief Re-created on Feb 22, 2010 for compatibility with MATLAB + * @author Kai Ni */ #pragma once diff --git a/gtsam/slam/Simulated2DOrientedPosePrior.h b/gtsam/slam/Simulated2DOrientedPosePrior.h index be8407b6c..54a83f1be 100644 --- a/gtsam/slam/Simulated2DOrientedPosePrior.h +++ b/gtsam/slam/Simulated2DOrientedPosePrior.h @@ -9,11 +9,10 @@ * -------------------------------------------------------------------------- */ -/* - * Simulated2DOrientedPosePrior.h - * - * Re-created on Feb 22, 2010 for compatibility with MATLAB - * Author: Kai Ni +/** + * @file Simulated2DOrientedPosePrior.h + * @brief Re-created on Feb 22, 2010 for compatibility with MATLAB + * @author Kai Ni */ #pragma once diff --git a/gtsam/slam/Simulated2DOrientedValues.h b/gtsam/slam/Simulated2DOrientedValues.h index 20bd7bffa..b1fe098f8 100644 --- a/gtsam/slam/Simulated2DOrientedValues.h +++ b/gtsam/slam/Simulated2DOrientedValues.h @@ -9,11 +9,10 @@ * -------------------------------------------------------------------------- */ -/* - * Simulated2DValues.h - * - * Re-created on Feb 22, 2010 for compatibility with MATLAB - * Author: Frank Dellaert +/** + * @file Simulated2DValues.h + * @brief Re-created on Feb 22, 2010 for compatibility with MATLAB + * @author Frank Dellaert */ #pragma once diff --git a/gtsam/slam/Simulated2DPointPrior.h b/gtsam/slam/Simulated2DPointPrior.h index 3610f9c1b..8fc896d92 100644 --- a/gtsam/slam/Simulated2DPointPrior.h +++ b/gtsam/slam/Simulated2DPointPrior.h @@ -9,11 +9,10 @@ * -------------------------------------------------------------------------- */ -/* - * Simulated2DPointPrior.h - * - * Re-created on Feb 22, 2010 for compatibility with MATLAB - * Author: Frank Dellaert +/** + * @file Simulated2DPointPrior.h + * @brief Re-created on Feb 22, 2010 for compatibility with MATLAB + * @author Frank Dellaert */ #pragma once diff --git a/gtsam/slam/Simulated2DPosePrior.h b/gtsam/slam/Simulated2DPosePrior.h index a0b123243..1c85e4d5b 100644 --- a/gtsam/slam/Simulated2DPosePrior.h +++ b/gtsam/slam/Simulated2DPosePrior.h @@ -9,11 +9,10 @@ * -------------------------------------------------------------------------- */ -/* - * Simulated2DPosePrior.h - * - * Re-created on Feb 22, 2010 for compatibility with MATLAB - * Author: Frank Dellaert +/** + * @file Simulated2DPosePrior.h + * @brief Re-created on Feb 22, 2010 for compatibility with MATLAB + * @author Frank Dellaert */ #pragma once diff --git a/gtsam/slam/Simulated2DValues.h b/gtsam/slam/Simulated2DValues.h index 1d11cd4a4..c4d1d1534 100644 --- a/gtsam/slam/Simulated2DValues.h +++ b/gtsam/slam/Simulated2DValues.h @@ -9,11 +9,10 @@ * -------------------------------------------------------------------------- */ -/* - * Simulated2DValues.h - * - * Re-created on Feb 22, 2010 for compatibility with MATLAB - * Author: Frank Dellaert +/** + * @file Simulated2DValues.h + * @brief Re-created on Feb 22, 2010 for compatibility with MATLAB + * @author Frank Dellaert */ #pragma once diff --git a/gtsam/slam/dataset.cpp b/gtsam/slam/dataset.cpp index 5d1e03358..6b247c3fe 100644 --- a/gtsam/slam/dataset.cpp +++ b/gtsam/slam/dataset.cpp @@ -9,12 +9,11 @@ * -------------------------------------------------------------------------- */ -/* - * dataset.cpp - * - * Created on: Jan 22, 2010 - * Author: nikai - * Description: utility functions for loading datasets +/** + * @file dataset.cpp + * @date Jan 22, 2010 + * @author nikai + * @brief utility functions for loading datasets */ diff --git a/gtsam/slam/dataset.h b/gtsam/slam/dataset.h index 7bf355893..d808dfa24 100644 --- a/gtsam/slam/dataset.h +++ b/gtsam/slam/dataset.h @@ -9,12 +9,11 @@ * -------------------------------------------------------------------------- */ -/* - * dataset.h - * - * Created on: Jan 22, 2010 - * Author: nikai - * Description: utility functions for loading datasets +/** + * @file dataset.h + * @date Jan 22, 2010 + * @author nikai + * @brief utility functions for loading datasets */ #pragma once diff --git a/gtsam/slam/tests/testGeneralSFMFactor.cpp b/gtsam/slam/tests/testGeneralSFMFactor.cpp index 1bc991da6..395d18a28 100644 --- a/gtsam/slam/tests/testGeneralSFMFactor.cpp +++ b/gtsam/slam/tests/testGeneralSFMFactor.cpp @@ -1,9 +1,8 @@ -/* - * testGeneralSFMFactor.cpp - * - * Created on: Dec 27, 2010 - * Author: nikai - * Description: unit tests for GeneralSFMFactor +/** + * @file testGeneralSFMFactor.cpp + * @date Dec 27, 2010 + * @author nikai + * @brief unit tests for GeneralSFMFactor */ #include diff --git a/gtsam/slam/tests/testGeneralSFMFactor_Cal3Bundler.cpp b/gtsam/slam/tests/testGeneralSFMFactor_Cal3Bundler.cpp index 03e1bb2ed..4adcc6e4c 100644 --- a/gtsam/slam/tests/testGeneralSFMFactor_Cal3Bundler.cpp +++ b/gtsam/slam/tests/testGeneralSFMFactor_Cal3Bundler.cpp @@ -1,9 +1,8 @@ -/* - * testGeneralSFMFactor.cpp - * - * Created on: Dec 27, 2010 - * Author: nikai - * Description: unit tests for GeneralSFMFactor +/** + * @file testGeneralSFMFactor.cpp + * @date Dec 27, 2010 + * @author nikai + * @brief unit tests for GeneralSFMFactor */ #include diff --git a/gtsam/slam/tests/testSimulated2DOriented.cpp b/gtsam/slam/tests/testSimulated2DOriented.cpp index 2404259ba..f0c0ee92c 100644 --- a/gtsam/slam/tests/testSimulated2DOriented.cpp +++ b/gtsam/slam/tests/testSimulated2DOriented.cpp @@ -9,12 +9,11 @@ * -------------------------------------------------------------------------- */ -/* - * testSimulated2DOriented.cpp - * - * Created on: Jun 10, 2010 - * Author: nikai - * Description: unit tests for simulated2DOriented +/** + * @file testSimulated2DOriented.cpp + * @date Jun 10, 2010 + * @author nikai + * @brief unit tests for simulated2DOriented */ #include diff --git a/gtsam/slam/visualSLAM.cpp b/gtsam/slam/visualSLAM.cpp index 5368dab93..23244f5f9 100644 --- a/gtsam/slam/visualSLAM.cpp +++ b/gtsam/slam/visualSLAM.cpp @@ -9,11 +9,10 @@ * -------------------------------------------------------------------------- */ -/* - * visualSLAM.cpp - * - * Created on: Jan 14, 2010 - * Author: richard +/** + * @file visualSLAM.cpp + * @date Jan 14, 2010 + * @author richard */ #include diff --git a/tests/testGaussianJunctionTree.cpp b/tests/testGaussianJunctionTree.cpp index 8c62dee7c..2e7e98a2e 100644 --- a/tests/testGaussianJunctionTree.cpp +++ b/tests/testGaussianJunctionTree.cpp @@ -9,12 +9,10 @@ * -------------------------------------------------------------------------- */ -/* - * testGaussianJunctionTree.cpp - * - * Created on: Jul 8, 2010 - * Author: nikai - * Description: +/** + * @file testGaussianJunctionTree.cpp + * @date Jul 8, 2010 + * @author nikai */ #include diff --git a/tests/testGraph.cpp b/tests/testGraph.cpp index d32428039..1bd46f12f 100644 --- a/tests/testGraph.cpp +++ b/tests/testGraph.cpp @@ -9,12 +9,11 @@ * -------------------------------------------------------------------------- */ -/* - * testGraph.cpp - * - * Created on: Jan 12, 2010 - * Author: nikai - * Description: unit test for graph-inl.h +/** + * @file testGraph.cpp + * @date Jan 12, 2010 + * @author nikai + * @brief unit test for graph-inl.h */ #include diff --git a/wrap/Argument.cpp b/wrap/Argument.cpp index e44b3033c..63751064c 100644 --- a/wrap/Argument.cpp +++ b/wrap/Argument.cpp @@ -10,8 +10,8 @@ * -------------------------------------------------------------------------- */ /** - * file: Argument.ccp - * Author: Frank Dellaert + * @file Argument.ccp + * @author Frank Dellaert **/ #include diff --git a/wrap/Argument.h b/wrap/Argument.h index 73c3ca12f..bf4a5a9a7 100644 --- a/wrap/Argument.h +++ b/wrap/Argument.h @@ -10,9 +10,9 @@ * -------------------------------------------------------------------------- */ /** - * file: Argument.h - * brief: arguments to constructors and methods - * Author: Frank Dellaert + * @file Argument.h + * @brief arguments to constructors and methods + * @author Frank Dellaert **/ #pragma once diff --git a/wrap/Class.cpp b/wrap/Class.cpp index de1620733..d84dfc146 100644 --- a/wrap/Class.cpp +++ b/wrap/Class.cpp @@ -10,8 +10,8 @@ * -------------------------------------------------------------------------- */ /** - * file: Class.ccp - * Author: Frank Dellaert + * @file Class.ccp + * @author Frank Dellaert **/ #include diff --git a/wrap/Class.h b/wrap/Class.h index f00812b95..dd91e99ab 100644 --- a/wrap/Class.h +++ b/wrap/Class.h @@ -10,9 +10,9 @@ * -------------------------------------------------------------------------- */ /** - * file: Class.h - * brief: describe the C++ class that is being wrapped - * Author: Frank Dellaert + * @file Class.h + * @brief describe the C++ class that is being wrapped + * @author Frank Dellaert **/ #pragma once diff --git a/wrap/Constructor.cpp b/wrap/Constructor.cpp index d26e16a07..9caf4793f 100644 --- a/wrap/Constructor.cpp +++ b/wrap/Constructor.cpp @@ -10,8 +10,8 @@ * -------------------------------------------------------------------------- */ /** - * file: Constructor.ccp - * Author: Frank Dellaert + * @file Constructor.ccp + * @author Frank Dellaert **/ #include diff --git a/wrap/Constructor.h b/wrap/Constructor.h index 0a15c06d1..d88cc64da 100644 --- a/wrap/Constructor.h +++ b/wrap/Constructor.h @@ -10,9 +10,9 @@ * -------------------------------------------------------------------------- */ /** - * file: Constructor.h - * brief: class describing a constructor + code generation - * Author: Frank Dellaert + * @file Constructor.h + * @brief class describing a constructor + code generation + * @author Frank Dellaert **/ #pragma once diff --git a/wrap/Method.cpp b/wrap/Method.cpp index cec6391bb..b66dc6032 100644 --- a/wrap/Method.cpp +++ b/wrap/Method.cpp @@ -10,8 +10,8 @@ * -------------------------------------------------------------------------- */ /** - * file: Method.ccp - * Author: Frank Dellaert + * @file Method.ccp + * @author Frank Dellaert **/ #include diff --git a/wrap/Method.h b/wrap/Method.h index 8666f74ac..4d8cc0d00 100644 --- a/wrap/Method.h +++ b/wrap/Method.h @@ -10,9 +10,9 @@ * -------------------------------------------------------------------------- */ /** - * file: Method.h - * brief: describes and generates code for methods - * Author: Frank Dellaert + * @file Method.h + * @brief describes and generates code for methods + * @author Frank Dellaert **/ #pragma once @@ -22,7 +22,7 @@ #include "Argument.h" -// Method class +/// Method class struct Method { bool is_const; ArgumentList args; diff --git a/wrap/Module.cpp b/wrap/Module.cpp index 82977e336..d7a7709f0 100644 --- a/wrap/Module.cpp +++ b/wrap/Module.cpp @@ -10,8 +10,8 @@ * -------------------------------------------------------------------------- */ /** - * file: Module.ccp - * Author: Frank Dellaert + * @file Module.ccp + * @author Frank Dellaert **/ #include diff --git a/wrap/Module.h b/wrap/Module.h index 5ee1248ca..54c148bb0 100644 --- a/wrap/Module.h +++ b/wrap/Module.h @@ -10,9 +10,9 @@ * -------------------------------------------------------------------------- */ /** - * file: Module.h - * brief: describes module to be wrapped - * Author: Frank Dellaert + * @file Module.h + * @brief describes module to be wrapped + * @author Frank Dellaert **/ #pragma once diff --git a/wrap/tests/testSpirit.cpp b/wrap/tests/testSpirit.cpp index 120e5561f..3f68952f3 100644 --- a/wrap/tests/testSpirit.cpp +++ b/wrap/tests/testSpirit.cpp @@ -10,8 +10,9 @@ * -------------------------------------------------------------------------- */ /** - * Unit test for Boost's awesome Spirit parser - * Author: Frank Dellaert + * @file testSpirit.cpp + * @brief Unit test for Boost's awesome Spirit parser + * @author Frank Dellaert **/ #include diff --git a/wrap/tests/testWrap.cpp b/wrap/tests/testWrap.cpp index 2e664c6c3..323959104 100644 --- a/wrap/tests/testWrap.cpp +++ b/wrap/tests/testWrap.cpp @@ -10,8 +10,9 @@ * -------------------------------------------------------------------------- */ /** - * Unit test for wrap.c - * Author: Frank Dellaert + * @file testWrap.cpp + * @brief Unit test for wrap.c + * @author Frank Dellaert **/ #include diff --git a/wrap/utilities.cpp b/wrap/utilities.cpp index f7376390f..72833f79a 100644 --- a/wrap/utilities.cpp +++ b/wrap/utilities.cpp @@ -10,8 +10,8 @@ * -------------------------------------------------------------------------- */ /** - * file: utilities.ccp - * Author: Frank Dellaert + * @file utilities.ccp + * @author Frank Dellaert **/ #include diff --git a/wrap/utilities.h b/wrap/utilities.h index e75c44025..d3ab3e197 100644 --- a/wrap/utilities.h +++ b/wrap/utilities.h @@ -10,8 +10,8 @@ * -------------------------------------------------------------------------- */ /** - * file: utilities.ccp - * Author: Frank Dellaert + * @file utilities.ccp + * @author Frank Dellaert **/ #pragma once diff --git a/wrap/wrap.cpp b/wrap/wrap.cpp index 1a52da6bd..c7fc71722 100644 --- a/wrap/wrap.cpp +++ b/wrap/wrap.cpp @@ -10,9 +10,9 @@ * -------------------------------------------------------------------------- */ /** - * file: wrap.ccp - * brief: wraps functions - * Author: Frank Dellaert + * @file wrap.ccp + * @brief wraps functions + * @author Frank Dellaert **/ #include