[commands] Disambiguate ProxyCommand and DeferredCommand (#6324)

This commit is contained in:
DeltaDizzy
2024-04-28 00:41:04 -05:00
committed by GitHub
parent 39d33bfca6
commit 1e4a647918
8 changed files with 69 additions and 33 deletions

View File

@@ -50,12 +50,15 @@ class CommandPtr final {
CommandPtr Repeatedly() &&;
/**
* Decorates this command to run "by proxy" by wrapping it in a
* ProxyCommand. This is useful for "forking off" from command groups
* when the user does not wish to extend the command's requirements to the
* entire command group.
* Decorates this command to run "by proxy" by wrapping it in a ProxyCommand.
* Use this for "forking off" from command compositions when the user does not
* wish to extend the command's requirements to the entire command
* composition. ProxyCommand has unique implications and semantics, see <a
* href="https://docs.wpilib.org/en/stable/docs/software/commandbased/command-compositions.html#scheduling-other-commands">the
* WPILib docs</a> for a full explanation.
*
* @return the decorated command
* @see ProxyCommand
*/
[[nodiscard]]
CommandPtr AsProxy() &&;