mirror of
https://github.com/wpilibsuite/allwpilib
synced 2026-07-04 03:11:43 +00:00
[docs] Add romi and xrp to docs build (#7045)
This commit is contained in:
@@ -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
|
||||
@@ -24,7 +29,8 @@ namespace frc {
|
||||
*/
|
||||
class OnBoardIO {
|
||||
public:
|
||||
enum ChannelMode { INPUT, OUTPUT };
|
||||
/** Mode for Romi onboard IO */
|
||||
enum ChannelMode { /** Input */ INPUT, /** Output */ OUTPUT };
|
||||
OnBoardIO(OnBoardIO::ChannelMode dio1, OnBoardIO::ChannelMode dio2);
|
||||
|
||||
static constexpr auto kMessageInterval = 1_s;
|
||||
@@ -73,4 +79,6 @@ class OnBoardIO {
|
||||
std::unique_ptr<frc::DigitalOutput> m_redLed;
|
||||
};
|
||||
|
||||
/** @} */
|
||||
|
||||
} // namespace frc
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
Reference in New Issue
Block a user