Minor doc fix

This commit is contained in:
Matthias Clasen 2009-07-05 23:55:00 -04:00
parent 563c55bb71
commit d5a5130519

View File

@ -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,7 +43,7 @@
* Returns: a new #GError
*
* Since: 2.22
**/
*/
GError*
g_error_new_valist (GQuark domain,
gint code,
@ -72,7 +72,7 @@ g_error_new_valist (GQuark domain,
* and a message formatted with @format.
*
* Return value: a new #GError
**/
*/
GError*
g_error_new (GQuark domain,
gint code,
@ -98,9 +98,9 @@ g_error_new (GQuark domain,
* @code: error code
* @message: error message
*
* Creates a new #GError; unlike g_error_new(), @message is not
* a printf()-style format string. Use this
* function if @message contains text you don't have control over,
* Creates a new #GError; unlike g_error_new(), @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.
*
* Return value: a new #GError
@ -129,8 +129,7 @@ g_error_new_literal (GQuark domain,
* @error: a #GError
*
* Frees a #GError and associated resources.
*
**/
*/
void
g_error_free (GError *error)
{
@ -148,7 +147,7 @@ g_error_free (GError *error)
* Makes a copy of @error.
*
* Return value: a new #GError
**/
*/
GError*
g_error_copy (const GError *error)
{
@ -175,7 +174,7 @@ g_error_copy (const GError *error)
* otherwise.
*
* Return value: whether @error has @domain and @code
**/
*/
gboolean
g_error_matches (const GError *error,
GQuark domain,
@ -198,9 +197,9 @@ g_error_matches (const GError *error,
* @format: printf()-style format
* @Varargs: args for @format
*
* Does nothing if @err is %NULL; if @err is non-%NULL, then *@err must
* be %NULL. A new #GError is created and assigned to *@err.
**/
* Does nothing if @err is %NULL; if @err is non-%NULL, then *@err
* must be %NULL. A new #GError is created and assigned to *@err.
*/
void
g_set_error (GError **err,
GQuark domain,
@ -232,14 +231,14 @@ g_set_error (GError **err,
* @code: error code
* @message: error message
*
* Does nothing if @err is %NULL; if @err is non-%NULL, then *@err must
* be %NULL. A new #GError is created and assigned to *@err.
* Does nothing if @err is %NULL; if @err is non-%NULL, then *@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,
@ -265,7 +264,7 @@ 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,
GError *src)
@ -293,7 +292,7 @@ g_propagate_error (GError **dest,
*
* 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,