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



commit d81e4edbd14b9e0aa3fc85b1a4e94c2b6d6cb2f7
Author: William Jon McCann <william jon mccann gmail com>
Date:   Tue Feb 4 18:30:46 2014 -0500

    docs: don't use <parameter> tags

 gtk/gtkfilechooserwidget.c |    2 +-
 gtk/gtkmain.c              |   12 ++++++------
 gtk/gtkstylecontext.c      |   11 +++--------
 gtk/gtktestutils.c         |    4 ++--
 4 files changed, 12 insertions(+), 17 deletions(-)
---
diff --git a/gtk/gtkfilechooserwidget.c b/gtk/gtkfilechooserwidget.c
index 4248000..cbd1ab3 100644
--- a/gtk/gtkfilechooserwidget.c
+++ b/gtk/gtkfilechooserwidget.c
@@ -7181,7 +7181,7 @@ gtk_file_chooser_widget_class_init (GtkFileChooserWidgetClass *class)
    * @path string of "`/`"
    * (a slash):  this lets you type <keycap>/</keycap> and
    * immediately type a path name.  On Unix systems, this is bound to
-   * <keycap>~</keycap> (tilde) with a <parameter>path</parameter> string
+   * <keycap>~</keycap> (tilde) with a @path string
    * of "~" itself for access to home directories.
    */
   signals[LOCATION_POPUP] =
diff --git a/gtk/gtkmain.c b/gtk/gtkmain.c
index 2324af5..1058d33 100644
--- a/gtk/gtkmain.c
+++ b/gtk/gtkmain.c
@@ -833,11 +833,11 @@ gtk_get_option_group (gboolean open_default_display)
 
 /**
  * gtk_init_with_args:
- * @argc: (inout): Address of the <parameter>argc</parameter> parameter of
+ * @argc: (inout): Address of the `argc` parameter of
  *     your main() function (or 0 if @argv is %NULL). This will be changed if 
  *     any arguments were handled.
  * @argv: (array length=argc) (inout) (allow-none): Address of the
- *     <parameter>argv</parameter> parameter of main(), or %NULL. Any options
+ *     `argv` 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 `--help` output, after
@@ -952,11 +952,11 @@ gtk_parse_args (int    *argc,
 
 /**
  * gtk_init_check:
- * @argc: (inout): Address of the <parameter>argc</parameter> parameter of
+ * @argc: (inout): Address of the `argc` parameter of
  *     your main() function (or 0 if @argv is %NULL). This will be changed if 
  *     any arguments were handled.
  * @argv: (array length=argc) (inout) (allow-none): Address of the
- *     <parameter>argv</parameter> parameter of main(), or %NULL. Any options
+ *     `argv` parameter of main(), or %NULL. Any options
  *     understood by GTK+ are stripped before return.
  *
  * This function does the same work as gtk_init() with only a single
@@ -986,11 +986,11 @@ gtk_init_check (int    *argc,
 
 /**
  * gtk_init:
- * @argc: (inout): Address of the <parameter>argc</parameter> parameter of
+ * @argc: (inout): Address of the `argc` parameter of
  *     your main() function (or 0 if @argv is %NULL). This will be changed if 
  *     any arguments were handled.
  * @argv: (array length=argc) (inout) (allow-none): Address of the
- *     <parameter>argv</parameter> parameter of main(), or %NULL. Any options
+ *     `argv` parameter of main(), or %NULL. Any options
  *     understood by GTK+ are stripped before return.
  *
  * Call this function before using any other GTK+ functions in your GUI
diff --git a/gtk/gtkstylecontext.c b/gtk/gtkstylecontext.c
index 247d1ca..11498a5 100644
--- a/gtk/gtkstylecontext.c
+++ b/gtk/gtkstylecontext.c
@@ -3855,9 +3855,7 @@ gtk_render_arrow (GtkStyleContext *context,
  * Renders the background of an element.
  *
  * Typical background rendering, showing the effect of
- * <parameter>background-image</parameter>,
- * <parameter>border-width</parameter> and
- * <parameter>border-radius</parameter>:
+ * `background-image`, `border-width` and `border-radius`:
  *
  * ![](background.png)
  *
@@ -3903,11 +3901,8 @@ gtk_render_background (GtkStyleContext *context,
  *
  * Renders a frame around the rectangle defined by @x, @y, @width, @height.
  *
- * Examples of frame rendering, showing the effect of
- * <parameter>border-image</parameter>,
- * <parameter>border-color</parameter>,
- * <parameter>border-width</parameter>,
- * <parameter>border-radius</parameter> and junctions:
+ * Examples of frame rendering, showing the effect of `border-image`,
+ * `border-color`, `border-width`, `border-radius` and junctions:
  *
  * ![](frames.png)
  *
diff --git a/gtk/gtktestutils.c b/gtk/gtktestutils.c
index 205f728..dc976e6 100644
--- a/gtk/gtktestutils.c
+++ b/gtk/gtktestutils.c
@@ -41,10 +41,10 @@
 
 /**
  * gtk_test_init:
- * @argcp: Address of the <parameter>argc</parameter> parameter of the
+ * @argcp: Address of the `argc` parameter of the
  *        main() function. Changed if any arguments were handled.
  * @argvp: (inout) (array length=argcp): Address of the 
- *        <parameter>argv</parameter> parameter of main().
+ *        `argv` parameter of main().
  *        Any parameters understood by g_test_init() or gtk_init() are
  *        stripped before return.
  * @...: currently unused


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