Commit 2dcbe27a authored by William Jon McCann's avatar William Jon McCann

docs: don't use <option>

parent 7dcbfe11
......@@ -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.
*
......
......@@ -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
......
......@@ -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 *
......
......@@ -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
......
......@@ -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
......
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