[glibmm] Remove unnecessary parts of the docs_override.xml files

From: Kjell Ahlstedt <kjellahl src gnome org>
To: commits-list gnome org
Cc:
Subject: [glibmm] Remove unnecessary parts of the docs_override.xml files
Date: Thu, 24 Apr 2014 08:42:17 +0000 (UTC)
commit 149cf07c6952a876f2a7946508bc18de7dfcbc30
Author: Kjell Ahlstedt <kjell ahlstedt bredband net>
Date:   Thu Apr 24 10:38:28 2014 +0200

    Remove unnecessary parts of the docs_override.xml files
    
    * gio/src/gio_docs_override.xml:
    * glib/src/glib_docs_override.xml: Remove parts with no significant
    difference compared to the docs.xml files. Remove duplicates.

 gio/src/gio_docs_override.xml   |   64 -------
 glib/src/glib_docs_override.xml |  378 ++-------------------------------------
 2 files changed, 11 insertions(+), 431 deletions(-)
---
diff --git a/gio/src/gio_docs_override.xml b/gio/src/gio_docs_override.xml
index 1a3a388..5ea862d 100644
--- a/gio/src/gio_docs_override.xml
+++ b/gio/src/gio_docs_override.xml
@@ -44,26 +44,7 @@ return %FALSE.  The operation may have been
 cancelled by triggering the cancellable object from another thread. If the operation
 was cancelled, a Gio::Error with CANCELLED will be thrown, and %FALSE will be 
 returned.
-
-
 </description>
-<parameters>
-<parameter name="enumerator">
-<parameter_description> a #GFileEnumerator.
-</parameter_description>
-</parameter>
-<parameter name="result">
-<parameter_description> a #GAsyncResult.
-</parameter_description>
-</parameter>
-<parameter name="error">
-<parameter_description> a #GError location to store the error occuring, or %NULL to 
-ignore.
-</parameter_description>
-</parameter>
-</parameters>
-<return> %TRUE if the close operation has finished successfully.
-</return>
 </function>
 
 <function name="g_file_append_to">
@@ -1733,49 +1714,4 @@ errors that can happen due to races when you execute the operation.
 </return>
 </function>
 
-<function name="g_volume_get_activation_root">
-<description>
-Gets the activation root for a #GVolume if it is known ahead of
-mount time. Returns %NULL otherwise. If not %NULL and if @volume
-is mounted, then the result of g_mount_get_root() on the
-#GMount object obtained from g_volume_get_mount() will always
-either be equal or a prefix of what this function returns. In
-other words, in code
-
-&lt;programlisting&gt;
-GMount *mount;
-GFile *mount_root
-GFile *volume_activation_root;
-
-mount = g_volume_get_mount (volume); // mounted, so never NULL
-mount_root = g_mount_get_root (mount);
-volume_activation_root = g_volume_get_activation_root(volume); // assume not NULL
-&lt;/programlisting&gt;
-
-then the expression
-
-&lt;programlisting&gt;
-(g_file_has_prefix (volume_activation_root, mount_root) ||
-      g_file_equal (volume_activation_root, mount_root))
-&lt;/programlisting&gt;
-
-will always be %TRUE.
-
-Activation roots are typically used in #GVolumeMonitor
-implementations to find the underlying mount to shadow, see
-g_mount_is_shadowed() for more details.
-
-Since: 2.18
-</description>
-<parameters>
-<parameter name="volume">
-<parameter_description> a #GVolume
-</parameter_description>
-</parameter>
-</parameters>
-<return> the activation root of @volume or %NULL. Use
-g_object_unref() to free.
-</return>
-</function>
-
 </root>
diff --git a/glib/src/glib_docs_override.xml b/glib/src/glib_docs_override.xml
index e903b4a..77c4d22 100644
--- a/glib/src/glib_docs_override.xml
+++ b/glib/src/glib_docs_override.xml
@@ -1,16 +1,10 @@
 <root>
     <function name="g_option_context_set_summary">
