[gtk+] Document GdkClipboard::changed

[Matthias Clasen <matthiasc src gnome org>]

commit e917949315b47f10f8004b4fd7c19bdb0b72a69c
Author: Matthias Clasen <mclasen redhat com>
Date:   Tue Dec 26 14:03:30 2017 -0500

    Document GdkClipboard::changed

 gdk/gdkclipboard.c           |    6 +++
 gdk/gdkcontentdeserializer.c |   86 ++++++++++++++++++++++++++++++++++++++++++
 gdk/gdkcontentserializer.c   |   86 ++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 178 insertions(+), 0 deletions(-)
---
diff --git a/gdk/gdkclipboard.c b/gdk/gdkclipboard.c
index b2d5641..ee9d8e9 100644
--- a/gdk/gdkclipboard.c
+++ b/gdk/gdkclipboard.c
@@ -425,6 +425,12 @@ gdk_clipboard_class_init (GdkClipboardClass *class)
                          G_PARAM_STATIC_STRINGS |
                          G_PARAM_EXPLICIT_NOTIFY);
 
+  /**
+   * GdkClipboard::changed:
+   * @clipboard: the object on which the signal was emitted
+   *
+   * The ::changed signal is emitted when the clipboard changes ownership.
+   */
   signals[CHANGED] =
     g_signal_new ("changed",
                   G_TYPE_FROM_CLASS (class),
diff --git a/gdk/gdkcontentdeserializer.c b/gdk/gdkcontentdeserializer.c
index 921f94d..91c5d6e 100644
--- a/gdk/gdkcontentdeserializer.c
+++ b/gdk/gdkcontentdeserializer.c
@@ -162,6 +162,14 @@ gdk_content_deserializer_run (const char                *mime_type,
   deserialize_func (deserializer);
 }
 
+/**
+ * gdk_content_deserializer_get_mime_type:
+ * @deserializer: a #GdkContentDeserializer
+ *
+ * Gets the mime type to deserialize from.
+ *
+ * Returns: (transfer none): the mime type for the current operation
+ */
 const char *
 gdk_content_deserializer_get_mime_type (GdkContentDeserializer *deserializer)
 {
@@ -170,6 +178,14 @@ gdk_content_deserializer_get_mime_type (GdkContentDeserializer *deserializer)
   return deserializer->mime_type;
 }
 
+/**
+ * gdk_content_deserializer_get_gtype:
+ * @deserializer: a #GdkContentDeserializer
+ *
+ * Gets the GType to create an instance of.
+ *
+ * Returns: (transfer none): the GType for the current operation
+ */
 GType
 gdk_content_deserializer_get_gtype (GdkContentDeserializer *deserializer)
 {
@@ -178,6 +194,14 @@ gdk_content_deserializer_get_gtype (GdkContentDeserializer *deserializer)
   return G_VALUE_TYPE (&deserializer->value);
 }
 
+/**
+ * gdk_content_deserializer_get_value:
+ * @deserializer: a #GdkContentDeserializer
+ *
+ * Gets the #GValue to store the deserialized object in.
+ *
+ * Returns: (transfer none): the #GValue for the current operation
+ */
 GValue *
 gdk_content_deserializer_get_value (GdkContentDeserializer *deserializer)
 {
@@ -186,6 +210,14 @@ gdk_content_deserializer_get_value (GdkContentDeserializer *deserializer)
   return &deserializer->value;
 }
 
+/**
+ * gdk_content_deserializer_get_input_stream:
+ * @deserializer: a #GdkContentDeserializer
+ *
+ * Gets the input stream that was passed to gdk_content_deserialize_async().
+ *
+ * Returns: (transfer none): the input stream for the current operation
+ */
 GInputStream *
 gdk_content_deserializer_get_input_stream (GdkContentDeserializer *deserializer)
 {
@@ -194,6 +226,14 @@ gdk_content_deserializer_get_input_stream (GdkContentDeserializer *deserializer)
   return deserializer->stream;
 }
 
+/**
+ * gdk_content_deserializer_get_priority:
+ * @deserializer: a #GdkContentDeserializer
+ *
+ * Gets the io priority that was passed to gdk_content_deserialize_async().
+ *
+ * Returns: the io priority for the current operation
+ */
 int
 gdk_content_deserializer_get_priority (GdkContentDeserializer *deserializer)
 {
@@ -202,6 +242,14 @@ gdk_content_deserializer_get_priority (GdkContentDeserializer *deserializer)
   return deserializer->priority;
 }
 
+/**
+ * gdk_content_deserializer_get_cancellable:
+ * @deserializer: a #GdkContentDeserializer
+ *
+ * Gets the cancellable that was passed to gdk_content_deserialize_async().
+ *
+ * Returns: (transfer none): the cancellable for the current operation
+ */
 GCancellable *
 gdk_content_deserializer_get_cancellable (GdkContentDeserializer *deserializer)
 {
@@ -210,6 +258,14 @@ gdk_content_deserializer_get_cancellable (GdkContentDeserializer *deserializer)
   return deserializer->cancellable;
 }
 
+/**
+ * gdk_content_deserializer_get_user_data:
+ * @deserializer: a #GdkContentDeserializer
+ *
+ * Gets the user data that was passed when the deserializer was registered.
+ *
+ * Returns: (transfer none): the user data for this deserializer
+ */
 gpointer
 gdk_content_deserializer_get_user_data (GdkContentDeserializer *deserializer)
 {
@@ -218,6 +274,14 @@ gdk_content_deserializer_get_user_data (GdkContentDeserializer *deserializer)
   return deserializer->user_data;
 }
 
+/**
+ * gdk_content_deserializer_set_task_data:
+ * @deserializer: a #GdkContentDeserializer
+ * @data: data to associate with this operation
+ * @notify: destroy notify for @data
+ *
+ * Associate data with the current deserialization operation.
+ */
 void
 gdk_content_deserializer_set_task_data (GdkContentDeserializer *deserializer,
                                         gpointer                data,
@@ -232,6 +296,14 @@ gdk_content_deserializer_set_task_data (GdkContentDeserializer *deserializer,
   deserializer->task_notify = notify;
 }
 
+/**
+ * gdk_content_deserializer_get_task_data:
+ * @deserializer: a #GdkContentDeserializer
+ *
+ * Gets the data that was associated with @deserializer via gdk_content_deserializer_set_task_data().
+ *
+ * Returns: (transfer none): the task data for @deserializer
+ */
 gpointer
 gdk_content_deserializer_get_task_data (GdkContentDeserializer *deserializer)
 {
@@ -253,6 +325,12 @@ gdk_content_deserializer_emit_callback (gpointer data)
   return G_SOURCE_REMOVE;
 }
 
+/**
+ * gdk_content_deserializer_return_success:
+ * @deserializer: a #GdkContentDeserializer
+ *
+ * Indicate that the deserialization has been successfully completed.
+ */
 void
 gdk_content_deserializer_return_success (GdkContentDeserializer *deserializer)
 {
@@ -267,6 +345,14 @@ gdk_content_deserializer_return_success (GdkContentDeserializer *deserializer)
   /* NB: the idle will destroy our reference */
 }
 
+/**
+ * gdk_content_deserializer_return_error:
+ * @deserializer: a #GdkContentDeserializer
+ * @error: a #GError
+ *
+ * Indicate that the deserialization has ended with an error.
+ * This function consumes @error.
+ */
 void
 gdk_content_deserializer_return_error (GdkContentDeserializer *deserializer,
                                        GError                 *error)
diff --git a/gdk/gdkcontentserializer.c b/gdk/gdkcontentserializer.c
index 1a6add9..f92789b 100644
--- a/gdk/gdkcontentserializer.c
+++ b/gdk/gdkcontentserializer.c
@@ -165,6 +165,14 @@ gdk_content_serializer_run (const char              *mime_type,
   serialize_func (serializer);
 }
 
+/**
+ * gdk_content_serializer_get_mime_type:
+ * @serializer: a #GdkContentSerializer
+ *
+ * Gets the mime type to serialize to.
+ *
+ * Returns: (transfer none): the mime type for the current operation
+ */
 const char *
 gdk_content_serializer_get_mime_type (GdkContentSerializer *serializer)
 {
@@ -173,6 +181,14 @@ gdk_content_serializer_get_mime_type (GdkContentSerializer *serializer)
   return serializer->mime_type;
 }
 
+/**
+ * gdk_content_serializer_get_gtype:
+ * @serializer: a #GdkContentSerializer
+ *
+ * Gets the GType to of the object to serialize.
+ *
+ * Returns: (transfer none): the GType for the current operation
+ */
 GType
 gdk_content_serializer_get_gtype (GdkContentSerializer *serializer)
 {
@@ -181,6 +197,14 @@ gdk_content_serializer_get_gtype (GdkContentSerializer *serializer)
   return G_VALUE_TYPE (&serializer->value);
 }
 
+/**
+ * gdk_content_serializer_get_value:
+ * @serializer: a #GdkContentSerializer
+ *
+ * Gets the #GValue to read the object to serialize from.
+ *
+ * Returns: (transfer none): the #GValue for the current operation
+ */
 const GValue *
 gdk_content_serializer_get_value (GdkContentSerializer *serializer)
 {
@@ -189,6 +213,14 @@ gdk_content_serializer_get_value (GdkContentSerializer *serializer)
   return &serializer->value;
 }
 
+/**
+ * gdk_content_serializer_get_output_stream:
+ * @serializer: a #GdkContentSerializer
+ *
+ * Gets the output stream that was passed to gdk_content_serialize_async().
+ *
+ * Returns: (transfer none): the output stream for the current operation
+ */
 GOutputStream *
 gdk_content_serializer_get_output_stream (GdkContentSerializer *serializer)
 {
@@ -197,6 +229,14 @@ gdk_content_serializer_get_output_stream (GdkContentSerializer *serializer)
   return serializer->stream;
 }
 
+/**
+ * gdk_content_serializer_get_priority:
+ * @serializer: a #GdkContentSerializer
+ *
+ * Gets the io priority that was passed to gdk_content_serialize_async().
+ *
+ * Returns: the io priority for the current operation
+ */
 int
 gdk_content_serializer_get_priority (GdkContentSerializer *serializer)
 {
@@ -205,6 +245,14 @@ gdk_content_serializer_get_priority (GdkContentSerializer *serializer)
   return serializer->priority;
 }
 
+/**
+ * gdk_content_serializer_get_cancellable:
+ * @serializer: a #GdkContentSerializer
+ *
+ * Gets the cancellable that was passed to gdk_content_serialize_async().
+ *
+ * Returns: (transfer none): the cancellable for the current operation
+ */
 GCancellable *
 gdk_content_serializer_get_cancellable (GdkContentSerializer *serializer)
 {
@@ -213,6 +261,14 @@ gdk_content_serializer_get_cancellable (GdkContentSerializer *serializer)
   return serializer->cancellable;
 }
 
+/**
+ * gdk_content_serializer_get_user_data:
+ * @serializer: a #GdkContentSerializer
+ *
+ * Gets the user data that was passed when the serializer was registered.
+ *
+ * Returns: (transfer none): the user data for this serializer
+ */
 gpointer
 gdk_content_serializer_get_user_data (GdkContentSerializer *serializer)
 {
@@ -221,6 +277,14 @@ gdk_content_serializer_get_user_data (GdkContentSerializer *serializer)
   return serializer->user_data;
 }
 
+/**
+ * gdk_content_serializer_set_task_data:
+ * @serializer: a #GdkContentSerializer
+ * @data: data to associate with this operation
+ * @notify: destroy notify for @data
+ *
+ * Associate data with the current serialization operation.
+ */
 void
 gdk_content_serializer_set_task_data (GdkContentSerializer   *serializer,
                                       gpointer                data,
@@ -235,6 +299,14 @@ gdk_content_serializer_set_task_data (GdkContentSerializer   *serializer,
   serializer->task_notify = notify;
 }
 
+/**
+ * gdk_content_serializer_get_task_data:
+ * @serializer: a #GdkContentSerializer
+ *
+ * Gets the data that was associated with @serializer via gdk_content_serializer_set_task_data().
+ *
+ * Returns: (transfer none): the task data for @serializer
+ */
 gpointer
 gdk_content_serializer_get_task_data (GdkContentSerializer *serializer)
 {
@@ -256,6 +328,12 @@ gdk_content_serializer_emit_callback (gpointer data)
   return G_SOURCE_REMOVE;
 }
 
+/**
+ * gdk_content_serializer_return_success:
+ * @serializer: a #GdkContentSerializer
+ *
+ * Indicate that the serialization has been successfully completed.
+ */
 void
 gdk_content_serializer_return_success (GdkContentSerializer *serializer)
 {
@@ -270,6 +348,14 @@ gdk_content_serializer_return_success (GdkContentSerializer *serializer)
   /* NB: the idle will destroy our reference */
 }
 
+/**
+ * gdk_content_serializer_return_error:
+ * @serializer: a #GdkContentSerializer
+ * @error: a #GError
+ *
+ * Indicate that the serialization has ended with an error.
+ * This function consumes @error.
+ */
 void
 gdk_content_serializer_return_error (GdkContentSerializer *serializer,
                                      GError               *error)