diff --git a/romiVendordep/src/main/native/include/frc/romi/OnBoardIO.h b/romiVendordep/src/main/native/include/frc/romi/OnBoardIO.h index b72d7b22ad8..eef6a8488db 100644 --- a/romiVendordep/src/main/native/include/frc/romi/OnBoardIO.h +++ b/romiVendordep/src/main/native/include/frc/romi/OnBoardIO.h @@ -12,6 +12,11 @@ namespace frc { +/** + * @ingroup romi_api + * @{ + */ + /** * This class represents the onboard IO of the Romi * reference robot. This includes the pushbuttons and @@ -74,4 +79,6 @@ class OnBoardIO { std::unique_ptr m_redLed; }; +/** @} */ + } // namespace frc diff --git a/romiVendordep/src/main/native/include/frc/romi/RomiGyro.h b/romiVendordep/src/main/native/include/frc/romi/RomiGyro.h index 363daf3a31b..5ef50456608 100644 --- a/romiVendordep/src/main/native/include/frc/romi/RomiGyro.h +++ b/romiVendordep/src/main/native/include/frc/romi/RomiGyro.h @@ -8,6 +8,11 @@ namespace frc { +/** + * @ingroup romi_api + * @{ + */ + /** * Use a rate gyro to return the robots heading relative to a starting position. * @@ -88,4 +93,6 @@ class RomiGyro { double m_angleZOffset = 0; }; +/** @} */ + } // namespace frc diff --git a/romiVendordep/src/main/native/include/frc/romi/RomiMotor.h b/romiVendordep/src/main/native/include/frc/romi/RomiMotor.h index 4bb925056b8..75bbe5b1629 100644 --- a/romiVendordep/src/main/native/include/frc/romi/RomiMotor.h +++ b/romiVendordep/src/main/native/include/frc/romi/RomiMotor.h @@ -8,6 +8,11 @@ namespace frc { +/** + * @defgroup romi_api Romi Hardware API + * @{ + */ + /** * RomiMotor * @@ -27,4 +32,6 @@ class RomiMotor : public PWMMotorController { RomiMotor& operator=(RomiMotor&&) = default; }; +/** @} */ + } // namespace frc diff --git a/xrpVendordep/src/main/native/include/frc/xrp/XRPGyro.h b/xrpVendordep/src/main/native/include/frc/xrp/XRPGyro.h index 4b2190894e6..1cf49a77105 100644 --- a/xrpVendordep/src/main/native/include/frc/xrp/XRPGyro.h +++ b/xrpVendordep/src/main/native/include/frc/xrp/XRPGyro.h @@ -8,6 +8,11 @@ namespace frc { +/** + * @ingroup xrp_api + * @{ + */ + /** * Use a rate gyro to return the robots heading relative to a starting position. * @@ -93,4 +98,6 @@ class XRPGyro { double m_angleZOffset = 0; }; +/** @} */ + } // namespace frc diff --git a/xrpVendordep/src/main/native/include/frc/xrp/XRPMotor.h b/xrpVendordep/src/main/native/include/frc/xrp/XRPMotor.h index 63a9e8c23c0..f9e96c1fe7d 100644 --- a/xrpVendordep/src/main/native/include/frc/xrp/XRPMotor.h +++ b/xrpVendordep/src/main/native/include/frc/xrp/XRPMotor.h @@ -18,6 +18,11 @@ namespace frc { WPI_IGNORE_DEPRECATED +/** + * @defgroup xrp_api XRP Hardware API + * @{ + */ + class XRPMotor : public frc::MotorController, public frc::MotorSafety { public: /** @@ -51,6 +56,8 @@ class XRPMotor : public frc::MotorController, public frc::MotorSafety { static void CheckDeviceAllocation(int deviceNum); }; +/** @} */ + WPI_UNIGNORE_DEPRECATED } // namespace frc diff --git a/xrpVendordep/src/main/native/include/frc/xrp/XRPOnBoardIO.h b/xrpVendordep/src/main/native/include/frc/xrp/XRPOnBoardIO.h index 4b97870f2c1..dc3e0c2114e 100644 --- a/xrpVendordep/src/main/native/include/frc/xrp/XRPOnBoardIO.h +++ b/xrpVendordep/src/main/native/include/frc/xrp/XRPOnBoardIO.h @@ -13,6 +13,11 @@ namespace frc { +/** + * @ingroup xrp_api + * @{ + */ + /** * This class represents the onboard IO of the XRP * reference robot. This the USER push button and @@ -43,4 +48,6 @@ class XRPOnBoardIO { frc::DigitalOutput m_led{1}; }; +/** @} */ + } // namespace frc diff --git a/xrpVendordep/src/main/native/include/frc/xrp/XRPRangefinder.h b/xrpVendordep/src/main/native/include/frc/xrp/XRPRangefinder.h index 5be78e67844..d2b949bb862 100644 --- a/xrpVendordep/src/main/native/include/frc/xrp/XRPRangefinder.h +++ b/xrpVendordep/src/main/native/include/frc/xrp/XRPRangefinder.h @@ -10,6 +10,11 @@ namespace frc { +/** + * @ingroup xrp_api + * @{ + */ + /** * This class represents the reflectance sensor pair * on the XRP robot. @@ -26,4 +31,6 @@ class XRPRangefinder { frc::AnalogInput m_rangefinder{2}; }; +/** @} */ + } // namespace frc diff --git a/xrpVendordep/src/main/native/include/frc/xrp/XRPReflectanceSensor.h b/xrpVendordep/src/main/native/include/frc/xrp/XRPReflectanceSensor.h index 8b85cd2b64c..8b1406c36f2 100644 --- a/xrpVendordep/src/main/native/include/frc/xrp/XRPReflectanceSensor.h +++ b/xrpVendordep/src/main/native/include/frc/xrp/XRPReflectanceSensor.h @@ -8,6 +8,11 @@ namespace frc { +/** + * @ingroup xrp_api + * @{ + */ + /** * This class represents the reflectance sensor pair * on the XRP robot. @@ -31,4 +36,6 @@ class XRPReflectanceSensor { frc::AnalogInput m_rightSensor{1}; }; +/** @} */ + } // namespace frc diff --git a/xrpVendordep/src/main/native/include/frc/xrp/XRPServo.h b/xrpVendordep/src/main/native/include/frc/xrp/XRPServo.h index b07c4498563..4f55f305155 100644 --- a/xrpVendordep/src/main/native/include/frc/xrp/XRPServo.h +++ b/xrpVendordep/src/main/native/include/frc/xrp/XRPServo.h @@ -12,6 +12,11 @@ namespace frc { +/** + * @ingroup xrp_api + * @{ + */ + /** * XRPServo. * @@ -65,4 +70,6 @@ class XRPServo { static void CheckDeviceAllocation(int deviceNum); }; +/** @} */ + } // namespace frc