feedback-led: Document hw LED types

2024-06-13 15:17:52 +02:00
parent 4afc8398e2
commit efd088daa8
1 changed files with 10 additions and 0 deletions
@@ -9,6 +9,16 @@

 G_BEGIN_DECLS

+/**
+ * FbdDevLedColor:
+ * @FBD_FEEDBACK_LED_COLOR_WHITE: A white LED
+ * @FBD_FEEDBACK_LED_COLOR_RED: A red LED
+ * @FBD_FEEDBACK_LED_COLOR_GREEN: A green LED
+ * @FBD_FEEDBACK_LED_COLOR_BLUE: A blue LED
+ * @FBD_FEEDBACK_LED_COLOR_RGB: A multicolor LED that can display arbitrary RGB values
+ *
+ * The color of a hardware LED.
+ */
 typedef enum _FbdFeedbackLedColor {
  FBD_FEEDBACK_LED_COLOR_WHITE = 0,
  FBD_FEEDBACK_LED_COLOR_RED = 1,