summaryrefslogtreecommitdiffstats
path: root/dbus/dbus-message.h
diff options
context:
space:
mode:
authorZack Rusin <zack@kde.org>2002-11-22 03:42:37 +0000
committerZack Rusin <zack@kde.org>2002-11-22 03:42:37 +0000
commitc68320376bc93cb744e0a0930eb241eefd764076 (patch)
treee72be53896089ab6a59ac8305a10035073e43a26 /dbus/dbus-message.h
parent5a6adeee6e20252f8f2b01349b7e95ee6e99e4ff (diff)
Adding documentation (Doxygen) support.
Diffstat (limited to 'dbus/dbus-message.h')
-rw-r--r--dbus/dbus-message.h29
1 files changed, 29 insertions, 0 deletions
diff --git a/dbus/dbus-message.h b/dbus/dbus-message.h
index 7dd7170b..73f6599f 100644
--- a/dbus/dbus-message.h
+++ b/dbus/dbus-message.h
@@ -31,13 +31,42 @@
DBUS_BEGIN_DECLS
+/**
+ * @defgroup Message
+ * @ingroup DBus
+ * @brief Message handling.
+ *
+ * This functions deal with message structure
+ * within DBus.
+ *
+ * @{
+ */
+
typedef struct DBusMessage DBusMessage;
+/**
+ * Constructs a new DBus message.
+ * @return New DBusMessage
+ */
DBusMessage* dbus_message_new (void);
+
+/**
+ * Increments a reference count on a message.
+ *
+ * @arg message It's the message whose reference count we're incrementing
+ * @see dbus_message_unref
+ */
void dbus_message_ref (DBusMessage *message);
+
+/**
+ * Decrements a reference count on a message.
+ *
+ * @arg message It's the message whose reference count we're decrementing
+ */
void dbus_message_unref (DBusMessage *message);
+/** @} */
DBUS_END_DECLS