From 73950b98573c3f2d526dfa2c7e1a5bd2648e85a5 Mon Sep 17 00:00:00 2001 From: Starlight220 <53231611+Starlight220@users.noreply.github.com> Date: Sun, 27 Sep 2020 10:08:53 +0300 Subject: [PATCH] [wpilibc] RobotBase::IsReal, IsSimulation: Add doxygen comments (#2735) --- wpilibc/src/main/native/include/frc/RobotBase.h | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/wpilibc/src/main/native/include/frc/RobotBase.h b/wpilibc/src/main/native/include/frc/RobotBase.h index 4139b03655..66d5637bd9 100644 --- a/wpilibc/src/main/native/include/frc/RobotBase.h +++ b/wpilibc/src/main/native/include/frc/RobotBase.h @@ -185,6 +185,11 @@ class RobotBase { virtual void EndCompetition() = 0; + /** + * Get if the robot is real. + * + * @return If the robot is running in the real world. + */ static constexpr bool IsReal() { #ifdef __FRC_ROBORIO__ return true; @@ -193,6 +198,11 @@ class RobotBase { #endif } + /** + * Get if the robot is a simulation. + * + * @return If the robot is running in simulation. + */ static constexpr bool IsSimulation() { return !IsReal(); } /**