[geocode-glib] Add missing doc comments

[Zeeshan Ali Khattak <zeeshanak src gnome org>]

commit 38309cb51d45d5d25be613fb1adb0f4eab0df2c8
Author: Zeeshan Ali (Khattak) <zeeshanak gnome org>
Date:   Tue Sep 3 03:04:33 2013 +0300

    Add missing doc comments

 geocode-glib/Makefile.am        |    2 +-
 geocode-glib/geocode-location.c |   41 +++++++++++++++++++++++++++++++++++
 geocode-glib/geocode-location.h |   45 ++++++++++++++++++++++++++++++++++----
 geocode-glib/geocode-place.c    |   33 ++++++++++++++++++++++++++++
 4 files changed, 115 insertions(+), 6 deletions(-)
---
diff --git a/geocode-glib/Makefile.am b/geocode-glib/Makefile.am
index 571896e..9f35c37 100644
--- a/geocode-glib/Makefile.am
+++ b/geocode-glib/Makefile.am
@@ -50,7 +50,7 @@ geocode-enum-types.h: $(GCGLIB_HEADER_FILES)
        $(AM_V_GEN) ($(GLIB_MKENUMS) \
                --fhead "#ifndef __GEOCODE_ENUM_TYPES_H__\n#define __GEOCODE_ENUM_TYPES_H__\n\n#include 
<glib-object.h>\n\nG_BEGIN_DECLS\n" \
                --fprod "/* enumerations from \"@filename \" */\n" \
-               --vhead "GType @enum_name _get_type (void) G_GNUC_CONST;\n#define GEOCODE_TYPE_ ENUMSHORT@ 
(@enum_name _get_type())\n" \
+               --vhead "GType @enum_name _get_type (void) G_GNUC_CONST;\n#define GEOCODE_TYPE_ ENUMSHORT@ 
(@enum_name _get_type())\n\n/**\n * SECTION:geocode-enum-types\n * @short_description: Geocode enumerated 
types\n * @include: geocode-glib/geocode-glib.h\n *\n * The enumerated types defined and used by 
geocode-glib.\n **/" \
                --ftail "G_END_DECLS\n\n#endif /* __GEOCODE_ENUM_TYPES_H__ */" $^ > xgen-$(@F) \
                && mv -f xgen-$(@F) $@)
 
