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 5ee9808aebc8fef6653a8727affbb0f86cfb9cd8..412420e4a54e1033fe29278a7141d5127f91c6c0 100644 (file)
--- 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,