updated documentation

Commands/Autonomous/Autonomous.cpp

@@ -8,6 +8,7 @@
 #include "AutoDrive.h"
 #include "Turn.h"
 #include "../Collector/RollIn.h"
+#include "../Collector/RollOut.h"
 #include "CollectTote.h"
 #include "ReleaseTote.h"
 Autonomous::Autonomous(int seq) {
@@ -24,11 +25,10 @@ Autonomous::Autonomous(int seq) {
       AddSequential(new Turn(SmartDashboard::GetNumber("TurnAmount")));
       break;
     case 2:
-      // Collect a tote with BinElevator, turn, drive to Auto Zone (TM)
+      //Collect a bin upright into the robot upright, turn, drive to Auto Zone (TM),turn
+      AddSequential(new RollIn(1.0));
       AddSequential(new Turn(SmartDashboard::GetNumber("TurnAmount")));
-      AddSequential(new BinRaise(1.2));
       AddSequential(new AutoDrive(SmartDashboard::GetNumber("Auto Zone Distance"), 0.0, -0.75));
-      AddSequential(new BinLower(1.0));
       AddSequential(new Turn(SmartDashboard::GetNumber("TurnAmount")));
       break;
     case 3:

Commands/BinElevator/BinCloseArms.h

@@ -5,9 +5,7 @@
 #include "WPILib.h"
 
 /**
- * @brief Closes BinElevatorArms (unused)
- *
- * Sets the solenoid to close the arms of the BinElevator
+ * @brief Closes BinElevatorArms
  */
 class BinCloseArms: public Command {
  public:

Commands/BinElevator/BinOpenArms.h

@@ -5,7 +5,7 @@
 #include "WPILib.h"
 
 /**
- * @brief Opens bin arms (unused)
+ * @brief Opens bin arms
  */
 class BinOpenArms: public Command {
  public:

Commands/Elevator/CloseArm.h

@@ -5,7 +5,7 @@
 #include "WPILib.h"
 
 /**
- * @brief Opens bin arms (unused)
+ * @brief Closes bin retaining arm
  */
 class CloseArm: public Command {
  public:
@@ -24,7 +24,7 @@ class CloseArm: public Command {
    */
   void Initialize();
   /**
-   * @brief Sets the solenoid to open the arms
+   * @brief Sets the solenoid to close the arm
    */
   void Execute();
   /**

Commands/Elevator/Lower.h

@@ -10,13 +10,15 @@
 class Lower: public Command {
  private:
   bool softLimits; //<! Enables/Disables hall effect sensors
-  double speed;
+  double speed; //<! speed to lower the elevator
  public:
   /**
    * @brief Constructs Lower
    *
    * @param timeout Timeout in seconds (default: 3.0)
+   *
    * @param useSoftLimits Enables/Disables soft limits via hall effect sensors (default: true)
+   *
    * @param liftSpeed Speed at which to lower the lift
    */
   Lower(double timeout = 3.0, bool useSoftLimits = true, double liftSpeed=0);
@@ -31,7 +33,7 @@ class Lower: public Command {
   /**
    * @brief Checks if the command is finished
    *
-   * @return True if the timeout was reached or if the bottom elevator sensor was triggered
+   * @return True if the timeout was reached
    */
   bool IsFinished();
   /**

Commands/Elevator/OpenArm.h

@@ -5,7 +5,7 @@
 #include "WPILib.h"
 
 /**
- * @brief Opens bin arms (unused)
+ * @brief Opens bin retaining arm
  */
 class OpenArm: public Command {
  public:
@@ -24,7 +24,7 @@ class OpenArm: public Command {
    */
   void Initialize();
   /**
-   * @brief Sets the solenoid to open the arms
+   * @brief Sets the solenoid to open the arm
    */
   void Execute();
   /**

Commands/Elevator/Raise.h

@@ -9,8 +9,8 @@
  */
 class Raise: public Command {
  private:
-  bool softLimits;
-  double speed;
+  bool softLimits; //<!Enabled/Disables soft limits
+  double speed; //<! speed to lower the elevator
  public:
   /**
    * @brief Constructs Raise
@@ -19,7 +19,7 @@ class Raise: public Command {
    *
    * @param useSoftLimits Enables/Disables soft limits via hall effect sensors (default: true)
    *
-   * @param speed Speed at which to raise the elevator
+   * @param liftSpeed Speed at which to raise the elevator
    */
   Raise(double timeout = 3.5, bool useSoftLimits = true, double liftSpeed=0);
   /**
@@ -33,7 +33,7 @@ class Raise: public Command {
   /**
    * @brief Checks if the command is finished
    *
-   * @return True if the timeout was reached or if the top elevator was triggered or if the middle elevator is triggered
+   * @return True if the timeout was reached
    */
   bool IsFinished();
   /**

Commands/Pneumatics/DisableCompressor.h

@@ -5,7 +5,7 @@
 #include "WPILib.h"
 
 /**
- * @brief DisableCompressors the elevator until a timeout is reached
+ * @brief disable the compressor regardless of current psi
  */
 class DisableCompressor: public Command {
  private:
@@ -23,17 +23,17 @@ class DisableCompressor: public Command {
    */
   void Initialize();
   /**
-   * @brief DisableCompressors the elevator at 1.0 power
+   * @brief DisableCompressors sets the compressor to disabled
    */
   void Execute();
   /**
    * @brief Checks if the command is finished
    *
-   * @return True if the timeout was reached or if the top elevator was triggered or if the middle elevator is triggered
+   * @return True if the timeout was reached
    */
   bool IsFinished();
   /**
-   * @brief Sets the elevator to stop
+   * @brief required for command
    */
   void End();
   /**

Commands/Pneumatics/EnableCompressor.h

@@ -5,7 +5,7 @@
 #include "WPILib.h"
 
 /**
- * @brief EnableCompressors the elevator until a timeout is reached
+ * @brief allows the compressor to run if the system is within the psi threshold
  */
 class EnableCompressor: public Command {
  private:
@@ -23,17 +23,17 @@ class EnableCompressor: public Command {
    */
   void Initialize();
   /**
-   * @brief EnableCompressors the elevator at 1.0 power
+   * @brief EnableCompressors sets the compressor to enabled
    */
   void Execute();
   /**
    * @brief Checks if the command is finished
    *
-   * @return True if the timeout was reached or if the top elevator was triggered or if the middle elevator is triggered
+   * @return True if the timeout was reached
    */
   bool IsFinished();
   /**
-   * @brief Sets the elevator to stop
+   * @brief required for the command
    */
   void End();
   /**

Doxyfile

@@ -28,7 +28,7 @@ DOXYFILE_ENCODING      = UTF-8
 # identify the project. Note that if you do not use Doxywizard you need
 # to put quotes around the project name if it contains spaces.
 
-PROJECT_NAME           = "Dent"
+PROJECT_NAME           = "Arthur"
 
 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
 # This could be handy for archiving the generated documentation or
@@ -40,7 +40,7 @@ PROJECT_NUMBER         =
 # for a project that appears at the top of each page and should give viewer
 # a quick idea about the purpose of the project. Keep the description short.
 
-PROJECT_BRIEF          = "The Hitchhikers 2015 Robot"
+PROJECT_BRIEF          = "The Hitchhikers 2015 Off-season Robot"
 
 # With the PROJECT_LOGO tag one can specify an logo or icon that is
 # included in the documentation. The maximum height of the logo should not

mainpage.dox

@@ -1,7 +1,7 @@
 /**
-* @mainpage Dent
+* @mainpage Arthur
 * 
-* The Hitchhikers Team 2015 robot, Dent. Features an elevator, bin elevator, and mecanum drive
+* The Hitchhikers Team 2015 off-season robot, Arthur. Features an elevator, pneumatic collector wheels, and arcade drive
 * @section Subsystems
 *   -# @ref Drivetrain
 *   -# @ref BinElevator
@@ -20,6 +20,10 @@
 *   -# @ref BinOut
 *   -# @ref RollIn
 *   -# @ref RollOut
+*   -# @ref EnableCompressor
+*   -# @ref DisableCompressor
+*   -# @ref OpenArm
+*   -# @ref CloseArm
 *   -# @ref Drive
 *   -# @ref Lower
 *   -# @ref Raise