[geocode-glib/bilelmoussaoui/gi-docgen: 3/9] docs: use inline docs for private types

[Bilal Elmoussaoui <bilelmoussaoui src gnome org>]

commit e51e557dcfc57d0e37d8aa596d7b40fa63fa02bf
Author: Bilal Elmoussaoui <bil elmoussaoui gmail com>
Date:   Fri Jan 14 13:05:53 2022 +0100

    docs: use inline docs for private types
    
    Otherwise they interfere with the docs from the public type.
    Which ends up causing gobject-introspection to pick the former instead of the later docs

 geocode-glib/geocode-backend.h      |  9 +--------
 geocode-glib/geocode-bounding-box.h |  7 +------
 geocode-glib/geocode-forward.h      |  6 +-----
 geocode-glib/geocode-location.h     |  6 +-----
 geocode-glib/geocode-mock-backend.h | 19 ++++++-------------
 geocode-glib/geocode-nominatim.h    |  9 +--------
 geocode-glib/geocode-place.h        |  6 +-----
 geocode-glib/geocode-reverse.h      |  6 +-----
 8 files changed, 13 insertions(+), 55 deletions(-)
---
diff --git a/geocode-glib/geocode-backend.h b/geocode-glib/geocode-backend.h
index da19068..00bcdc4 100644
--- a/geocode-glib/geocode-backend.h
+++ b/geocode-glib/geocode-backend.h
@@ -31,14 +31,7 @@
 
 G_BEGIN_DECLS
 
-/**
- * GeocodeBackend:
- *
- * All the fields in the #GeocodeBackend structure are private and should
- * never be accessed directly.
- *
- * Since: 3.23.1
- */
+// All the fields in the #GeocodeBackend structure are private and should never be accessed directly.
 #define GEOCODE_TYPE_BACKEND (geocode_backend_get_type ())
 G_DECLARE_INTERFACE (GeocodeBackend, geocode_backend, GEOCODE, BACKEND, GObject)
 
diff --git a/geocode-glib/geocode-bounding-box.h b/geocode-glib/geocode-bounding-box.h
index 5c84234..a242e84 100644
--- a/geocode-glib/geocode-bounding-box.h
+++ b/geocode-glib/geocode-bounding-box.h
@@ -41,12 +41,7 @@ typedef struct _GeocodeBoundingBox        GeocodeBoundingBox;
 typedef struct _GeocodeBoundingBoxClass   GeocodeBoundingBoxClass;
 typedef struct _GeocodeBoundingBoxPrivate GeocodeBoundingBoxPrivate;
 
-/**
- * GeocodeBoundingBox:
- *
- * All the fields in the #GeocodeLocation structure are private and should
- * never be accessed directly.
-**/
+// All the fields in the #GeocodeBoundingBox structure are private and should never be accessed directly.
 struct _GeocodeBoundingBox {
     /* <private> */
     GObject parent_instance;
diff --git a/geocode-glib/geocode-forward.h b/geocode-glib/geocode-forward.h
index c17e558..8b3c319 100644
--- a/geocode-glib/geocode-forward.h
+++ b/geocode-glib/geocode-forward.h
@@ -40,11 +40,7 @@ GType geocode_forward_get_type (void) G_GNUC_CONST;
 #define GEOCODE_IS_FORWARD_CLASS(klass)       (G_TYPE_CHECK_CLASS_TYPE ((klass), GEOCODE_TYPE_FORWARD))
 #define GEOCODE_FORWARD_GET_CLASS(obj)        (G_TYPE_INSTANCE_GET_CLASS ((obj), GEOCODE_TYPE_FORWARD, 
GeocodeForwardClass))
 
-/**
- * GeocodeForward:
- *
- * All the fields in the #GeocodeForward structure are private and should never be accessed directly.
-**/
+// All the fields in the #GeocodeForward structure are private and should never be accessed directly.
 typedef struct _GeocodeForward        GeocodeForward;
 typedef struct _GeocodeForwardClass   GeocodeForwardClass;
 typedef struct _GeocodeForwardPrivate GeocodeForwardPrivate;
diff --git a/geocode-glib/geocode-location.h b/geocode-glib/geocode-location.h
index 8b4f8ff..98341bb 100644
--- a/geocode-glib/geocode-location.h
+++ b/geocode-glib/geocode-location.h
@@ -41,11 +41,7 @@ typedef struct _GeocodeLocation        GeocodeLocation;
 typedef struct _GeocodeLocationClass   GeocodeLocationClass;
 typedef struct _GeocodeLocationPrivate GeocodeLocationPrivate;
 