-        <description>
-            Adds a string to be displayed in --help output before the list of options. This
-            is typically a summary of the program functionality. 
-
-            Note that the summary is translated (see set_translate_func(),
-            set_translation_domain()).
-
-            Since: 2.14
-
-        </description>
-        <parameters>
+    <parameters>
+    <parameter name="context">
+    <parameter_description> a #GOptionContext
+    </parameter_description>
+    </parameter>
             <parameter name="summary">
                 <parameter_description> a string to be shown in --help output before the list of
                     options
@@ -20,30 +14,12 @@
         <return></return>
     </function>
 
-    <function name="g_option_context_get_summary">
-        <description>
-            Returns: the summary
-            See set_summary() for more information
-
-            Since: 2.14
-        </description>
-        <parameters>
-        </parameters>
-        <return> the summary
-        </return>
-    </function>
-
     <function name="g_option_context_set_description">
-        <description>
-            Adds a string to be displayed in --help output after the list of
-            options. This text often includes a bug reporting address.
-
-            Note that the summary is translated (see set_translate_func()).
-
-            Since: 2.14
-
-        </description>
         <parameters>
+        <parameter name="context">
+        <parameter_description> a #GOptionContext
+        </parameter_description>
+        </parameter>
             <parameter name="description">
                 <parameter_description> a string to be shown in --help output
                     after the list of options
@@ -53,37 +29,6 @@
         <return></return>
     </function>
 
-    <function name="g_option_context_get_description">
-        <description>
-            Returns: the description
-            See set_description() for more information
-
-            Since: 2.14
-        </description>
-        <parameters>
-        </parameters>
-        <return> the description
-        </return>
-    </function>
-
-    <function name="g_option_context_set_translation_domain">
-        <description>
-            A convenience function to use gettext() for translating
-            user-visible strings. 
-
-            Since: 2.14
-
-        </description>
-        <parameters>
-            <parameter name="domain">
-                <parameter_description> the domain to use
-                </parameter_description>
-            </parameter>
-        </parameters>
-        <return></return>
-    </function>
-
-
 <function name="g_key_file_get_double">
 <description>
 Return value: the value associated with the key as a double.
@@ -92,57 +37,6 @@ Since: 2.14
 
 \throw Glib::KeyFileError
 </description>
-<parameters>
-<parameter name="key_file">
-<parameter_description> a #GKeyFile
-</parameter_description>
-</parameter>
-<parameter name="group_name">
-<parameter_description> a group name
-</parameter_description>
-</parameter>
-<parameter name="key">
-<parameter_description> a key
-</parameter_description>
-</parameter>
-<parameter name="error">
-<parameter_description> return location for a #GError
-</parameter_description>
-</parameter>
-</parameters>
-<return> the value associated with the key as a double, or
-0.0 if the key was not found or could not be parsed.
-</return>
-</function>
-
-
-<function name="g_key_file_set_double">
-<description>
-Associates a new double value with @key under @group_name.
-If @key cannot be found then it is created. 
-
-Since: 2.14
-
-</description>
-<parameters>
-<parameter name="key_file">
-<parameter_description> a #GKeyFile
-</parameter_description>
-</parameter>
-<parameter name="group_name">
-<parameter_description> a group name
-</parameter_description>
-</parameter>
-<parameter name="key">
-<parameter_description> a key
-</parameter_description>
-</parameter>
-<parameter name="value">
-<parameter_description> an double value
-</parameter_description>
-</parameter>
-</parameters>
-<return></return>
 </function>
 
 
@@ -155,26 +49,6 @@ Since: 2.6
 \throw Glib::FileError
 \throw Glib::KeyFileError
 </description>
-<parameters>
-<parameter name="key_file">
-<parameter_description> an empty #GKeyFile struct
-</parameter_description>
-</parameter>
-<parameter name="file">
-<parameter_description> the path of a filename to load, in the GLib file name encoding
-</parameter_description>
-</parameter>
-<parameter name="flags">
-<parameter_description> flags from #GKeyFileFlags
-</parameter_description>
-</parameter>
-<parameter name="error">
-<parameter_description> return location for a #GError, or %NULL
-</parameter_description>
-</parameter>
-</parameters>
-<return> %TRUE if a key file could be loaded, %FALSE otherwise
-</return>
 </function>
 
 
