diff options
| -rw-r--r-- | ChangeLog | 7 | ||||
| -rw-r--r-- | dbus/dbus.h | 10 | ||||
| -rw-r--r-- | glib/dbus-gmain.c | 12 |
3 files changed, 22 insertions, 7 deletions
@@ -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 diff --git a/dbus/dbus.h b/dbus/dbus.h index 3c6efd39..e61d61d8 100644 --- a/dbus/dbus.h +++ b/dbus/dbus.h @@ -47,9 +47,15 @@ #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. + * * @{ */ diff --git a/glib/dbus-gmain.c b/glib/dbus-gmain.c index a6c7d25c..d6a925ef 100644 --- a/glib/dbus-gmain.c +++ b/glib/dbus-gmain.c @@ -33,13 +33,15 @@ /** * @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. */ /** |