[glibmm] Regenerated *_docs.xml files.



commit 52799d22fa2dc8d8ab3def71e08321735df6c8c7
Author: Murray Cumming <murrayc murrayc com>
Date:   Thu Apr 3 11:14:24 2014 +0200

    Regenerated *_docs.xml files.

 gio/src/gio_docs.xml   |   61 +++++++++++++++++++++++++++++++----------------
 glib/src/glib_docs.xml |   21 +++++++++++-----
 2 files changed, 54 insertions(+), 28 deletions(-)
---
diff --git a/gio/src/gio_docs.xml b/gio/src/gio_docs.xml
index 27e4ce7..a9e39fe 100644
--- a/gio/src/gio_docs.xml
+++ b/gio/src/gio_docs.xml
@@ -3644,11 +3644,25 @@ previewed in a file manager. Returned as the value of the key
 <description>
 Error codes returned by GIO functions.
 
+Note that this domain may be extended in future GLib releases. In
+general, new error codes either only apply to new APIs, or else
+replace #G_IO_ERROR_FAILED in cases that were not explicitly
+distinguished before. You should therefore avoid writing code like
+|[&lt;!-- language=&quot;C&quot; --&gt;
+if (g_error_matches (error, G_IO_ERROR, G_IO_ERROR_FAILED))
+{
+// Assume that this is EPRINTERONFIRE
+...
+}
+]|
+but should instead treat all unrecognized error codes the same as
+#G_IO_ERROR_FAILED.
 
 </description>
 <parameters>
 <parameter name="G_IO_ERROR_FAILED">
-<parameter_description> Generic error condition for when any operation fails.
+<parameter_description> Generic error condition for when an operation fails
+and no more specific #GIOErrorEnum value is defined.
 </parameter_description>
 </parameter>
 <parameter name="G_IO_ERROR_NOT_FOUND">
@@ -3708,7 +3722,7 @@ Error codes returned by GIO functions.
 </parameter_description>
 </parameter>
 <parameter name="G_IO_ERROR_NOT_SUPPORTED">
-<parameter_description> Operation not supported for the current backend.
+<parameter_description> Operation (or one of its parameters) not supported
 </parameter_description>
 </parameter>
 <parameter name="G_IO_ERROR_NOT_MOUNTED">
@@ -41648,7 +41662,7 @@ in the following two cases
 (such as `/path/to/my icon.png`) without escaping
 if the #GFile for @icon is a native file.  If the file is not
 native, the returned string is the result of g_file_get_uri()
-(such as `sftp://path/to/my\%20icon.png`).
+(such as `sftp://path/to/my%20icon.png`).
 
 - If @icon is a #GThemedIcon with exactly one name, the encoding is
 simply the name (such as `network-server`).
@@ -43127,7 +43141,10 @@ ignore.
 
 <function name="g_io_error_from_errno">
 <description>
-Converts errno.h error codes into GIO error codes.
+Converts errno.h error codes into GIO error codes. The fallback
+value %G_IO_ERROR_FAILED is returned for error codes not currently
+handled (but note that future GLib releases may return a more
+specific value instead).
 
 
 </description>
@@ -43143,9 +43160,15 @@ Converts errno.h error codes into GIO error codes.
 
 <function name="g_io_error_from_win32_error">
 <description>
-Converts some common error codes into GIO error codes. The
-fallback value G_IO_ERROR_FAILED is returned for error codes not
-handled.
+Converts some common error codes (as returned from GetLastError()
+or WSAGetLastError()) into GIO error codes. The fallback value
+%G_IO_ERROR_FAILED is returned for error codes not currently
+handled (but note that future GLib releases may return a more
+specific value instead).
+
+You can use g_win32_error_message() to get a localized string
+corresponding to @error_code. (But note that unlike g_strerror(),
+g_win32_error_message() returns a string that must be freed.)
 
 Since: 2.26
 
@@ -47565,8 +47588,8 @@ Adds a button to @notification that activates @action when clicked.
 @action must be an application-wide action (it must start with &quot;app.&quot;).
 
 If @target_format is given, it is used to collect remaining
-positional parameters into a GVariant instance, similar to
-g_variant_new(). @action will be activated with that GVariant as its
+positional parameters into a #GVariant instance, similar to
+g_variant_new(). @action will be activated with that #GVariant as its
 parameter.
 
 Since: 2.40
@@ -47586,11 +47609,11 @@ Since: 2.40
 </parameter_description>
 </parameter>
 <parameter name="target_format">
