From 8af68fb360f7396bff5d89bb6f9ccb3dc2df30ba Mon Sep 17 00:00:00 2001
From: Guido Günther <agx@sigxcpu.org>
Date: Mon, 24 Feb 2014 20:22:23 +0100
Subject: GI annotation and gtk-doc fixup

Fixes gir-scanner warnings like

lpf-loc.h:57: Warning: Lpf: lpf_loc_get_opaque: return value: Missing
(transfer) annotation
---
 src/lpf-loc.c      | 20 ++++++++++++++++++--
 src/lpf-loc.h      |  2 +-
 src/lpf-manager.c  |  1 +
 src/lpf-manager.h  |  2 +-
 src/lpf-provider.c |  6 ++++++
 src/lpf-provider.h |  2 +-
 src/lpf-stop.c     |  6 ++----
 7 files changed, 30 insertions(+), 9 deletions(-)

diff --git a/src/lpf-loc.c b/src/lpf-loc.c
index 3e2aaac..e51e70b 100644
--- a/src/lpf-loc.c
+++ b/src/lpf-loc.c
@@ -179,6 +179,14 @@ lpf_loc_init (LpfLoc *self)
 {
 }
 
+/**
+ * lpf_loc_get_opaque: (skip)
+ * @self: a #LpfLoc
+ *
+ * Get the opaque data stored by a provider.
+ *
+ * Returns: pointer to the opaue data
+ */
 gpointer
 lpf_loc_get_opaque(LpfLoc *self)
 {
@@ -187,10 +195,18 @@ lpf_loc_get_opaque(LpfLoc *self)
     return priv->opaque;
 }
 
-gpointer
+/**
+ * lpf_loc_set_opaque: (skip)
+ * @self: a #LpfLoc
+ * @opaque: pointer to opaque data
+ *
+ * Set the opaque data stored by a provider. The data will
+ * be freed using g_free.
+ */
+void
 lpf_loc_set_opaque(LpfLoc *self, gpointer opaque)
 {
     LpfLocPrivate *priv = GET_PRIVATE (self);
 
-    return priv->opaque = opaque;
+    priv->opaque = opaque;
 }
diff --git a/src/lpf-loc.h b/src/lpf-loc.h
index fa1b15f..ae68a33 100644
--- a/src/lpf-loc.h
+++ b/src/lpf-loc.h
@@ -55,7 +55,7 @@ typedef struct {
 GType lpf_loc_get_type (void);
 /* FIXME: Only used by providers, don't export symbol */
 gpointer lpf_loc_get_opaque (LpfLoc *self);
-gpointer lpf_loc_set_opaque (LpfLoc *self, gpointer opaque);
+void lpf_loc_set_opaque (LpfLoc *self, gpointer opaque);
 
 G_END_DECLS
 
diff --git a/src/lpf-manager.c b/src/lpf-manager.c
index e2692d2..e67ddf5 100644
--- a/src/lpf-manager.c
+++ b/src/lpf-manager.c
@@ -80,6 +80,7 @@ static gchar *plugin_path(const char *name)
 
 /**
  * lpf_manager_get_available_providers:
+ *
  * Returns: (transfer full): List of available providers
  */
 GStrv lpf_manager_get_available_providers(void)
diff --git a/src/lpf-manager.h b/src/lpf-manager.h
index 8ee1b13..323f9d2 100644
--- a/src/lpf-manager.h
+++ b/src/lpf-manager.h
@@ -38,7 +38,7 @@ G_BEGIN_DECLS
 #define LPF_MANAGER_ERROR g_spawn_error_quark ()
 
 /**
- * LpfManagerError
+ * LpfManagerError:
  * @LPF_MANAGER_ERROR_ACTIVATION_FAILED: activation of the provider failed
  *
  * Error codes returned by manager
diff --git a/src/lpf-provider.c b/src/lpf-provider.c
index 871037b..18a6789 100644
--- a/src/lpf-provider.c
+++ b/src/lpf-provider.c
@@ -249,3 +249,9 @@ static void
 lpf_provider_init (LpfProvider *self G_GNUC_UNUSED)
 {
 }
+
+/**
+ * lpf_provider_create: (skip)
+ *
+ * Create the provider
+ */
diff --git a/src/lpf-provider.h b/src/lpf-provider.h
index 1c27183..4f6b07b 100644
--- a/src/lpf-provider.h
+++ b/src/lpf-provider.h
@@ -35,7 +35,7 @@ G_BEGIN_DECLS
 #define LPF_PROVIDER_ERROR g_spawn_error_quark ()
 
 /**
- * LpfProviderError
+ * LpfProviderError:
  * @LPF_PROVIDER_ERROR_REQUEST_FAILED: a request to fetch data from a remote failed
  * @LPF_PROVIDER_ERROR_PARSE_FAILED:   parsing the reply failed
  *
diff --git a/src/lpf-stop.c b/src/lpf-stop.c
index a42806c..3bb4e58 100644
--- a/src/lpf-stop.c
+++ b/src/lpf-stop.c
@@ -116,10 +116,8 @@ lpf_stop_set_property (GObject *object,
     }
 }
 
-/**
- * calc_delay: Calculate the time difference between planned and
- * real time in minutes
- */
+/* calc_delay: Calculate the time difference between planned and real time in
+ * minutes */
 static gint
 calc_delay(GDateTime *planned, GDateTime *real)
 {
-- 
cgit v1.2.3