[Spice-devel] [PATCH spice-gtk 2/3] doc: add some missing block comments

[Marc-André Lureau]

Signed-off-by: Marc-André Lureau <marcandre.lureau at gmail.com>
---
 src/channel-display.h         | 35 +++++++++++++++++++++++++++++++++++
 src/spice-grabsequence-priv.h |  1 +
 src/spice-grabsequence.h      |  5 +++++
 3 files changed, 41 insertions(+)

diff --git a/src/channel-display.h b/src/channel-display.h
index bd4bc87..ad82a16 100644
--- a/src/channel-display.h
+++ b/src/channel-display.h
@@ -39,6 +39,17 @@ typedef struct _SpiceDisplayChannelPrivate SpiceDisplayChannelPrivate;
 
 #define SPICE_TYPE_GL_SCANOUT (spice_gl_scanout_get_type ())
 
+/**
+ * SpiceGlScanout:
+ * @fd: a drm DMABUF file that can be imported with eglCreateImageKHR
+ * @width: width of the scanout
+ * @height: height of the scanout
+ * @stride: stride of the scanout
+ * @format: the drm fourcc format
+ * @y0top: orientation of the scanout
+ *
+ * Holds the information necessary for using the GL display scanout.
+ **/
 typedef struct _SpiceGlScanout SpiceGlScanout;
 struct _SpiceGlScanout {
     gint fd;
@@ -49,6 +60,17 @@ struct _SpiceGlScanout {
     gboolean y0top;
 };
 
+/**
+ * SpiceDisplayMonitorConfig:
+ * @id: monitor id
+ * @surface_id: monitor surface id
+ * @x: x position of the monitor
+ * @y: y position of the monitor
+ * @width: width of the monitor
+ * @height: height of the monitor
+ *
+ * Holds a monitor configuration.
+ **/
 typedef struct _SpiceDisplayMonitorConfig SpiceDisplayMonitorConfig;
 struct _SpiceDisplayMonitorConfig {
     guint id;
@@ -59,6 +81,19 @@ struct _SpiceDisplayMonitorConfig {
     guint height;
 };
 
+/**
+ * SpiceDisplayPrimary:
+ * @format: primary buffer format
+ * @width: width of the primary
+ * @height: height of the primary
+ * @stride: stride of the primary
+ * @shmid: identifier of the shared memory segment associated with
+ * the @data, or -1 if not shm
+ * @data: pointer to primary buffer
+ * @marked: whether the display is marked ready
+ *
+ * Holds the information necessary to use the primary surface.
+ **/
 typedef struct _SpiceDisplayPrimary SpiceDisplayPrimary;
 struct _SpiceDisplayPrimary {
     enum SpiceSurfaceFmt format;
diff --git a/src/spice-grabsequence-priv.h b/src/spice-grabsequence-priv.h
index 5475730..97f05b2 100644
--- a/src/spice-grabsequence-priv.h
+++ b/src/spice-grabsequence-priv.h
@@ -21,6 +21,7 @@
 #include <glib.h>
 
 struct _SpiceGrabSequence {
+    /*< private >*/
     guint nkeysyms;
     guint *keysyms;
 };
diff --git a/src/spice-grabsequence.h b/src/spice-grabsequence.h
index 6e68e29..7f61ba1 100644
--- a/src/spice-grabsequence.h
+++ b/src/spice-grabsequence.h
@@ -33,6 +33,11 @@ G_BEGIN_DECLS
 
 #define SPICE_TYPE_GRAB_SEQUENCE            (spice_grab_sequence_get_type ())
 
+/**
+ * SpiceGrabSequence:
+ *
+ * An opaque type that represents a grab sequence.
+ **/
 typedef struct _SpiceGrabSequence SpiceGrabSequence;
 
 GType spice_grab_sequence_get_type(void);
-- 
2.7.4