@@ -184,27 +58,9 @@ Returns the value associated with @key under @group_name.
 
 Since: 2.6
 
-\throw Glib::FileError in the event the key cannot be found (with the Glib::KEY_FILE_ERROR_KEY_NOT_FOUND 
code).
-\throw Glib::KeyFileError in the event that the @group_name cannot be found (with the 
Glib::KEY_FILE_ERROR_GROUP_NOT_FOUND).
+\throw Glib::KeyFileError in the event the key cannot be found (with the Glib::KeyFileError::KEY_NOT_FOUND 
code).
+\throw Glib::KeyFileError in the event that the @group_name cannot be found (with the 
Glib::KeyFileError::GROUP_NOT_FOUND code).
 </description>
-<parameters>
-<parameter name="key_file">
-<parameter_description> a #GKeyFile
-</parameter_description>
-</parameter>
-<parameter name="group_name">
-<parameter_description> a group name
-</parameter_description>
-</parameter>
-<parameter name="key">
-<parameter_description> a key
-</parameter_description>
-</parameter>
-<parameter name="error">
-<parameter_description> return location for a #GError, or %NULL
-</parameter_description>
-</parameter>
-</parameters>
 <return> The value as a string.
 </return>
 </function>
@@ -252,28 +108,6 @@ written above the first group in the file.
 
 \throw Glib::KeyFileError
 </description>
-<parameters>
-<parameter name="key_file">
-<parameter_description> a #GKeyFile
-</parameter_description>
-</parameter>
-<parameter name="group_name">
-<parameter_description> a group name, or %NULL
-</parameter_description>
-</parameter>
-<parameter name="key">
-<parameter_description> a key
-</parameter_description>
-</parameter>
-<parameter name="comment">
-<parameter_description> a comment
-</parameter_description>
-</parameter>
-<parameter name="error">
-<parameter_description> return location for a #GError
-</parameter_description>
-</parameter>
-</parameters>
 <return></return>
 </function>
 
@@ -286,24 +120,6 @@ be removed above the first group in the file.
 
 \throw Glib::KeyFileError
 </description>
-<parameters>
-<parameter name="key_file">
-<parameter_description> a #GKeyFile
-</parameter_description>
-</parameter>
-<parameter name="group_name">
-<parameter_description> a group name, or %NULL
-</parameter_description>
-</parameter>
-<parameter name="key">
-<parameter_description> a key
-</parameter_description>
-</parameter>
-<parameter name="error">
-<parameter_description> return location for a #GError
-</parameter_description>
-</parameter>
-</parameters>
 <return></return>
 </function>
 
@@ -316,58 +132,6 @@ Since: 2.6
 
 \throw Glib::KeyFileError
 </description>
-<parameters>
-<parameter name="key_file">
-<parameter_description> a #GKeyFile
-</parameter_description>
-</parameter>
-<parameter name="group_name">
-<parameter_description> a group name
-</parameter_description>
-</parameter>
-<parameter name="key">
-<parameter_description> a key name
-</parameter_description>
-</parameter>
-<parameter name="error">
-<parameter_description> return location for a #GError
-</parameter_description>
-</parameter>
-</parameters>
-<return> %TRUE if @key is a part of @group_name, %FALSE
-otherwise.
-</return>
-</function>
-
-<function name="g_key_file_get_value">
-<description>
-Return value: a newly allocated string or %NULL.
-
-Since: 2.6
-
-\throw Glib::KeyFileError
-</description>
-<parameters>
-<parameter name="key_file">
-<parameter_description> a #GKeyFile
-</parameter_description>
-</parameter>
-<parameter name="group_name">
-<parameter_description> a group name
-</parameter_description>
-</parameter>
-<parameter name="key">
-<parameter_description> a key
-</parameter_description>
-</parameter>
-<parameter name="error">
-<parameter_description> return location for a #GError, or %NULL
-</parameter_description>
-</parameter>
-</parameters>
-<return> a newly allocated string or %NULL if the specified 
-key cannot be found.
-</return>
 </function>
 
 <function name="g_key_file_get_string">
@@ -378,27 +142,6 @@ Since: 2.6
 
 \throw Glib::KeyFileError
 </description>
