From: Bartosz Golaszewski <bartekgola@gmail.com>
Date: Sun, 5 Nov 2017 19:23:42 +0000 (+0100)
Subject: doc: update the descriptions for chip iterators
X-Git-Url: http://git.maquefel.me/?a=commitdiff_plain;h=1039b1cfb40ac73273a9a78b0a585048f7179dcf;p=qemu-gpiodev%2Flibgpiod.git

doc: update the descriptions for chip iterators

The 'next' routines for chip iterators can no longer fail. Update
the docs accordingly. Also: turn the extended description into a note
for the noclose variant.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>
---

diff --git a/include/gpiod.h b/include/gpiod.h
index 3276036..8c0ec91 100644
--- a/include/gpiod.h
+++ b/include/gpiod.h
@@ -1180,8 +1180,8 @@ void gpiod_chip_iter_free_noclose(struct gpiod_chip_iter *iter) GPIOD_API;
 /**
  * @brief Get the next gpiochip handle.
  * @param iter The gpiochip iterator object.
- * @return Pointer to an open gpiochip handle or NULL if the next chip can't
- *         be accessed.
+ * @return Pointer to the next open gpiochip handle or NULL if no more chips
+ *         are present in the system.
  * @note The previous chip handle will be closed using ::gpiod_chip_iter_free.
  */
 struct gpiod_chip *
@@ -1190,11 +1190,10 @@ gpiod_chip_iter_next(struct gpiod_chip_iter *iter) GPIOD_API;
 /**
  * @brief Get the next gpiochip handle without closing the previous one.
  * @param iter The gpiochip iterator object.
- * @return Pointer to an open gpiochip handle or NULL if the next chip can't
- *         be accessed.
- *
- * This function works just like ::gpiod_chip_iter_next but doesn't close the
- * most recently opened chip handle.
+ * @return Pointer to the next open gpiochip handle or NULL if no more chips
+ *         are present in the system.
+ * @note This function works just like ::gpiod_chip_iter_next but doesn't
+ *       close the most recently opened chip handle.
  */
 struct gpiod_chip *
 gpiod_chip_iter_next_noclose(struct gpiod_chip_iter *iter) GPIOD_API;