-<parameter_description> a GVariant format string, or %NULL
+<parameter_description> a #GVariant format string, or %NULL
 </parameter_description>
 </parameter>
 <parameter name="Varargs">
-<parameter_description> positional parameters, as determined by @format_string
+<parameter_description> positional parameters, as determined by @target_format
 </parameter_description>
 </parameter>
 </parameters>
@@ -47622,7 +47645,7 @@ Since: 2.40
 </parameter_description>
 </parameter>
 <parameter name="target">
-<parameter_description> a GVariant to use as @action's parameter, or %NULL
+<parameter_description> a #GVariant to use as @action's parameter, or %NULL
 </parameter_description>
 </parameter>
 </parameters>
@@ -47709,8 +47732,8 @@ activated when the notification is clicked on. It must be an
 application-wide action (it must start with &quot;app.&quot;).
 
 If @target_format is given, it is used to collect remaining
-positional parameters into a GVariant instance, similar to
-g_variant_new(). @action will be activated with that GVariant as its
+positional parameters into a #GVariant instance, similar to
+g_variant_new(). @action will be activated with that #GVariant as its
 parameter.
 
 When no default action is set, the application that the notification
@@ -47729,11 +47752,11 @@ Since: 2.40
 </parameter_description>
 </parameter>
 <parameter name="target_format">
-<parameter_description> a GVariant format string, or %NULL
+<parameter_description> a #GVariant format string, or %NULL
 </parameter_description>
 </parameter>
 <parameter name="Varargs">
-<parameter_description> positional parameters, as determined by @format_string
+<parameter_description> positional parameters, as determined by @target_format
 </parameter_description>
 </parameter>
 </parameters>
@@ -47746,10 +47769,6 @@ Sets the default action of @notification to @action. This action is
 activated when the notification is clicked on. It must be an
 application-wide action (start with &quot;app.&quot;).
 
-If @target_format is given, it is used to collect remaining
-positional parameters into a GVariant instance, similar to
-g_variant_new().
-
 If @target is non-%NULL, @action will be activated with @target as
 its parameter.
 
@@ -47769,7 +47788,7 @@ Since: 2.40
 </parameter_description>
 </parameter>
 <parameter name="target">
-<parameter_description> a GVariant to use as @action's parameter, or %NULL
+<parameter_description> a #GVariant to use as @action's parameter, or %NULL
 </parameter_description>
 </parameter>
 </parameters>
diff --git a/glib/src/glib_docs.xml b/glib/src/glib_docs.xml
index f7dbd12..c40583a 100644
--- a/glib/src/glib_docs.xml
+++ b/glib/src/glib_docs.xml
@@ -13600,7 +13600,7 @@ The following format specifiers are supported:
 - \%C: the century number (year/100) as a 2-digit integer (00-99)
 - \%d: the day of the month as a decimal number (range 01 to 31)
 - \%e: the day of the month as a decimal number (range  1 to 31)
-- \%F: equivalent to `\%Y-\%m-\%d` (the ISO 8601 date format)
+- \%F: equivalent to `%Y-%m-%d` (the ISO 8601 date format)
 - \%g: the last two digits of the ISO 8601 week-based year as a
 decimal number (00-99). This works well with \%V and \%u.
 - \%G: the ISO 8601 week-based year as a decimal number. This works
@@ -15456,6 +15456,13 @@ Returns %TRUE if @error matches @domain and @code, %FALSE
 otherwise. In particular, when @error is %NULL, %FALSE will
 be returned.
 
+If @domain contains a `FAILED` (or otherwise generic) error code,
+you should generally not check for it explicitly, but should
+instead treat any not-explicitly-recognized error code as being
+equilalent to the `FAILED` code. This way, if the domain is
+extended in the future to provide a more specific error code for
+a certain case, your code will still work.
+
 
 </description>
 <parameters>
@@ -57365,12 +57372,12 @@ Since: 2.32
 
 <function name="g_win32_error_message">
 <description>
-Translate a Win32 error code (as returned by GetLastError()) into
-the corresponding message. The message is either language neutral,
-or in the thread's language, or the user's language, the system's
-language, or US English (see docs for FormatMessage()). The
-returned string is in UTF-8. It should be deallocated with
-g_free().
+Translate a Win32 error code (as returned by GetLastError() or
+WSAGetLastError()) into the corresponding message. The message is
+either language neutral, or in the thread's language, or the user's
+language, the system's language, or US English (see docs for
+FormatMessage()). The returned string is in UTF-8. It should be
+deallocated with g_free().
 
 
 </description>


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