Hello,
while writing python wrapper for libgpiod I found a few documentation
glitches. Attached is a patch.
Kind regards,
Gasper Zejn
>From c7775cc9f8849b1364c2c578cb780a25ab11738a Mon Sep 17 00:00:00 2001
From: Gasper Zejn <zejn@xxxxxxxxxxxxx>
Date: Fri, 23 Feb 2018 13:00:01 +0100
Subject: [PATCH] Documentation fixes
---
include/gpiod.h | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/include/gpiod.h b/include/gpiod.h
index c8ba3e2..a6e1b2c 100644
--- a/include/gpiod.h
+++ b/include/gpiod.h
@@ -177,7 +177,7 @@ enum {
};
/**
- * @brief Simple event callack signature.
+ * @brief Simple event callback signature.
*
* The callback function takes the following arguments: event type (int),
* GPIO line offset (unsigned int), event timestamp (const struct timespec *)
@@ -597,14 +597,14 @@ const char *gpiod_line_consumer(struct gpiod_line *line) GPIOD_API;
/**
* @brief Read the GPIO line direction setting.
* @param line GPIO line object.
- * @return Returns GPIOD_DIRECTION_INPUT or GPIOD_DIRECTION_OUTPUT.
+ * @return Returns GPIOD_LINE_DIRECTION_INPUT or GPIOD_LINE_DIRECTION_OUTPUT.
*/
int gpiod_line_direction(struct gpiod_line *line) GPIOD_API;
/**
* @brief Read the GPIO line active state setting.
* @param line GPIO line object.
- * @return Returns GPIOD_ACTIVE_STATE_HIGH or GPIOD_ACTIVE_STATE_LOW.
+ * @return Returns GPIOD_LINE_ACTIVE_STATE_HIGH or GPIOD_LINE_ACTIVE_STATE_LOW.
*/
int gpiod_line_active_state(struct gpiod_line *line) GPIOD_API;
--
2.11.0
