fix up docs for EggDBusInterfaceProxy

2 files changed, 35 insertions, 3 deletions

diff --git a/src/eggdbus/eggdbusinterfaceproxy.c b/src/eggdbus/eggdbusinterfaceproxy.c
index 8099de7..c6d1c55 100644
--- a/src/eggdbus/eggdbusinterfaceproxy.c
+++ b/src/eggdbus/eggdbusinterfaceproxy.c
@@ -44,8 +44,24 @@
  * @short_description: Abstract base class for interface proxies
  * @see_also: #EggDBusObjectProxy
  *
- * Instances of #EggDBusInterfaceProxy represents a proxy for
- * accessing a specific D-Bus interface on a specific remote object.
+ * #EggDBusInterfaceProxy is an abstract base class that all interface proxies for concrete
+ * D-Bus interfaces are derived from. The base class provides a way to get the #EggDBusObjectProxy
+ * and also maps D-Bus properties to GObject properties.
+ *
+ * You normally get an interface proxy by using the QUERY_INTERFACE() macros in generated
+ * glue GInterface code; for example for the interface proxy for the <literal>org.freedesktop.DBus</literal>
+ * D-Bus interface, you should use the EGG_DBUS_QUERY_INTERFACE_BUS() macro:
+ *
+ * <programlisting>
+ * EggDBusBus *bus;
+ *
+ * bus = EGG_DBUS_BUS_QUERY_INTERFACE (object_proxy);
+ *
+ * /<!-- -->* use the bus object to invoke methods on the org.freedesktop.DBus
+ *  * interface on the remote object represented by object_proxy. Also, use
+ *  * the bus object for getting/setting properties and connecting to signals.
+ *  *<!-- -->/
+ * </programlisting>
  */
 
 typedef struct
@@ -410,6 +426,14 @@ egg_dbus_interface_proxy_class_init (EggDBusInterfaceProxyClass *klass)
   g_type_class_add_private (klass, sizeof (EggDBusInterfaceProxyPrivate));
 }
 
+/**
+ * egg_dbus_interface_proxy_get_object_proxy:
+ * @interface_proxy: A #EggDBusInterfaceProxy.
+ *
+ * Gets the object proxy that @interface_proxy is associated with.
+ *
+ * Returns: A #EggDBusObjectProxy. Do not free, the returned object is owned by @interface_proxy.
+ **/
 EggDBusObjectProxy *
 egg_dbus_interface_proxy_get_object_proxy (EggDBusInterfaceProxy *interface_proxy)
 {
@@ -422,6 +446,14 @@ egg_dbus_interface_proxy_get_object_proxy (EggDBusInterfaceProxy *interface_prox
   return klass->get_object_proxy (interface_proxy);
 }
 
+/**
+ * egg_dbus_interface_proxy_get_interface_iface:
+ * @interface_proxy: A #EggDBusInterfaceProxy.
+ *
+ * Gets the D-Bus interface VTable for @interface_proxy.
+ *
+ * Returns: A #EggDBusInterfaceIface.
+ **/
 EggDBusInterfaceIface *
 egg_dbus_interface_proxy_get_interface_iface (EggDBusInterfaceProxy *interface_proxy)
 {
diff --git a/src/eggdbus/eggdbusobjectproxy.c b/src/eggdbus/eggdbusobjectproxy.c
index df16ada..7163fd1 100644
--- a/src/eggdbus/eggdbusobjectproxy.c
+++ b/src/eggdbus/eggdbusobjectproxy.c
@@ -86,7 +86,7 @@
  * To use a D-Bus interface on a #EggDBusObjectProxy instance you will need a #EggDBusInterfaceProxy
  * instance for the D-Bus interface in question. Interface proxies can be obtained using the
  * egg_dbus_object_proxy_query_interface() method. Typically language bindings will provide a
- * way to obtain it; for generated C/GObject code, a macro is generated. For example, to invoke the
+ * way to obtain it; for generated C/GObject code, a macro is provided. For example, to invoke the
  * <literal>Ping</literal> method on the <literal>org.freedesktop.DBus.Peer</literal> interface
  * on a #EggDBusObjectProxy, the #EggDBusPeer interface proxy is used:
  *