[geocode-glib] lib: Update API docs

[Bastien Nocera <hadess src gnome org>]

commit b59dfa1d5e6552a9400d0a28b7786e286fee887e
Author: Bastien Nocera <hadess hadess net>
Date:   Wed May 4 17:23:15 2011 +0100

    lib: Update API docs

 geocode-glib/geocode-error.c |   15 +++++++++++++++
 geocode-glib/geocode-error.h |   17 ++++++++++++++++-
 geocode-glib/geocode-glib.c  |   11 +++++++++++
 3 files changed, 42 insertions(+), 1 deletions(-)
---
diff --git a/geocode-glib/geocode-error.c b/geocode-glib/geocode-error.c
index b7a04cd..5a35ad3 100644
--- a/geocode-glib/geocode-error.c
+++ b/geocode-glib/geocode-error.c
@@ -22,6 +22,21 @@
 
 #include "geocode-error.h"
 
+/**
+ * SECTION:geocode-error
+ * @short_description: Error helper functions
+ * @include: geocode-glib/geocode-glib.h
+ *
+ * Contains helper functions for reporting errors to the user.
+ **/
+
+/**
+ * geocode_error_quark:
+ *
+ * Gets the geocode-glib error quark.
+ *
+ * Return value: a #GQuark.
+ **/
 GQuark
 geocode_error_quark (void)
 {
diff --git a/geocode-glib/geocode-error.h b/geocode-glib/geocode-error.h
index 5e651e1..4ea1177 100644
--- a/geocode-glib/geocode-error.h
+++ b/geocode-glib/geocode-error.h
@@ -27,12 +27,27 @@
 
 G_BEGIN_DECLS
 
+/**
+ * G_IO_ERROR:
+ *
+ * Error domain for geocode-glib. Errors from this domain will be from
+ * the #GeocodeError enumeration.
+ * See #GError for more information on error domains.
+ **/
+#define GEOCODE_ERROR (geocode_error_quark ())
+
+/**
+ * GeocodeError:
+ * @GEOCODE_ERROR_PARSE: An error occured parsing the response from the web service.
+ * @GEOCODE_ERROR_NOT_SUPPORTED: The request made was not supported.
+ *
+ * Error codes returned by geocode-glib functions.
+ **/
 typedef enum {
 	GEOCODE_ERROR_PARSE,
 	GEOCODE_ERROR_NOT_SUPPORTED
 } GeocodeError;
 
-#define GEOCODE_ERROR (geocode_error_quark ())
 
 GQuark geocode_error_quark (void);
 
diff --git a/geocode-glib/geocode-glib.c b/geocode-glib/geocode-glib.c
index 8a73735..8c861e8 100644
--- a/geocode-glib/geocode-glib.c
+++ b/geocode-glib/geocode-glib.c
@@ -27,6 +27,15 @@
 #include <geocode-error.h>
 #include <geocode-glib-private.h>
 
+/**
+ * SECTION:geocode-glib
+ * @short_description: Geocode glib main functions
+ * @include: geocode-glib/geocode-glib.h
+ *
+ * Contains functions for geocoding and reverse geocoding using the
+ * <ulink url="http://developer.yahoo.com/geo/placefinder/guide/requests.html";>Yahoo! Place Finder APIs</ulink>.
+ **/
+
 struct GeocodeObjectPrivate {
 	GHashTable *ht;
 	guint reverse : 1;
@@ -107,6 +116,8 @@ struct {
  * #GHashTable is in the format used by Telepathy, and documented
  * on <ulink url="http://telepathy.freedesktop.org/spec/Connection_Interface_Location.html#Mapping:Location";>Telepathy's specification site</ulink>.
  *
+ * See also: <ulink url="http://xmpp.org/extensions/xep-0080.html";>XEP-0080 specification</ulink>.
+ *
  * Returns: a new #GeocodeObject. Use g_object_unref() when done.
  **/
 GeocodeObject *