2005-01-21 Havoc Pennington <hp@redhat.com>
authorHavoc Pennington <hp@redhat.com>
Fri, 21 Jan 2005 05:06:10 +0000 (05:06 +0000)
committerHavoc Pennington <hp@redhat.com>
Fri, 21 Jan 2005 05:06:10 +0000 (05:06 +0000)
* glib/dbus-gmain.c: don't put the GLib bindings in the same
toplevel doxygen group as the low-level API stuff

* dbus/dbus.h: note that libdbus is the low-level API

ChangeLog
dbus/dbus.h
glib/dbus-gmain.c

index 804c9b2..2f0f2ea 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,10 @@
+2005-01-21  Havoc Pennington  <hp@redhat.com>
+
+       * glib/dbus-gmain.c: don't put the GLib bindings in the same
+       toplevel doxygen group as the low-level API stuff
+
+       * dbus/dbus.h: note that libdbus is the low-level API
+
 2005-01-20  Havoc Pennington  <hp@redhat.com>
 
        * update-dbus-docs.sh: script to update docs on the web site, only
index 3c6efd3..e61d61d 100644 (file)
 #undef DBUS_INSIDE_DBUS_H
 
 /**
- * @defgroup DBus D-BUS message system public API
- * @brief The exported public API of the D-BUS library.
+ * @defgroup DBus D-BUS low-level public API
+ * @brief The low-level public API of the D-BUS library
  *
+ * libdbus provides a low-level API intended primarily for use by
+ * bindings to specific object systems and languages.  D-BUS is most
+ * convenient when used with the GLib bindings, Python bindings, Qt
+ * bindings, Mono bindings, and so forth.  This low-level API has a
+ * lot of complexity useful only for bindings.
+ * 
  * @{
  */
 
index a6c7d25..d6a925e 100644 (file)
 
 /**
  * @defgroup DBusGLib GLib bindings
- * @ingroup  DBus
  * @brief API for using D-BUS with GLib
  *
- * Convenience functions are provided for using D-BUS
- * with the GLib library (see http://www.gtk.org for GLib
- * information).
- * 
+ * libdbus proper is a low-level API, these GLib bindings wrap libdbus
+ * with a much higher-level approach. The higher level approach is
+ * possible because GLib defines a main loop, an object/type system,
+ * and an out-of-memory handling policy (it exits the program).
+ * See http://www.gtk.org for GLib information.
+ *
+ * To manipulate remote objects, use #DBusGProxy.
  */
 
 /**