2
0
mirror of https://github.com/team2059/Dent synced 2024-12-18 20:52:29 -05:00

Fixed documentation errors

This commit is contained in:
Austen Adler 2015-03-09 10:07:54 -04:00
parent 123898882c
commit ecfa765560
8 changed files with 18 additions and 19 deletions

View File

@ -25,9 +25,9 @@ class Autonomous: public CommandGroup{
/** /**
* @brief Constructs Autonomous * @brief Constructs Autonomous
* *
* @param int The sequence to run * @param seq The sequence to run
*/ */
Autonomous(int); Autonomous(int seq=0);
}; };
#endif #endif
// vim: ts=2:sw=2:et // vim: ts=2:sw=2:et

View File

@ -17,9 +17,9 @@ class Turn: public Command{
/** /**
* @brief Constructs Turn * @brief Constructs Turn
* *
* @param double Timeout in seconds * @param timeout Timeout in seconds
*/ */
Turn(double); Turn(double timeout);
/** /**
* @brief Initializes the class * @brief Initializes the class
*/ */

View File

@ -11,11 +11,12 @@
*/ */
class BinCloseArms: public Command{ class BinCloseArms: public Command{
public: public:
BinCloseArms(double timeout = 0.5);
/** /**
* @brief Constructs BinCloseArms * @brief Constructs BinCloseArms
*
* @param timeout The timeout
*/ */
BinCloseArms(); BinCloseArms(double timeout = 0.5);
/** /**
* @brief Initializes the class * @brief Initializes the class
*/ */

View File

@ -9,14 +9,13 @@
*/ */
class BinLower: public Command{ class BinLower: public Command{
private: private:
float timeout; //<! The timeout
public: public:
/** /**
* @brief Constructs BinLower * @brief Constructs BinLower
* *
* @param float Timeout in seconds * @param float The timeout
*/ */
BinLower(float); BinLower(float timeout);
/** /**
* @brief Initializes the class * @brief Initializes the class
*/ */

View File

@ -12,9 +12,9 @@ class BinOpenArms: public Command{
/** /**
* @brief Constructs BinOpenArms * @brief Constructs BinOpenArms
* *
* @param double The timeout * @param timeout The timeout
*/ */
BinOpenArms(double); BinOpenArms(double timeout);
/** /**
* @brief Constructs BinOpenArms * @brief Constructs BinOpenArms
*/ */

View File

@ -9,15 +9,13 @@
*/ */
class BinRaise: public Command{ class BinRaise: public Command{
private: private:
float timeout; //<! The timeout
public: public:
BinRaise(double);
/** /**
* @brief Constructs BinRaise * @brief Constructs BinRaise
* *
* @param float Timeout in seconds * @param timeout Timeout in seconds
*/ */
BinRaise(float); BinRaise(double timeout);
/** /**
* @brief Initializes the class * @brief Initializes the class
*/ */

View File

@ -17,9 +17,9 @@ class RollIn: public Command{
/** /**
* @brief Constructs RollIn * @brief Constructs RollIn
* *
* @param double Timeout in seconds * @param double Speed to roll the collector
*/ */
RollIn(double); RollIn(double speed);
/** /**
* @brief Initializes the class * @brief Initializes the class
*/ */

View File

@ -11,11 +11,12 @@
*/ */
class RollOut: public Command{ class RollOut: public Command{
public: public:
RollOut(double timeout = 2.0);
/** /**
* @brief Constructs RollOut * @brief Constructs RollOut
*
* @param timeout The timeout
*/ */
RollOut(); RollOut(double timeout=2.0);
/** /**
* @brief Initializes the class * @brief Initializes the class
*/ */