[gtk+] docs: use markdown for <envar> tags



commit a479ee5de5c1c58d82657a30aa01f7c3b885f4cc
Author: William Jon McCann <william jon mccann gmail com>
Date:   Mon Feb 3 16:20:00 2014 -0500

    docs: use markdown for <envar> tags

 gdk/gdk.c               |    2 +-
 gdk/gdkdisplaymanager.c |    4 ++--
 gdk/x11/gdkmain-x11.c   |    2 +-
 gtk/deprecated/gtkrc.c  |   12 ++++++------
 gtk/gtkapplication.c    |    2 +-
 gtk/gtkcssprovider.c    |    8 ++++----
 gtk/gtkfilechooser.c    |    2 +-
 7 files changed, 16 insertions(+), 16 deletions(-)
---
diff --git a/gdk/gdk.c b/gdk/gdk.c
index 664b011..7ec90f7 100644
--- a/gdk/gdk.c
+++ b/gdk/gdk.c
@@ -339,7 +339,7 @@ gdk_parse_args (int    *argc,
  * gdk_get_display:
  *
  * Gets the name of the display, which usually comes from the
- * <envar>DISPLAY</envar> environment variable or the
+ * `DISPLAY` environment variable or the
  * <option>--display</option> command line option.
  *
  * Returns: the name of the display.
diff --git a/gdk/gdkdisplaymanager.c b/gdk/gdkdisplaymanager.c
index e53556a..9870037 100644
--- a/gdk/gdkdisplaymanager.c
+++ b/gdk/gdkdisplaymanager.c
@@ -232,7 +232,7 @@ static const gchar *allowed_backends;
  * followed by the Quartz backend, and then all
  * others.
  *
- * If the <envar>GDK_BACKEND</envar> environment variable
+ * If the `GDK_BACKEND` environment variable
  * is set, it determines what backends are tried in what
  * order, while still respecting the set of allowed backends
  * that are specified by this function.
@@ -286,7 +286,7 @@ static GdkBackend gdk_backends[] = {
  * Gets the singleton #GdkDisplayManager object.
  *
  * When called for the first time, this function consults the
- * <envar>GDK_BACKEND</envar> environment variable to find out which
+ * `GDK_BACKEND` environment variable to find out which
  * of the supported GDK backends to use (in case GDK has been compiled
  * with multiple backends). Applications can use gdk_set_allowed_backends()
  * to limit what backends can be used.
diff --git a/gdk/x11/gdkmain-x11.c b/gdk/x11/gdkmain-x11.c
index 68d13a5..0b4a7d6 100644
--- a/gdk/x11/gdkmain-x11.c
+++ b/gdk/x11/gdkmain-x11.c
@@ -454,7 +454,7 @@ gdk_x11_get_default_root_xwindow (void)
  * 
  * Return value: (transfer none): the Xlib Display* for
  * the display specified in the <option>--display</option> command
- * line option or the <envar>DISPLAY</envar> environment variable.
+ * line option or the `DISPLAY` environment variable.
  **/
 Display *
 gdk_x11_get_default_xdisplay (void)
diff --git a/gtk/deprecated/gtkrc.c b/gtk/deprecated/gtkrc.c
index 97095f7..d18ecfe 100644
--- a/gtk/deprecated/gtkrc.c
+++ b/gtk/deprecated/gtkrc.c
@@ -93,14 +93,14 @@
  * can be retrieved with gtk_rc_get_default_files()
  * and modified with gtk_rc_add_default_file() and
  * gtk_rc_set_default_files().
- * Additionally, the <envar>GTK2_RC_FILES</envar> environment variable
+ * Additionally, the `GTK2_RC_FILES` environment variable
  * can be set to a #G_SEARCHPATH_SEPARATOR_S-separated list of files
  * in order to overwrite the set of default files at runtime.
 
  * <anchor id="locale-specific-rc"/>
  * 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 <envar>LANG</envar> is set to <literal>ja_JP.ujis</literal>,
+ * 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>,
  * and parses the first of those that exists.
@@ -294,7 +294,7 @@
  * * <literal>im_module_file <replaceable>pathname</replaceable></literal>
  *
  *    Sets the pathname for the IM modules file. Setting this from RC files
- *       is deprecated; you should use the environment variable <envar>GTK_IM_MODULE_FILE</envar>
+ *       is deprecated; you should use the environment variable `GTK_IM_MODULE_FILE`
  *       instead.
  *
  * * <literal>style <replaceable>name</replaceable> [ =
@@ -825,7 +825,7 @@ gtk_rc_make_default_dir (const gchar *type)
  * gtk_rc_get_im_module_path:
  *
  * Obtains the path in which to look for IM modules. See the documentation
- * of the <envar>GTK_PATH</envar>
+ * of the `GTK_PATH`
  * environment variable for more details about looking up modules. This
  * function is useful solely for utilities supplied with GTK+ and should
  * not be used by applications under normal circumstances.
@@ -849,7 +849,7 @@ gtk_rc_get_im_module_path (void)
  * gtk_rc_get_im_module_file:
  *
  * Obtains the path to the IM modules file. See the documentation
- * of the <envar>GTK_IM_MODULE_FILE</envar>
+ * of the `GTK_IM_MODULE_FILE`
  * environment variable for more details.
  *
  * Returns: (type filename): a newly-allocated string containing the
@@ -909,7 +909,7 @@ gtk_rc_get_theme_dir (void)
  *
  * Returns a directory in which GTK+ looks for theme engines.
  * For full information about the search for theme engines,
- * see the docs for <envar>GTK_PATH</envar> in
+ * see the docs for `GTK_PATH` in
  * <xref linkend="gtk-running"/>.
  *
  * return value: (type filename): the directory. (Must be freed with g_free())
diff --git a/gtk/gtkapplication.c b/gtk/gtkapplication.c
index 242cccb..87cbf5d 100644
--- a/gtk/gtkapplication.c
+++ b/gtk/gtkapplication.c
@@ -881,7 +881,7 @@ gtk_application_class_init (GtkApplicationClass *class)
  * Note that commandline arguments are not passed to gtk_init().
  * All GTK+ functionality that is available via commandline arguments
  * can also be achieved by setting suitable environment variables
- * such as <envar>G_DEBUG</envar>, so this should not be a big
+ * such as `G_DEBUG`, so this should not be a big
  * problem. If you absolutely must support GTK+ commandline arguments,
  * you can explicitly call gtk_init() before creating the application
  * instance.
diff --git a/gtk/gtkcssprovider.c b/gtk/gtkcssprovider.c
index 2848438..ce16b53 100644
--- a/gtk/gtkcssprovider.c
+++ b/gtk/gtkcssprovider.c
@@ -61,15 +61,15 @@
  * calling gtk_css_provider_load_from_file() and adding the provider with
  * gtk_style_context_add_provider() or gtk_style_context_add_provider_for_screen().
  * In addition, certain files will be read when GTK+ is initialized. First,
- * the file <filename><envar>$XDG_CONFIG_HOME</envar>/gtk-3.0/gtk.css</filename>
+ * the file `$XDG_CONFIG_HOME/gtk-3.0/gtk.css`
  * is loaded if it exists. Then, GTK+ tries to load
- * <filename><envar>$HOME</envar>/.themes/<replaceable>theme-name</replaceable>/gtk-3.0/gtk.css</filename>,
+ * `$HOME/.themes/<replaceable>theme-name</replaceable>/gtk-3.0/gtk.css`,
  * falling back to
- * 
<filename><replaceable>datadir</replaceable>/share/themes/<replaceable>theme-name</replaceable>/gtk-3.0/gtk.css</filename>,
+ * `<replaceable>datadir</replaceable>/share/themes/<replaceable>theme-name</replaceable>/gtk-3.0/gtk.css`,
  * where <replaceable>theme-name</replaceable> is the name of the current theme
  * (see the #GtkSettings:gtk-theme-name setting) and <replaceable>datadir</replaceable>
  * is the prefix configured when GTK+ was compiled, unless overridden by the
- * <envar>GTK_DATA_PREFIX</envar> environment variable.
+ * `GTK_DATA_PREFIX` environment variable.
  * 
  * ## Style sheets
  *
diff --git a/gtk/gtkfilechooser.c b/gtk/gtkfilechooser.c
index 68aa4c4..00d0c0c 100644
--- a/gtk/gtkfilechooser.c
+++ b/gtk/gtkfilechooser.c
@@ -63,7 +63,7 @@
  * rules are applied if the URI contains non-ASCII characters.
  * However, filenames are always returned in
  * the character set specified by the
- * <envar>G_FILENAME_ENCODING</envar> environment variable.
+ * `G_FILENAME_ENCODING` environment variable.
  * Please see the GLib documentation for more details about this
  * variable.
  *


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]