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/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)