summaryrefslogtreecommitdiffstats
path: root/dbus/dbus-shared.h
diff options
context:
space:
mode:
authorHavoc Pennington <hp@redhat.com>2006-10-21 21:57:31 +0000
committerHavoc Pennington <hp@redhat.com>2006-10-21 21:57:31 +0000
commit58a0d2759aedc854ccac78d7252f117662734142 (patch)
tree27e6376bb3075a1b5c670bc29dcac8c7d29ee480 /dbus/dbus-shared.h
parentfed8880c6f718b9f06e589d1769494a47b395c0d (diff)
2006-10-21 Havoc Pennington <hp@redhat.com>
* More documentation - all public API now documented according to Doxygen
Diffstat (limited to 'dbus/dbus-shared.h')
-rw-r--r--dbus/dbus-shared.h7
1 files changed, 5 insertions, 2 deletions
diff --git a/dbus/dbus-shared.h b/dbus/dbus-shared.h
index 78d305ef..6d9284e7 100644
--- a/dbus/dbus-shared.h
+++ b/dbus/dbus-shared.h
@@ -40,9 +40,12 @@ extern "C" {
* @defgroup DBusShared Shared constants
* @ingroup DBus
*
- * Shared constants.
+ * @brief Shared header included by both libdbus and C/C++ bindings such as the GLib bindings.
+ *
+ * Usually a C/C++ binding such as the GLib or Qt binding won't want to include dbus.h in its
+ * public headers. However, a few constants and macros may be useful to include; those are
+ * found here and in dbus-protocol.h
*
- * @brief Stuff used by both dbus/dbus.h low-level and C/C++ binding APIs
* @{
*/