Team2890/allwpilib
4
0
Fork 0
mirror of https://github.com/wpilibsuite/allwpilib synced 2026-06-21 01:01:43 +00:00
Code Issues Packages Projects Releases Wiki Activity

Spelling and grammar cleanups (#4849)

Browse Source
This commit is contained in:
Sriman Achanta
2022-12-26 14:32:13 -05:00
committed by GitHub
parent 176fddeb4c
commit 92149efa11
110 changed files with 317 additions and 319 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
wpilibNewCommands/src/main/native/include/frc2/command/Command.h
View File

@@ -238,7 +238,7 @@ safe) semantics.
* Decorates this command to only run if this condition is not met. If the
* command is already running and the condition changes to true, the command
* will not stop running. The requirements of this command will be kept for
* the new conditonal command.
* the new conditional command.
*
* @param condition the condition that will prevent the command from running
* @return the decorated command

2
wpilibNewCommands/src/main/native/include/frc2/command/CommandPtr.h
View File

@@ -163,7 +163,7 @@ class CommandPtr final {
* Decorates this command to only run if this condition is not met. If the
* command is already running and the condition changes to true, the command
* will not stop running. The requirements of this command will be kept for
* the new conditonal command.
* the new conditional command.
*
* @param condition the condition that will prevent the command from running
* @return the decorated command

8
wpilibNewCommands/src/main/native/include/frc2/command/MecanumControllerCommand.h
View File

@@ -268,7 +268,7 @@ class MecanumControllerCommand
*
* <p>Note: The controllers will *not* set the outputVolts to zero upon
* completion of the path - this is left to the user, since it is not
* appropriate for paths with non-stationary end-states.
* appropriate for paths with nonstationary end-states.
*
* @param trajectory The trajectory to follow.
* @param pose A function that supplies the robot pose - use one
@@ -306,7 +306,7 @@ class MecanumControllerCommand
*
* <p>Note: The controllers will *not* set the outputVolts to zero upon
* completion of the path - this is left to the user, since it is not
* appropriate for paths with non-stationary end-states.
* appropriate for paths with nonstationary end-states.
*
* <p>Note 2: The final rotation of the robot will be set to the rotation of
* the final pose in the trajectory. The robot will not follow the rotations
@@ -346,7 +346,7 @@ class MecanumControllerCommand
*
* <p>Note: The controllers will *not* set the outputVolts to zero upon
* completion of the path - this is left to the user, since it is not
* appropriate for paths with non-stationary end-states.
* appropriate for paths with nonstationary end-states.
*
* @param trajectory The trajectory to follow.
* @param pose A function that supplies the robot pose - use one
@@ -384,7 +384,7 @@ class MecanumControllerCommand
*
* <p>Note: The controllers will *not* set the outputVolts to zero upon
* completion of the path - this is left to the user, since it is not
* appropriate for paths with non-stationary end-states.
* appropriate for paths with nonstationary end-states.
*
* <p>Note2: The final rotation of the robot will be set to the rotation of
* the final pose in the trajectory. The robot will not follow the rotations

2
wpilibNewCommands/src/main/native/include/frc2/command/ParallelCommandGroup.h
View File

@@ -59,7 +59,7 @@ class ParallelCommandGroup
ParallelCommandGroup(ParallelCommandGroup&& other) = default;
// No copy constructors for commandgroups
// No copy constructors for command groups
ParallelCommandGroup(const ParallelCommandGroup&) = delete;
// Prevent template expansion from emulating copy ctor

2
wpilibNewCommands/src/main/native/include/frc2/command/SelectCommand.h
View File

@@ -38,7 +38,7 @@ template <typename Key>
class SelectCommand : public CommandHelper<CommandBase, SelectCommand<Key>> {
public:
/**
* Creates a new selectcommand.
* Creates a new SelectCommand.
*
* @param commands the map of commands to choose from
* @param selector the selector to determine which command to run

2
wpilibNewCommands/src/main/native/include/frc2/command/button/Button.h
View File

@@ -243,7 +243,7 @@ class Button : public Trigger {
/**
* Binds a command to start when the button is pressed, and be canceled when
* it is pessed again. Transfers command ownership to the button scheduler,
* it is pressed again. Transfers command ownership to the button scheduler,
* so the user does not have to worry about lifespan - rvalue refs will be
* *moved*, lvalue refs will be *copied.*
*

32
wpilibNewCommands/src/main/native/include/frc2/command/button/CommandGenericHID.h
View File

@@ -66,49 +66,49 @@ class CommandGenericHID : public frc::GenericHID {
CommandScheduler::GetInstance().GetDefaultButtonLoop()) const;
/**
* Constructs a Trigger instance based around the 0-degree angle (up) of the
* Constructs a Trigger instance based around the 0 degree angle (up) of the
* default (index 0) POV on the HID.
*
* @param loop the event loop instance to attach the event to. Defaults to
* {@link CommandScheduler::GetDefaultButtonLoop() the default command
* scheduler button loop}.
* @return a Trigger instance based around the 0-degree angle of a POV on the
* @return a Trigger instance based around the 0 degree angle of a POV on the
* HID.
*/
Trigger POVUp(frc::EventLoop* loop = CommandScheduler::GetInstance()
.GetDefaultButtonLoop()) const;
/**
* Constructs a Trigger instance based around the 45-degree angle (right up)
* Constructs a Trigger instance based around the 45 degree angle (right up)
* of the default (index 0) POV on the HID.
*
* @param loop the event loop instance to attach the event to. Defaults to
* {@link CommandScheduler::GetDefaultButtonLoop() the default command
* scheduler button loop}.
* @return a Trigger instance based around the 45-degree angle of a POV on the
* @return a Trigger instance based around the 45 degree angle of a POV on the
* HID.
*/
Trigger POVUpRight(frc::EventLoop* loop = CommandScheduler::GetInstance()
.GetDefaultButtonLoop()) const;
/**
* Constructs a Trigger instance based around the 90-degree angle (right) of
* Constructs a Trigger instance based around the 90 degree angle (right) of
* the default (index 0) POV on the HID.
*
* @param loop the event loop instance to attach the event to. Defaults to
* {@link CommandScheduler::GetDefaultButtonLoop() the default command
* scheduler button loop}.
* @return a Trigger instance based around the 90-degree angle of a POV on the
* @return a Trigger instance based around the 90 degree angle of a POV on the
* HID.
*/
Trigger POVRight(frc::EventLoop* loop = CommandScheduler::GetInstance()
.GetDefaultButtonLoop()) const;
/**
* Constructs a Trigger instance based around the 135-degree angle (right
* Constructs a Trigger instance based around the 135 degree angle (right
* down) of the default (index 0) POV on the HID.
*
* @return a Trigger instance based around the 135-degree angle of a POV on
* @return a Trigger instance based around the 135 degree angle of a POV on
* the HID.
*/
Trigger POVDownRight(
@@ -116,52 +116,52 @@ class CommandGenericHID : public frc::GenericHID {
CommandScheduler::GetInstance().GetDefaultButtonLoop()) const;
/**
* Constructs a Trigger instance based around the 180-degree angle (down) of
* Constructs a Trigger instance based around the 180 degree angle (down) of
* the default (index 0) POV on the HID.
*
* @param loop the event loop instance to attach the event to. Defaults to
* {@link CommandScheduler::GetDefaultButtonLoop() the default command
* scheduler button loop}.
* @return a Trigger instance based around the 180-degree angle of a POV on
* @return a Trigger instance based around the 180 degree angle of a POV on
* the HID.
*/
Trigger POVDown(frc::EventLoop* loop = CommandScheduler::GetInstance()
.GetDefaultButtonLoop()) const;
/**
* Constructs a Trigger instance based around the 225-degree angle (down left)
* Constructs a Trigger instance based around the 225 degree angle (down left)
* of the default (index 0) POV on the HID.
*
* @param loop the event loop instance to attach the event to. Defaults to
* {@link CommandScheduler::GetDefaultButtonLoop() the default command
* scheduler button loop}.
* @return a Trigger instance based around the 225-degree angle of a POV on
* @return a Trigger instance based around the 225 degree angle of a POV on
* the HID.
*/
Trigger POVDownLeft(frc::EventLoop* loop = CommandScheduler::GetInstance()
.GetDefaultButtonLoop()) const;
/**
* Constructs a Trigger instance based around the 270-degree angle (left) of
* Constructs a Trigger instance based around the 270 degree angle (left) of
* the default (index 0) POV on the HID.
*
* @param loop the event loop instance to attach the event to. Defaults to
* {@link CommandScheduler::GetDefaultButtonLoop() the default command
* scheduler button loop}.
* @return a Trigger instance based around the 270-degree angle of a POV on
* @return a Trigger instance based around the 270 degree angle of a POV on
* the HID.
*/
Trigger POVLeft(frc::EventLoop* loop = CommandScheduler::GetInstance()
.GetDefaultButtonLoop()) const;
/**
* Constructs a Trigger instance based around the 315-degree angle (left up)
* Constructs a Trigger instance based around the 315 degree angle (left up)
* of the default (index 0) POV on the HID.
*
* @param loop the event loop instance to attach the event to. Defaults to
* {@link CommandScheduler::GetDefaultButtonLoop() the default command
* scheduler button loop}.
* @return a Trigger instance based around the 315-degree angle of a POV on
* @return a Trigger instance based around the 315 degree angle of a POV on
* the HID.
*/
Trigger POVUpLeft(frc::EventLoop* loop = CommandScheduler::GetInstance()

2
wpilibNewCommands/src/main/native/include/frc2/command/button/JoystickButton.h
View File

@@ -23,7 +23,7 @@ class JoystickButton : public Button {
* Creates a JoystickButton that commands can be bound to.
*
* @param joystick The joystick on which the button is located.
* @param buttonNumber The number of the button on the joystic.
* @param buttonNumber The number of the button on the joystick.
*/
WPI_IGNORE_DEPRECATED
explicit JoystickButton(frc::GenericHID* joystick, int buttonNumber)