[glibmm] DBus docs: Add a descripton for they doxygen group.
- From: Murray Cumming <murrayc src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [glibmm] DBus docs: Add a descripton for they doxygen group.
- Date: Wed, 6 Apr 2011 12:17:07 +0000 (UTC)
commit bc8a9df4ba9c1c4e462992459b22f5eb7b9cab33
Author: Murray Cumming <murrayc murrayc com>
Date: Wed Apr 6 14:16:53 2011 +0200
DBus docs: Add a descripton for they doxygen group.
* gio/src/dbusconnection.hg: Expand the defgroup doxygen comment block.
ChangeLog | 6 ++++++
gio/src/dbusconnection.hg | 10 ++++++++--
2 files changed, 14 insertions(+), 2 deletions(-)
---
diff --git a/ChangeLog b/ChangeLog
index c6fb8fd..6bc8b96 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 ebbc27a..f842434 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.
*
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]