[glib/gvariant] remove trailing space from GVariant XML docs



commit 34a247899a40bd789fb9464c096d42d7a3819c67
Author: Ryan Lortie <desrt desrt ca>
Date:   Thu Jan 21 14:50:20 2010 -0500

    remove trailing space from GVariant XML docs

 docs/reference/glib/gvariant-varargs.xml |   90 +++++++++++++++---------------
 1 files changed, 45 insertions(+), 45 deletions(-)
---
diff --git a/docs/reference/glib/gvariant-varargs.xml b/docs/reference/glib/gvariant-varargs.xml
index f4217e1..fd29551 100644
--- a/docs/reference/glib/gvariant-varargs.xml
+++ b/docs/reference/glib/gvariant-varargs.xml
@@ -7,11 +7,11 @@
   <title>Variable Argument Conversions</title>
 
   <para>
-   This page attempts to document how to perform variable argument conversions with GVariant. 
+   This page attempts to document how to perform variable argument conversions with GVariant.
   </para>
   <para>
    A conversion string is a two-way mapping between a single <link linkend='GVariant'>GVariant</link> value and one or
-   more C values. 
+   more C values.
   </para>
   <para>
    A conversion from C values into a <link linkend='GVariant'>GVariant</link> value is made using the
@@ -27,7 +27,7 @@
   <para>
    This section exhaustively describes all possibilities for GVariant format strings.  There are no valid forms of
    format strings other than those described here.  Please note that the format string syntax is likely to expand in the
-   future. 
+   future.
   </para>
   <para>
    Valid format strings have one of the following forms:
@@ -38,17 +38,17 @@
    </listitem>
    <listitem>
     <para>
-     a type string prefixed with a '<literal>@</literal>' 
+     a type string prefixed with a '<literal>@</literal>'
     </para>
    </listitem>
    <listitem>
     <para>
-     a type string of a concrete, fixed-sized type, prefixed with a '<literal>&amp;</literal>' 
+     a type string of a concrete, fixed-sized type, prefixed with a '<literal>&amp;</literal>'
     </para>
    </listitem>
    <listitem>
     <para>
-     a type string of a concrete, fixed-sized type, prefixed with a '<literal>&amp;a</literal>' 
+     a type string of a concrete, fixed-sized type, prefixed with a '<literal>&amp;a</literal>'
     </para>
    </listitem>
    <listitem>
@@ -60,18 +60,18 @@
    </listitem>
    <listitem>
     <para>
-     any conversion string, prefixed with an '<literal>m</literal>' 
+     any conversion string, prefixed with an '<literal>m</literal>'
     </para>
    </listitem>
    <listitem>
     <para>
-     a sequence of zero or more format strings strings, concatenated and enclosed in parentheses 
+     a sequence of zero or more format strings strings, concatenated and enclosed in parentheses
     </para>
    </listitem>
    <listitem>
     <para>
      an opening brace, followed by two format strings, followed by a closing brace (subject to the constraint that the
-     first format string correspond to a type valid for use as the key type of a dictionary) 
+     first format string correspond to a type valid for use as the key type of a dictionary)
     </para>
    </listitem>
   </itemizedlist>
@@ -81,7 +81,7 @@
 
    <para>
     The following table describes the rough meaning of symbols that may appear inside a GVariant format string.  Each
-    symbol is described in detail in its own section, including usage examples. 
+    symbol is described in detail in its own section, including usage examples.
   </para>
 
   <informaltable>
@@ -98,7 +98,7 @@
       </entry>
       <entry colsep='1' rowsep='1'>
        <para>
-         <emphasis role='strong'>Meaning</emphasis> 
+         <emphasis role='strong'>Meaning</emphasis>
        </para>
       </entry>
      </row>
@@ -115,7 +115,7 @@
       <entry colsep='1' rowsep='1'>
        <para>
         Used for building or deconstructing boolean, byte and numeric types.  See
