[geocode-glib] docs: Document some GEOCODE_TYPE_* macros



commit 618b8c228c695cfea7d9b7b977ad2996ea2eeae1
Author: Philip Withnall <withnall endlessm com>
Date:   Wed Jan 25 14:18:54 2017 +0000

    docs: Document some GEOCODE_TYPE_* macros
    
    Normally these don’t need to be documented, but gtk-doc wants
    documentation comments for these ones for some reason. This is probably
    a bug in how gtk-doc detects whether a symbol is interesting
    (potentially due to use of G_DECLARE_[DERIVABLE|FINAL]_TYPE?). Once it’s
    fixed in gtk-doc upstream, we can remove these documentation comments.
    
    https://bugzilla.gnome.org/show_bug.cgi?id=777745

 geocode-glib/geocode-backend.h      |    8 ++++++++
 geocode-glib/geocode-mock-backend.h |    8 ++++++++
 geocode-glib/geocode-nominatim.h    |    8 ++++++++
 3 files changed, 24 insertions(+), 0 deletions(-)
---
diff --git a/geocode-glib/geocode-backend.h b/geocode-glib/geocode-backend.h
index 729f268..c4a05fb 100644
--- a/geocode-glib/geocode-backend.h
+++ b/geocode-glib/geocode-backend.h
@@ -43,6 +43,14 @@ G_BEGIN_DECLS
 G_DECLARE_INTERFACE (GeocodeBackend, geocode_backend, GEOCODE, BACKEND, GObject)
 
 /**
+ * GEOCODE_TYPE_BACKEND:
+ *
+ * See #GeocodeBackend.
+ *
+ * Since: 3.23.1
+ */
+
+/**
  * GeocodeBackendInterface:
  * @forward_search: handles a synchronous forward geocoding request.
  * @forward_search_async: starts an asynchronous forward geocoding request.
diff --git a/geocode-glib/geocode-mock-backend.h b/geocode-glib/geocode-mock-backend.h
index d3c4c42..1bc3f67 100644
--- a/geocode-glib/geocode-mock-backend.h
+++ b/geocode-glib/geocode-mock-backend.h
@@ -39,6 +39,14 @@ G_BEGIN_DECLS
 G_DECLARE_FINAL_TYPE (GeocodeMockBackend, geocode_mock_backend,
                       GEOCODE, MOCK_BACKEND, GObject)
 
+/**
+ * GEOCODE_TYPE_MOCK_BACKEND:
+ *
+ * See #GeocodeMockBackend.
+ *
+ * Since: 3.23.1
+ */
+
 GeocodeMockBackend *geocode_mock_backend_new (void);
 
 void geocode_mock_backend_add_forward_result (GeocodeMockBackend *self,
diff --git a/geocode-glib/geocode-nominatim.h b/geocode-glib/geocode-nominatim.h
index 5410306..05e3e8f 100644
--- a/geocode-glib/geocode-nominatim.h
+++ b/geocode-glib/geocode-nominatim.h
@@ -43,6 +43,14 @@ G_BEGIN_DECLS
 G_DECLARE_DERIVABLE_TYPE (GeocodeNominatim, geocode_nominatim, GEOCODE, NOMINATIM, GObject)
 
 /**
+ * GEOCODE_TYPE_NOMINATIM:
+ *
+ * See #GeocodeNominatim.
+ *
+ * Since: 3.23.1
+ */
+
+/**
  * GeocodeNominatimClass:
  * @query: synchronous query function to override network `GET` requests.
  * @query_async: asynchronous version of @query.


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