[gtk+] docs: don't use <keycap> tags

From: William Jon McCann <mccann src gnome org>
To: commits-list gnome org
Cc:
Subject: [gtk+] docs: don't use <keycap> tags
Date: Wed, 5 Feb 2014 00:54:55 +0000 (UTC)
commit 2c4431e6baa0a0b594d1aea1711abd4611699cbd
Author: William Jon McCann <william jon mccann gmail com>
Date:   Tue Feb 4 19:29:00 2014 -0500

    docs: don't use <keycap> tags

 gtk/gtkcellrendereraccel.c |    2 +-
 gtk/gtkfilechooser.c       |    2 +-
 gtk/gtkfilechooserwidget.c |   51 +++++++++++++++----------------------------
 gtk/gtkrecentchooser.c     |    2 +-
 gtk/gtkscrollbar.c         |    2 +-
 gtk/gtkscrolledwindow.c    |   17 ++++++--------
 6 files changed, 29 insertions(+), 47 deletions(-)
---
diff --git a/gtk/gtkcellrendereraccel.c b/gtk/gtkcellrendereraccel.c
index a953361..3cc7aad 100644
--- a/gtk/gtkcellrendereraccel.c
+++ b/gtk/gtkcellrendereraccel.c
@@ -36,7 +36,7 @@
  * @Title: GtkCellRendererAccel
  *
  * #GtkCellRendererAccel displays a keyboard accelerator (i.e. a
- * key combination like <keycombo><keycap>Control</keycap><keycap>a</keycap></keycombo>.
+ * key combination like `Control + a`.
  * If the cell renderer is editable, the accelerator can be changed by
  * simply typing the new combination.
  *
diff --git a/gtk/gtkfilechooser.c b/gtk/gtkfilechooser.c
index 9aa044b..909e608 100644
--- a/gtk/gtkfilechooser.c
+++ b/gtk/gtkfilechooser.c
@@ -275,7 +275,7 @@ gtk_file_chooser_default_init (GtkFileChooserInterface *iface)
    *
    * This signal is emitted when the user "activates" a file in the file
    * chooser.  This can happen by double-clicking on a file in the file list, or
-   * by pressing <keycap>Enter</keycap>.
+   * by pressing `Enter`.
    *
    * Normally you do not need to connect to this signal.  It is used internally
    * by #GtkFileChooserDialog to know when to activate the default button in the
diff --git a/gtk/gtkfilechooserwidget.c b/gtk/gtkfilechooserwidget.c
index cbd1ab3..2bb25aa 100644
--- a/gtk/gtkfilechooserwidget.c
+++ b/gtk/gtkfilechooserwidget.c
@@ -7175,13 +7175,13 @@ gtk_file_chooser_widget_class_init (GtkFileChooserWidgetClass *class)
    * the file he wishes to select.
    *
    * The default bindings for this signal are
-   * <keycombo><keycap>Control</keycap><keycap>L</keycap></keycombo>
+   * `Control + L`
    * with a @path string of "" (the empty
-   * string).  It is also bound to <keycap>/</keycap> with a
+   * string).  It is also bound to `/` with a
    * @path string of "`/`"
-   * (a slash):  this lets you type <keycap>/</keycap> and
+   * (a slash):  this lets you type `/` and
    * immediately type a path name.  On Unix systems, this is bound to
-   * <keycap>~</keycap> (tilde) with a @path string
+   * `~` (tilde) with a @path string
    * of "~" itself for access to home directories.
    */
   signals[LOCATION_POPUP] =
@@ -7204,8 +7204,7 @@ gtk_file_chooser_widget_class_init (GtkFileChooserWidgetClass *class)
    * This is used to make the file chooser show a "Location"
    * prompt when the user pastes #GtkFileChooserWidget.
    *
