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



commit 2dcbe27a06d2a0ef4c3ba507d41243d1c6565117
Author: William Jon McCann <william jon mccann gmail com>
Date:   Tue Feb 4 17:48:33 2014 -0500

    docs: don't use <option>

 gdk/gdk.c              |    4 ++--
 gdk/gdkevents.c        |    2 +-
 gdk/x11/gdkmain-x11.c  |    2 +-
 gtk/deprecated/gtkrc.c |    2 +-
 gtk/gtkmain.c          |    6 +++---
 5 files changed, 8 insertions(+), 8 deletions(-)
---
diff --git a/gdk/gdk.c b/gdk/gdk.c
index 7ec90f7..075f7c0 100644
--- a/gdk/gdk.c
+++ b/gdk/gdk.c
@@ -340,7 +340,7 @@ gdk_parse_args (int    *argc,
  *
  * Gets the name of the display, which usually comes from the
  * `DISPLAY` environment variable or the
- * <option>--display</option> command line option.
+ * `--display` command line option.
  *
  * Returns: the name of the display.
  *
@@ -1098,7 +1098,7 @@ gdk_threads_add_timeout_seconds (guint       interval,
  * gdk_get_program_class:
  *
  * Gets the program class. Unless the program class has explicitly
- * been set with gdk_set_program_class() or with the <option>--class</option>
+ * been set with gdk_set_program_class() or with the `--class`
  * commandline option, the default value is the program name (determined
  * with g_get_prgname()) with the first character converted to uppercase.
  *
diff --git a/gdk/gdkevents.c b/gdk/gdkevents.c
index a569d6d..70bd6d8 100644
--- a/gdk/gdkevents.c
+++ b/gdk/gdkevents.c
@@ -1975,7 +1975,7 @@ gdk_event_get_event_sequence (const GdkEvent *event)
  * 
  * Sets whether a trace of received events is output.
  * Note that GTK+ must be compiled with debugging (that is,
- * configured using the <option>--enable-debug</option> option)
+ * configured using the `--enable-debug` option)
  * to use this option.
  **/
 void
diff --git a/gdk/x11/gdkmain-x11.c b/gdk/x11/gdkmain-x11.c
index 0b4a7d6..b99e1fe 100644
--- a/gdk/x11/gdkmain-x11.c
+++ b/gdk/x11/gdkmain-x11.c
@@ -453,7 +453,7 @@ gdk_x11_get_default_root_xwindow (void)
  * Gets the default GTK+ display.
  * 
  * Return value: (transfer none): the Xlib Display* for
- * the display specified in the <option>--display</option> command
+ * the display specified in the `--display` command
  * line option or the `DISPLAY` environment variable.
  **/
 Display *
diff --git a/gtk/deprecated/gtkrc.c b/gtk/deprecated/gtkrc.c
index c35635e..d7eb201 100644
--- a/gtk/deprecated/gtkrc.c
+++ b/gtk/deprecated/gtkrc.c
@@ -86,7 +86,7 @@
  * 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
+ * `--prefix` or `--sysconfdir` options when
  * configuring GTK+.)
  *
  * The set of these <firstterm>default</firstterm> files
diff --git a/gtk/gtkmain.c b/gtk/gtkmain.c
index fe19e42..9234782 100644
--- a/gtk/gtkmain.c
+++ b/gtk/gtkmain.c
@@ -840,19 +840,19 @@ gtk_get_option_group (gboolean open_default_display)
  *     <parameter>argv</parameter> parameter of main(), or %NULL. Any options
  *     understood by GTK+ are stripped before return.
  * @parameter_string: (allow-none): a string which is displayed in
- *    the first line of <option>--help</option> output, after
+ *    the first line of `--help` output, after
  *    <literal><replaceable>programname</replaceable> [OPTION...]</literal>
  * @entries: (array zero-terminated=1): a %NULL-terminated array
  *    of #GOptionEntrys describing the options of your program
  * @translation_domain: a translation domain to use for translating
- *    the <option>--help</option> output for the options in @entries
+ *    the `--help` output for the options in @entries
  *    and the @parameter_string with gettext(), or %NULL
  * @error: a return location for errors
  *
  * This function does the same work as gtk_init_check().
  * Additionally, it allows you to add your own commandline options,
  * and it automatically generates nicely formatted
- * <option>--help</option> output. Note that your program will
+ * `--help` output. Note that your program will
  * be terminated after writing out the help output.
  *
  * Returns: %TRUE if the windowing system has been successfully


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