mirror of
https://github.com/team2059/Dent
synced 2024-12-18 20:52:29 -05:00
Documentation, formatting fixes
This commit is contained in:
parent
3de6e0023c
commit
d8f39bef0a
@ -23,9 +23,9 @@ class AutoDrive: public Command{
|
||||
*
|
||||
* @param duration Timeout in seconds
|
||||
* @param xtmp Joystick x value (default: 0.0)
|
||||
* @param ytmp Joystick y value (default: 0.75)
|
||||
* @param ytmp Joystick y value (default: -0.75)
|
||||
* @param ztmp Joystick z value (default: 0.0)
|
||||
* @param useGyro Use the gyro when driving
|
||||
* @param useGyro Use the gyro when driving (default: true)
|
||||
*/
|
||||
AutoDrive(double duration, double xtmp = 0.0, double ytmp = -0.75, double ztmp = 0.0, bool useGyro = true);
|
||||
/**
|
||||
|
@ -37,7 +37,7 @@ class Autonomous: public CommandGroup{
|
||||
/**
|
||||
* @brief Constructs Autonomous
|
||||
*
|
||||
* @param seq The sequence to run
|
||||
* @param seq The sequence to run (default: 0)
|
||||
*/
|
||||
Autonomous(int seq = 0);
|
||||
};
|
||||
|
@ -12,7 +12,6 @@
|
||||
* Turns the robot until a timeout is reached
|
||||
*/
|
||||
class Turn: public Command{
|
||||
private:
|
||||
public:
|
||||
/**
|
||||
* @brief Constructs Turn
|
||||
|
@ -14,7 +14,7 @@ class BinCloseArms: public Command{
|
||||
/**
|
||||
* @brief Constructs BinCloseArms
|
||||
*
|
||||
* @param timeout The timeout
|
||||
* @param timeout Timeout in seconds (default: 0.5)
|
||||
*/
|
||||
BinCloseArms(double timeout = 0.5);
|
||||
/**
|
||||
|
@ -12,7 +12,7 @@ class BinLower: public Command{
|
||||
/**
|
||||
* @brief Constructs BinLower
|
||||
*
|
||||
* @param timeout The timeout
|
||||
* @param timeout Timeout in seconds
|
||||
*/
|
||||
BinLower(float timeout);
|
||||
/**
|
||||
|
@ -12,7 +12,7 @@ class BinOpenArms: public Command{
|
||||
/**
|
||||
* @brief Constructs BinOpenArms
|
||||
*
|
||||
* @param timeout The timeout
|
||||
* @param timeout Timeout in seconds
|
||||
*/
|
||||
BinOpenArms(double timeout);
|
||||
/**
|
||||
|
@ -14,7 +14,7 @@ class RollOut: public Command{
|
||||
/**
|
||||
* @brief Constructs RollOut
|
||||
*
|
||||
* @param timeout The timeout
|
||||
* @param timeout Timeout in seconds (default: 2.0)
|
||||
*/
|
||||
RollOut(double timeout = 2.0);
|
||||
/**
|
||||
|
@ -3,7 +3,6 @@
|
||||
|
||||
#include "Commands/Command.h"
|
||||
#include "../../DentRobot.h"
|
||||
#include "../../DentRobot.h"
|
||||
#include "WPILib.h"
|
||||
|
||||
/**
|
||||
|
@ -11,6 +11,8 @@ class Lower: public Command{
|
||||
public:
|
||||
/**
|
||||
* @brief Constructs Lower
|
||||
*
|
||||
* @param timeout Timeout in seconds (default: 3.0)
|
||||
*/
|
||||
Lower(double timeout = 3.0);
|
||||
/**
|
||||
|
@ -11,6 +11,8 @@ class Raise: public Command{
|
||||
public:
|
||||
/**
|
||||
* @brief Constructs Raise
|
||||
*
|
||||
* @param timeout Timeout in seconds (default: 3.5)
|
||||
*/
|
||||
Raise(double timeout = 3.5);
|
||||
/**
|
||||
|
11
OI.h
11
OI.h
@ -9,16 +9,17 @@
|
||||
*/
|
||||
class OI{
|
||||
private:
|
||||
Joystick *leftStick, *rightStick;
|
||||
Joystick *leftStick, //<! Left joystick
|
||||
*rightStick; //<! Right joystick
|
||||
public:
|
||||
/**
|
||||
* @brief Constructs OI
|
||||
*/
|
||||
OI();
|
||||
Command *raise, //!< Raise command
|
||||
*lower, //!< Lower command
|
||||
*binLower, //!< BinLower command
|
||||
*binRaise; //!< BinRaise command
|
||||
Command *raise, //<! Raise command
|
||||
*lower, //<! Lower command
|
||||
*binLower, //<! BinLower command
|
||||
*binRaise; //<! BinRaise command
|
||||
/**
|
||||
* @brief Returns the right joystick
|
||||
*
|
||||
|
@ -24,9 +24,7 @@ class BinElevator{
|
||||
/**
|
||||
* @brief Runs the bin elevator
|
||||
*
|
||||
* @param power The power to run the bin elevator
|
||||
*
|
||||
* Ranges from -1.0 to 1.0
|
||||
* @param power The power to run the bin elevator (-1.0 to 1.0)
|
||||
*/
|
||||
void Run(double power);
|
||||
/**
|
||||
|
@ -33,25 +33,25 @@ class Collector: public Subsystem{
|
||||
/**
|
||||
* @brief Moves the collectors
|
||||
*
|
||||
* @param power The speed to run the collectors
|
||||
* @param power The power to run the collectors
|
||||
*/
|
||||
void MoveRollers(double power);
|
||||
/**
|
||||
* @brief Moves the left roller
|
||||
*
|
||||
* @param power The speed to run the left roller
|
||||
* @param power The power to run the left roller
|
||||
*/
|
||||
void MoveLeftRoller(double power);
|
||||
/**
|
||||
* @brief Moves the right roller
|
||||
*
|
||||
* @param power The speed to run the right roller
|
||||
* @param power The power to run the right roller
|
||||
*/
|
||||
void MoveRightRoller(double power);
|
||||
/**
|
||||
* @brief Moves the bottom rollers
|
||||
*
|
||||
* @param power The speed to run the bottom rollers
|
||||
* @param power The power to run the bottom rollers
|
||||
*/
|
||||
void MoveBottomRollers(double power);
|
||||
/**
|
||||
|
@ -39,7 +39,7 @@ class Drivetrain: public Subsystem{
|
||||
* @param y Joystick y value (-1.0 to 1.0)
|
||||
* @param z Joystick z value (-1.0 to 1.0)
|
||||
* @param sensitivity Sensitivity (0.0 to 1.0)
|
||||
* @param driveStraight Overrides z value to correct for motor lag
|
||||
* @param driveStraight Overrides z value to correct for motor lag (default: false)
|
||||
*/
|
||||
void DriveMecanum(double x, double y, double z, double sensitivity, bool driveStraight = false);
|
||||
/**
|
||||
|
@ -24,8 +24,6 @@
|
||||
* -# @ref Autonomous
|
||||
* -# @ref CollectTote
|
||||
* -# @ref ReleaseTote
|
||||
* -# @ref CheckDrive
|
||||
* -# @ref CheckRobot
|
||||
*
|
||||
* Note: Recycling containers are referred to bins throughout the project
|
||||
*/
|
||||
|
Loading…
Reference in New Issue
Block a user