[Spice-devel] [PATCH spice-gtk 5/5] doc: Display properties of spice-gtk classes

[Pavel Grunt]

It is done by putting theirsymbols in appropriate sections
---
 doc/reference/spice-gtk-sections.txt |  6 ++++++
 src/spice-gtk-session.h              | 11 +++++++++++
 src/spice-widget.h                   | 11 +++++++++++
 src/usb-device-widget.h              | 10 ++++++++++
 4 files changed, 38 insertions(+)

diff --git a/doc/reference/spice-gtk-sections.txt b/doc/reference/spice-gtk-sections.txt
index 6f49df3..99baddf 100644
--- a/doc/reference/spice-gtk-sections.txt
+++ b/doc/reference/spice-gtk-sections.txt
@@ -350,6 +350,8 @@ SpiceUsbDeviceManagerPrivate
 <SECTION>
 <FILE>spice-gtk-session</FILE>
 <TITLE>SpiceGtkSession</TITLE>
+SpiceGtkSession
+SpiceGtkSessionClass
 spice_gtk_session_get
 spice_gtk_session_copy_to_guest
 spice_gtk_session_paste_from_guest
@@ -368,6 +370,8 @@ SpiceGtkSessionPrivate
 <SECTION>
 <FILE>spice-widget</FILE>
 <TITLE>SpiceDisplay</TITLE>
+SpiceDisplay
+SpiceDisplayClass
 SpiceDisplayKeyEvent
 spice_display_new
 spice_display_new_with_monitor
@@ -402,6 +406,8 @@ SpiceDisplayPrivate
 <SECTION>
 <FILE>usb-device-widget</FILE>
 <TITLE>SpiceUsbDeviceWidget</TITLE>
+SpiceUsbDeviceWidget
+SpiceUsbDeviceWidgetClass
 <SUBSECTION>
 spice_usb_device_widget_new
 <SUBSECTION Standard>
diff --git a/src/spice-gtk-session.h b/src/spice-gtk-session.h
index b04f4fc..28b45f6 100644
--- a/src/spice-gtk-session.h
+++ b/src/spice-gtk-session.h
@@ -33,7 +33,18 @@ G_BEGIN_DECLS
 #define SPICE_IS_GTK_SESSION_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), SPICE_TYPE_GTK_SESSION))
 #define SPICE_GTK_SESSION_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), SPICE_TYPE_GTK_SESSION, SpiceGtkSessionClass))
 
+/**
+ * SpiceGtkSession:
+ *
+ * The #SpiceGtkSession struct is opaque and should not be accessed directly.
+ */
 typedef struct _SpiceGtkSession SpiceGtkSession;
+
+/**
+ * SpiceGtkSessionClass:
+ *
+ * Class structure for #SpiceGtkSession. It is opaque and should not be accessed directly.
+ */
 typedef struct _SpiceGtkSessionClass SpiceGtkSessionClass;
 
 GType spice_gtk_session_get_type(void);
diff --git a/src/spice-widget.h b/src/spice-widget.h
index a8adf9c..d93737e 100644
--- a/src/spice-widget.h
+++ b/src/spice-widget.h
@@ -40,7 +40,18 @@ G_BEGIN_DECLS
 #define SPICE_DISPLAY_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS((obj), SPICE_TYPE_DISPLAY, SpiceDisplayClass))
 
 
+/**
+ * SpiceDisplay:
+ *
+ * The #SpiceDisplay struct is opaque and should not be accessed directly.
+ */
 typedef struct _SpiceDisplay SpiceDisplay;
+
+/**
+ * SpiceDisplayClass:
+ *
+ * Class structure for #SpiceDisplay. It is opaque and should not be accessed directly.
+ */
 typedef struct _SpiceDisplayClass SpiceDisplayClass;
 
 /**
diff --git a/src/usb-device-widget.h b/src/usb-device-widget.h
index a4ba638..f566283 100644
--- a/src/usb-device-widget.h
+++ b/src/usb-device-widget.h
@@ -37,7 +37,17 @@ G_BEGIN_DECLS
 #define SPICE_IS_USB_DEVICE_WIDGET_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), SPICE_TYPE_USB_DEVICE_WIDGET))
 #define SPICE_USB_DEVICE_WIDGET_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), SPICE_TYPE_USB_DEVICE_WIDGET, SpiceUsbDeviceWidgetClass))
 
+/**
+ * SpiceUsbDeviceWidget:
+ *
+ * The #SpiceUsbDeviceWidget struct is opaque and should not be accessed directly.
+ */
 typedef struct _SpiceUsbDeviceWidget SpiceUsbDeviceWidget;
+/**
+ * SpiceUsbDeviceWidgetClass:
+ *
+ * Class structure for #SpiceUsbDeviceWidget. It is opaque and should not be accessed directly.
+ */
 typedef struct _SpiceUsbDeviceWidgetClass SpiceUsbDeviceWidgetClass;
 typedef struct _SpiceUsbDeviceWidgetPrivate SpiceUsbDeviceWidgetPrivate;
 
-- 
2.12.2