[gtk+] docs: use markdown instead of <filename> tags

From: William Jon McCann <mccann src gnome org>
To: commits-list gnome org
Cc:
Subject: [gtk+] docs: use markdown instead of <filename> tags
Date: Tue, 4 Feb 2014 22:03:59 +0000 (UTC)
commit 50e06e11eeeefd561eb88edcb1c46371970801ab
Author: William Jon McCann <william jon mccann gmail com>
Date:   Mon Feb 3 16:34:03 2014 -0500

    docs: use markdown instead of <filename> tags

 gdk/gdkcolor.c         |    2 +-
 gdk/gdkevents.h        |    2 +-
 gdk/gdkkeys.c          |    6 +++---
 gtk/deprecated/gtkrc.c |   22 +++++++++++-----------
 gtk/gtkbindings.c      |    2 +-
 gtk/gtkbuilder.c       |    2 +-
 gtk/gtkcssprovider.c   |    2 +-
 gtk/gtkimcontext.c     |    2 +-
 gtk/gtkplug.c          |    2 +-
 gtk/gtksettings.c      |   10 +++++-----
 gtk/gtkshow.c          |    6 +++---
 gtk/gtksocket.c        |    2 +-
 gtk/gtkstylecontext.c  |    2 +-
 gtk/gtkstyleprovider.h |    2 +-
 14 files changed, 32 insertions(+), 32 deletions(-)