-        <link linkend='gvariant-format-strings-numeric-types'>Numeric Types</link> below. 
+        <link linkend='gvariant-format-strings-numeric-types'>Numeric Types</link> below.
        </para>
       </entry>
      </row>
@@ -145,7 +145,7 @@
       <entry colsep='1' rowsep='1'>
        <para>
         Used for building or deconstructing variant types.  See
-        <link linkend='gvariant-format-strings-variant'>Variants</link> below. 
+        <link linkend='gvariant-format-strings-variant'>Variants</link> below.
        </para>
       </entry>
      </row>
@@ -161,7 +161,7 @@
       <entry colsep='1' rowsep='1'>
        <para>
         Used for building or deconstructing arrays.  See
-        <link linkend='gvariant-format-strings-arrays'>Arrays</link> below. 
+        <link linkend='gvariant-format-strings-arrays'>Arrays</link> below.
        </para>
       </entry>
      </row>
@@ -177,7 +177,7 @@
       <entry colsep='1' rowsep='1'>
        <para>
          Used for building or deconstructing maybe types.  See
-         <link linkend='gvariant-format-strings-nullable-types'>Nullable Types</link> below. 
+         <link linkend='gvariant-format-strings-nullable-types'>Nullable Types</link> below.
        </para>
       </entry>
      </row>
@@ -193,7 +193,7 @@
       <entry colsep='1' rowsep='1'>
        <para>
          Used for building or deconstructing tuples.  See
-         <link linkend='gvariant-format-strings-tuples'>Tuples</link> below. 
+         <link linkend='gvariant-format-strings-tuples'>Tuples</link> below.
        </para>
       </entry>
      </row>
@@ -209,7 +209,7 @@
       <entry colsep='1' rowsep='1'>
        <para>
         Used for building or deconstructing dictionary entries. See
-        <link linkend='gvariant-format-strings-dictionaries'>Dictionaries</link> below. 
+        <link linkend='gvariant-format-strings-dictionaries'>Dictionaries</link> below.
        </para>
       </entry>
      </row>
@@ -231,7 +231,7 @@
         *)</code>.  For <link linkend='g-variant-get'><function>g_variant_get()</function></link> this means that you
         must pass a pointer to a <code>(<link linkend='GVariant'>GVariant</link> *)</code> for the value to be returned
         by reference or <link linkend='NULL--CAPS'><literal>NULL</literal></link> to ignore the value.  See
-        <link linkend='gvariant-format-strings-gvariant'><code>GVariant *</code></link> below. 
+        <link linkend='gvariant-format-strings-gvariant'><code>GVariant *</code></link> below.
        </para>
       </entry>
      </row>
@@ -300,7 +300,7 @@
     Variable argument conversions from numeric types work in the most obvious way possible.  Upon encountering one of
     these characters, <link linkend='g-variant-new'><function>g_variant_new()</function></link> takes the equivalent C
     type as an argument.  <link linkend='g-variant-get'><function>g_variant_get()</function></link> takes a pointer to
-    the equivalent C type (or <link linkend='NULL--CAPS'><literal>NULL</literal></link> to ignore the value). 
+    the equivalent C type (or <link linkend='NULL--CAPS'><literal>NULL</literal></link> to ignore the value).
    </para>
 
    <para>
@@ -314,12 +314,12 @@
       <row rowsep='1'>
        <entry colsep='1' rowsep='1'>
         <para>
-          <emphasis role='strong'>Character</emphasis> 
+          <emphasis role='strong'>Character</emphasis>
         </para>
        </entry>
        <entry colsep='1' rowsep='1'>
         <para>
-          <emphasis role='strong'>Equivalent C type</emphasis> 
+          <emphasis role='strong'>Equivalent C type</emphasis>
         </para>
        </entry>
       </row>
@@ -475,19 +475,19 @@
     with <link linkend='g-variant-new'><function>g_variant_new()</function></link> and format characters
     '<literal>b</literal>', '<literal>y</literal>', '<literal>n</literal>', '<literal>q</literal>',
     '<literal>i</literal>', '<literal>u</literal>' and '<literal>h</literal>'.  Specifically, you can use integer
