[retro-gtk/core-fixes: 1/8] core: Document the iterated signal

[Adrien Plazas <aplazas src gnome org>]

commit 148fae5035c3de1607518e205a0d18e18152613a
Author: Adrien Plazas <kekun plazas laposte net>
Date:   Sun Feb 16 08:13:44 2020 +0100

    core: Document the iterated signal

 retro-runner/retro-core.c | 10 ++++++++++
 1 file changed, 10 insertions(+)
---
diff --git a/retro-runner/retro-core.c b/retro-runner/retro-core.c
index c96ba19..13a4a0a 100644
--- a/retro-runner/retro-core.c
+++ b/retro-runner/retro-core.c
@@ -512,6 +512,16 @@ retro_core_class_init (RetroCoreClass *klass)
                   G_TYPE_ULONG,
                   G_TYPE_DOUBLE);
 
+  /**
+   * RetroCore::iterated:
+   * @self: the #RetroCore
+   *
+   * The ::iterated signal is emitted at the end of a core's iteration.
+   *
+   * When ::runahead is > 0 and the core is iterated over multiple times
+   * internally, ::iterated will be emitted only once, after the perceived
+   * iteration is completed.
+   */
   signals[SIG_ITERATED_SIGNAL] =
     g_signal_new ("iterated", RETRO_TYPE_CORE, G_SIGNAL_RUN_LAST,
                   0, NULL, NULL,