[wpilibc] RobotBase::IsReal, IsSimulation: Add doxygen comments (#2735)

This commit is contained in:
Starlight220
2020-09-27 10:08:53 +03:00
committed by GitHub
parent 61ee331f11
commit 73950b9857

View File

@@ -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(); }
/**