-<parameters>
-<parameter name="key_file">
-<parameter_description> a #GKeyFile
-</parameter_description>
-</parameter>
-<parameter name="group_name">
-<parameter_description> a group name
-</parameter_description>
-</parameter>
-<parameter name="key">
-<parameter_description> a key
-</parameter_description>
-</parameter>
-<parameter name="error">
-<parameter_description> return location for a #GError, or %NULL
-</parameter_description>
-</parameter>
-</parameters>
-<return> a newly allocated string or %NULL if the specified 
-key cannot be found.
-</return>
 </function>
 
 <function name="g_key_file_get_locale_string">
@@ -409,31 +152,6 @@ Since: 2.6
 
 \throw Glib::KeyFileError
 </description>
-<parameters>
-<parameter name="key_file">
-<parameter_description> a #GKeyFile
-</parameter_description>
-</parameter>
-<parameter name="group_name">
-<parameter_description> a group name
-</parameter_description>
-</parameter>
-<parameter name="key">
-<parameter_description> a key
-</parameter_description>
-</parameter>
-<parameter name="locale">
-<parameter_description> a locale identifier or %NULL
-</parameter_description>
-</parameter>
-<parameter name="error">
-<parameter_description> return location for a #GError, or %NULL
-</parameter_description>
-</parameter>
-</parameters>
-<return> a newly allocated string or %NULL if the specified 
-key cannot be found.
-</return>
 </function>
 
 <function name="g_key_file_get_boolean">
@@ -444,27 +162,6 @@ Since: 2.6
 
 \throw Glib::KeyFileError
 </description>
-<parameters>
-<parameter name="key_file">
-<parameter_description> a #GKeyFile
-</parameter_description>
-</parameter>
-<parameter name="group_name">
-<parameter_description> a group name
-</parameter_description>
-</parameter>
-<parameter name="key">
-<parameter_description> a key
-</parameter_description>
-</parameter>
-<parameter name="error">
-<parameter_description> return location for a #GError
-</parameter_description>
-</parameter>
-</parameters>
-<return> the value associated with the key as a boolean, 
-or %FALSE if the key was not found or could not be parsed.
-</return>
 </function>
 
 <function name="g_key_file_get_integer">
@@ -475,27 +172,6 @@ Since: 2.6
 
 \throw Glib::KeyFileError
 </description>
-<parameters>
-<parameter name="key_file">
-<parameter_description> a #GKeyFile
-</parameter_description>
-</parameter>
-<parameter name="group_name">
-<parameter_description> a group name
-</parameter_description>
-</parameter>
-<parameter name="key">
-<parameter_description> a key
-</parameter_description>
-</parameter>
-<parameter name="error">
-<parameter_description> return location for a #GError
-</parameter_description>
-</parameter>
-</parameters>
-<return> the value associated with the key as an integer, or
-0 if the key was not found or could not be parsed.
-</return>
 </function>
 
 <function name="g_key_file_remove_group">
@@ -505,20 +181,6 @@ from the key file.
 
 \throw Glib::KeyFileError
 </description>
-<parameters>
-<parameter name="key_file">
-<parameter_description> a #GKeyFile
-</parameter_description>
-</parameter>
-<parameter name="group_name">
-<parameter_description> a group name
-</parameter_description>
-</parameter>
-<parameter name="error">
-<parameter_description> return location for a #GError or %NULL
-</parameter_description>
-</parameter>
-</parameters>
 <return></return>
 </function>
 
@@ -528,24 +190,6 @@ Removes @key in @group_name from the key file.
 
 \throw Glib::KeyFileError
 </description>
-<parameters>
-<parameter name="key_file">
-<parameter_description> a #GKeyFile
-</parameter_description>
-</parameter>
-<parameter name="group_name">
-<parameter_description> a group name
-</parameter_description>
-</parameter>
-<parameter name="key">
-<parameter_description> a key name to remove
-</parameter_description>
-</parameter>
-<parameter name="error">
-<parameter_description> return location for a #GError or %NULL
-</parameter_description>
-</parameter>
-</parameters>
 <return></return>
 </function>
[Date Prev][Date Next] [Thread Prev][Thread Next] [Thread Index] [Date Index] [Author Index]