-    literals with these characters. 
+    literals with these characters.
    </para>
 
    <para>
     When using the '<literal>x</literal>' and '<literal>t</literal>' characters, you must ensure that the value that you
     provide is 64 bit.  This means that you should use a cast or make use of the
     <link linkend='G-GINT64-CONSTANT--CAPS'><literal>G_GINT64_CONSTANT</literal></link> or
-    <link linkend='G-GUINT64-CONSTANT--CAPS'><literal>G_GUINT64_CONSTANT</literal></link> macros. 
+    <link linkend='G-GUINT64-CONSTANT--CAPS'><literal>G_GUINT64_CONSTANT</literal></link> macros.
    </para>
 
    <para>
     No type promotion occurs when using <link linkend='g-variant-get'><function>g_variant_get()</function></link> since
-    it operates with pointers.  The pointers must always point to a memory region of exactly the correct size. 
+    it operates with pointers.  The pointers must always point to a memory region of exactly the correct size.
    </para>
 
    <refsect3>
@@ -529,7 +529,7 @@ value4 = g_variant_new ("x", G_GINT64_CONSTANT (998877665544332211));
     <link linkend='gchar'>gchar</link> *)</code> and makes a copy of it.
     <link linkend='NULL--CAPS'><literal>NULL</literal></link> is not a valid string.  If the '<literal>o</literal>' or
     '<literal>g</literal>' characters are used, care must be taken to ensure that the passed string is a valid DBus
-    object path or DBus type signature, respectively. 
+    object path or DBus type signature, respectively.
    </para>
    <para>
     Upon encounting '<literal>s</literal>', '<literal>o</literal>' or '<literal>g</literal>', <link
@@ -576,7 +576,7 @@ value3 = g_variant_new ("g", "iias");
     Upon encountering a '<literal>v</literal>',
     <link linkend='g-variant-new'><function>g_variant_new()</function></link> takes a <code>(<link
     linkend='GVariant'>GVariant</link> *)</code>.  The value of the
-    <link linkend='GVariant'><type>GVariant</type></link> is used as the contents of the variant value. 
+    <link linkend='GVariant'><type>GVariant</type></link> is used as the contents of the variant value.
    </para>
    <para>
     Upon encountering a '<literal>v</literal>', <link
@@ -586,7 +586,7 @@ value3 = g_variant_new ("g", "iias");
     containing the contents of the variant value.  It is appropriate to free this reference using
     <link linkend='g-variant-unref'><function>g_variant_unref()</function></link>.
     <link linkend='NULL--CAPS'><literal>NULL</literal></link> may also be passed to indicate that the value should be
-    ignored (in which case no new reference is created). 
+    ignored (in which case no new reference is created).
    </para>
 
    <refsect3>
@@ -620,7 +620,7 @@ y = g_variant_get_variant (x);]]></programlisting></informalexample>
     for an array of the type given in the type string.  The builder will have
     <link linkend='g-variant-builder-end'><function>g_variant_builder_end()</function></link> called on it and the
     result will be used as the value.  As a special exception, if the given type string is a definite type, then
-    <link linkend='NULL--CAPS'><literal>NULL</literal></link> may be given to mean an empty array of that type. 
+    <link linkend='NULL--CAPS'><literal>NULL</literal></link> may be given to mean an empty array of that type.
    </para>
 
    <para>
@@ -630,7 +630,7 @@ y = g_variant_get_variant (x);]]></programlisting></informalexample>
     <code>(<link linkend='GVariantIter'>GVariantIter</link> *)</code>).  The iter (which is assumed to be completely
     uninitialised) is initialised for iterating over the elements of the array.
     <link linkend='NULL--CAPS'><literal>NULL</literal></link> may also be given to indicate that the value of the array
-    should be ignored. 
+    should be ignored.
    </para>
 
    <refsect3>