-   * The default binding for this signal is
-   * <keycombo><keycap>Control</keycap><keycap>V</keycap></keycombo>.
+   * The default binding for this signal is `Control + V`.
    */
   signals[LOCATION_POPUP_ON_PASTE] =
     g_signal_new_class_handler (I_("location-popup-on-paste"),
@@ -7228,8 +7227,7 @@ gtk_file_chooser_widget_class_init (GtkFileChooserWidgetClass *class)
    * prompt which the user can use to manually type the name of
    * the file he wishes to select.
    *
-   * The default binding for this signal is
-   * <keycombo><keycap>Control</keycap><keycap>L</keycap></keycombo>.
+   * The default binding for this signal is `Control + L`.
    */
   signals[LOCATION_TOGGLE_POPUP] =
     g_signal_new_class_handler (I_("location-toggle-popup"),
@@ -7251,8 +7249,7 @@ gtk_file_chooser_widget_class_init (GtkFileChooserWidgetClass *class)
    * This is used to make the file chooser go to the parent of
    * the current folder in the file hierarchy.
    *
-   * The default binding for this signal is
-   * <keycombo><keycap>Alt</keycap><keycap>Up</keycap></keycombo>.
+   * The default binding for this signal is `Alt + Up`.
    */
   signals[UP_FOLDER] =
     g_signal_new_class_handler (I_("up-folder"),
@@ -7278,8 +7275,7 @@ gtk_file_chooser_widget_class_init (GtkFileChooserWidgetClass *class)
    * "/foo/bar/baz", with bar currently displayed, then this will cause
    * the file chooser to switch to the "baz" subfolder.
    *
-   * The default binding for this signal is
-   * <keycombo><keycap>Alt</keycap><keycap>Down</keycap></keycombo>.
+   * The default binding for this signal is `Alt + Down`.
    */
   signals[DOWN_FOLDER] =
     g_signal_new_class_handler (I_("down-folder"),
@@ -7301,8 +7297,7 @@ gtk_file_chooser_widget_class_init (GtkFileChooserWidgetClass *class)
    * This is used to make the file chooser show the user's home
    * folder in the file list.
    *
-   * The default binding for this signal is
-   * <keycombo><keycap>Alt</keycap><keycap>Home</keycap></keycombo>.
+   * The default binding for this signal is `Alt + Home`.
    */
   signals[HOME_FOLDER] =
     g_signal_new_class_handler (I_("home-folder"),
@@ -7324,8 +7319,7 @@ gtk_file_chooser_widget_class_init (GtkFileChooserWidgetClass *class)
    * This is used to make the file chooser show the user's Desktop
    * folder in the file list.
    *
-   * The default binding for this signal is
-   * <keycombo><keycap>Alt</keycap><keycap>D</keycap></keycombo>.
+   * The default binding for this signal is `Alt + D`.
    */
   signals[DESKTOP_FOLDER] =
     g_signal_new_class_handler (I_("desktop-folder"),
@@ -7350,17 +7344,11 @@ gtk_file_chooser_widget_class_init (GtkFileChooserWidgetClass *class)
    * For example, if you have three bookmarks, you can pass 0, 1, 2 to
    * this signal to switch to each of them, respectively.
    *
-   * The default binding for this signal is
-   * <keycombo><keycap>Alt</keycap><keycap>1</keycap></keycombo>,
-   * <keycombo><keycap>Alt</keycap><keycap>2</keycap></keycombo>,
-   * etc. until
-   * <keycombo><keycap>Alt</keycap><keycap>0</keycap></keycombo>.  Note
-   * that in the default binding,
-   * that <keycombo><keycap>Alt</keycap><keycap>1</keycap></keycombo> is
-   * actually defined to switch to the bookmark at index 0, and so on
-   * successively;
-   * <keycombo><keycap>Alt</keycap><keycap>0</keycap></keycombo> is
-   * defined to switch to the bookmark at index 10.
+   * The default binding for this signal is `Alt + 1`, `Alt + 2`,
+   * etc. until `Alt + 0`.  Note that in the default binding, that
+   * `Alt + 1` is actually defined to switch to the bookmark at index
+   * 0, and so on successively; `Alt + 0` is defined to switch to the
+   * bookmark at index 10.
    */
   signals[QUICK_BOOKMARK] =
     g_signal_new_class_handler (I_("quick-bookmark"),
@@ -7381,8 +7369,7 @@ gtk_file_chooser_widget_class_init (GtkFileChooserWidgetClass *class)
    *
    * This is used to make the file chooser display hidden files.
    *
-   * The default binding for this signal is
-   * <keycombo><keycap>Control</keycap><keycap>H</keycap></keycombo>.
+   * The default binding for this signal is `Control + H`.
    */
   signals[SHOW_HIDDEN] =
     g_signal_new_class_handler (I_("show-hidden"),
@@ -7403,8 +7390,7 @@ gtk_file_chooser_widget_class_init (GtkFileChooserWidgetClass *class)
    *
    * This is used to make the file chooser show the search entry.
    *
-   * The default binding for this signal is
-   * <keycombo><keycap>Alt</keycap><keycap>S</keycap></keycombo>.
+   * The default binding for this signal is `Alt + S`.
    */
   signals[SEARCH_SHORTCUT] =
     g_signal_new_class_handler (I_("search-shortcut"),
@@ -7425,8 +7411,7 @@ gtk_file_chooser_widget_class_init (GtkFileChooserWidgetClass *class)
    *
    * This is used to make the file chooser show the Recent location.
    *
-   * The default binding for this signal is
-   * <keycombo><keycap>Alt</keycap><keycap>R</keycap></keycombo>.
+   * The default binding for this signal is `Alt + R`.
    */
   signals[RECENT_SHORTCUT] =
     g_signal_new_class_handler (I_("recent-shortcut"),
diff --git a/gtk/gtkrecentchooser.c b/gtk/gtkrecentchooser.c
index 6c1c2d6..50ff1cd 100644
--- a/gtk/gtkrecentchooser.c
+++ b/gtk/gtkrecentchooser.c
@@ -104,7 +104,7 @@ gtk_recent_chooser_default_init (GtkRecentChooserInterface *iface)
    * This signal is emitted when the user "activates" a recent item
    * in the recent chooser.  This can happen by double-clicking on an item
    * in the recently used resources list, or by pressing
-   * <keycap>Enter</keycap>.
+   * `Enter`.
    *
    * Since: 2.10
    */
diff --git a/gtk/gtkscrollbar.c b/gtk/gtkscrollbar.c
index 63cdf38..ecd4c7e 100644
--- a/gtk/gtkscrollbar.c
+++ b/gtk/gtkscrollbar.c
@@ -50,7 +50,7 @@
  * scrollable area. The #GtkAdjustment:step-increment and
  * #GtkAdjustment:page-increment fields are properties when the user asks to
  * step down (using the small stepper arrows) or page down (using for
- * example the <keycap>PageDown</keycap> key).
+ * example the `Page Down` key).
  */
 
 
diff --git a/gtk/gtkscrolledwindow.c b/gtk/gtkscrolledwindow.c
index e17376e..5bea3e1 100644
--- a/gtk/gtkscrolledwindow.c
+++ b/gtk/gtkscrolledwindow.c
@@ -520,16 +520,13 @@ gtk_scrolled_window_class_init (GtkScrolledWindowClass *class)
    * @direction_type: either %GTK_DIR_TAB_FORWARD or
    *   %GTK_DIR_TAB_BACKWARD
    *
-   * The ::move-focus-out signal is a
-   * <link linkend="keybinding-signals">keybinding signal</link>
-   * which gets emitted when focus is moved away from the scrolled
-   * window by a keybinding.
-   * The #GtkWidget::move-focus signal is emitted with @direction_type
-   * on this scrolled windows toplevel parent in the container hierarchy.
-   * The default bindings for this signal are
-   * <keycombo><keycap>Tab</keycap><keycap>Ctrl</keycap></keycombo>
-   * and
-   * <keycombo><keycap>Tab</keycap><keycap>Ctrl</keycap><keycap>Shift</keycap></keycombo>.
+   * The ::move-focus-out signal is a <link
+   * linkend="keybinding-signals">keybinding signal</link> which gets
+   * emitted when focus is moved away from the scrolled window by a
+   * keybinding.  The #GtkWidget::move-focus signal is emitted with
+   * @direction_type on this scrolled windows toplevel parent in the
+   * container hierarchy.  The default bindings for this signal are
+   * `Tab + Ctrl` and `Tab + Ctrl + Shift`.
    */
   signals[MOVE_FOCUS_OUT] =
     g_signal_new (I_("move-focus-out"),
[Date Prev][Date Next] [Thread Prev][Thread Next] [Thread Index] [Date Index] [Author Index]