mirror of
https://github.com/wpilibsuite/allwpilib
synced 2026-06-21 01:01:43 +00:00
[docs] Add missing docs to enum fields (NFC) (#6150)
Co-authored-by: Tyler Veness <calcmogul@gmail.com>
This commit is contained in:
@@ -42,10 +42,17 @@ class Encoder : public CounterBase,
|
||||
friend class DMASample;
|
||||
|
||||
public:
|
||||
/**
|
||||
* Encoder indexing types.
|
||||
*/
|
||||
enum IndexingType {
|
||||
/// Reset while the signal is high.
|
||||
kResetWhileHigh,
|
||||
/// Reset while the signal is low.
|
||||
kResetWhileLow,
|
||||
/// Reset on falling edge of the signal.
|
||||
kResetOnFallingEdge,
|
||||
/// Reset on rising edge of the signal.
|
||||
kResetOnRisingEdge
|
||||
};
|
||||
|
||||
|
||||
Reference in New Issue
Block a user