---
diff --git a/gdk/gdkcolor.c b/gdk/gdkcolor.c
index e2371c9..4fe82d1 100644
--- a/gdk/gdkcolor.c
+++ b/gdk/gdkcolor.c
@@ -131,7 +131,7 @@ G_DEFINE_BOXED_TYPE (GdkColor, gdk_color,
  * @red, @green, and @blue fields of a #GdkColor.
  *
  * The string can either one of a large set of standard names
- * (taken from the X11 <filename>rgb.txt</filename> file), or
+ * (taken from the X11 `rgb.txt` file), or
  * it can be a hex value in the form '&num;rgb' '&num;rrggbb'
  * '&num;rrrgggbbb' or '&num;rrrrggggbbbb' where 'r', 'g' and
  * 'b' are hex digits of the red, green, and blue components
diff --git a/gdk/gdkevents.h b/gdk/gdkevents.h
index 8df160b..5ab75c0 100644
--- a/gdk/gdkevents.h
+++ b/gdk/gdkevents.h
@@ -791,7 +791,7 @@ struct _GdkEventScroll
  *   the modifier keys (e.g. Control, Shift and Alt) and the pointer
  *   buttons. See #GdkModifierType.
  * @keyval: the key that was pressed or released. See the
- *   <filename>&lt;gdk/gdkkeysyms.h&gt;</filename> header file for a
+ *   `gdk/gdkkeysyms.h` header file for a
  *   complete list of GDK key codes.
  * @length: the length of @string.
  * @string: a string containing an approximation of the text that
diff --git a/gdk/gdkkeys.c b/gdk/gdkkeys.c
index dbd0a5e..568cf3a 100644
--- a/gdk/gdkkeys.c
+++ b/gdk/gdkkeys.c
@@ -40,7 +40,7 @@
  * #GdkEventKey structure, which is passed to signal handlers for the
  * #GtkWidget::key-press-event and #GtkWidget::key-release-event signals.
  * The complete list of key values can be found in the
- * <filename>&lt;gdk/gdkkeysyms.h&gt;</filename> header file.
+ * `gdk/gdkkeysyms.h` header file.
  *
  * Key values are regularly updated from the upstream X.org X11 implementation,
  * so new values are added regularly. They will be prefixed with GDK_KEY_ rather
@@ -681,7 +681,7 @@ gdk_keymap_get_modifier_mask (GdkKeymap         *keymap,
  * Converts a key value into a symbolic name.
  *
  * The names are the same as those in the
- * <filename>&lt;gdk/gdkkeysyms.h&gt;</filename> header file
+ * `gdk/gdkkeysyms.h` header file
  * but without the leading "GDK_KEY_".
  *
  * Return value: (transfer none): a string containing the name of the key,
@@ -701,7 +701,7 @@ gdk_keyval_name (guint keyval)
  * Converts a key name to a key value.
  *
  * The names are the same as those in the
- * <filename>&lt;gdk/gdkkeysyms.h&gt;</filename> header file
+ * `gdk/gdkkeysyms.h` header file
  * but without the leading "GDK_KEY_".
  *
  * Returns: the corresponding key value, or %GDK_KEY_VoidSymbol
diff --git a/gtk/deprecated/gtkrc.c b/gtk/deprecated/gtkrc.c
index d18ecfe..c35635e 100644
--- a/gtk/deprecated/gtkrc.c
+++ b/gtk/deprecated/gtkrc.c
@@ -82,10 +82,10 @@
  * file by calling gtk_rc_parse(). In addition to this,
  * certain files will be read at the end of gtk_init().
  * Unless modified, the files looked for will be
- * <filename>&lt;SYSCONFDIR&gt;/gtk-2.0/gtkrc</filename>
- * and <filename>.gtkrc-3.0</filename> in the users home directory.
- * (<filename>&lt;SYSCONFDIR&gt;</filename> defaults to
- * <filename>/usr/local/etc</filename>. It can be changed with the
+ * `SYSCONFDIR/gtk-2.0/gtkrc`
+ * and `.gtkrc-3.0` in the users home directory.
+ * (`SYSCONFDIR` defaults to
+ * `/usr/local/etc`. It can be changed with the
  * <option>--prefix</option> or <option>--sysconfdir</option> options when
  * configuring GTK+.)
  *
@@ -101,8 +101,8 @@
  * For each RC file, in addition to the file itself, GTK+ will look for
  * a locale-specific file that will be parsed after the main file.
  * For instance, if `LANG` is set to <literal>ja_JP.ujis</literal>,
- * when loading the default file <filename>~/.gtkrc</filename> then GTK+ looks
- * for <filename>~/.gtkrc.ja_JP</filename> and <filename>~/.gtkrc.ja</filename>,
+ * when loading the default file `~/.gtkrc` then GTK+ looks
+ * for `~/.gtkrc.ja_JP` and `~/.gtkrc.ja`,
  * and parses the first of those that exists.
  *
  * # Pathnames and patterns #
@@ -184,14 +184,14 @@
  *
  * # Theme gtkrc files #
  *
- * Theme RC files are loaded first from under the <filename>~/.themes/</filename>,
+ * Theme RC files are loaded first from under the `~/.themes/`,
  * then from the directory from gtk_rc_get_theme_dir(). The files looked at will
- * be <filename>gtk-3.0/gtkrc</filename>.
+ * be `gtk-3.0/gtkrc`.
  *
  * When the application prefers dark themes
  * (see the #GtkSettings:gtk-application-prefer-dark-theme property for details),
- * <filename>gtk-3.0/gtkrc-dark</filename> will be loaded first, and if not present
- * <filename>gtk-3.0/gtkrc</filename> will be loaded.
+ * `gtk-3.0/gtkrc-dark` will be loaded first, and if not present
+ * `gtk-3.0/gtkrc` will be loaded.
  *
  * # Optimizing RC Style Matches #
  *
@@ -451,7 +451,7 @@
  *
  * <anchor id="color-format"/>
  * Colors can be specified as a string containing a color name (GTK+ knows
- * all names from the X color database <filename>/usr/lib/X11/rgb.txt</filename>),
+ * all names from the X color database `/usr/lib/X11/rgb.txt`),
  * in one of the hexadecimal forms <literal>#rrrrggggbbbb</literal>,
  * <literal>#rrrgggbbb</literal>, <literal>#rrggbb</literal>,
  * or <literal>#rgb</literal>, where <literal>r</literal>,
diff --git a/gtk/gtkbindings.c b/gtk/gtkbindings.c
index 53cb489..0647491 100644
--- a/gtk/gtkbindings.c
+++ b/gtk/gtkbindings.c
@@ -58,7 +58,7 @@
  * signal emissions on the target widget. Key combinations are strings
  * consisting of an optional #GdkModifierType name and
  * <link linkend="gdk3-Keyboard-Handling">key names</link>
- * such as those defined in <filename>&lt;gdk/gdkkeysyms.h&gt;</filename>
+ * such as those defined in `gdk/gdkkeysyms.h`
  * or returned from gdk_keyval_name(), they have to be parsable by
  * gtk_accelerator_parse(). Specifications of signal emissions consist
  * of a string identifying the signal name, and a list of signal specific
diff --git a/gtk/gtkbuilder.c b/gtk/gtkbuilder.c
index b5334a9..3e07cbf 100644
--- a/gtk/gtkbuilder.c
+++ b/gtk/gtkbuilder.c
@@ -65,7 +65,7 @@
  * <firstterm>UI definitions</firstterm> if the context is clear.
  * Do not confuse GtkBuilder UI Definitions with
  * <link linkend="XML-UI">GtkUIManager UI Definitions</link>, which
- * are more limited in scope. It is common to use <filename>.ui</filename>
+ * are more limited in scope. It is common to use `.ui`
  * as the filename extension for files containing GtkBuilder UI
  * definitions.
  * |[
diff --git a/gtk/gtkcssprovider.c b/gtk/gtkcssprovider.c
index ce16b53..93b2f84 100644
--- a/gtk/gtkcssprovider.c
+++ b/gtk/gtkcssprovider.c
@@ -281,7 +281,7 @@
  * by setting the gtk-key-bindings style property.
  *
  * Customized key bindings are typically defined in a separate
- * <filename>gtk-keys.css</filename> CSS file and GTK+ loads this file
+ * `gtk-keys.css` CSS file and GTK+ loads this file
  * according to the current key theme, which is defined by the
  * #GtkSettings:gtk-key-theme-name setting.
  *
diff --git a/gtk/gtkimcontext.c b/gtk/gtkimcontext.c
index 9e0a9eb..aab5efa 100644
--- a/gtk/gtkimcontext.c
+++ b/gtk/gtkimcontext.c
@@ -91,7 +91,7 @@
  * as specified in the #GtkIMContextInfo array returned by im_module_list().
  *
  * After a new loadable input method module has been installed on the system,
- * the configuration file <filename>gtk.immodules</filename> needs to be
+ * the configuration file `gtk.immodules` needs to be
  * regenerated by <link linkend="gtk-query-immodules-3.0">gtk-query-immodules-3.0</link>,
  * in order for the new input method to become available to GTK+ applications.
  */
diff --git a/gtk/gtkplug.c b/gtk/gtkplug.c
index 9390b5a..b93fb78 100644
--- a/gtk/gtkplug.c
+++ b/gtk/gtkplug.c
@@ -64,7 +64,7 @@
  * The #GtkPlug and #GtkSocket widgets are only available when GTK+
  * is compiled for the X11 platform and %GDK_WINDOWING_X11 is defined.
  * They can only be used on a #GdkX11Display. To use #GtkPlug and
- * #GtkSocket, you need to include the <filename>gtk/gtkx.h</filename>
+ * #GtkSocket, you need to include the `gtk/gtkx.h`
  * header.
  */
 
diff --git a/gtk/gtksettings.c b/gtk/gtksettings.c
index f28d7d3..f3a1453 100644
--- a/gtk/gtksettings.c
+++ b/gtk/gtksettings.c
@@ -71,13 +71,13 @@
  * manager that is usually part of the desktop environment, along with
  * utilities that let the user change these settings. In the absence of
  * an Xsettings manager, GTK+ reads default values for settings from
- * <filename>settings.ini</filename> files in
- * <filename>/etc/gtk-3.0</filename>, <filename>$XDG_CONFIG_DIRS/gtk-3.0</filename>
- * and <filename>$XDG_CONFIG_HOME/gtk-3.0</filename>.
+ * `settings.ini` files in
+ * `/etc/gtk-3.0`, `$XDG_CONFIG_DIRS/gtk-3.0`
+ * and `$XDG_CONFIG_HOME/gtk-3.0`.
  * These files must be valid key files (see #GKeyFile), and have
  * a section called Settings. Themes can also provide default values
- * for settings by installing a <filename>settings.ini</filename> file
- * next to their <filename>gtk.css</filename> file.
+ * for settings by installing a `settings.ini` file
+ * next to their `gtk.css` file.
  *
  * Applications can override system-wide settings with
  * gtk_settings_set_string_property(), gtk_settings_set_long_property(),
diff --git a/gtk/gtkshow.c b/gtk/gtkshow.c
index 2de66be..0bfb9cb 100644
--- a/gtk/gtkshow.c
+++ b/gtk/gtkshow.c
@@ -37,9 +37,9 @@
  * need to install gvfs to get support for uri schemes such as http://
  * or ftp://, as only local files are handled by GIO itself).
  * Typical examples are
- * - <filename>file:///home/gnome/pict.jpg</filename>
- * - <filename>http://www.gnome.org</filename>
- * - <filename>mailto:me&commat;gnome.org</filename>
+ * - `file:///home/gnome/pict.jpg`
+ * - `http://www.gnome.org`
+ * - `mailto:me&commat;gnome.org`
  * Ideally the timestamp is taken from the event triggering
  * the gtk_show_uri() call. If timestamp is not known you can take
  * %GDK_CURRENT_TIME.
diff --git a/gtk/gtksocket.c b/gtk/gtksocket.c
index 15ba2a8..ffd50c4 100644
--- a/gtk/gtksocket.c
+++ b/gtk/gtksocket.c
@@ -110,7 +110,7 @@
  * The #GtkPlug and #GtkSocket widgets are only available when GTK+
  * is compiled for the X11 platform and %GDK_WINDOWING_X11 is defined.
  * They can only be used on a #GdkX11Display. To use #GtkPlug and
- * #GtkSocket, you need to include the <filename>gtk/gtkx.h</filename>
+ * #GtkSocket, you need to include the `gtk/gtkx.h`
  * header.
  */
 
diff --git a/gtk/gtkstylecontext.c b/gtk/gtkstylecontext.c
index e6a0aaf..dca6ab7 100644
--- a/gtk/gtkstylecontext.c
+++ b/gtk/gtkstylecontext.c
@@ -231,7 +231,7 @@
  * to make your style information prevail to the theme's, so you must use
  * a #GtkStyleProvider with the %GTK_STYLE_PROVIDER_PRIORITY_APPLICATION
  * priority, keep in mind that the user settings in
- * <filename><replaceable>XDG_CONFIG_HOME</replaceable>/gtk-3.0/gtk.css</filename> will
+ * `<replaceable>XDG_CONFIG_HOME</replaceable>/gtk-3.0/gtk.css` will
  * still take precedence over your changes, as it uses the
  * %GTK_STYLE_PROVIDER_PRIORITY_USER priority.
  *
diff --git a/gtk/gtkstyleprovider.h b/gtk/gtkstyleprovider.h
index cb0960f..ef5c355 100644
--- a/gtk/gtkstyleprovider.h
+++ b/gtk/gtkstyleprovider.h
@@ -74,7 +74,7 @@ G_BEGIN_DECLS
  * GTK_STYLE_PROVIDER_PRIORITY_USER:
  *
  * The priority used for the style information from
- * <filename>~/.gtk-3.0.css</filename>.
+ * `~/.gtk-3.0.css`.
  *
  * You should not use priorities higher than this, to
  * give the user the last word.
[Date Prev][Date Next] [Thread Prev][Thread Next] [Thread Index] [Date Index] [Author Index]