doc: add missing @return entries
authorBartosz Golaszewski <bartosz.golaszewski@linaro.org>
Wed, 31 May 2023 15:21:47 +0000 (17:21 +0200)
committerBartosz Golaszewski <bartosz.golaszewski@linaro.org>
Wed, 31 May 2023 15:21:47 +0000 (17:21 +0200)
There are two line-request functions that don't have their return values
documented. Fix it.

Signed-off-by: Bartosz Golaszewski <bartosz.golaszewski@linaro.org>
include/gpiod.h

index 9815446ba3f2e296474a46095ea0c41c81635d49..45f31f764b26440efe841989dc9e7a03f0b33e90 100644 (file)
@@ -983,6 +983,7 @@ int gpiod_line_request_get_values(struct gpiod_line_request *request,
  * @param request Line request object.
  * @param offset The offset of the line for which the value should be set.
  * @param value Value to set.
+ * @return 0 on success, -1 on failure.
  */
 int gpiod_line_request_set_value(struct gpiod_line_request *request,
                                 unsigned int offset,
@@ -1014,6 +1015,7 @@ int gpiod_line_request_set_values_subset(struct gpiod_line_request *request,
  *               Each value is associated with the line identified by the
  *               corresponding entry in the offset array filled by
  *               ::gpiod_line_request_get_requested_offsets.
+ * @return 0 on success, -1 on failure.
  */
 int gpiod_line_request_set_values(struct gpiod_line_request *request,
                                  const enum gpiod_line_value *values);