diff --git a/geocode-glib/geocode-location.c b/geocode-glib/geocode-location.c
index 79c0dcf..71008e4 100644
--- a/geocode-glib/geocode-location.c
+++ b/geocode-glib/geocode-location.c
@@ -322,6 +322,7 @@ geocode_location_new_with_description (gdouble     latitude,
 
 /**
  * geocode_location_set_description:
+ * @loc: a #GeocodeLocation
  * @description: a description for the location
  *
  * Sets the description of @loc to @description.
@@ -337,6 +338,14 @@ geocode_location_set_description (GeocodeLocation *loc,
         loc->priv->description = g_strdup (description);
 }
 
+/**
+ * geocode_location_get_description:
+ * @loc: a #GeocodeLocation
+ *
+ * Gets the description of location @loc.
+ *
+ * Returns: The description of location @loc.
+ **/
 const char *
 geocode_location_get_description (GeocodeLocation *loc)
 {
@@ -345,6 +354,14 @@ geocode_location_get_description (GeocodeLocation *loc)
         return loc->priv->description;
 }
 
+/**
+ * geocode_location_get_latitude:
+ * @loc: a #GeocodeLocation
+ *
+ * Gets the latitude of location @loc.
+ *
+ * Returns: The latitude of location @loc.
+ **/
 gdouble
 geocode_location_get_latitude (GeocodeLocation *loc)
 {
@@ -353,6 +370,14 @@ geocode_location_get_latitude (GeocodeLocation *loc)
         return loc->priv->latitude;
 }
 
+/**
+ * geocode_location_get_longitude:
+ * @loc: a #GeocodeLocation
+ *
+ * Gets the longitude of location @loc.
+ *
+ * Returns: The longitude of location @loc.
+ **/
 gdouble
 geocode_location_get_longitude (GeocodeLocation *loc)
 {
@@ -361,6 +386,14 @@ geocode_location_get_longitude (GeocodeLocation *loc)
         return loc->priv->longitude;
 }
 
+/**
+ * geocode_location_get_accuracy:
+ * @loc: a #GeocodeLocation
+ *
+ * Gets the accuracy (in meters) of location @loc.
+ *
+ * Returns: The accuracy of location @loc.
+ **/
 gdouble
 geocode_location_get_accuracy (GeocodeLocation *loc)
 {
@@ -370,6 +403,14 @@ geocode_location_get_accuracy (GeocodeLocation *loc)
         return loc->priv->accuracy;
 }
 
+/**
+ * geocode_location_get_timestamp:
+ * @loc: a #GeocodeLocation
+ *
+ * Gets the timestamp (in seconds since Epoc) of location @loc.
+ *
+ * Returns: The timestamp of location @loc.
+ **/
 guint64
 geocode_location_get_timestamp (GeocodeLocation *loc)
 {
diff --git a/geocode-glib/geocode-location.h b/geocode-glib/geocode-location.h
index 762b215..6e1e8bf 100644
--- a/geocode-glib/geocode-location.h
+++ b/geocode-glib/geocode-location.h
@@ -62,11 +62,46 @@ struct _GeocodeLocationClass {
         GObjectClass parent_class;
 };
 
-#define GEOCODE_LOCATION_ACCURACY_UNKNOWN   -1
-#define GEOCODE_LOCATION_ACCURACY_STREET    1000    /*    1 km */
-#define GEOCODE_LOCATION_ACCURACY_CITY      15000   /*   15 km */
-#define GEOCODE_LOCATION_ACCURACY_REGION    50000   /*   50 km */
-#define GEOCODE_LOCATION_ACCURACY_COUNTRY   300000  /*  300 km */
+/**
+ * GEOCODE_LOCATION_ACCURACY_UNKNOWN:
+ *
+ * Constant representing unknown accuracy.
+ */
+#define GEOCODE_LOCATION_ACCURACY_UNKNOWN -1
+
+/**
+ * GEOCODE_LOCATION_ACCURACY_STREET:
+ *
+ * Constant representing street-level accuracy.
+ */
+#define GEOCODE_LOCATION_ACCURACY_STREET 1000 /* 1 km */
+
+/**
+ * GEOCODE_LOCATION_ACCURACY_CITY:
+ *
+ * Constant representing city-level accuracy.
+ */
+#define GEOCODE_LOCATION_ACCURACY_CITY 15000 /* 15 km */
+
+/**
+ * GEOCODE_LOCATION_ACCURACY_REGION:
+ *
+ * Constant representing region-level accuracy.
+ */
+#define GEOCODE_LOCATION_ACCURACY_REGION 50000 /* 50 km */
+
+/**
+ * GEOCODE_LOCATION_ACCURACY_COUNTRY:
+ *
+ * Constant representing country-level accuracy.
+ */
+#define GEOCODE_LOCATION_ACCURACY_COUNTRY 300000 /* 300 km */
+
+/**
+ * GEOCODE_LOCATION_ACCURACY_CONTINENT:
+ *
+ * Constant representing continent-level accuracy.
+ */
 #define GEOCODE_LOCATION_ACCURACY_CONTINENT 3000000 /* 3000 km */
 
 #define GEOCODE_TYPE_LOCATION (geocode_location_get_type ())
diff --git a/geocode-glib/geocode-place.c b/geocode-glib/geocode-place.c
index fc7e782..6eaa094 100644
--- a/geocode-glib/geocode-place.c
+++ b/geocode-glib/geocode-place.c
@@ -558,6 +558,7 @@ geocode_place_new_with_location (const char      *name,
 /**
  * geocode_place_set_name:
  * @place: A place
+ * @name: the name of place
  *
  * Sets the name of the @place to @name.
  **/
@@ -577,6 +578,8 @@ geocode_place_set_name (GeocodePlace *place,
  * @place: A place
  *
  * Gets the name of the @place.
+ *
+ * Returns: The name of the @place.
  **/
 const char *
 geocode_place_get_name (GeocodePlace *place)
@@ -591,6 +594,8 @@ geocode_place_get_name (GeocodePlace *place)
  * @place: A place
  *
  * Gets the type of the @place.
+ *
+ * Returns: The type of the @place.
  **/
 GeocodePlaceType
 geocode_place_get_place_type (GeocodePlace *place)
@@ -623,6 +628,8 @@ geocode_place_set_location (GeocodePlace *place,
  * geocode_place_get_location:
  * @place: A place
  *
+ * Gets the associated location object.
+ *
  * Returns: (transfer none): The associated location object.
  **/
 GeocodeLocation *
@@ -656,6 +663,8 @@ geocode_place_set_street_address (GeocodePlace *place,
  * @place: A place
  *
  * Gets the street address of the @place.
+ *
+ * Returns: The street address of the @place.
  **/
 const char *
 geocode_place_get_street_address (GeocodePlace *place)
@@ -688,6 +697,8 @@ geocode_place_set_street (GeocodePlace *place,
  * @place: A place
  *
  * Gets the street of the @place.
+ *
+ * Returns: The street of the @place.
  **/
 const char *
 geocode_place_get_street (GeocodePlace *place)
@@ -720,6 +731,8 @@ geocode_place_set_building (GeocodePlace *place,
  * @place: A place
  *
  * Gets the building of the @place.
+ *
+ * Returns: The building of the @place.
  **/
 const char *
 geocode_place_get_building (GeocodePlace *place)
@@ -752,6 +765,8 @@ geocode_place_set_postal_code (GeocodePlace *place,
  * @place: A place
  *
  * Gets the postal code of the @place.
+ *
+ * Returns: The postal code of the @place.
  **/
 const char *
 geocode_place_get_postal_code (GeocodePlace *place)
@@ -784,6 +799,8 @@ geocode_place_set_area (GeocodePlace *place,
  * @place: A place
  *
  * Gets the area of the @place.
+ *
+ * Returns: The area of the @place.
  **/
 const char *
 geocode_place_get_area (GeocodePlace *place)
@@ -816,6 +833,8 @@ geocode_place_set_town (GeocodePlace *place,
  * @place: A place
  *
  * Gets the town of the @place.
+ *
+ * Returns: The town of the @place.
  **/
 const char *
 geocode_place_get_town (GeocodePlace *place)
@@ -848,6 +867,8 @@ geocode_place_set_county (GeocodePlace *place,
  * @place: A place
  *
  * Gets the county of the @place.
+ *
+ * Returns: The country of the @place.
  **/
 const char *
 geocode_place_get_county (GeocodePlace *place)
@@ -880,6 +901,8 @@ geocode_place_set_state (GeocodePlace *place,
  * @place: A place
  *
  * Gets the state of the @place.
+ *
+ * Returns: The state of the @place.
  **/
 const char *
 geocode_place_get_state (GeocodePlace *place)
@@ -912,6 +935,8 @@ geocode_place_set_administrative_area (GeocodePlace *place,
  * @place: A place
  *
  * Gets the local administrative area of the @place.
+ *
+ * Returns: The local administrative area of the @place.
  **/
 const char *
 geocode_place_get_administrative_area (GeocodePlace *place)
@@ -944,6 +969,8 @@ geocode_place_set_country_code (GeocodePlace *place,
  * @place: A place
  *
  * Gets the ISO country code of the @place.
+ *
+ * Returns: The ISO country code of the @place.
  **/
 const char *
 geocode_place_get_country_code (GeocodePlace *place)
@@ -976,6 +1003,8 @@ geocode_place_set_country (GeocodePlace *place,
  * @place: A place
  *
  * Gets the country of the @place.
+ *
+ * Returns: The country of the @place.
  **/
 const char *
 geocode_place_get_country (GeocodePlace *place)
@@ -1008,6 +1037,8 @@ geocode_place_set_continent (GeocodePlace *place,
  * @place: A place
  *
  * Gets the continent of the @place.
+ *
+ * Returns: The continent of the @place.
  **/
 const char *
 geocode_place_get_continent (GeocodePlace *place)
@@ -1022,6 +1053,8 @@ geocode_place_get_continent (GeocodePlace *place)
  * @place: A place
  *
  * Gets the #GIcon representing the @place.
+ *
+ * Returns: (transfer none): The #GIcon representing the @place.
  **/
 GIcon *
 geocode_place_get_icon (GeocodePlace *place)