[gtk+] gdk: Fill in some blanks in the docs



commit 77f0e678ece8cee1b8da8fa0dab1adeec5e113d3
Author: Matthias Clasen <mclasen redhat com>
Date:   Mon Dec 4 15:58:30 2017 -0800

    gdk: Fill in some blanks in the docs
    
    This is just an initial cut; more work is needed.

 gdk/gdkclipboard.c           |   16 +++++++++++++++-
 gdk/gdkcontentdeserializer.c |   11 +++++++++++
 gdk/gdkcontentformats.c      |    2 +-
 gdk/gdkcontentprovider.c     |    9 +++++++++
 gdk/gdkcontentserializer.c   |   11 +++++++++++
 gdk/gdktexture.c             |    2 +-
 gdk/gdkvulkancontext.c       |   16 ++++++++++++++++
 7 files changed, 64 insertions(+), 3 deletions(-)
---
diff --git a/gdk/gdkclipboard.c b/gdk/gdkclipboard.c
index 94e2247..1f5f5cf 100644
--- a/gdk/gdkclipboard.c
+++ b/gdk/gdkclipboard.c
@@ -30,6 +30,20 @@
 #include "gdkpipeiostreamprivate.h"
 #include "gdktexture.h"
 
+/**
+ * SECTION:gdkclipboard
+ * @Short_description: Share data between applications for Copy-and-Paste
+ * @Title: Clipboards
+ * @See_also: #GdkContentProvider, #GdkContentFormats
+ *
+ * The #GdkClipboard object represents a clipboard of data shared
+ * between different applications or between different parts of
+ * the same application.
+ *
+ * To get a GdkClipboard object, use gdk_display_get_clipboard() or
+ * gdk_display_get_primary_clipboard().
+ */
+
 typedef struct _GdkClipboardPrivate GdkClipboardPrivate;
 
 struct _GdkClipboardPrivate
@@ -453,7 +467,7 @@ gdk_clipboard_get_formats (GdkClipboard *clipboard)
  * gdk_clipboard_is_local:
  * @clipboard: a #GdkClipboard
  *
- * Returns if the clipboard is local. A clipboard is consideredlocal if it was
+ * Returns if the clipboard is local. A clipboard is considered local if it was
  * last claimed by the running application.
  *
  * Note that gdk_clipboard_get_content() may return %NULL even on a local
diff --git a/gdk/gdkcontentdeserializer.c b/gdk/gdkcontentdeserializer.c
index 64390b9..921f94d 100644
--- a/gdk/gdkcontentdeserializer.c
+++ b/gdk/gdkcontentdeserializer.c
@@ -26,6 +26,17 @@
 
 #include <gdk-pixbuf/gdk-pixbuf.h>
 
+
+/**
+ * SECTION:gdkcontentdeserializer
+ * @Short_description: Deserialize content for transfer
+ * @Title: GdkContentSerializer
+ * @See_also: #GdkContentDeserializer
+ *
+ * A GdkContentDeserializer is used to deserialize content for inter-application
+ * data transfers.
+ */
+
 typedef struct _Deserializer Deserializer;
 
 struct _Deserializer 
diff --git a/gdk/gdkcontentformats.c b/gdk/gdkcontentformats.c
index ab97163..04bd064 100644
--- a/gdk/gdkcontentformats.c
+++ b/gdk/gdkcontentformats.c
@@ -20,7 +20,7 @@
  * @Title: Content Formats
  * @Short_description: Advertising and negotiating of content
  *     exchange formats
- * @See_also: #GdkDragContext, #GdkClipboard
+ * @See_also: #GdkDragContext, #GdkClipboard, #GdkContentProvider
  *
  * This section describes the #GdkContentFormats structure that is used to
  * advertise and negotiate the format of content passed between different
diff --git a/gdk/gdkcontentprovider.c b/gdk/gdkcontentprovider.c
index 9d89f94..235d195 100644
--- a/gdk/gdkcontentprovider.c
+++ b/gdk/gdkcontentprovider.c
@@ -24,6 +24,15 @@
 #include "gdkcontentformats.h"
 #include "gdkintl.h"
 
+/**
+ * SECTION:gdkcontentprovider
+ * @Short_description: Provides content for data transfer between applications
+ * @Title: GdkContentProvider
+ *
+ * A GdkContentProvider is used to provide content for the clipboard in
+ * a number of formats.
+ */
+
 typedef struct _GdkContentProviderPrivate GdkContentProviderPrivate;
 
 struct _GdkContentProviderPrivate
diff --git a/gdk/gdkcontentserializer.c b/gdk/gdkcontentserializer.c
index d4421ce..e033272 100644
--- a/gdk/gdkcontentserializer.c
+++ b/gdk/gdkcontentserializer.c
@@ -28,6 +28,17 @@
 #include <gdk-pixbuf/gdk-pixbuf.h>
 #include <string.h>
 
+
+/**
+ * SECTION:gdkcontentserializer
+ * @Short_description: Serialize content for transfer
+ * @Title: GdkContentSerializer
+ * @See_also: #GdkContentDeserializer, #GdkContentProvider
+ *
+ * A GdkContentSerializer is used to serialize content for inter-application
+ * data transfers.
+ */
+
 typedef struct _Serializer Serializer;
 
 struct _Serializer 
diff --git a/gdk/gdktexture.c b/gdk/gdktexture.c
index 6921297..09a06fa 100644
--- a/gdk/gdktexture.c
+++ b/gdk/gdktexture.c
@@ -17,7 +17,7 @@
  */
 
 /**
- * SECTION:GdkTexture
+ * SECTION:textures
  * @Title: GdkTexture
  * @Short_description: Pixel data
  *
diff --git a/gdk/gdkvulkancontext.c b/gdk/gdkvulkancontext.c
index 3fd697a..6651f52 100644
--- a/gdk/gdkvulkancontext.c
+++ b/gdk/gdkvulkancontext.c
@@ -28,6 +28,22 @@
 #include "gdkinternals.h"
 #include "gdkintl.h"
 
+/**
+ * SECTION:gdkvulkancontext
+ * @Title: GdkVulkanContext
+ * @Short_description: Vulkan context
+ *
+ * #GdkVulkanContext is an object representing the platform-specific
+ * Vulkan drawing context.
+ *
+ * #GdkVulkanContexts are created for a #GdkWindow using
+ * gdk_window_create_vulkan_context(), and the context will match the
+ * the characteristics of the window.
+ *
+ * Support for #GdkGLContext is platform-specific, context creation
+ * can fail, returning %NULL context.
+ */
+
 typedef struct _GdkVulkanContextPrivate GdkVulkanContextPrivate;
 
 struct _GdkVulkanContextPrivate {


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]