Minor doc fix

glib/gerror.c

@@ -21,7 +21,7 @@
  * Modified by the GLib Team and others 1997-2000.  See the AUTHORS
  * file for a list of people on the GLib Team.  See the ChangeLog
  * files for a list of changes.  These files are distributed with
- * GLib at ftp://ftp.gtk.org/pub/gtk/. 
+ * GLib at ftp://ftp.gtk.org/pub/gtk/.
  */
 
 #include "config.h"
@@ -35,7 +35,7 @@
  * @domain: error domain
  * @code: error code
  * @format: printf()-style format for error message
- * @var_args: #va_list of parameters for the message format
+ * @args: #va_list of parameters for the message format
  *
  * Creates a new #GError with the given @domain and @code,
  * and a message formatted with @format.
@@ -43,36 +43,36 @@
  * Returns: a new #GError
  *
  * Since: 2.22
- **/
+ */
 GError*
-g_error_new_valist (GQuark         domain,
+g_error_new_valist (GQuark       domain,
-                    gint           code,
+                    gint         code,
-                    const gchar   *format,
+                    const gchar *format,
-                    va_list        args)
+                    va_list      args)
 {
   GError *error;
-  
+
   error = g_slice_new (GError);
-  
+
   error->domain = domain;
   error->code = code;
   error->message = g_strdup_vprintf (format, args);
-  
+
   return error;
 }
 
 /**
  * g_error_new:
- * @domain: error domain 
+ * @domain: error domain
  * @code: error code
  * @format: printf()-style format for error message
  * @Varargs: parameters for message format
- * 
+ *
  * Creates a new #GError with the given @domain and @code,
  * and a message formatted with @format.
- * 
+ *
  * Return value: a new #GError
- **/
+ */
 GError*
 g_error_new (GQuark       domain,
              gint         code,
@@ -97,12 +97,12 @@ g_error_new (GQuark       domain,
  * @domain: error domain
  * @code: error code
  * @message: error message
- * 
+ *
- * Creates a new #GError; unlike g_error_new(), @message is not
+ * Creates a new #GError; unlike g_error_new(), @message is
- * a printf()-style format string. Use this 
+ * not a printf()-style format string. Use this function if
- * function if @message contains text you don't have control over, 
+ * @message contains text you don't have control over,
  * that could include printf() escape sequences.
- * 
+ *
  * Return value: a new #GError
  **/
 GError*
@@ -120,7 +120,7 @@ g_error_new_literal (GQuark         domain,
   err->domain = domain;
   err->code = code;
   err->message = g_strdup (message);
-  
+
   return err;
 }
 
@@ -129,12 +129,11 @@ g_error_new_literal (GQuark         domain,
  * @error: a #GError
  *
  * Frees a #GError and associated resources.
- * 
+ */
- **/
 void
 g_error_free (GError *error)
 {
-  g_return_if_fail (error != NULL);  
+  g_return_if_fail (error != NULL);
 
   g_free (error->message);
 
@@ -144,16 +143,16 @@ g_error_free (GError *error)
 /**
  * g_error_copy:
  * @error: a #GError
- * 
+ *
  * Makes a copy of @error.
- * 
+ *
  * Return value: a new #GError
- **/
+ */
 GError*
 g_error_copy (const GError *error)
 {
   GError *copy;
-  
+ 
   g_return_val_if_fail (error != NULL, NULL);
 
   copy = g_slice_new (GError);
@@ -170,12 +169,12 @@ g_error_copy (const GError *error)
  * @error: a #GError
  * @domain: an error domain
  * @code: an error code
- * 
+ *
  * Returns %TRUE if @error matches @domain and @code, %FALSE
  * otherwise.
- * 
+ *
  * Return value: whether @error has @domain and @code
- **/
+ */
 gboolean
 g_error_matches (const GError *error,
                  GQuark        domain,
@@ -194,13 +193,13 @@ g_error_matches (const GError *error,
  * g_set_error:
  * @err: a return location for a #GError, or %NULL
  * @domain: error domain
- * @code: error code 
+ * @code: error code
  * @format: printf()-style format
- * @Varargs: args for @format 
+ * @Varargs: args for @format
- * 
+ *
- * Does nothing if @err is %NULL; if @err is non-%NULL, then *@err must
+ * Does nothing if @err is %NULL; if @err is non-%NULL, then *@err
- * be %NULL. A new #GError is created and assigned to *@err.
+ * must be %NULL. A new #GError is created and assigned to *@err.
- **/
+ */
 void
 g_set_error (GError      **err,
              GQuark        domain,
@@ -209,12 +208,12 @@ g_set_error (GError      **err,
              ...)
 {
   GError *new;
-  
+
   va_list args;
 
   if (err == NULL)
     return;
-  
+
   va_start (args, format);
   new = g_error_new_valist (domain, code, format, args);
   va_end (args);
@@ -222,24 +221,24 @@ g_set_error (GError      **err,
   if (*err == NULL)
     *err = new;
   else
-    g_warning (ERROR_OVERWRITTEN_WARNING, new->message);    
+    g_warning (ERROR_OVERWRITTEN_WARNING, new->message); 
 }
 
 /**
  * g_set_error_literal:
  * @err: a return location for a #GError, or %NULL
  * @domain: error domain
- * @code: error code 
+ * @code: error code
  * @message: error message
  *
- * Does nothing if @err is %NULL; if @err is non-%NULL, then *@err must
+ * Does nothing if @err is %NULL; if @err is non-%NULL, then *@err
- * be %NULL. A new #GError is created and assigned to *@err.
+ * must be %NULL. A new #GError is created and assigned to *@err.
  * Unlike g_set_error(), @message is not a printf()-style format string.
  * Use this function if @message contains text you don't have control over,
  * that could include printf() escape sequences.
  *
  * Since: 2.18
- **/
+ */
 void
 g_set_error_literal (GError      **err,
                      GQuark        domain,
@@ -247,7 +246,7 @@ g_set_error_literal (GError      **err,
                      const gchar  *message)
 {
   GError *new;
-  
+
   if (err == NULL)
     return;
 
@@ -255,7 +254,7 @@ g_set_error_literal (GError      **err,
   if (*err == NULL)
     *err = new;
   else
-    g_warning (ERROR_OVERWRITTEN_WARNING, new->message);    
+    g_warning (ERROR_OVERWRITTEN_WARNING, new->message); 
 }
 
 /**
@@ -265,13 +264,13 @@ g_set_error_literal (GError      **err,
  *
  * If @dest is %NULL, free @src; otherwise, moves @src into *@dest.
  * The error variable @dest points to must be %NULL.
- **/
+ */
 void
-g_propagate_error (GError       **dest,
+g_propagate_error (GError **dest,
-		   GError        *src)
+		   GError  *src)
 {
   g_return_if_fail (src != NULL);
-  
+ 
   if (dest == NULL)
     {
       if (src)
@@ -290,10 +289,10 @@ g_propagate_error (GError       **dest,
 /**
  * g_clear_error:
  * @err: a #GError return location
- * 
+ *
  * If @err is %NULL, does nothing. If @err is non-%NULL,
  * calls g_error_free() on *@err and sets *@err to %NULL.
- **/
+ */
 void
 g_clear_error (GError **err)
 {
@@ -337,7 +336,7 @@ g_error_add_prefix (gchar       **string,
  * to you.
  *
  * Since: 2.16
- **/
+ */
 void
 g_prefix_error (GError      **err,
                 const gchar  *format,
@@ -359,10 +358,10 @@ g_prefix_error (GError      **err,
  * @src: error to move into the return location
  * @format: printf()-style format string
  * @...: arguments to @format
- * 
+ *
  * If @dest is %NULL, free @src; otherwise,
  * moves @src into *@dest. *@dest must be %NULL.
- * After the move, add a prefix as with 
+ * After the move, add a prefix as with
  * g_prefix_error().
  *
  * Since: 2.16