[retro-gtk/c-port: 37/37] Documentation fixes

[Adrien Plazas <aplazas src gnome org>]

commit 87600d587a7f2a29f796f15b73d888ceabdda254
Author: Adrien Plazas <kekun plazas laposte net>
Date:   Tue Sep 26 15:46:18 2017 +0200

    Documentation fixes

 retro-gtk/retro-core-view.c       |   15 +++++++++++++++
 retro-gtk/retro-main-loop.c       |    6 ++++++
 retro-gtk/retro-module-iterator.c |    8 +++++++-
 retro-gtk/retro-module-iterator.h |    4 ----
 retro-gtk/retro-module-query.c    |    8 +++++++-
 5 files changed, 35 insertions(+), 6 deletions(-)
---
diff --git a/retro-gtk/retro-core-view.c b/retro-gtk/retro-core-view.c
index 6b35bac..92d3893 100644
--- a/retro-gtk/retro-core-view.c
+++ b/retro-gtk/retro-core-view.c
@@ -553,6 +553,12 @@ retro_core_view_set_pixbuf (RetroCoreView *self,
     g_object_notify_by_pspec (G_OBJECT (self), properties[PROP_PIXBUF]);
 }
 
+/**
+ * retro_core_view_get_pixbuf:
+ * @self: a #RetroCoreView
+ *
+ * Returns: (transfer none):A #GdkPixbuf
+ */
 GdkPixbuf *
 retro_core_view_get_pixbuf (RetroCoreView *self)
 {
@@ -586,6 +592,15 @@ retro_core_view_hide_video (RetroCoreView *self)
   retro_cairo_display_hide_video (self->display);
 }
 
+/**
+ * retro_core_view_as_input_device:
+ * @self: a #RetroCoreView
+ * @device_type: a #RetroDeviceType
+ *
+ * Exposes @self as a #RetroInputDevice of the requested type.
+ *
+ * Returns: (transfer full):A new #RetroInputDevice
+ */
 RetroInputDevice *
 retro_core_view_as_input_device (RetroCoreView   *self,
                                  RetroDeviceType  device_type)
diff --git a/retro-gtk/retro-main-loop.c b/retro-gtk/retro-main-loop.c
index 8973bd4..b7da670 100644
--- a/retro-gtk/retro-main-loop.c
+++ b/retro-gtk/retro-main-loop.c
@@ -194,6 +194,12 @@ retro_main_loop_get_speed_rate (RetroMainLoop *self)
   return self->speed_rate;
 }
 
+/**
+ * retro_main_loop_get_core:
+ * @self: a #RetroMainLoop
+ *
+ * Returns: (transfer none):A new #RetroCore
+ */
 RetroCore *
 retro_main_loop_get_core (RetroMainLoop *self)
 {
diff --git a/retro-gtk/retro-module-iterator.c b/retro-gtk/retro-module-iterator.c
index 5de815f..086c289 100644
--- a/retro-gtk/retro-module-iterator.c
+++ b/retro-gtk/retro-module-iterator.c
@@ -261,6 +261,12 @@ retro_module_iterator_next_in_current_path (RetroModuleIterator  *self,
 
 /* Public */
 
+/**
+ * retro_module_iterator_get:
+ * @self: a #RetroModuleIterator
+ *
+ * Returns: (nullable) (transfer full):A #RetroCoreDescriptor or %NULL
+ */
 RetroCoreDescriptor *
 retro_module_iterator_get (RetroModuleIterator *self)
 {
@@ -312,7 +318,7 @@ retro_module_iterator_next (RetroModuleIterator *self)
  * @lookup_paths: (array zero-terminated=1): paths where to look for Libretro cores
  * @recursive: whether to look recursively into the sub-directories
  *
- * Returns: A new #ModuleIterator
+ * Returns: A new #RetroModuleIterator
  */
 RetroModuleIterator *
 retro_module_iterator_new (const gchar * const *lookup_paths,
diff --git a/retro-gtk/retro-module-iterator.h b/retro-gtk/retro-module-iterator.h
index db93627..0cb9161 100644
--- a/retro-gtk/retro-module-iterator.h
+++ b/retro-gtk/retro-module-iterator.h
@@ -4,14 +4,10 @@
 #define RETRO_MODULE_ITERATOR_H
 
 #include <glib-object.h>
-
 #include "retro-core-descriptor.h"
 
 G_BEGIN_DECLS
 
-// FIXME Remove as soon as possible.
-typedef struct _RetroCoreDescriptor RetroCoreDescriptor;
-
 #define RETRO_TYPE_MODULE_ITERATOR (retro_module_iterator_get_type())
 
 G_DECLARE_FINAL_TYPE (RetroModuleIterator, retro_module_iterator, RETRO, MODULE_ITERATOR, GObject)
diff --git a/retro-gtk/retro-module-query.c b/retro-gtk/retro-module-query.c
index da5c2c8..acae6cb 100644
--- a/retro-gtk/retro-module-query.c
+++ b/retro-gtk/retro-module-query.c
@@ -59,6 +59,12 @@ retro_module_query_get_plugin_lookup_paths ()
 
 /* Public */
 
+/**
+ * retro_module_query_iterator:
+ * @self: a #RetroModuleQuery
+ *
+ * Returns: (transfer full):A new #RetroModuleIterator
+ */
 RetroModuleIterator *
 retro_module_query_iterator (RetroModuleQuery *self)
 {
@@ -68,7 +74,7 @@ retro_module_query_iterator (RetroModuleQuery *self)
   g_return_val_if_fail (RETRO_IS_MODULE_ITERATOR (self), NULL);
 
   paths = retro_module_query_get_plugin_lookup_paths ();
-  result = retro_module_iterator_new (paths, self->recursive);
+  result = retro_module_iterator_new ((const gchar * const *) paths, self->recursive);
   g_strfreev (paths);
 
   return result;