[retro-gtk/c-port: 40/42] Documentation fixes
- From: Adrien Plazas <aplazas src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [retro-gtk/c-port: 40/42] Documentation fixes
- Date: Wed, 4 Oct 2017 05:25:45 +0000 (UTC)
commit 37f43dcdc59ebdc90bf420a7ec00fcae44e8f724
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 | 13 +++++++++++++
retro-gtk/retro-module-query.c | 8 +++++++-
4 files changed, 41 insertions(+), 1 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 5a0045f..1ad7134 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)
{
@@ -307,6 +313,13 @@ retro_module_iterator_next (RetroModuleIterator *self)
return FALSE;
}
+/**
+ * retro_module_iterator_new:
+ * @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 #RetroModuleIterator
+ */
RetroModuleIterator *
retro_module_iterator_new (gchar **lookup_paths,
gboolean recursive)
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;
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]