[retro-gtk/build-doc] fixes

[Adrien Plazas <aplazas src gnome org>]

commit 71fc47eac4c2057a9f0520514d5cdff35ebca184
Author: Adrien Plazas <kekun plazas laposte net>
Date:   Mon Apr 13 11:32:56 2020 +0200

    fixes

 doc/meson.build                   | 19 ++++++++++++++++++-
 doc/retro-gtk-doc.xml             |  5 +++--
 retro-gtk/retro-cairo-display.c   |  8 ++++++++
 retro-gtk/retro-core-descriptor.c |  7 +++++++
 retro-gtk/retro-core-view.c       |  7 +++++++
 retro-gtk/retro-core.c            |  7 +++++++
 retro-gtk/retro-gl-display.c      |  8 ++++++++
 retro-gtk/retro-gtk-version.h.in  |  5 +----
 retro-gtk/retro-log.c             | 13 +++++++++++--
 retro-gtk/retro-option.c          |  7 +++++++
 retro-gtk/retro-pixbuf.c          |  9 +++++++++
 retro-gtk/retro-video-filter.c    |  7 +++++++
 12 files changed, 93 insertions(+), 9 deletions(-)
---
diff --git a/doc/meson.build b/doc/meson.build
index a31f67b..3fe17ea 100644
--- a/doc/meson.build
+++ b/doc/meson.build
@@ -5,6 +5,23 @@ gtk_docpath = gtk.get_pkgconfig_variable('prefix') / 'share' / 'gtk-doc' / 'html
 docpath = get_option('datadir') / 'gtk-doc' / 'html'
 
 private_headers = [
+  'ipc-runner-private.h',
+  'retro-cairo-display-private.h',
+  'retro-controller-iterator-private.h',
+  'retro-controller-state-private.h',
+  'retro-core-view-controller-private.h',
+  'retro-framebuffer-private.h',
+  'retro-gl-display-private.h',
+  'retro-glsl-filter-private.h',
+  'retro-input-private.h',
+  'retro-keyboard-key-private.h',
+  'retro-keyboard-private.h',
+  'retro-memfd-private.h',
+  'retro-option-iterator-private.h',
+  'retro-option-private.h',
+  'retro-pixdata-private.h',
+  'retro-pixel-format-private.h',
+  'retro-runner-process-private.h',
 ]
 
 content_files = [
@@ -19,11 +36,11 @@ gnome.gtkdoc(
     meson.source_root() / 'shared',
     meson.build_root()  / 'shared',
   ],
+  ignore_headers: private_headers,
   dependencies: retro_gtk_dep,
   gobject_typesfile: 'retro-gtk.types',
   scan_args: [
     '--rebuild-types',
-    '--ignore-headers=' + ' '.join(private_headers),
   ],
   mkdb_args: [
     '--default-includes=retro-gtk/retro-gtk.h',
diff --git a/doc/retro-gtk-doc.xml b/doc/retro-gtk-doc.xml
index 79a666d..252cefb 100644
--- a/doc/retro-gtk-doc.xml
+++ b/doc/retro-gtk-doc.xml
@@ -39,13 +39,11 @@
     <xi:include href="xml/retro-core.xml"/>
     <xi:include href="xml/retro-input.xml"/>
     <xi:include href="xml/retro-key-joypad-mapping.xml"/>
-    <xi:include href="xml/retro-log.xml"/>
     <xi:include href="xml/retro-memory-type.xml"/>
     <xi:include href="xml/retro-module-iterator.xml"/>
     <xi:include href="xml/retro-module-query.xml"/>
     <xi:include href="xml/retro-option-iterator.xml"/>
     <xi:include href="xml/retro-option.xml"/>
-    <xi:include href="xml/retro-pixbuf.xml"/>
     <xi:include href="xml/retro-pixdata.xml"/>
     <xi:include href="xml/retro-rumble-effect.xml"/>
     <xi:include href="xml/retro-video-filter.xml"/>
@@ -54,6 +52,9 @@
   <chapter id="helpers">
     <title>Helpers</title>
     <xi:include href="xml/retro-gtk-version.xml"/>
+
+    <xi:include href="xml/retro-log.xml"/>
+    <xi:include href="xml/retro-pixbuf.xml"/>
   </chapter>
 
   <chapter id="object-tree">
diff --git a/retro-gtk/retro-cairo-display.c b/retro-gtk/retro-cairo-display.c
index 1fbbbcd..3c1bb70 100644
--- a/retro-gtk/retro-cairo-display.c
+++ b/retro-gtk/retro-cairo-display.c
@@ -5,6 +5,14 @@
 #include "retro-pixbuf.h"
 #include "retro-pixdata.h"
 
+/**
+ * PRIVATE:retro-cairo-display
+ * @short_description: A widget rendering the video output from a core via Cairo
+ * @title: RetroCairoDisplay
+ * @See_also: #RetroGLDisplay
+ * @stability: Private
+ */
+
 struct _RetroCairoDisplay
 {
   GtkDrawingArea parent_instance;
diff --git a/retro-gtk/retro-core-descriptor.c b/retro-gtk/retro-core-descriptor.c
index 5e3dae2..bc12b0f 100644
--- a/retro-gtk/retro-core-descriptor.c
+++ b/retro-gtk/retro-core-descriptor.c
@@ -2,6 +2,13 @@
 
 #include "retro-core-descriptor.h"
 
+/**
+ * SECTION:retro-core-desciptor
+ * @short_description: An object describing the capabilities and requirements of a Libretro core
+ * @title: RetroCoreDescriptor
+ * @See_also: #RetroGore
+ */
+
 struct _RetroCoreDescriptor
 {
   GObject parent_instance;
diff --git a/retro-gtk/retro-core-view.c b/retro-gtk/retro-core-view.c
index 157ba23..b852b7a 100644
--- a/retro-gtk/retro-core-view.c
+++ b/retro-gtk/retro-core-view.c
@@ -9,6 +9,13 @@
 #include "retro-input-private.h"
 #include "retro-keyboard-private.h"
 
+/**
+ * SECTION:retro-core-view
+ * @short_description: A widget to handle a core's inputs and outputs
+ * @title: RetroCoreView
+ * @See_also: #RetroCore, #RetroVideoFilter
+ */
+
 struct _RetroCoreView
 {
   GtkEventBox parent_instance;
diff --git a/retro-gtk/retro-core.c b/retro-gtk/retro-core.c
index e44719d..5ed0978 100644
--- a/retro-gtk/retro-core.c
+++ b/retro-gtk/retro-core.c
@@ -20,6 +20,13 @@
 #include "retro-pixdata-private.h"
 #include "retro-runner-process-private.h"
 
+/**
+ * SECTION:retro-core
+ * @short_description: An object handling a Libretro core
+ * @title: RetroCore
+ * @See_also: #RetroCoreView
+ */
+
 #define RETRO_CORE_ERROR (retro_core_error_quark ())
 
 enum {
diff --git a/retro-gtk/retro-gl-display.c b/retro-gtk/retro-gl-display.c
index a6a3a0f..2f9a58e 100644
--- a/retro-gtk/retro-gl-display.c
+++ b/retro-gtk/retro-gl-display.c
@@ -7,6 +7,14 @@
 #include "retro-pixbuf.h"
 #include "retro-pixdata.h"
 
+/**
+ * PRIVATE:retro-gl-display
+ * @short_description: A widget rendering the video output from a core via OpenGL
+ * @title: RetroGLDisplay
+ * @See_also: #RetroCairoDisplay
+ * @stability: Private
+ */
+
 struct _RetroGLDisplay
 {
   GtkGLArea parent_instance;
diff --git a/retro-gtk/retro-gtk-version.h.in b/retro-gtk/retro-gtk-version.h.in
index 6d09b4d..d511aa8 100644
--- a/retro-gtk/retro-gtk-version.h.in
+++ b/retro-gtk/retro-gtk-version.h.in
@@ -8,11 +8,8 @@
 
 /**
  * SECTION:retro-gtk-version
- * @short_description: retro-gtk version checking
+ * @short_description: Version checking
  * @title: Version
- *
- * retro-gtk provides macros to check the version of the library
- * at compile-time
  */
 
 /**
diff --git a/retro-gtk/retro-log.c b/retro-gtk/retro-log.c
index 8cc4396..d45c75f 100644
--- a/retro-gtk/retro-log.c
+++ b/retro-gtk/retro-log.c
@@ -2,6 +2,15 @@
 
 #include "retro-core.h"
 
+/**
+ * SECTION:retro-log
+ * @short_description: Logging functions
+ * @title: Logging Functions
+ * @See_also: #RetroCore
+ *
+ * Convenience functions to connect to the #RetroCore::log signal of #RetroCore.
+ */
+
 /**
  * retro_g_log:
  * @sender: a #RetroCore
@@ -12,8 +21,8 @@
  *
  * Logs an error or debugging message.
  *
- * This is a convenience function to forward the log signal of #RetroCore to
- * g_log(), see it for more information.
+ * This is a convenience function to forward the #RetroCore::log signal of
+ * #RetroCore to g_log(), see it for more information.
  */
 void
 retro_g_log (RetroCore      *sender,
diff --git a/retro-gtk/retro-option.c b/retro-gtk/retro-option.c
index 488ff9b..e27cb8e 100644
--- a/retro-gtk/retro-option.c
+++ b/retro-gtk/retro-option.c
@@ -1,5 +1,12 @@
 // This file is part of retro-gtk. License: GPL-3.0+.
 
+/**
+ * SECTION:retro-option
+ * @short_description: An object representing an option from a Libretro core
+ * @title: RetroOption
+ * @See_also: #RetroGore
+ */
+
 #include "retro-option-private.h"
 
 struct _RetroOption
diff --git a/retro-gtk/retro-pixbuf.c b/retro-gtk/retro-pixbuf.c
index 900417d..e7d2530 100644
--- a/retro-gtk/retro-pixbuf.c
+++ b/retro-gtk/retro-pixbuf.c
@@ -3,6 +3,15 @@
 #include "retro-pixbuf.h"
 #include <string.h>
 
+/**
+ * SECTION:retro-pixbuf
+ * @short_description: Helper functions for #GdkPixbuf
+ * @title: Pixbuf Helpers
+ * @See_also: #GdkPixbuf, #RetroCoreView
+ *
+ * Convenience functions to handle the options of a #GdkPixbuf.
+ */
+
 /**
  * retro_pixbuf_get_aspect_ratio:
  * @pixbuf: a #GdkPixbuf
diff --git a/retro-gtk/retro-video-filter.c b/retro-gtk/retro-video-filter.c
index dc86d7f..028892d 100644
--- a/retro-gtk/retro-video-filter.c
+++ b/retro-gtk/retro-video-filter.c
@@ -2,6 +2,13 @@
 
 #include "retro-video-filter.h"
 
+/**
+ * SECTION:retro-video-filter
+ * @short_description: A video filter enumeration
+ * @title: RetroVideoFilter
+ * @See_also: #RetroCoreView
+ */
+
 /**
  * retro_video_filter_from_string:
  * @filter: a filter name