RC_Channel: use @LoggerEnum to give name for three level source enum

ArduPilot · Dec 22, 2024 · 807239b · 807239b
1 parent e39b800
commit 807239b
Showing 1 changed file with 8 additions and 8 deletions.
diff --git a/libraries/RC_Channel/RC_Channel.h b/libraries/RC_Channel/RC_Channel.h
@@ -314,19 +314,19 @@ class RC_Channel {
         HIGH       // indicates auxiliary switch is in the high position (pwm >1800)
     };
 
-    // Trigger structure containing the function, position and pwm (if applicable)
+    // Trigger structure containing the function, position, source and source index
     struct AuxFuncTrigger {
         AUX_FUNC func;
         AuxSwitchPos pos;
+        // @LoggerEnum: AuxFuncTrigger::Source
         enum class Source : uint8_t {
-            INIT,
-            RC,
-            BUTTON,
-            MAVLINK,
-            MISSION,
-            SCRIPTING,
+            INIT,      // Source index is RC channel index
+            RC,        // Source index is RC channel index
+            BUTTON,    // Source index is button index
+            MAVLINK,   // Source index is MAVLink channel number
+            MISSION,   // Source index is mission item index
+            SCRIPTING, // Source index is not used (always 0)
         } source;
-        // Index within source
         uint16_t source_index;
     };