[geocode-glib] forward: Document geo URI scheme usage



commit 538e625aac0fae7ea65c0187920cd03a807ecddd
Author: Jonas Danielsson <jonas threetimestwo org>
Date:   Tue Apr 8 22:24:44 2014 +0200

    forward: Document geo URI scheme usage
    
    https://bugzilla.gnome.org/show_bug.cgi?id=727861

 geocode-glib/geocode-location.c |   11 +++++++++++
 1 files changed, 11 insertions(+), 0 deletions(-)
---
diff --git a/geocode-glib/geocode-location.c b/geocode-glib/geocode-location.c
index 3a0aa9f..cbeda32 100644
--- a/geocode-glib/geocode-location.c
+++ b/geocode-glib/geocode-location.c
@@ -648,6 +648,17 @@ geocode_location_new_with_description (gdouble     latitude,
  *
  * Initialize a #GeocodeLocation object with the given @uri.
  *
+ * The URI should be in the geo scheme (RFC 5870) which in its simplest form
+ * looks like:
+ *
+ * - geo:latitude,longitude
+ *
+ * An <ulink
+ * url="http://developer.android.com/guide/components/intents-common.html#Maps";>
+ * Android extension</ulink> to set a description is also supported in the form of:
+ *
+ * - geo:0,0?q=latitude,longitude(description)
+ *
  * Returns: %TRUE on success and %FALSE on error.
  **/
 gboolean


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]