more doxygen fixes

release/4.3a0
Chris Beall 2012-09-07 19:12:02 +00:00
parent 9e960b4589
commit 49a952d237
4 changed files with 15 additions and 10 deletions

View File

@ -50,10 +50,10 @@ namespace gtsam {
/** /**
* Constructor * Constructor
* @param z is the 2 dimensional location of point in image (the measurement) * @param measured is the 2 dimensional location of point in image (the measurement)
* @param model is the standard deviation of the measurements * @param model is the standard deviation of the measurements
* @param i is basically the frame number * @param cameraKey is the index of the camera
* @param j is the index of the landmark * @param landmarkKey is the index of the landmark
*/ */
GeneralSFMFactor(const Point2& measured, const SharedNoiseModel& model, Key cameraKey, Key landmarkKey) : GeneralSFMFactor(const Point2& measured, const SharedNoiseModel& model, Key cameraKey, Key landmarkKey) :
Base(model, cameraKey, landmarkKey), measured_(measured) {} Base(model, cameraKey, landmarkKey), measured_(measured) {}
@ -72,6 +72,7 @@ namespace gtsam {
/** /**
* print * print
* @param s optional string naming the factor * @param s optional string naming the factor
* @param keyFormatter optional formatter for printing out Symbols
*/ */
void print(const std::string& s = "SFMFactor", const KeyFormatter& keyFormatter = DefaultKeyFormatter) const { void print(const std::string& s = "SFMFactor", const KeyFormatter& keyFormatter = DefaultKeyFormatter) const {
Base::print(s, keyFormatter); Base::print(s, keyFormatter);
@ -140,10 +141,11 @@ namespace gtsam {
/** /**
* Constructor * Constructor
* @param z is the 2 dimensional location of point in image (the measurement) * @param measured is the 2 dimensional location of point in image (the measurement)
* @param model is the standard deviation of the measurements * @param model is the standard deviation of the measurements
* @param i is basically the frame number * @param poseKey is the index of the camera
* @param j is the index of the landmark * @param landmarkKey is the index of the landmark
* @param calibKey is the index of the calibration
*/ */
GeneralSFMFactor2(const Point2& measured, const SharedNoiseModel& model, Key poseKey, Key landmarkKey, Key calibKey) : GeneralSFMFactor2(const Point2& measured, const SharedNoiseModel& model, Key poseKey, Key landmarkKey, Key calibKey) :
Base(model, poseKey, landmarkKey, calibKey), measured_(measured) {} Base(model, poseKey, landmarkKey, calibKey), measured_(measured) {}
@ -159,6 +161,7 @@ namespace gtsam {
/** /**
* print * print
* @param s optional string naming the factor * @param s optional string naming the factor
* @param keyFormatter optional formatter useful for printing Symbols
*/ */
void print(const std::string& s = "SFMFactor2", const KeyFormatter& keyFormatter = DefaultKeyFormatter) const { void print(const std::string& s = "SFMFactor2", const KeyFormatter& keyFormatter = DefaultKeyFormatter) const {
Base::print(s, keyFormatter); Base::print(s, keyFormatter);

View File

@ -56,10 +56,10 @@ namespace gtsam {
/** /**
* Constructor * Constructor
* TODO: Mark argument order standard (keys, measurement, parameters) * TODO: Mark argument order standard (keys, measurement, parameters)
* @param z is the 2 dimensional location of point in image (the measurement) * @param measured is the 2 dimensional location of point in image (the measurement)
* @param model is the standard deviation * @param model is the standard deviation
* @param j_pose is basically the frame number * @param poseKey is the index of the camera
* @param j_landmark is the index of the landmark * @param pointKey is the index of the landmark
* @param K shared pointer to the constant calibration * @param K shared pointer to the constant calibration
*/ */
GenericProjectionFactor(const Point2& measured, const SharedNoiseModel& model, GenericProjectionFactor(const Point2& measured, const SharedNoiseModel& model,
@ -78,6 +78,7 @@ namespace gtsam {
/** /**
* print * print
* @param s optional string naming the factor * @param s optional string naming the factor
* @param keyFormatter optional formatter useful for printing Symbols
*/ */
void print(const std::string& s = "", const KeyFormatter& keyFormatter = DefaultKeyFormatter) const { void print(const std::string& s = "", const KeyFormatter& keyFormatter = DefaultKeyFormatter) const {
std::cout << s << "GenericProjectionFactor, z = "; std::cout << s << "GenericProjectionFactor, z = ";

View File

@ -70,6 +70,7 @@ public:
/** /**
* print * print
* @param s optional string naming the factor * @param s optional string naming the factor
* @param keyFormatter optional formatter useful for printing Symbols
*/ */
void print(const std::string& s = "", const KeyFormatter& keyFormatter = DefaultKeyFormatter) const { void print(const std::string& s = "", const KeyFormatter& keyFormatter = DefaultKeyFormatter) const {
Base::print(s, keyFormatter); Base::print(s, keyFormatter);

View File

@ -43,7 +43,7 @@ public:
* TODO: Mark argument order standard (keys, measurement, parameters) * TODO: Mark argument order standard (keys, measurement, parameters)
* @param measured is the 2 dimensional location of point in image (the measurement) * @param measured is the 2 dimensional location of point in image (the measurement)
* @param model is the standard deviation * @param model is the standard deviation
* @param poseKey is basically the frame number * @param poseKey is the index of the camera pose
* @param pointKey is the index of the landmark * @param pointKey is the index of the landmark
* @param invDepthKey is the index of inverse depth * @param invDepthKey is the index of inverse depth
* @param K shared pointer to the constant calibration * @param K shared pointer to the constant calibration