@@ -694,12 +694,12 @@ value = g_variant_new ("as", builder);
     <code>(<link linkend='gboolean'>gboolean</link> *)</code>.
    </para>
    <para>
-    If <link linkend='NULL--CAPS'><literal>NULL</literal></link>, or a pointer to 
+    If <link linkend='NULL--CAPS'><literal>NULL</literal></link>, or a pointer to
     <link linkend='FALSE--CAPS'><literal>FALSE</literal></link> is given to
     <link linkend='g-variant-new'><function>g_variant_new()</function></link> then the null value is constructed.  In
     the case that the arguments were collected, they will be ignored.  Otherwise (if a pointer to
     <link linkend='TRUE--CAPS'><literal>TRUE</literal></link> was given), the arguments are used in the normal way to
-    create the non-null value. 
+    create the non-null value.
    </para>
    <para>
     If <link linkend='NULL--CAPS'><literal>NULL</literal></link> is given to
@@ -708,9 +708,9 @@ value = g_variant_new ("as", builder);
     whether the value was non-null.  In the case that the value was non-null, the
     <link linkend='gboolean'><type>gboolean</type></link> will be set to
     <link linkend='TRUE--CAPS'><literal>TRUE</literal></link> and the value will be stored in the arguments in the usual
-    way.  In the case that the value was null, the <link linkend='gboolean'><type>gboolean</type></link> will be set to 
+    way.  In the case that the value was null, the <link linkend='gboolean'><type>gboolean</type></link> will be set to
     <link linkend='FALSE--CAPS'><literal>FALSE</literal></link> and the arguments will be collected in the normal way,
-    but they values that they point to will be ignored. 
+    but they values that they point to will be ignored.
    </para>
    <para>
     The macro <link linkend='G-VARIANT-JUST--CAPS'><literal>G_VARIANT_JUST</literal></link> is provided.  It evaluates
@@ -791,7 +791,7 @@ value5 = g_variant_new ("(m(ii)s)", NULL, "Done");
    </para>
 
    <para>
-    Tuples are handled by handling each item in the tuple, in sequence.  Each item is handled in the usual way. 
+    Tuples are handled by handling each item in the tuple, in sequence.  Each item is handled in the usual way.
    </para>
 
    <refsect3>
@@ -824,7 +824,7 @@ value2 = g_variant_new ("()");
    </para>
 
    <para>
-    Dictionary entries are handled by handling first the key, then the value.  Each is handled in the usual way. 
+    Dictionary entries are handled by handling first the key, then the value.  Each is handled in the usual way.
    </para>
 
    <refsect3>
@@ -846,7 +846,7 @@ dict = g_variant_builder_end (b);]]></programlisting></informalexample>
     <emphasis role='strong'>
      Characters: <literal>@</literal>, <literal>*</literal>, <literal>?</literal>, <literal>r</literal>
     </emphasis>
-     
+
    </para>
    <para>
     Upon encountering a '<literal>@</literal>' in front of a type string,
@@ -858,7 +858,7 @@ dict = g_variant_builder_end (b);]]></programlisting></informalexample>
     the same as '<literal>@*</literal>' (ie: take a <link linkend='GVariant'><type>GVariant</type></link> of any type).
     '<literal>?</literal>' is the same as '<literal>@?</literal>' (ie: take a
     <link linkend='GVariant'><type>GVariant</type></link> of any basic type).  '<literal>r</literal>' is the same as
-    '<literal>@r</literal>' (ie: take a <link linkend='GVariant'><type>GVariant</type></link> of any tuple type). 
+    '<literal>@r</literal>' (ie: take a <link linkend='GVariant'><type>GVariant</type></link> of any tuple type).
    </para>
    <para>
     Upon encountering a '<literal>@</literal>' in front of a type string,
@@ -873,7 +873,7 @@ dict = g_variant_builder_end (b);]]></programlisting></informalexample>
    <para>
     You can always use '<literal>*</literal>' as an alternative to '<literal>?</literal>', '<literal>r</literal>' or any
     use of '<literal>@</literal>'.  Using the other characters where possible is recommended, however, due to the
