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

[commands] CommandGenericHID POV methods: Fix docs (NFC) (#4760)

Browse Source
This commit is contained in:
Ryan Blue
2022-12-05 16:46:46 -05:00
committed by GitHub
parent 6789869663
commit eab0d929e6
2 changed files with 18 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -72,7 +72,7 @@ class CommandGenericHID : public frc::GenericHID {
* @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 0-degree angle of a POV on the
* HID.
*/
Trigger POVUp(frc::EventLoop* loop = CommandScheduler::GetInstance()
@@ -85,7 +85,7 @@ class CommandGenericHID : public frc::GenericHID {
* @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 45-degree angle of a POV on the
* HID.
*/
Trigger POVUpRight(frc::EventLoop* loop = CommandScheduler::GetInstance()
@@ -122,8 +122,8 @@ class CommandGenericHID : public frc::GenericHID {
* @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
* HID.
* @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;
@@ -135,8 +135,8 @@ class CommandGenericHID : public frc::GenericHID {
* @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
* HID.
* @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;
@@ -148,8 +148,8 @@ class CommandGenericHID : public frc::GenericHID {
* @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
* HID.
* @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;
@@ -161,20 +161,20 @@ class CommandGenericHID : public frc::GenericHID {
* @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
* HID.
* @return a Trigger instance based around the 315-degree angle of a POV on
* the HID.
*/
Trigger POVUpLeft(frc::EventLoop* loop = CommandScheduler::GetInstance()
.GetDefaultButtonLoop()) const;
/**
* Constructs a Trigger instance based around the center (not pressed) of the
* default (index 0) POV on the HID.
* Constructs a Trigger instance based around the center (not pressed)
* position 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 center position of a POV on the
* HID.
*/
Trigger POVCenter(frc::EventLoop* loop = CommandScheduler::GetInstance()