Add comments to message and service files

CopterExpress · Jan 29, 2021 · ab4ec11 · ab4ec11
1 parent 723ed69
commit ab4ec11
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 12 deletions.
diff --git a/led_msgs/msg/LEDState.msg b/led_msgs/msg/LEDState.msg
@@ -1,4 +1,6 @@
-uint32 index
-uint8 r
-uint8 g
-uint8 b
+# This message represents a state of an LED
+
+uint32 index # number of LED in a LED strip or other LEDs set
+uint8 r      # red component of the color, 0..255
+uint8 g      # green component of the color, 0..255
+uint8 b      # blue component of the color, 0..255
diff --git a/led_msgs/msg/LEDStateArray.msg b/led_msgs/msg/LEDStateArray.msg
@@ -1 +1,3 @@
+# Full state of a LED strip or other set of LEDs
+
 LEDState[] leds
diff --git a/led_msgs/srv/SetLED.srv b/led_msgs/srv/SetLED.srv
@@ -1,7 +1,9 @@
-uint32 index
-uint8 r
-uint8 g
-uint8 b
+# This service sets an LED color
+
+uint32 index   # number of LED in a LED strip or other LEDs set
+uint8 r        # red component of the color, 0..255
+uint8 g        # green component of the color, 0..255
+uint8 b        # blue component of the color, 0..255
 ---
-bool success
-string message
+bool success   # True if the call succeeded
+string message # Error or informational message
diff --git a/led_msgs/srv/SetLEDs.srv b/led_msgs/srv/SetLEDs.srv
@@ -1,4 +1,6 @@
+# This service sets chosen LED colors in a LED strip or other LEDs set
+
 LEDState[] leds
 ---
-bool success
-string message
+bool success   # True if the call succeeded
+string message # Error or informational message