[glib] Stop using replaceable tags
- From: Matthias Clasen <matthiasc src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [glib] Stop using replaceable tags
- Date: Thu, 6 Feb 2014 21:49:56 +0000 (UTC)
commit df990914cf28a4b8417597d5b2208aa2bf34e694
Author: Matthias Clasen <mclasen redhat com>
Date: Thu Feb 6 16:49:29 2014 -0500
Stop using replaceable tags
gio/gfileattribute.c | 6 +++---
gio/gsettings.c | 8 ++++----
glib/goption.c | 22 +++++++++-------------
glib/gtestutils.c | 14 ++++++--------
4 files changed, 22 insertions(+), 28 deletions(-)
---
diff --git a/gio/gfileattribute.c b/gio/gfileattribute.c
index 78f94e6..426143b 100644
--- a/gio/gfileattribute.c
+++ b/gio/gfileattribute.c
@@ -207,9 +207,9 @@
* "xattr::". Keys for the "xattr-sys" namespace are constructed by
* concatenating "xattr-sys::" with the extended attribute name. All extended
* attribute values are returned as hex-encoded strings in which bytes outside
- * the ASCII range are encoded as hexadecimal escape sequences of the form
- * \x<replaceable>nn</replaceable>.
- **/
+ * the ASCII range are encoded as escape sequences of the form \x`nn`
+ * where `nn` is a 2-digit hexadecimal number.
+ */
/*
* _g_file_attribute_value_free:
diff --git a/gio/gsettings.c b/gio/gsettings.c
index 4e171ba..aaf4c21 100644
--- a/gio/gsettings.c
+++ b/gio/gsettings.c
@@ -2172,11 +2172,11 @@ g_settings_is_writable (GSettings *settings,
/**
* g_settings_get_child:
* @settings: a #GSettings object
- * @name: the name of the 'child' schema
+ * @name: the name of the child schema
*
- * Creates a 'child' settings object which has a base path of
- * <replaceable>base-path</replaceable>/@name, where
- * <replaceable>base-path</replaceable> is the base path of @settings.
+ * Creates a child settings object which has a base path of
+ * `base-path/@name`, where `base-path` is the base path of
+ * @settings.
*
* The schema for the child settings object must have been declared
* in the schema of @settings using a <child> element.
diff --git a/glib/goption.c b/glib/goption.c
index 1a4459e..9d251ff 100644
--- a/glib/goption.c
+++ b/glib/goption.c
@@ -52,11 +52,9 @@
* Another important feature of GOption is that it can automatically
* generate nicely formatted help output. Unless it is explicitly turned
* off with g_option_context_set_help_enabled(), GOption will recognize
- * the `--help`, `-?`, `--help-all` and
- * `--help-`<replaceable>groupname</replaceable> options
- * (where <replaceable>groupname</replaceable> is the name of a
- * #GOptionGroup) and write a text similar to the one shown in the
- * following example to stdout.
+ * the `--help`, `-?`, `--help-all` and `--help-groupname` options
+ * (where `groupname` is the name of a #GOptionGroup) and write a text
+ * similar to the one shown in the following example to stdout.
*
* |[
* Usage:
@@ -325,9 +323,8 @@ G_DEFINE_QUARK (g-option-context-error-quark, g_option_error)
/**
* g_option_context_new:
* @parameter_string: (allow-none): a string which is displayed in
- * the first line of `--help` output, after the
- * usage summary
- * `<replaceable>programname</replaceable> [OPTION...]`
+ * the first line of `--help` output, after the usage summary
+ * `programname [OPTION...]`
*
* Creates a new option context.
*
@@ -409,11 +406,10 @@ void g_option_context_free (GOptionContext *context)
* @context: a #GOptionContext
* @help_enabled: %TRUE to enable `--help`, %FALSE to disable it
*
- * Enables or disables automatic generation of `--help`
- * output. By default, g_option_context_parse() recognizes
- * `--help`, `-h`, `-?`, `--help-all`
- * and `--help-`<replaceable>groupname</replaceable> and creates
- * suitable output to stdout.
+ * Enables or disables automatic generation of `--help` output.
+ * By default, g_option_context_parse() recognizes `--help`, `-h`,
+ * `-?`, `--help-all` and `--help-groupname` and creates suitable
+ * output to stdout.
*
* Since: 2.6
*/
diff --git a/glib/gtestutils.c b/glib/gtestutils.c
index 33366ca..bfcc8e1 100644
--- a/glib/gtestutils.c
+++ b/glib/gtestutils.c
@@ -1453,11 +1453,9 @@ g_test_get_root (void)
*
* Runs all tests under the toplevel suite which can be retrieved
* with g_test_get_root(). Similar to g_test_run_suite(), the test
- * cases to be run are filtered according to
- * test path arguments (-p <replaceable>testpath</replaceable>) as
- * parsed by g_test_init().
- * g_test_run_suite() or g_test_run() may only be called once
- * in a program.
+ * cases to be run are filtered according to test path arguments
+ * (`-p testpath`) as parsed by g_test_init(). g_test_run_suite()
+ * or g_test_run() may only be called once in a program.
*
* In general, the tests and sub-suites within each suite are run in
* the order in which they are defined. However, note that prior to
@@ -2144,9 +2142,9 @@ g_test_run_suite_internal (GTestSuite *suite,
*
* Execute the tests within @suite and all nested #GTestSuites.
* The test suites to be executed are filtered according to
- * test path arguments (-p <replaceable>testpath</replaceable>)
- * as parsed by g_test_init(). See the g_test_run() documentation
- * for more information on the order that tests are run in.
+ * test path arguments (`-p testpath`) as parsed by g_test_init().
+ * See the g_test_run() documentation for more information on the
+ * order that tests are run in.
*
* g_test_run_suite() or g_test_run() may only be called once
* in a program.
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]