summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMurray Cumming <murrayc@murrayc.com>2011-04-06 14:16:53 +0200
committerMurray Cumming <murrayc@murrayc.com>2011-04-06 14:16:53 +0200
commitbc8a9df4ba9c1c4e462992459b22f5eb7b9cab33 (patch)
tree80f12c5126354d2cfe3cb4d0416a174e08cfd502
parent71377c30b83dfa6f2fc736b709babdb95af1d150 (diff)
downloadglibmm-bc8a9df4ba9c1c4e462992459b22f5eb7b9cab33.tar.gz
DBus docs: Add a descripton for they doxygen group.
* gio/src/dbusconnection.hg: Expand the defgroup doxygen comment block.
-rw-r--r--ChangeLog6
-rw-r--r--gio/src/dbusconnection.hg10
2 files changed, 14 insertions, 2 deletions
diff --git a/ChangeLog b/ChangeLog
index c6fb8fd8..6bc8b967 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,9 @@
+2011-04-06 Murray Cumming <murrayc@murrayc.com>
+
+ DBus docs: Add a descripton for they doxygen group.
+
+ * gio/src/dbusconnection.hg: Expand the defgroup doxygen comment block.
+
2.28.0:
2011-04-05 Murray Cumming <murrayc@murrayc.com>
diff --git a/gio/src/dbusconnection.hg b/gio/src/dbusconnection.hg
index ebbc27ae..f8424348 100644
--- a/gio/src/dbusconnection.hg
+++ b/gio/src/dbusconnection.hg
@@ -48,7 +48,13 @@ _WRAP_ENUM(SubtreeFlags, GDBusSubtreeFlags, s#^DBUS_##, NO_GTYPE)
_GMMPROC_EXTRA_NAMESPACE(DBus)
-/// @defgroup DBus D-Bus API
+
+/** @defgroup DBus D-Bus API
+ *
+ * API to use D-Bus services as a client or to implement a D-Bus service.
+ * To write client code, see Gio::DBus::Proxy.
+ * To export objects on the bus for other clients, see Gio::DBus::own_name(), for instance.
+ */
//TODO: Add example from C API in class docs.
/** A D-Bus Connection.
@@ -57,7 +63,7 @@ _GMMPROC_EXTRA_NAMESPACE(DBus)
* For instance, it lets you establish a connection over any transport that
* can by represented as an IOStream.
*
- * This class is rarely used directly in D-Bus clients. If you are writing an
+ * This class is rarely used directly in D-Bus clients. If you are writing a
* D-Bus client, it is often easier to use the Gio::DBus::own_name(),
* Gio::DBus::watch_name() or Gio::DBus::Proxy::create_for_bus() APIs.
*