Add doxygen topics

rzblue · Sep 7, 2024 · d12f896 · d12f896
1 parent e60d097
commit d12f896
Show file tree

Hide file tree

Showing 9 changed files with 63 additions and 0 deletions.
diff --git 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<frc::DigitalOutput> 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -12,6 +12,11 @@
 
 namespace frc {
 
+/**
+ * @ingroup xrp_api
+ * @{
+ */
+
 /**
  * XRPServo.
  *
@@ -65,4 +70,6 @@ class XRPServo {
   static void CheckDeviceAllocation(int deviceNum);
 };
 
+/** @} */
+
 }  // namespace frc