[gtk/clipboard-set-docs] docs: Expand gdk_clipboard_set() docs
- From: Benjamin Otte <otte src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gtk/clipboard-set-docs] docs: Expand gdk_clipboard_set() docs
- Date: Sun, 22 Aug 2021 14:01:37 +0000 (UTC)
commit f12315557e3243f2fdea2a1b6d4f33e2d6145966
Author: Benjamin Otte <otte benjamin googlemail com>
Date: Sun Aug 22 14:01:24 2021 +0000
docs: Expand gdk_clipboard_set() docs
- expand a bit on the varargs
- use common examples, not textbuffers.
- use 2 examples, one for static values, one for variables.
gdk/gdkclipboard.c | 8 +++++++-
1 file changed, 7 insertions(+), 1 deletion(-)
---
diff --git a/gdk/gdkclipboard.c b/gdk/gdkclipboard.c
index bbd1a1fde5..c1ceb7310c 100644
--- a/gdk/gdkclipboard.c
+++ b/gdk/gdkclipboard.c
@@ -1253,9 +1253,15 @@ gdk_clipboard_set_content (GdkClipboard *clipboard,
* @...: value contents conforming to @type
*
* Sets the clipboard to contain the value collected from the given varargs.
+ *
+ * Values should be passed the same way they are passed to other value
+ * collecting APIs, such as `[method GObject Object set]` or
+ * `[id@g_signal_emit]` .
*
* ```c
- * gdk_clipboard_set (clipboard, GTK_TYPE_TEXT_BUFFER, buffer);
+ * gdk_clipboard_set (clipboard, GTK_TYPE_STRING, "Hello World");
+ *
+ * gdk_clipboard_set (clipboard, GDK_TYPE_TEXTURE, some_texture);
* ```
*/
void
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]