Replace @Varargs with @...

to make gtk-doc happy.
This commit is contained in:
Ryan Lortie 2011-07-22 13:25:32 +02:00
parent ea63f16c59
commit 5dbc12e9f1
9 changed files with 26 additions and 26 deletions

View File

@ -391,7 +391,7 @@ g_error_new_valist (GQuark domain,
* @domain: error domain * @domain: error domain
* @code: error code * @code: error code
* @format: printf()-style format for error message * @format: printf()-style format for error message
* @Varargs: parameters for message format * @...: parameters for message format
* *
* Creates a new #GError with the given @domain and @code, * Creates a new #GError with the given @domain and @code,
* and a message formatted with @format. * and a message formatted with @format.
@ -521,7 +521,7 @@ g_error_matches (const GError *error,
* @domain: error domain * @domain: error domain
* @code: error code * @code: error code
* @format: printf()-style format * @format: printf()-style format
* @Varargs: args for @format * @...: args for @format
* *
* Does nothing if @err is %NULL; if @err is non-%NULL, then *@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. * must be %NULL. A new #GError is created and assigned to *@err.

View File

@ -1534,7 +1534,7 @@ g_build_pathv (const gchar *separator,
* g_build_path: * g_build_path:
* @separator: a string used to separator the elements of the path. * @separator: a string used to separator the elements of the path.
* @first_element: the first element in the path * @first_element: the first element in the path
* @Varargs: remaining elements in path, terminated by %NULL * @...: remaining elements in path, terminated by %NULL
* *
* Creates a path from a series of elements using @separator as the * Creates a path from a series of elements using @separator as the
* separator between elements. At the boundary between two elements, * separator between elements. At the boundary between two elements,
@ -1728,7 +1728,7 @@ g_build_filenamev (gchar **args)
/** /**
* g_build_filename: * g_build_filename:
* @first_element: the first element in the path * @first_element: the first element in the path
* @Varargs: remaining elements in path, terminated by %NULL * @...: remaining elements in path, terminated by %NULL
* *
* Creates a filename from a series of elements using the correct * Creates a filename from a series of elements using the correct
* separator for filenames. * separator for filenames.

View File

@ -2454,7 +2454,7 @@ g_markup_vprintf_escaped (const gchar *format,
/** /**
* g_markup_printf_escaped: * g_markup_printf_escaped:
* @format: printf() style format string * @format: printf() style format string
* @Varargs: the arguments to insert in the format string * @...: the arguments to insert in the format string
* *
* Formats arguments according to @format, escaping * Formats arguments according to @format, escaping
* all string and character arguments in the fashion * all string and character arguments in the fashion

View File

@ -1034,7 +1034,7 @@ g_set_print_handler (GPrintFunc func)
/** /**
* g_print: * g_print:
* @format: the message format. See the printf() documentation * @format: the message format. See the printf() documentation
* @Varargs: the parameters to insert into the format string * @...: the parameters to insert into the format string
* *
* Outputs a formatted message via the print handler. * Outputs a formatted message via the print handler.
* The default print handler simply outputs the message to stdout. * The default print handler simply outputs the message to stdout.
@ -1113,7 +1113,7 @@ g_set_printerr_handler (GPrintFunc func)
/** /**
* g_printerr: * g_printerr:
* @format: the message format. See the printf() documentation * @format: the message format. See the printf() documentation
* @Varargs: the parameters to insert into the format string * @...: the parameters to insert into the format string
* *
* Outputs a formatted message via the error message handler. * Outputs a formatted message via the error message handler.
* The default handler simply outputs the message to stderr. * The default handler simply outputs the message to stderr.

View File

@ -31,7 +31,7 @@
* g_printf: * g_printf:
* @format: a standard printf() format string, but notice * @format: a standard printf() format string, but notice
* <link linkend="string-precision">string precision pitfalls</link>. * <link linkend="string-precision">string precision pitfalls</link>.
* @Varargs: the arguments to insert in the output. * @...: the arguments to insert in the output.
* *
* An implementation of the standard printf() function which supports * An implementation of the standard printf() function which supports
* positional parameters, as specified in the Single Unix Specification. * positional parameters, as specified in the Single Unix Specification.
@ -59,7 +59,7 @@ g_printf (gchar const *format,
* @file: the stream to write to. * @file: the stream to write to.
* @format: a standard printf() format string, but notice * @format: a standard printf() format string, but notice
* <link linkend="string-precision">string precision pitfalls</link>. * <link linkend="string-precision">string precision pitfalls</link>.
* @Varargs: the arguments to insert in the output. * @...: the arguments to insert in the output.
* *
* An implementation of the standard fprintf() function which supports * An implementation of the standard fprintf() function which supports
* positional parameters, as specified in the Single Unix Specification. * positional parameters, as specified in the Single Unix Specification.
@ -90,7 +90,7 @@ g_fprintf (FILE *file,
* enough to hold the formatted result * enough to hold the formatted result
* @format: a standard printf() format string, but notice * @format: a standard printf() format string, but notice
* <link linkend="string-precision">string precision pitfalls</link>. * <link linkend="string-precision">string precision pitfalls</link>.
* @Varargs: the arguments to insert in the output. * @...: the arguments to insert in the output.
* *
* An implementation of the standard sprintf() function which supports * An implementation of the standard sprintf() function which supports
* positional parameters, as specified in the Single Unix Specification. * positional parameters, as specified in the Single Unix Specification.
@ -126,7 +126,7 @@ g_sprintf (gchar *string,
* terminating nul character). * terminating nul character).
* @format: a standard printf() format string, but notice * @format: a standard printf() format string, but notice
* <link linkend="string-precision">string precision pitfalls</link>. * <link linkend="string-precision">string precision pitfalls</link>.
* @Varargs: the arguments to insert in the output. * @...: the arguments to insert in the output.
* *
* A safer form of the standard sprintf() function. The output is guaranteed * A safer form of the standard sprintf() function. The output is guaranteed
* to not exceed @n characters (including the terminating nul character), so * to not exceed @n characters (including the terminating nul character), so

View File

@ -280,9 +280,9 @@ g_relation_index (GRelation *relation,
/** /**
* g_relation_insert: * g_relation_insert:
* @relation: a #GRelation. * @relation: a #GRelation.
* @Varargs: the fields of the record to add. These must match the * @...: the fields of the record to add. These must match the
* number of fields in the #GRelation, and of type #gpointer * number of fields in the #GRelation, and of type #gpointer
* or #gconstpointer. * or #gconstpointer.
* *
* Inserts a record into a #GRelation. * Inserts a record into a #GRelation.
* *
@ -516,8 +516,8 @@ g_relation_count (GRelation *relation,
/** /**
* g_relation_exists: * g_relation_exists:
* @relation: a #GRelation. * @relation: a #GRelation.
* @Varargs: the fields of the record to compare. The number must match * @...: the fields of the record to compare. The number must match
* the number of fields in the #GRelation. * the number of fields in the #GRelation.
* @Returns: %TRUE if a record matches. * @Returns: %TRUE if a record matches.
* *
* Returns %TRUE if a record with the given values exists in a * Returns %TRUE if a record with the given values exists in a

View File

@ -259,7 +259,7 @@ g_strdup_vprintf (const gchar *format,
* g_strdup_printf: * g_strdup_printf:
* @format: a standard printf() format string, but notice * @format: a standard printf() format string, but notice
* <link linkend="string-precision">string precision pitfalls</link> * <link linkend="string-precision">string precision pitfalls</link>
* @Varargs: the parameters to insert into the format string * @...: the parameters to insert into the format string
* *
* Similar to the standard C sprintf() function but safer, since it * Similar to the standard C sprintf() function but safer, since it
* calculates the maximum space required and allocates memory to hold * calculates the maximum space required and allocates memory to hold
@ -285,7 +285,7 @@ g_strdup_printf (const gchar *format,
/** /**
* g_strconcat: * g_strconcat:
* @string1: the first string to add, which must not be %NULL * @string1: the first string to add, which must not be %NULL
* @Varargs: a %NULL-terminated list of strings to append to the string * @...: a %NULL-terminated list of strings to append to the string
* *
* Concatenates all of the given strings into one long string. * Concatenates all of the given strings into one long string.
* The returned string should be freed with g_free() when no longer needed. * The returned string should be freed with g_free() when no longer needed.
@ -2666,7 +2666,7 @@ g_strjoinv (const gchar *separator,
/** /**
* g_strjoin: * g_strjoin:
* @separator: a string to insert between each of the strings, or %NULL * @separator: a string to insert between each of the strings, or %NULL
* @Varargs: a %NULL-terminated list of strings to join * @...: a %NULL-terminated list of strings to join
* *
* Joins a number of strings together to form one long string, with the * Joins a number of strings together to form one long string, with the
* optional @separator inserted between each of them. The returned string * optional @separator inserted between each of them. The returned string

View File

@ -1455,7 +1455,7 @@ g_string_vprintf (GString *string,
* g_string_sprintf: * g_string_sprintf:
* @string: a #GString * @string: a #GString
* @format: the string format. See the sprintf() documentation * @format: the string format. See the sprintf() documentation
* @Varargs: the parameters to insert into the format string * @...: the parameters to insert into the format string
* *
* Writes a formatted string into a #GString. * Writes a formatted string into a #GString.
* This is similar to the standard sprintf() function, * This is similar to the standard sprintf() function,
@ -1470,7 +1470,7 @@ g_string_vprintf (GString *string,
* g_string_printf: * g_string_printf:
* @string: a #GString * @string: a #GString
* @format: the string format. See the printf() documentation * @format: the string format. See the printf() documentation
* @Varargs: the parameters to insert into the format string * @...: the parameters to insert into the format string
* *
* Writes a formatted string into a #GString. * Writes a formatted string into a #GString.
* This is similar to the standard sprintf() function, * This is similar to the standard sprintf() function,
@ -1496,7 +1496,7 @@ g_string_printf (GString *string,
* g_string_sprintfa: * g_string_sprintfa:
* @string: a #GString * @string: a #GString
* @format: the string format. See the sprintf() documentation * @format: the string format. See the sprintf() documentation
* @Varargs: the parameters to insert into the format string * @...: the parameters to insert into the format string
* *
* Appends a formatted string onto the end of a #GString. * Appends a formatted string onto the end of a #GString.
* This function is similar to g_string_sprintf() except that * This function is similar to g_string_sprintf() except that
@ -1509,7 +1509,7 @@ g_string_printf (GString *string,
* g_string_append_printf: * g_string_append_printf:
* @string: a #GString * @string: a #GString
* @format: the string format. See the printf() documentation * @format: the string format. See the printf() documentation
* @Varargs: the parameters to insert into the format string * @...: the parameters to insert into the format string
* *
* Appends a formatted string onto the end of a #GString. * Appends a formatted string onto the end of a #GString.
* This function is similar to g_string_printf() except * This function is similar to g_string_printf() except

View File

@ -407,7 +407,7 @@ parse_args (gint *argc_p,
* Changed if any arguments were handled. * Changed if any arguments were handled.
* @argv: Address of the @argv parameter of main(). * @argv: Address of the @argv parameter of main().
* Any parameters understood by g_test_init() stripped before return. * Any parameters understood by g_test_init() stripped before return.
* @Varargs: Reserved for future extension. Currently, you must pass %NULL. * @...: Reserved for future extension. Currently, you must pass %NULL.
* *
* Initialize the GLib testing framework, e.g. by seeding the * Initialize the GLib testing framework, e.g. by seeding the
* test random number generator, the name for g_get_prgname() * test random number generator, the name for g_get_prgname()
@ -705,7 +705,7 @@ g_test_timer_last (void)
* g_test_minimized_result: * g_test_minimized_result:
* @minimized_quantity: the reported value * @minimized_quantity: the reported value
* @format: the format string of the report message * @format: the format string of the report message
* @Varargs: arguments to pass to the printf() function * @...: arguments to pass to the printf() function
* *
* Report the result of a performance or measurement test. * Report the result of a performance or measurement test.
* The test should generally strive to minimize the reported * The test should generally strive to minimize the reported
@ -736,7 +736,7 @@ g_test_minimized_result (double minimized_quantity,
* g_test_maximized_result: * g_test_maximized_result:
* @maximized_quantity: the reported value * @maximized_quantity: the reported value
* @format: the format string of the report message * @format: the format string of the report message
* @Varargs: arguments to pass to the printf() function * @...: arguments to pass to the printf() function
* *
* Report the result of a performance or measurement test. * Report the result of a performance or measurement test.
* The test should generally strive to maximize the reported * The test should generally strive to maximize the reported