-    improvements in type safety and code self-documentation. 
+    improvements in type safety and code self-documentation.
    </para>
 
    <refsect3>
@@ -917,7 +917,7 @@ value2 = g_variant_new ("(@(iii)*)", value1, g_variant_new_string ("foo"));
     The '<code>&amp;</code>' character has 3 closely-related uses.  In all cases, when used with
     <link linkend='g-variant-get'><function>g_variant_get()</function></link> it means that a pointer directly to the
     serialised data stored inside the GVariant is returned (either directly or indirectly).  This pointer is valid only
-    for as long as the GVariant exists. 
+    for as long as the GVariant exists.
    </para>
    <para>
     The three cases are as follows:
@@ -928,7 +928,7 @@ value2 = g_variant_new ("(@(iii)*)", value1, g_variant_new_string ("foo"));
     absolutely no effect.  The string is collected and duplicated normally.  For
     <link linkend='g-variant-get'><function>g_variant_get()</function></link> it means that instead of creating a newly
     allocated copy of the string, a pointer to the serialised data is returned.  This pointer should not be freed.
-    Validity checks are performed to ensure that the string data will always be properly nul-terminated. 
+    Validity checks are performed to ensure that the string data will always be properly nul-terminated.
    </para>
    <para>
     The next case is when '<literal>&amp;</literal>' is used to prefix a type string corresponding to a fixed-size type
@@ -941,7 +941,7 @@ value2 = g_variant_new ("(@(iii)*)", value1, g_variant_new_string ("foo"));
     <link linkend='g-variant-get'><function>g_variant_get()</function></link> collects a pointer to a
     <link linkend='gpointer'><type>gpointer</type></link> and sets it to point to the serialised data.  In the
     <link linkend='g-variant-get'><function>g_variant_get()</function></link> case,
-    <link linkend='NULL--CAPS'><literal>NULL</literal></link> may be given to ignore the value. 
+    <link linkend='NULL--CAPS'><literal>NULL</literal></link> may be given to ignore the value.
    </para>
    <para>
     The last case is when '<literal>&amp;a</literal>' is used to prefix a type string corresponding to a fixed-size type
@@ -989,17 +989,17 @@ value3 = g_variant_new ("&(ii)", &struc);]]></programlisting></informalexample>
    <para>
     The '<literal>^</literal>' character currently only has one purpose: to convert to and from
     <link linkend='G-TYPE-STRV'><literal>G_TYPE_STRV</literal></link> type arrays of strings.  It is always used with
-    arrays of strings (or other string types).  It has two forms. 
+    arrays of strings (or other string types).  It has two forms.
    </para>
    <itemizedlist>
     <listitem>
      <para>
-      '<literal>^as</literal>' (or <literal>o</literal> or <literal>g</literal>) 
+      '<literal>^as</literal>' (or <literal>o</literal> or <literal>g</literal>)
      </para>
     </listitem>
     <listitem>
      <para>
-      '<literal>^a&amp;s</literal>' (or <literal>o</literal> or <literal>g</literal>) 
+      '<literal>^a&amp;s</literal>' (or <literal>o</literal> or <literal>g</literal>)
      </para>
     </listitem>
    </itemizedlist>
@@ -1018,7 +1018,7 @@ value3 = g_variant_new ("&(ii)", &struc);]]></programlisting></informalexample>
     <link linkend='g-strfreev'><function>g_strfreev()</function></link>.  In the case of '<literal>^a&amp;s</literal>',
     a shallow copy is made; the strings themselves are embedded in the serialised data and owned by the original
     <link linkend='GVariant'><type>GVariant</type></link> instance -- it is only appropriate to free the outer array
-    with <link linkend='g-free'><function>g_free()</function></link>. 
+    with <link linkend='g-free'><function>g_free()</function></link>.
    </para>
   </refsect2>
  </refsect1>



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