From: Richard Hult <richard@imendio.com>
Date: Thu, 18 Mar 2004 11:10:59 +0000 (+0000)
Subject: 2004-03-18  Richard Hult  <richard@imendio.com>
X-Git-Tag: dbus-0.21~1
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=69bf27e5563cbad2d2c9a74ea43e89a8dcb83357;p=thirdparty%2Fdbus.git

2004-03-18  Richard Hult  <richard@imendio.com>

	* dbus/dbus-message.c (dbus_message_get_auto_activation)
	(dbus_message_set_auto_activation): Add doxygen docs.
---

diff --git a/ChangeLog b/ChangeLog
index 809664e78..afafe0a80 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+2004-03-18  Richard Hult  <richard@imendio.com>
+
+	* dbus/dbus-message.c (dbus_message_get_auto_activation) 
+	(dbus_message_set_auto_activation): Add doxygen docs.
+
 2004-03-16  Richard Hult  <richard@imendio.com>
 
 	* bus/activation.c: (bus_activation_service_created),
diff --git a/dbus/dbus-message.c b/dbus/dbus-message.c
index 696b25038..63e2afe7c 100644
--- a/dbus/dbus-message.c
+++ b/dbus/dbus-message.c
@@ -4387,6 +4387,16 @@ dbus_message_get_no_reply (DBusMessage *message)
   return (*header & DBUS_HEADER_FLAG_NO_REPLY_EXPECTED) != 0;
 }
 
+
+/**
+ * Sets a flag indicating that the addressed service will be auto-activated
+ * before the message is delivered. When this flag is set, the message is held
+ * until the service is succesfully activated or fail to activate. In case of
+ * failure, the reply will be an activation error.
+ *
+ * @param message the message
+ * @param auto_activation #TRUE if auto-activation is desired
+ */
 void
 dbus_message_set_auto_activation (DBusMessage *message,
 				  dbus_bool_t  auto_activation)
@@ -4404,6 +4414,13 @@ dbus_message_set_auto_activation (DBusMessage *message,
     *header &= ~DBUS_HEADER_FLAG_AUTO_ACTIVATION;
 }
 
+/**
+ * Returns #TRUE if the message will cause the addressed service to be
+ * auto-activated.
+ *
+ * @param message the message
+ * @returns #TRUE if the message will use auto-activation
+ */
 dbus_bool_t
 dbus_message_get_auto_activation (DBusMessage *message)
 {