Commit 50e06e11 authored by William Jon McCann's avatar William Jon McCann

docs: use markdown instead of <filename> tags

parent a479ee5d
...@@ -131,7 +131,7 @@ G_DEFINE_BOXED_TYPE (GdkColor, gdk_color, ...@@ -131,7 +131,7 @@ G_DEFINE_BOXED_TYPE (GdkColor, gdk_color,
* @red, @green, and @blue fields of a #GdkColor. * @red, @green, and @blue fields of a #GdkColor.
* *
* The string can either one of a large set of standard names * 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' * it can be a hex value in the form '&num;rgb' '&num;rrggbb'
* '&num;rrrgggbbb' or '&num;rrrrggggbbbb' where 'r', 'g' and * '&num;rrrgggbbb' or '&num;rrrrggggbbbb' where 'r', 'g' and
* 'b' are hex digits of the red, green, and blue components * 'b' are hex digits of the red, green, and blue components
......
...@@ -791,7 +791,7 @@ struct _GdkEventScroll ...@@ -791,7 +791,7 @@ struct _GdkEventScroll
* the modifier keys (e.g. Control, Shift and Alt) and the pointer * the modifier keys (e.g. Control, Shift and Alt) and the pointer
* buttons. See #GdkModifierType. * buttons. See #GdkModifierType.
* @keyval: the key that was pressed or released. See the * @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. * complete list of GDK key codes.
* @length: the length of @string. * @length: the length of @string.
* @string: a string containing an approximation of the text that * @string: a string containing an approximation of the text that
......
...@@ -40,7 +40,7 @@ ...@@ -40,7 +40,7 @@
* #GdkEventKey structure, which is passed to signal handlers for the * #GdkEventKey structure, which is passed to signal handlers for the
* #GtkWidget::key-press-event and #GtkWidget::key-release-event signals. * #GtkWidget::key-press-event and #GtkWidget::key-release-event signals.
* The complete list of key values can be found in the * 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, * 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 * 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, ...@@ -681,7 +681,7 @@ gdk_keymap_get_modifier_mask (GdkKeymap *keymap,
* Converts a key value into a symbolic name. * Converts a key value into a symbolic name.
* *
* The names are the same as those in the * 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_". * but without the leading "GDK_KEY_".
* *
* Return value: (transfer none): a string containing the name of the key, * Return value: (transfer none): a string containing the name of the key,
...@@ -701,7 +701,7 @@ gdk_keyval_name (guint keyval) ...@@ -701,7 +701,7 @@ gdk_keyval_name (guint keyval)
* Converts a key name to a key value. * Converts a key name to a key value.
* *
* The names are the same as those in the * 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_". * but without the leading "GDK_KEY_".
* *
* Returns: the corresponding key value, or %GDK_KEY_VoidSymbol * Returns: the corresponding key value, or %GDK_KEY_VoidSymbol
......
...@@ -82,10 +82,10 @@ ...@@ -82,10 +82,10 @@
* file by calling gtk_rc_parse(). In addition to this, * file by calling gtk_rc_parse(). In addition to this,
* certain files will be read at the end of gtk_init(). * certain files will be read at the end of gtk_init().
* Unless modified, the files looked for will be * Unless modified, the files looked for will be
* <filename>&lt;SYSCONFDIR&gt;/gtk-2.0/gtkrc</filename> * `SYSCONFDIR/gtk-2.0/gtkrc`
* and <filename>.gtkrc-3.0</filename> in the users home directory. * and `.gtkrc-3.0` in the users home directory.
* (<filename>&lt;SYSCONFDIR&gt;</filename> defaults to * (`SYSCONFDIR` defaults to
* <filename>/usr/local/etc</filename>. It can be changed with the * `/usr/local/etc`. It can be changed with the
* <option>--prefix</option> or <option>--sysconfdir</option> options when * <option>--prefix</option> or <option>--sysconfdir</option> options when
* configuring GTK+.) * configuring GTK+.)
* *
...@@ -101,8 +101,8 @@ ...@@ -101,8 +101,8 @@
* For each RC file, in addition to the file itself, GTK+ will look for * 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. * a locale-specific file that will be parsed after the main file.
* For instance, if `LANG` 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 * when loading the default file `~/.gtkrc` then GTK+ looks
* for <filename>~/.gtkrc.ja_JP</filename> and <filename>~/.gtkrc.ja</filename>, * for `~/.gtkrc.ja_JP` and `~/.gtkrc.ja`,
* and parses the first of those that exists. * and parses the first of those that exists.
* *
* # Pathnames and patterns # * # Pathnames and patterns #
...@@ -184,14 +184,14 @@ ...@@ -184,14 +184,14 @@
* *
* # Theme gtkrc files # * # 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 * 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 * When the application prefers dark themes
* (see the #GtkSettings:gtk-application-prefer-dark-theme property for details), * (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 * `gtk-3.0/gtkrc-dark` will be loaded first, and if not present
* <filename>gtk-3.0/gtkrc</filename> will be loaded. * `gtk-3.0/gtkrc` will be loaded.
* *
* # Optimizing RC Style Matches # * # Optimizing RC Style Matches #
* *
...@@ -451,7 +451,7 @@ ...@@ -451,7 +451,7 @@
* *
* <anchor id="color-format"/> * <anchor id="color-format"/>
* Colors can be specified as a string containing a color name (GTK+ knows * 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>, * in one of the hexadecimal forms <literal>#rrrrggggbbbb</literal>,
* <literal>#rrrgggbbb</literal>, <literal>#rrggbb</literal>, * <literal>#rrrgggbbb</literal>, <literal>#rrggbb</literal>,
* or <literal>#rgb</literal>, where <literal>r</literal>, * or <literal>#rgb</literal>, where <literal>r</literal>,
......
...@@ -58,7 +58,7 @@ ...@@ -58,7 +58,7 @@
* signal emissions on the target widget. Key combinations are strings * signal emissions on the target widget. Key combinations are strings
* consisting of an optional #GdkModifierType name and * consisting of an optional #GdkModifierType name and
* <link linkend="gdk3-Keyboard-Handling">key names</link> * <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 * or returned from gdk_keyval_name(), they have to be parsable by
* gtk_accelerator_parse(). Specifications of signal emissions consist * gtk_accelerator_parse(). Specifications of signal emissions consist
* of a string identifying the signal name, and a list of signal specific * of a string identifying the signal name, and a list of signal specific
......
...@@ -65,7 +65,7 @@ ...@@ -65,7 +65,7 @@
* <firstterm>UI definitions</firstterm> if the context is clear. * <firstterm>UI definitions</firstterm> if the context is clear.
* Do not confuse GtkBuilder UI Definitions with * Do not confuse GtkBuilder UI Definitions with
* <link linkend="XML-UI">GtkUIManager UI Definitions</link>, which * <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 * as the filename extension for files containing GtkBuilder UI
* definitions. * definitions.
* |[ * |[
......
...@@ -281,7 +281,7 @@ ...@@ -281,7 +281,7 @@
* by setting the gtk-key-bindings style property. * by setting the gtk-key-bindings style property.
* *
* Customized key bindings are typically defined in a separate * 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 * according to the current key theme, which is defined by the
* #GtkSettings:gtk-key-theme-name setting. * #GtkSettings:gtk-key-theme-name setting.
* *
......
...@@ -91,7 +91,7 @@ ...@@ -91,7 +91,7 @@
* as specified in the #GtkIMContextInfo array returned by im_module_list(). * as specified in the #GtkIMContextInfo array returned by im_module_list().
* *
* After a new loadable input method module has been installed on the system, * 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>, * 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. * in order for the new input method to become available to GTK+ applications.
*/ */
......
...@@ -64,7 +64,7 @@ ...@@ -64,7 +64,7 @@
* The #GtkPlug and #GtkSocket widgets are only available when GTK+ * The #GtkPlug and #GtkSocket widgets are only available when GTK+
* is compiled for the X11 platform and %GDK_WINDOWING_X11 is defined. * is compiled for the X11 platform and %GDK_WINDOWING_X11 is defined.
* They can only be used on a #GdkX11Display. To use #GtkPlug and * 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. * header.
*/ */
......
...@@ -71,13 +71,13 @@ ...@@ -71,13 +71,13 @@
* manager that is usually part of the desktop environment, along with * manager that is usually part of the desktop environment, along with
* utilities that let the user change these settings. In the absence of * utilities that let the user change these settings. In the absence of
* an Xsettings manager, GTK+ reads default values for settings from * an Xsettings manager, GTK+ reads default values for settings from
* <filename>settings.ini</filename> files in * `settings.ini` files in
* <filename>/etc/gtk-3.0</filename>, <filename>$XDG_CONFIG_DIRS/gtk-3.0</filename> * `/etc/gtk-3.0`, `$XDG_CONFIG_DIRS/gtk-3.0`
* and <filename>$XDG_CONFIG_HOME/gtk-3.0</filename>. * and `$XDG_CONFIG_HOME/gtk-3.0`.
* These files must be valid key files (see #GKeyFile), and have * These files must be valid key files (see #GKeyFile), and have
* a section called Settings. Themes can also provide default values * a section called Settings. Themes can also provide default values
* for settings by installing a <filename>settings.ini</filename> file * for settings by installing a `settings.ini` file
* next to their <filename>gtk.css</filename> file. * next to their `gtk.css` file.
* *
* Applications can override system-wide settings with * Applications can override system-wide settings with
* gtk_settings_set_string_property(), gtk_settings_set_long_property(), * gtk_settings_set_string_property(), gtk_settings_set_long_property(),
......
...@@ -37,9 +37,9 @@ ...@@ -37,9 +37,9 @@
* need to install gvfs to get support for uri schemes such as http:// * need to install gvfs to get support for uri schemes such as http://
* or ftp://, as only local files are handled by GIO itself). * or ftp://, as only local files are handled by GIO itself).
* Typical examples are * Typical examples are
* - <filename>file:///home/gnome/pict.jpg</filename> * - `file:///home/gnome/pict.jpg`
* - <filename>http://www.gnome.org</filename> * - `http://www.gnome.org`
* - <filename>mailto:me&commat;gnome.org</filename> * - `mailto:me&commat;gnome.org`
* Ideally the timestamp is taken from the event triggering * Ideally the timestamp is taken from the event triggering
* the gtk_show_uri() call. If timestamp is not known you can take * the gtk_show_uri() call. If timestamp is not known you can take
* %GDK_CURRENT_TIME. * %GDK_CURRENT_TIME.
......
...@@ -110,7 +110,7 @@ ...@@ -110,7 +110,7 @@
* The #GtkPlug and #GtkSocket widgets are only available when GTK+ * The #GtkPlug and #GtkSocket widgets are only available when GTK+
* is compiled for the X11 platform and %GDK_WINDOWING_X11 is defined. * is compiled for the X11 platform and %GDK_WINDOWING_X11 is defined.
* They can only be used on a #GdkX11Display. To use #GtkPlug and * 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. * header.
*/ */
......
...@@ -231,7 +231,7 @@ ...@@ -231,7 +231,7 @@
* to make your style information prevail to the theme's, so you must use * to make your style information prevail to the theme's, so you must use
* a #GtkStyleProvider with the %GTK_STYLE_PROVIDER_PRIORITY_APPLICATION * a #GtkStyleProvider with the %GTK_STYLE_PROVIDER_PRIORITY_APPLICATION
* priority, keep in mind that the user settings in * 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 * still take precedence over your changes, as it uses the
* %GTK_STYLE_PROVIDER_PRIORITY_USER priority. * %GTK_STYLE_PROVIDER_PRIORITY_USER priority.
* *
......
...@@ -74,7 +74,7 @@ G_BEGIN_DECLS ...@@ -74,7 +74,7 @@ G_BEGIN_DECLS
* GTK_STYLE_PROVIDER_PRIORITY_USER: * GTK_STYLE_PROVIDER_PRIORITY_USER:
* *
* The priority used for the style information from * 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 * You should not use priorities higher than this, to
* give the user the last word. * give the user the last word.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment