[kdbus] sync with kdbus (kdbus.h - commit: 5ae1ecac44cb)

[platform/upstream/glib.git] / glib / ggettext.c

diff --git a/glib/ggettext.c b/glib/ggettext.c
index bd5c9d4..636fdbb 100644 (file)
--- a/glib/ggettext.c
+++ b/glib/ggettext.c
@@ -162,7 +162,7 @@ glib_pgettext (const gchar *msgctxtid,
  *
  * An auxiliary function for gettext() support (see Q_()).
  *
- * Return value: @msgval, unless @msgval is identical to @msgid
+ * Returns: @msgval, unless @msgval is identical to @msgid
  *     and contains a '|' character, in which case a pointer to
  *     the substring of msgid after the first '|' character is returned.
  *
@@ -370,17 +370,19 @@ _g_dgettext_should_translate (void)
  *
  * This function disables translations if and only if upon its first
  * call all the following conditions hold:
- * <itemizedlist>
- * <listitem>@domain is not %NULL</listitem>
- * <listitem>textdomain() has been called to set a default text domain</listitem>
- * <listitem>there is no translations available for the default text domain
- *           and the current locale</listitem>
- * <listitem>current locale is not "C" or any English locales (those
- *           starting with "en_")</listitem>
- * </itemizedlist>
+ * 
+ * - @domain is not %NULL
+ *
+ * - textdomain() has been called to set a default text domain
+ *
+ * - there is no translations available for the default text domain
+ *   and the current locale
+ *
+ * - current locale is not "C" or any English locales (those
+ *   starting with "en_")
  *
  * Note that this behavior may not be desired for example if an application
- * has its untranslated messages in a language other than English.  In those
+ * has its untranslated messages in a language other than English. In those
  * cases the application should call textdomain() after initializing GTK+.
  *
  * Applications should normally not use this function directly,
@@ -408,7 +410,7 @@ g_dgettext (const gchar *domain,
  * @category: a locale category
  *
  * This is a variant of g_dgettext() that allows specifying a locale
- * category instead of always using <envar>LC_MESSAGES</envar>. See g_dgettext() for
+ * category instead of always using `LC_MESSAGES`. See g_dgettext() for
  * more information about how this functions differs from calling
  * dcgettext() directly.
  *
@@ -471,12 +473,12 @@ g_dngettext (const gchar *domain,
  * easy-to-use form.
  *
  * In order to use these macros in an application, you must include
- * <filename>glib/gi18n.h</filename>. For use in a library, you must include
- * <filename>glib/gi18n-lib.h</filename> <emphasis>after</emphasis> defining
- * the GETTEXT_PACKAGE macro suitably for your library:
- * |[
- * &num;define GETTEXT_PACKAGE "gtk20"
- * &num;include &lt;glib/gi18n-lib.h&gt;
+ * `<glib/gi18n.h>`. For use in a library, you must include
+ * `<glib/gi18n-lib.h>`
+ * after defining the %GETTEXT_PACKAGE macro suitably for your library:
+ * |[<!-- language="C" -->
+ * #define GETTEXT_PACKAGE "gtk20"
+ * #include <glib/gi18n-lib.h>
  * ]|
  * For an application, note that you also have to call bindtextdomain(),
  * bind_textdomain_codeset(), textdomain() and setlocale() early on in your
@@ -521,9 +523,9 @@ g_dngettext (const gchar *domain,
  * with context.
  *
  * If you are using the Q_() macro, you need to make sure that you pass
- * <option>--keyword=Q_</option> to xgettext when extracting messages.
+ * `--keyword=Q_` to xgettext when extracting messages.
  * If you are using GNU gettext >= 0.15, you can also use
- * <option>--keyword=Q_:1g</option> to let xgettext split the context
+ * `--keyword=Q_:1g` to let xgettext split the context
  * string off into a msgctxt line in the po file.
  *
  * Returns: the translated message
@@ -540,13 +542,13 @@ g_dngettext (const gchar *domain,
  * used as a context. This is mainly useful for short strings which
  * may need different translations, depending on the context in which
  * they are used.
- * |[
+ * |[<!-- language="C" -->
  * label1 = C_("Navigation", "Back");
  * label2 = C_("Body part", "Back");
  * ]|
  *
  * If you are using the C_() macro, you need to make sure that you pass
- * <option>--keyword=C_:1c,2</option> to xgettext when extracting messages.
+ * `--keyword=C_:1c,2` to xgettext when extracting messages.
  * Note that this only works with GNU gettext >= 0.15.
  *
  * Returns: the translated message
@@ -562,7 +564,7 @@ g_dngettext (const gchar *domain,
  * where the translated strings can't be directly used, e.g. in string
  * array initializers. To get the translated string, call gettext()
  * at runtime.
- * |[
+ * |[<!-- language="C" -->
  * {
  *   static const char *messages[] = {
  *     N_("some very meaningful message"),
@@ -591,7 +593,7 @@ g_dngettext (const gchar *domain,
  * be directly used, e.g. in string array initializers. To get the
  * translated string, you should call g_dpgettext2() at runtime.
  *
- * |[
+ * |[<!-- language="C" -->
  * {
  *   static const char *messages[] = {
  *     NC_("some context", "some very meaningful message"),
@@ -600,8 +602,8 @@ g_dngettext (const gchar *domain,
  *   const char *string;
  *   ...
  *   string
- *     = index &gt; 1 ? g_dpgettext2 (NULL, "some context", "a default message")
- *                    : g_dpgettext2 (NULL, "some context", messages[index]);
+ *     = index > 1 ? g_dpgettext2 (NULL, "some context", "a default message")
+ *                 : g_dpgettext2 (NULL, "some context", messages[index]);
  *
  *   fputs (string);
  *   ...
@@ -609,7 +611,7 @@ g_dngettext (const gchar *domain,
  * ]|
  *
  * If you are using the NC_() macro, you need to make sure that you pass
- * <option>--keyword=NC_:1c,2</option> to xgettext when extracting messages.
+ * `--keyword=NC_:1c,2` to xgettext when extracting messages.
  * Note that this only works with GNU gettext >= 0.15. Intltool has support
  * for the NC_() macro since version 0.40.1.
  *