Continued working on documentation

Commands/Autonomous/AutoDrive.h

@@ -13,7 +13,8 @@
  */
 class AutoDrive: public Command{
   private:
-    double x, y;
+    double x, //<! The x value of the simulated joystick value
+           y; //<! The y value of the simulated joystick value
   public:
     /**
      * @brief Constructs AutoDrive

Commands/Autonomous/Turn.h

@@ -13,7 +13,6 @@
  */
 class Turn: public Command{
   private:
-    int degrees;
   public:
     /**
      * @brief Constructs Turn

Commands/BinElevator/BinLower.h

@@ -9,7 +9,7 @@
  */
 class BinLower: public Command{
   private:
-    float timeout;
+    float timeout; //<! The timeout
   public:
     /**
      * @brief Constructs BinLower

Commands/BinElevator/BinRaise.h

@@ -9,7 +9,7 @@
  */
 class BinRaise: public Command{
   private:
-    float timeout;
+    float timeout; //<! The timeout
   public:
     /**
      * @brief Constructs BinRaise

Commands/Collector/RollIn.h

@@ -11,7 +11,7 @@
  */
 class RollIn: public Command{
   private:
-    double rawSpeed;
+    double rawSpeed; //<! Raw speed of the collector
   public:
     /**
      * @brief Constructs RollIn

Commands/Test/CheckDrive.h

@@ -11,7 +11,7 @@
  */
 class CheckDrive: public CommandGroup{
   private:
-    int motor;
+    int motor; //<! TODO
   public:
     /**
      * @brief TODO

DentRobot.h

@@ -8,24 +8,77 @@
 #include "Subsystems/Collector.h"
 #include "Subsystems/Pneumatics.h"
 #include "Commands/Autonomous/Autonomous.h"
+/**
+ * @brief The Hitchhikers 2015 robot, Dent
+ *
+ * Features a 4-motor collector, 4-motor mecanum drivetrain, two one-motor elevators
+ */
 class DentRobot: public IterativeRobot {
   private:
+    /**
+     * @brief The default driving command
+     */
     Command *driveCommand = NULL;
   public:
+    /**
+     * @brief Constructs DentRobot
+     */
     DentRobot();
+    /**
+     * @brief The 2-joystick OI
+     */
     static OI* oi;
+    /**
+     * @brief The 4-motor Collctor
+     */
     static Collector* collector;
+    /**
+     * @brief The 4-motor mechanum Drivetrain
+     */
     static Drivetrain* drivetrain;
+    /**
+     * @brief The main one-motor Elevator for lifting totes
+     */
     static Elevator* elevator;
+    /**
+     * @brief The back one-motor Elevator for lifting totes or bins
+     */
     static BinElevator* binElevator;
+    /**
+     * @brief The Pneumatics system (UNUSED)
+     */
     static Pneumatics* pneumatics;
+    /**
+     * @brief The Autonomous command
+     */
     static CommandGroup* aut;
+    /**
+     * @brief Initializes the robot
+     */
     void RobotInit();
+    /**
+     * @brief Periodically run when disabled
+     */
     void DisabledPeriodic();
+    /**
+     * @brief Initializes the autonomous period
+     */
     void AutonomousInit();
+    /**
+     * @brief Periodically run when enabled in autonomous
+     */
     void AutonomousPeriodic();
+    /**
+     * @brief Initializes the teleop period
+     */
     void TeleopInit();
+    /**
+     * @brief Periodically run when enabled in autonomous
+     */
     void TeleopPeriodic();
+    /**
+     * @brief Periodically run when enabled in test mode
+     */
     void TestPeriodic();
 };
 #endif

Subsystems/Collector.h

@@ -2,16 +2,46 @@
 #define COLLECTOR_H
 
 #include "WPILib.h"
+/**
+ * @brief Collects totes
+ * 
+ * Uses four motors, two on the sides, one on the bottom, and one on the ramp to collect and eject totes
+ */
 class Collector: public Subsystem
 {
   private:
-    CANTalon *collectorMotorLeft, *collectorMotorBottom, *collectorMotorRamp, *collectorMotorRight;
+    CANTalon *collectorMotorLeft,   //<! Left collector motor
+             *collectorMotorBottom, //<! Bottom collctor motor
+             *collectorMotorRamp,   //<! Ramp collctor motor
+             *collectorMotorRight;  //<! Right collector motor
+    /**
+     * @brief Analog input for sonar (UNUSED)
+     */
     AnalogInput *sonarAnalog;
+    /**
+     * @brief Digital output for sonar (UNUSED)
+     */
     DigitalOutput *sonarDigital;
   public:
+    /**
+     * @brief Constructs Collector
+     */
     Collector();
+    /**
+     * @brief No action
+     */
     void InitDefaultCommand();
+    /**
+     * @brief Moves the collectors
+     *
+     * @param double The speed to run the collectors
+     */
     void MoveRollers(double);
+    /**
+     * @brief Gets the distance of the sonar (UNUSED)
+     *
+     * @return The sonar distance
+     */
     double GetSonarDistance();
 };
 #endif