[geocode-glib] docs: Add a section overview for geocode-nominatim



commit 7aaf923b9814d02d11b3b91a7d6d8a2bca910472
Author: Philip Withnall <withnall endlessm com>
Date:   Wed Jan 25 14:18:30 2017 +0000

    docs: Add a section overview for geocode-nominatim
    
    gtk-doc’s checks were fretting about it being missing.
    
    https://bugzilla.gnome.org/show_bug.cgi?id=777745

 geocode-glib/geocode-nominatim.c |   14 ++++++++++++++
 1 files changed, 14 insertions(+), 0 deletions(-)
---
diff --git a/geocode-glib/geocode-nominatim.c b/geocode-glib/geocode-nominatim.c
index 41227d2..c1c2e6b 100644
--- a/geocode-glib/geocode-nominatim.c
+++ b/geocode-glib/geocode-nominatim.c
@@ -32,6 +32,20 @@
 #include "geocode-glib.h"
 #include "geocode-nominatim.h"
 
+/**
+ * SECTION:geocode-nominatim
+ * @short_description: Geocoding resolver using a Nominatim web service
+ * @include: geocode-glib/geocode-glib.h
+ *
+ * Contains functions for geocoding using the
+ * [OSM Nominatim APIs](http://wiki.openstreetmap.org/wiki/Nominatim) exposed
+ * by a Nominatim server at a given URI. By default, the GNOME Nominatim server
+ * is used, but other server details may be given when constructing a
+ * #GeocodeNominatim.
+ *
+ * Since: 3.23.1
+ */
+
 typedef enum {
        PROP_BASE_URL = 1,
        PROP_MAINTAINER_EMAIL_ADDRESS,


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