udev: update docs, NEWS

5 files changed, 7 insertions, 0 deletions

diff --git a/src/libudev/libudev-device.c b/src/libudev/libudev-device.c
index f0aab5d464..a8277d1363 100644
--- a/src/libudev/libudev-device.c
+++ b/src/libudev/libudev-device.c
@@ -1022,6 +1022,7 @@ _public_ struct udev_device *udev_device_ref(struct udev_device *udev_device)
  * Drop a reference of a udev device. If the refcount reaches zero,
  * the resources of the device will be released.
  *
+ * Returns: the passed udev device if it has still an active reference, or #NULL otherwise.
  **/
 _public_ struct udev_device *udev_device_unref(struct udev_device *udev_device)
 {
diff --git a/src/libudev/libudev-enumerate.c b/src/libudev/libudev-enumerate.c
index 671bfd7bcf..a945758e38 100644
--- a/src/libudev/libudev-enumerate.c
+++ b/src/libudev/libudev-enumerate.c
@@ -111,6 +111,8 @@ _public_ struct udev_enumerate *udev_enumerate_ref(struct udev_enumerate *udev_e
  *
  * Drop a reference of an enumeration context. If the refcount reaches zero,
  * all resources of the enumeration context will be released.
+ *
+ * Returns: the passed enumeration context if it has still an active reference, or #NULL otherwise.
  **/
 _public_ struct udev_enumerate *udev_enumerate_unref(struct udev_enumerate *udev_enumerate)
 {
diff --git a/src/libudev/libudev-monitor.c b/src/libudev/libudev-monitor.c
index 96506fe580..566e9761aa 100644
--- a/src/libudev/libudev-monitor.c
+++ b/src/libudev/libudev-monitor.c
@@ -400,6 +400,7 @@ _public_ struct udev_monitor *udev_monitor_ref(struct udev_monitor *udev_monitor
  * the bound socket will be closed, and the resources of the monitor
  * will be released.
  *
+ * Returns: the passed udev monitor if it has still an active reference, or #NULL otherwise.
  **/
 _public_ struct udev_monitor *udev_monitor_unref(struct udev_monitor *udev_monitor)
 {
diff --git a/src/libudev/libudev-queue.c b/src/libudev/libudev-queue.c
index 15a7f558b1..1b3da39f83 100644
--- a/src/libudev/libudev-queue.c
+++ b/src/libudev/libudev-queue.c
@@ -92,6 +92,8 @@ _public_ struct udev_queue *udev_queue_ref(struct udev_queue *udev_queue)
  *
  * Drop a reference of a udev queue context. If the refcount reaches zero,
  * the resources of the queue context will be released.
+ *
+ * Returns: the passed queue context if it has still an active reference, or #NULL otherwise.
  **/
 _public_ struct udev_queue *udev_queue_unref(struct udev_queue *udev_queue)
 {
diff --git a/src/libudev/libudev.c b/src/libudev/libudev.c
index 5b754a22a4..07a24d5c3c 100644
--- a/src/libudev/libudev.c
+++ b/src/libudev/libudev.c
@@ -221,6 +221,7 @@ _public_ struct udev *udev_ref(struct udev *udev)
  * Drop a reference of the udev library context. If the refcount
  * reaches zero, the resources of the context will be released.
  *
+ * Returns: the passed udev library context if it has still an active reference, or #NULL otherwise.
  **/
 _public_ struct udev *udev_unref(struct udev *udev)
 {