From: Simon McVittie <smcv@collabora.com>
Date: Fri, 16 May 2025 10:52:11 +0000 (+0100)
Subject: timeout: Document fallibility of _dbus_timeout_new()
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=7b272b7d8b7edf08bb011327434524c2508c113e;p=thirdparty%2Fdbus.git

timeout: Document fallibility of _dbus_timeout_new()

Like all other functions that allocate memory, libdbus assumes that this
can fail on OOM.

Signed-off-by: Simon McVittie <smcv@collabora.com>
---

diff --git a/dbus/dbus-timeout.c b/dbus/dbus-timeout.c
index 5ee9808ae..412420e4a 100644
--- a/dbus/dbus-timeout.c
+++ b/dbus/dbus-timeout.c
@@ -60,7 +60,7 @@ struct DBusTimeout
  * @param handler function to call when the timeout occurs.
  * @param data data to pass to the handler
  * @param free_data_function function to be called to free the data.
- * @returns the new DBusTimeout object,
+ * @returns the new DBusTimeout object, or #NULL if out of memory
  */
 DBusTimeout*
 _dbus_timeout_new (int                 interval,