Team2890/allwpilib
4
0
Fork 0
mirror of https://github.com/wpilibsuite/allwpilib synced 2026-07-05 03:21:42 +00:00
Code Issues Packages Projects Releases Wiki Activity

[docs] Add missing docs to enum fields (NFC) (#6150)

Browse Source 
Co-authored-by: Tyler Veness <calcmogul@gmail.com>
This commit is contained in:
m10653
2024-01-05 00:36:26 -05:00
committed by GitHub
parent 4210f5635d
commit 13f4460e00
49 changed files with 665 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
wpilibc/src/main/native/include/frc/SPI.h
View File

@@ -25,14 +25,34 @@ class DigitalSource;
*/
class SPI {
public:
enum Port { kOnboardCS0 = 0, kOnboardCS1, kOnboardCS2, kOnboardCS3, kMXP };
/**
* SPI port.
*/
enum Port {
/// Onboard SPI bus port CS0.
kOnboardCS0 = 0,
/// Onboard SPI bus port CS1.
kOnboardCS1,
/// Onboard SPI bus port CS2.
kOnboardCS2,
/// Onboard SPI bus port CS3.
kOnboardCS3,
/// MXP (roboRIO MXP) SPI bus port.
kMXP
};
/**
* SPI mode.
*/
enum Mode {
kMode0 = HAL_SPI_kMode0, /*!< Clock idle low, data sampled on rising edge */
kMode1 =
HAL_SPI_kMode1, /*!< Clock idle low, data sampled on falling edge */
kMode2 =
HAL_SPI_kMode2, /*!< Clock idle high, data sampled on falling edge */
kMode3 = HAL_SPI_kMode3 /*!< Clock idle high, data sampled on rising edge */
/// Clock idle low, data sampled on rising edge.
kMode0 = HAL_SPI_kMode0,
/// Clock idle low, data sampled on falling edge.
kMode1 = HAL_SPI_kMode1,
/// Clock idle high, data sampled on falling edge.
kMode2 = HAL_SPI_kMode2,
/// Clock idle high, data sampled on rising edge.
kMode3 = HAL_SPI_kMode3
};
/**