Permalink
Browse files

Fixed Doxygen to correctly display repository name.

Added @brief tags to class descriptors in Noggin classes.
  • Loading branch information...
1 parent c5beae3 commit 20cd63faf86a26c8128161876c997a0a6ea28a75 Tucker Hermans committed Aug 17, 2009
Showing with 684 additions and 677 deletions.
  1. +666 −666 Doxyfile
  2. +1 −1 noggin/BallEKF.h
  3. +2 −2 noggin/EKF.h
  4. +1 −1 noggin/LocEKF.h
  5. +1 −2 noggin/LocSystem.h
  6. +6 −0 noggin/Noggin.h
  7. +6 −4 noggin/NogginStructs.h
  8. +1 −1 noggin/Observation.h
View
1,332 Doxyfile

Large diffs are not rendered by default.

Oops, something went wrong.
View
@@ -15,7 +15,7 @@
#include "NogginStructs.h"
/**
- * Class for tracking of ball position and velocity. Extends the abstract
+ * @brief Class for tracking of ball position and velocity. Extends the abstract
* EKF class.
*/
class BallEKF : public EKF<RangeBearingMeasurement, MotionModel,
View
@@ -35,8 +35,8 @@ static const int ZMP_NUM_DIMENSIONS = 2;
static const int ZMP_NUM_MEASUREMENTS = 2;
static const float DONT_PROCESS_KEY = -1337.0f;
/**
- * EKF - An abstract class which implements the computational components of
- * an Extended Kalman Filter.
+ * @brief An abstract class which implements the computational components of
+ * an Extended Kalman Filter.
*
* @date August 2008
* @author Tucker Hermans
View
@@ -17,7 +17,7 @@
#include "LocSystem.h"
/**
- * Class for tracking of loc position and velocity. Extends the abstract
+ * @brief Class for tracking of loc position and velocity. Extends the abstract
* EKF class.
*/
class LocEKF : public EKF<Observation,
View
@@ -1,6 +1,5 @@
/**
- * LocSystem.h - Header file for the simple abstract Loc System class
- * Defines an interface for a localization system. Current implementing classes
+ * @brief Defines an interface for a localization system. Current implementing classes
* are LocEKF and MCL
*
* @author Tucker Hermans
View
@@ -18,6 +18,12 @@
//#define LOG_LOCALIZATION
+/**
+ *
+ * @brief Class to control the main thread function of all reasoning and
+ * planning components of the robot.
+ */
+
class Noggin
{
public:
View
@@ -14,7 +14,9 @@
#include "NBMath.h"
using namespace NBMath;
-// Pose Estimate
+/**
+ * @brief Estimate of the robot's (x,y,heading) pose.
+ */
class PoseEst
{
public:
@@ -73,7 +75,7 @@ class PoseEst
};
/**
- * Class to hold the ball positin and velocity in the x and y directions
+ * @brief Class to hold the ball positin and velocity in the x and y directions
*/
class BallPose
{
@@ -109,7 +111,7 @@ class BallPose
};
/**
- * Stores field location information about a concrete point landmark
+ * @brief Stores field location information about a concrete point landmark
*/
class PointLandmark
{
@@ -126,7 +128,7 @@ class PointLandmark
};
/**
- * Stores field location information about a concrete line landmark
+ * @brief Stores field location information about a concrete line landmark
*/
class LineLandmark
{
View
@@ -20,7 +20,7 @@
#include "NogginStructs.h"
/**
- * Class to hold the informations associated with the observation of a landmark
+ * @brief Class to hold the informations associated with the observation of a landmark
*/
class Observation
{

0 comments on commit 20cd63f

Please sign in to comment.