From 3108b8b4d3f6ddbc1f48b94b8693cac5fba9d493 Mon Sep 17 00:00:00 2001
From: Matthias Clasen <mclasen@redhat.com>
Date: Thu, 23 Jul 2020 12:43:46 -0400
Subject: [PATCH] docs: Explain the shortcutcontroller example a bit

Add a reference to the the syntax for shortcut actions
in builder files.
---
 gtk/gtkshortcutcontroller.c | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

diff --git a/gtk/gtkshortcutcontroller.c b/gtk/gtkshortcutcontroller.c
index 1b995f5098..1d4806b198 100644
--- a/gtk/gtkshortcutcontroller.c
+++ b/gtk/gtkshortcutcontroller.c
@@ -50,7 +50,7 @@
  *         <property name='scope'>managed</property>
  *         <child>
  *           <object class='GtkShortcut'>
- *             <property name='trigger'>&lt;Control&gt;k</property>
+ *             <property name='trigger'><![CDATA[<Control>k]]></property>
  *             <property name='action'>activate</property>
  *           </object>
  *         </child>
@@ -58,6 +58,11 @@
  *     </child>
  *   </object>
  * ]|
+ *
+ * This example creates a #GtkActivateAction for triggering the `activate`
+ * signal of the GtkButton. See gtk_shortcut_action_parse_string() for the syntax
+ * for other kinds of #GtkShortcutAction. See gtk_shortcut_trigger_parse_string()
+ * to learn more about the syntax for triggers.
  **/
 
 #include "config.h"