-/**
- * GeocodeLocation:
- *
- * All the fields in the #GeocodeLocation structure are private and should never be accessed directly.
-**/
+// All the fields in the #GeocodeLocation structure are private and should never be accessed directly.
 struct _GeocodeLocation {
         /* <private> */
         GObject parent_instance;
diff --git a/geocode-glib/geocode-mock-backend.h b/geocode-glib/geocode-mock-backend.h
index 5d9795f..72f4715 100644
--- a/geocode-glib/geocode-mock-backend.h
+++ b/geocode-glib/geocode-mock-backend.h
@@ -27,14 +27,7 @@
 
 G_BEGIN_DECLS
 
-/**
- * GeocodeMockBackend:
- *
- * All the fields in the #GeocodeMockBackend structure are private and should
- * never be accessed directly.
- *
- * Since: 3.23.1
- */
+// All the fields in the #GeocodeMockBackend structure are private and should never be accessed directly.
 #define GEOCODE_TYPE_MOCK_BACKEND (geocode_mock_backend_get_type ())
 G_DECLARE_FINAL_TYPE (GeocodeMockBackend, geocode_mock_backend,
                       GEOCODE, MOCK_BACKEND, GObject)
@@ -62,17 +55,17 @@ void geocode_mock_backend_clear              (GeocodeMockBackend *self);
 
 /**
  * GeocodeMockBackendQuery:
- * @params: query parameters, in the format accepted by geocode_forward_search()
- *     (if @is_forward is %TRUE) or geocode_reverse_resolve() (otherwise)
- * @is_forward: %TRUE if this represents a call to geocode_forward_search();
- *     %FALSE if it represents a call to geocode_reverse_resolve()
+ * @params: query parameters, in the format accepted by [method@Forward.search]
+ *     (if @is_forward is %TRUE) or [method@Reverse.resolve] (otherwise)
+ * @is_forward: %TRUE if this represents a call to [method@Forward.search];
+ *     %FALSE if it represents a call to [method@Reverse.resolve]
  * @results: (nullable) (element-type GeocodePlace): results returned by the
  *     query, or %NULL if an error was returned
  * @error: (nullable): error returned by the query, or %NULL if a result set
  *     was returned
  *
  * The details of a forward or reverse query which was performed on a
- * #GeocodeMockBackend by application code. This includes the input (@params,
+ * [class@MockBackend] by application code. This includes the input (@params,
  * @is_forward), and the output which was returned (@results or @error).
  *
  * Empty result sets are represented by the %GEOCODE_ERROR_NO_MATCHES error
diff --git a/geocode-glib/geocode-nominatim.h b/geocode-glib/geocode-nominatim.h
index a2b3926..08e2b66 100644
--- a/geocode-glib/geocode-nominatim.h
+++ b/geocode-glib/geocode-nominatim.h
@@ -31,14 +31,7 @@
 
 G_BEGIN_DECLS
 
-/**
- * GeocodeNominatim:
- *
- * All the fields in the #GeocodeNominatim structure are private and should
- * never be accessed directly.
- *
- * Since: 3.23.1
- */
+// All the fields in the #GeocodeNominatim structure are private and should never be accessed directly.
 #define GEOCODE_TYPE_NOMINATIM (geocode_nominatim_get_type ())
 G_DECLARE_DERIVABLE_TYPE (GeocodeNominatim, geocode_nominatim, GEOCODE, NOMINATIM, GObject)
 
diff --git a/geocode-glib/geocode-place.h b/geocode-glib/geocode-place.h
index b661494..5dca4a2 100644
--- a/geocode-glib/geocode-place.h
+++ b/geocode-glib/geocode-place.h
@@ -44,11 +44,7 @@ typedef struct _GeocodePlace        GeocodePlace;
 typedef struct _GeocodePlaceClass   GeocodePlaceClass;
 typedef struct _GeocodePlacePrivate GeocodePlacePrivate;
 
-/**
- * GeocodePlace:
- *
- * All the fields in the #GeocodePlace structure are private and should never be accessed directly.
-**/
+// All the fields in the #GeocodePlace structure are private and should never be accessed directly.
 struct _GeocodePlace {
         /* <private> */
         GObject parent_instance;
diff --git a/geocode-glib/geocode-reverse.h b/geocode-glib/geocode-reverse.h
index 98b2cff..08aa25c 100644
--- a/geocode-glib/geocode-reverse.h
+++ b/geocode-glib/geocode-reverse.h
@@ -39,11 +39,7 @@ GType geocode_reverse_get_type (void) G_GNUC_CONST;
 #define GEOCODE_IS_REVERSE_CLASS(klass)      (G_TYPE_CHECK_CLASS_TYPE ((klass), GEOCODE_TYPE_REVERSE))
 #define GEOCODE_REVERSE_GET_CLASS(obj)       (G_TYPE_INSTANCE_GET_CLASS ((obj), GEOCODE_TYPE_REVERSE, 
GeocodeReverseClass))
 
-/**
- * GeocodeReverse:
- *
- * All the fields in the #GeocodeReverse structure are private and should never be accessed directly.
-**/
+// All the fields in the #GeocodeReverse structure are private and should never be accessed directly.
 typedef struct _GeocodeReverse        GeocodeReverse;
 typedef struct _GeocodeReverseClass   GeocodeReverseClass;
 typedef struct _GeocodeReversePrivate GeocodeReversePrivate;