From 350b6c5664e243895cdc7f661ce878184b4406ca Mon Sep 17 00:00:00 2001
From: Stefan Sauer <st.kost@gmail.com>
Date: Sun, 11 Feb 2024 21:36:21 +0100
Subject: [PATCH] Another small doc update.

We'll need to align this with teh GObject naming conventions to fit
better (will be followup change).
---
 docs/reference/bt-gst/buzztrax-gst-docs.xml     |  1 +
 docs/reference/bt-gst/buzztrax-gst-sections.txt |  4 ++--
 src/lib/gst/ui.c                                | 15 +++++++--------
 src/lib/gst/ui.h                                | 10 ++++++++--
 4 files changed, 18 insertions(+), 12 deletions(-)

diff --git a/docs/reference/bt-gst/buzztrax-gst-docs.xml b/docs/reference/bt-gst/buzztrax-gst-docs.xml
index f1bde9663..91e9f25e9 100644
--- a/docs/reference/bt-gst/buzztrax-gst-docs.xml
+++ b/docs/reference/bt-gst/buzztrax-gst-docs.xml
@@ -59,6 +59,7 @@
     <xi:include href="xml/childbin.xml"/>
     <xi:include href="xml/propertymeta.xml"/>
     <xi:include href="xml/tempo.xml"/>
+    <xi:include href="xml/ui.xml"/>
   </chapter>
 
   <chapter>
diff --git a/docs/reference/bt-gst/buzztrax-gst-sections.txt b/docs/reference/bt-gst/buzztrax-gst-sections.txt
index 43fc30318..444c93fe9 100644
--- a/docs/reference/bt-gst/buzztrax-gst-sections.txt
+++ b/docs/reference/bt-gst/buzztrax-gst-sections.txt
@@ -474,14 +474,14 @@ gstbt_tone_conversion_tuning_get_type
 <SECTION>
 <FILE>ui</FILE>
 <TITLE>GstBtUi</TITLE>
-GstBtUiCustomGfx
+GstBtUiCustomGfxInterface
 GstBtUiCustomGfxResponse
 gstbt_ui_custom_gfx_request
+GstBtUiCustomGfx
 <SUBSECTION Standard>
 GSTBT_UI_TYPE_CUSTOM_GFX
 </SECTION>
 
-
 <SECTION>
 <FILE>wavereplay</FILE>
 <TITLE>GstBtWaveReplay</TITLE>
diff --git a/src/lib/gst/ui.c b/src/lib/gst/ui.c
index 83c0c4d70..60aa3c1c3 100644
--- a/src/lib/gst/ui.c
+++ b/src/lib/gst/ui.c
@@ -29,14 +29,6 @@
  *
  * Allows a machine to supply its own graphics to be drawn over the machine in
  * the Machine View.
- *
- * SIGNALS:
- *
- * gstbt-ui-gfx-invalidated() [G_SIGNAL_ACTION]
- * 
- * Machines generally don't have to do anything in response to this signal, but
- * they should emit it when something happens that should change the image,
- * i.e. by the machine on a parameter change.
  */
 
 #include "ui.h"
@@ -44,6 +36,13 @@
 G_DEFINE_INTERFACE(GstBtUiCustomGfx, gstbt_ui_custom_gfx, G_TYPE_OBJECT)
 
 static void gstbt_ui_custom_gfx_default_init (GstBtUiCustomGfxInterface *iface) {
+  /**
+   * GstBtUiCustomGfx::gstbt-ui-custom-gfx-invalidated:
+   *
+   * Machines generally don't have to do anything in response to this signal, but
+   * they should emit it when something happens that should change the image,
+   * i.e. by the machine on a parameter change.
+   */
   g_signal_new (
     "gstbt-ui-custom-gfx-invalidated",
     G_OBJECT_CLASS_TYPE(iface),
diff --git a/src/lib/gst/ui.h b/src/lib/gst/ui.h
index 63dc0043f..d583f74ee 100644
--- a/src/lib/gst/ui.h
+++ b/src/lib/gst/ui.h
@@ -26,7 +26,6 @@ G_BEGIN_DECLS
 
 /**
  * GstBtUiCustomGfxResponse:
- *
  * @version: set to 0
  * @width: width of returned image in pixels
  * @height: height of returned image in pixels
@@ -47,8 +46,13 @@ G_DECLARE_INTERFACE (GstBtUiCustomGfx, gstbt_ui_custom_gfx, GSTBT_UI, CUSTOM_GFX
                      GObject)
 
 /**
- * GstBtUiCustomGfxInterface:
+ * GstBtUiCustomGfx:
  *
+ * Opaque interface handle.
+ */
+/**
+ * GstBtUiCustomGfxInterface:
+ * @parent: parent type
  * @request: Return the machine's current custom gfx image.
  *           Ownership of the returned object isn't transferred, so cached data
  *           can be used (both response structure and image data.)
@@ -56,6 +60,8 @@ G_DECLARE_INTERFACE (GstBtUiCustomGfx, gstbt_ui_custom_gfx, GSTBT_UI, CUSTOM_GFX
  *           The actual rendering of the image may be done here.
  *
  *           May return NULL; in that case, Buzztrax's standard gfx are used.
+ *
+ * Interface structure.
  */
 struct _GstBtUiCustomGfxInterface {
   GTypeInterface parent;