doc: minor fix for line bulk loop macros
authorBartosz Golaszewski <bartekgola@gmail.com>
Tue, 24 Oct 2017 12:48:54 +0000 (14:48 +0200)
committerBartosz Golaszewski <bartekgola@gmail.com>
Tue, 24 Oct 2017 12:48:54 +0000 (14:48 +0200)
Make it clear in the @brief section what the difference is between the
two variants.

Signed-off-by: Bartosz Golaszewski <bartekgola@gmail.com>
include/gpiod.h

index eb42bbd781ca61fce13abc4921ca37379f3c5f52..d13c97a12e9d28308d4e81f884b1fe5104b13e33 100644 (file)
@@ -499,7 +499,8 @@ gpiod_line_bulk_num_lines(struct gpiod_line_bulk *bulk)
             (lineptr)++, (line) = *(lineptr))
 
 /**
- * @brief Iterate over all line handles held by a line bulk object.
+ * @brief Iterate over all line handles held by a line bulk object (integer
+ *        counter variant).
  * @param bulk Line bulk object.
  * @param line GPIO line handle. On each iteration, the subsequent line handle
  *             is assigned to this pointer.