Skip to contentSkip to conversation

doc: fix comment mix up in gpiod.h

PATCH Applied Kent Gibson 2 participants 2 messages May 27, 2020 GPIO

lore
Share & tools
lore

Kent Gibson

author
#0 lore raw

PATCH 1/1 doc: fix comment mix up in gpiod.h

A couple of the doc comments for GPIOD_LINE_REQUEST_XX values document the wrong value.
Switch them so that they document the appropriate value.

Signed-off-by Kent Gibson <[email protected]>
---
 include/gpiod.h | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
include/gpiod.h +2 -2
index 3af97c4..f03ce95 100644
@@ -956,11 +956,11 @@ enum {
 	GPIOD_LINE_REQUEST_DIRECTION_OUTPUT,
 	/**< Request the line(s) for setting the GPIO line state. */
 	GPIOD_LINE_REQUEST_EVENT_FALLING_EDGE,
-	/**< Monitor both types of events. */
+	/**< Only watch falling edge events. */
 	GPIOD_LINE_REQUEST_EVENT_RISING_EDGE,
 	/**< Only watch rising edge events. */
 	GPIOD_LINE_REQUEST_EVENT_BOTH_EDGES,
-	/**< Only watch falling edge events. */
+	/**< Monitor both types of events. */
 };
 
 /**
Signature · 1 line
2.26.2
Applied
#1 lore raw

śr., 27 maj 2020 o 03:11 Kent Gibson <[email protected]> napisał(a):

Quoted 29 lines

A couple of the doc comments for GPIOD_LINE_REQUEST_XX values document the wrong value.
Switch them so that they document the appropriate value.

Signed-off-by Kent Gibson <[email protected]>
---
 include/gpiod.h | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
include/gpiod.h +2 -3
index 3af97c4..f03ce95 100644
@@ -956,11 +956,11 @@ enum {
        GPIOD_LINE_REQUEST_DIRECTION_OUTPUT,
        /**< Request the line(s) for setting the GPIO line state. */
        GPIOD_LINE_REQUEST_EVENT_FALLING_EDGE,
-       /**< Monitor both types of events. */
+       /**< Only watch falling edge events. */
        GPIOD_LINE_REQUEST_EVENT_RISING_EDGE,
        /**< Only watch rising edge events. */
        GPIOD_LINE_REQUEST_EVENT_BOTH_EDGES,
-       /**< Only watch falling edge events. */
+       /**< Monitor both types of events. */
 };
 
 /**
--
Quoted 2 lines

2.26.2

Applied, thanks!

Bartosz