diff options
author | Soeren Sandmann <sandmann@daimi.au.dk> | 2002-11-08 18:47:56 +0000 |
---|---|---|
committer | Søren Sandmann Pedersen <ssp@src.gnome.org> | 2002-11-08 18:47:56 +0000 |
commit | d201974f56d7b805f70b5c5703be79e8db73526e (patch) | |
tree | 7cd2d8604a69daa475bee072ad2bb35e49002611 /docs | |
parent | 10520a9228e11c6b9083eb96948d7ed5e40bda4b (diff) | |
download | glib-d201974f56d7b805f70b5c5703be79e8db73526e.tar.gz glib-d201974f56d7b805f70b5c5703be79e8db73526e.tar.bz2 glib-d201974f56d7b805f70b5c5703be79e8db73526e.zip |
Trivial s/foo/foo_/ fixes to make <glib.h> includable with -Wshadow
Fri Nov 8 19:44:20 2002 Soeren Sandmann <sandmann@daimi.au.dk>
* docs/reference/glib/tmpl/arrays.sgml:
* docs/reference/glib/tmpl/arrays_byte.sgml:
* docs/reference/glib/tmpl/arrays_pointer.sgml:
* docs/reference/glib/tmpl/date.sgml:
* docs/reference/glib/tmpl/linked_lists_double.sgml:
* docs/reference/glib/tmpl/linked_lists_single.sgml:
* docs/reference/glib/tmpl/main.sgml:
* docs/reference/glib/tmpl/queue.sgml:
* docs/reference/glib/tmpl/random_numbers.sgml:
* docs/reference/glib/tmpl/relations.sgml:
* docs/reference/glib/tmpl/scanner.sgml:
* docs/reference/gobject/tmpl/gtype.sgml:
* docs/reference/gobject/tmpl/value_arrays.sgml glib/garray.h:
* glib/gdate.h glib/giochannel.h glib/glist.h glib/gmain.c:
* glib/gmain.h glib/gqueue.c glib/gqueue.h glib/grand.c glib/grand.h:
* glib/grel.h glib/gslist.h glib/gtimer.h gobject/gvaluearray.h:
Trivial s/foo/foo_/ fixes to make <glib.h> includable with
-Wshadow without warnings (#91680)
Diffstat (limited to 'docs')
-rw-r--r-- | docs/reference/glib/tmpl/arrays.sgml | 12 | ||||
-rw-r--r-- | docs/reference/glib/tmpl/arrays_byte.sgml | 4 | ||||
-rw-r--r-- | docs/reference/glib/tmpl/arrays_pointer.sgml | 6 | ||||
-rw-r--r-- | docs/reference/glib/tmpl/date.sgml | 4 | ||||
-rw-r--r-- | docs/reference/glib/tmpl/linked_lists_double.sgml | 4 | ||||
-rw-r--r-- | docs/reference/glib/tmpl/linked_lists_single.sgml | 4 | ||||
-rw-r--r-- | docs/reference/glib/tmpl/main.sgml | 8 | ||||
-rw-r--r-- | docs/reference/glib/tmpl/queue.sgml | 4 | ||||
-rw-r--r-- | docs/reference/glib/tmpl/random_numbers.sgml | 16 | ||||
-rw-r--r-- | docs/reference/glib/tmpl/relations.sgml | 2 | ||||
-rw-r--r-- | docs/reference/glib/tmpl/scanner.sgml | 1 | ||||
-rw-r--r-- | docs/reference/gobject/tmpl/gtype.sgml | 10 | ||||
-rw-r--r-- | docs/reference/gobject/tmpl/value_arrays.sgml | 12 |
13 files changed, 49 insertions, 38 deletions
diff --git a/docs/reference/glib/tmpl/arrays.sgml b/docs/reference/glib/tmpl/arrays.sgml index 3f360e141..6602e13b1 100644 --- a/docs/reference/glib/tmpl/arrays.sgml +++ b/docs/reference/glib/tmpl/arrays.sgml @@ -71,7 +71,7 @@ Creates a new #GArray. @zero_terminated: %TRUE if the array should have an extra element at the end which is set to 0. -@clear: %TRUE if #GArray elements should be automatically cleared to 0 +@clear_: %TRUE if #GArray elements should be automatically cleared to 0 when they are allocated. @element_size: the size of each element in bytes. @Returns: the new #GArray. @@ -86,7 +86,7 @@ array is still 0. </para> @zero_terminated: %TRUE if the array should have an extra element at the end with all bits cleared. -@clear: %TRUE if all bits in the array should be cleared to 0 on allocation. +@clear_: %TRUE if all bits in the array should be cleared to 0 on allocation. @element_size: size of each element in the array. @reserved_size: number of elements preallocated. @Returns: the new #GArray. @@ -182,7 +182,7 @@ Inserts @len elements into a #GArray at the given index. </para> @array: a #GArray. -@index: the index to place the elements at. +@index_: the index to place the elements at. @data: a pointer to the elements to insert. @len: the number of elements to insert. @Returns: the #GArray. @@ -195,7 +195,7 @@ The following elements are moved down one place. </para> @array: a #GArray. -@index: the index of the element to remove. +@index_: the index of the element to remove. @Returns: the #GArray. @@ -208,7 +208,7 @@ g_array_remove_index(). </para> @array: a @GArray. -@index: the index of the element to remove. +@index_: the index of the element to remove. @Returns: the #GArray. @@ -260,7 +260,7 @@ The return value is cast to the given type. <!-- ##### FUNCTION g_array_set_size ##### --> <para> Sets the size of the array, expanding it if necessary. -If the array was created with @clear set to %TRUE, the new elements are set to 0. +If the array was created with @clear_ set to %TRUE, the new elements are set to 0. </para> @array: a #GArray. diff --git a/docs/reference/glib/tmpl/arrays_byte.sgml b/docs/reference/glib/tmpl/arrays_byte.sgml index dedb301e8..5614edf41 100644 --- a/docs/reference/glib/tmpl/arrays_byte.sgml +++ b/docs/reference/glib/tmpl/arrays_byte.sgml @@ -108,7 +108,7 @@ The following bytes are moved down one place. </para> @array: a #GByteArray. -@index: the index of the byte to remove. +@index_: the index of the byte to remove. @Returns: the #GByteArray. @@ -121,7 +121,7 @@ g_byte_array_remove_index(). </para> @array: a #GByteArray. -@index: the index of the byte to remove. +@index_: the index of the byte to remove. @Returns: the #GByteArray. diff --git a/docs/reference/glib/tmpl/arrays_pointer.sgml b/docs/reference/glib/tmpl/arrays_pointer.sgml index 889628b5e..0222cfc37 100644 --- a/docs/reference/glib/tmpl/arrays_pointer.sgml +++ b/docs/reference/glib/tmpl/arrays_pointer.sgml @@ -121,7 +121,7 @@ The following elements are moved down one place. </para> @array: a #GPtrArray. -@index: the index of the pointer to remove. +@index_: the index of the pointer to remove. @Returns: the pointer which was removed. @@ -151,7 +151,7 @@ g_ptr_array_remove_index(). </para> @array: a #GPtrArray. -@index: the index of the pointer to remove. +@index_: the index of the pointer to remove. @Returns: the pointer which was removed. @@ -192,7 +192,7 @@ Returns the pointer at the given index of the pointer array. </para> @array: a #GPtrArray. -@index: the index of the pointer to return. +@index_: the index of the pointer to return. @Returns: the pointer at the given index. diff --git a/docs/reference/glib/tmpl/date.sgml b/docs/reference/glib/tmpl/date.sgml index 0f6bf0b8b..6fcec9974 100644 --- a/docs/reference/glib/tmpl/date.sgml +++ b/docs/reference/glib/tmpl/date.sgml @@ -107,7 +107,7 @@ length of the sleep. </para> -@time: +@time_: @microseconds: @@ -334,7 +334,7 @@ g_date_set_time (date, time (NULL)); </para> @date: a #GDate. -@time: #GTime value to set. +@time_: #GTime value to set. <!-- ##### FUNCTION g_date_set_parse ##### --> diff --git a/docs/reference/glib/tmpl/linked_lists_double.sgml b/docs/reference/glib/tmpl/linked_lists_double.sgml index be76f7b29..5da5cb985 100644 --- a/docs/reference/glib/tmpl/linked_lists_double.sgml +++ b/docs/reference/glib/tmpl/linked_lists_double.sgml @@ -193,11 +193,11 @@ self-contained list with one element. <!-- ##### FUNCTION g_list_delete_link ##### --> <para> -Deletes the node @link from @list. +Deletes the node @link_ from @list. </para> @list: a #GList. -@link: node to delete from @list. +@link_: node to delete from @list. @Returns: the new head of @list. diff --git a/docs/reference/glib/tmpl/linked_lists_single.sgml b/docs/reference/glib/tmpl/linked_lists_single.sgml index 0c09e4f5e..8a3db2e12 100644 --- a/docs/reference/glib/tmpl/linked_lists_single.sgml +++ b/docs/reference/glib/tmpl/linked_lists_single.sgml @@ -195,7 +195,7 @@ self-contained list with one element. </para> @list: a #GSList. -@link: an element in the #GSList. +@link_: an element in the #GSList. @Returns: the new start of the #GSList, without the element. @@ -205,7 +205,7 @@ Deletes a node of @list. Returns the new list head. </para> @list: a #GSList. -@link: node to delete. +@link_: node to delete. @Returns: new head of @list. diff --git a/docs/reference/glib/tmpl/main.sgml b/docs/reference/glib/tmpl/main.sgml index ce5a12fe2..79d938ca3 100644 --- a/docs/reference/glib/tmpl/main.sgml +++ b/docs/reference/glib/tmpl/main.sgml @@ -429,7 +429,7 @@ g_main_context_pending(). @context: @max_priority: -@timeout: +@timeout_: @fds: @n_fds: @Returns: @@ -482,7 +482,7 @@ The semantics of the function should match those of the @ufds: an array of #GPollFD elements. @nfsd: the number of elements in @ufds. -@timeout: the maximum time to wait for an event of the file descriptors. +@timeout_: the maximum time to wait for an event of the file descriptors. A negative value indicates an infinite timeout. @Returns: the number of #GPollFD elements which have events or errors reported, or -1 if an error occurred. @@ -648,10 +648,10 @@ event sources in a generic manner. Called before all the file descriptors are polled. If the source can determine that it is ready here (without waiting for the results of the <function>poll()</function> call) it should return %TRUE. -It can also return a @timeout value which should be the maximum timeout +It can also return a @timeout_ value which should be the maximum timeout (in milliseconds) which should be passed to the <function>poll()</function> call. The actual timeout used will be -1 if all sources returned -1, or it will -be the minimum of all the @timeout values returned which were >= 0. +be the minimum of all the @timeout_ values returned which were >= 0. </entry> </row> diff --git a/docs/reference/glib/tmpl/queue.sgml b/docs/reference/glib/tmpl/queue.sgml index 99427edee..3846eec65 100644 --- a/docs/reference/glib/tmpl/queue.sgml +++ b/docs/reference/glib/tmpl/queue.sgml @@ -129,7 +129,7 @@ Contains the public fields of a <link linkend="glib-queues">Queue</link>. </para> @queue: -@link: +@link_: <!-- ##### FUNCTION g_queue_push_tail_link ##### --> @@ -138,7 +138,7 @@ Contains the public fields of a <link linkend="glib-queues">Queue</link>. </para> @queue: -@link: +@link_: <!-- ##### FUNCTION g_queue_pop_head_link ##### --> diff --git a/docs/reference/glib/tmpl/random_numbers.sgml b/docs/reference/glib/tmpl/random_numbers.sgml index cfa1ee3a3..ada8a85a0 100644 --- a/docs/reference/glib/tmpl/random_numbers.sgml +++ b/docs/reference/glib/tmpl/random_numbers.sgml @@ -60,37 +60,37 @@ accessed through the <function>g_rand_*</function> functions. <!-- ##### FUNCTION g_rand_free ##### --> -@rand: +@rand_: <!-- ##### FUNCTION g_rand_set_seed ##### --> -@rand: +@rand_: @seed: <!-- ##### MACRO g_rand_boolean ##### --> <para> -Returns a random #gboolean from @rand. This corresponds to a unbiased +Returns a random #gboolean from @rand_. This corresponds to a unbiased coin toss. </para> -@rand: a #GRand. +@rand_: a #GRand. @Returns: a random #gboolean. <!-- ##### FUNCTION g_rand_int ##### --> -@rand: +@rand_: @Returns: <!-- ##### FUNCTION g_rand_int_range ##### --> -@rand: +@rand_: @begin: @end: @Returns: @@ -99,14 +99,14 @@ coin toss. <!-- ##### FUNCTION g_rand_double ##### --> -@rand: +@rand_: @Returns: <!-- ##### FUNCTION g_rand_double_range ##### --> -@rand: +@rand_: @begin: @end: @Returns: diff --git a/docs/reference/glib/tmpl/relations.sgml b/docs/reference/glib/tmpl/relations.sgml index 70b7ce61e..102f0fb41 100644 --- a/docs/reference/glib/tmpl/relations.sgml +++ b/docs/reference/glib/tmpl/relations.sgml @@ -194,7 +194,7 @@ The returned value should not be changed. </para> @tuples: the tuple data, returned by g_relation_select(). -@index: the index of the record. +@index_: the index of the record. @field: the field to return. @Returns: the field of the record. diff --git a/docs/reference/glib/tmpl/scanner.sgml b/docs/reference/glib/tmpl/scanner.sgml index 4488296f1..9b0ed99f6 100644 --- a/docs/reference/glib/tmpl/scanner.sgml +++ b/docs/reference/glib/tmpl/scanner.sgml @@ -214,6 +214,7 @@ is searched for in the default scope in addition to the current scope @char_2_token: @symbol_2_token: @scope_0_fallback: +@store_int64: @padding_dummy: <!-- ##### FUNCTION g_scanner_input_file ##### --> diff --git a/docs/reference/gobject/tmpl/gtype.sgml b/docs/reference/gobject/tmpl/gtype.sgml index 092b1f1e0..85837d59d 100644 --- a/docs/reference/gobject/tmpl/gtype.sgml +++ b/docs/reference/gobject/tmpl/gtype.sgml @@ -730,6 +730,16 @@ g_free()ed after use. @Returns: Newly allocated and 0-terminated array of interface types. +<!-- ##### FUNCTION g_type_interface_prerequisites ##### --> +<para> + +</para> + +@interface_type: +@n_prerequisites: +@Returns: + + <!-- ##### FUNCTION g_type_set_qdata ##### --> <para> diff --git a/docs/reference/gobject/tmpl/value_arrays.sgml b/docs/reference/gobject/tmpl/value_arrays.sgml index b9e6219b6..643fe5714 100644 --- a/docs/reference/gobject/tmpl/value_arrays.sgml +++ b/docs/reference/gobject/tmpl/value_arrays.sgml @@ -25,12 +25,12 @@ in order for it to be used as a boxed type through %G_TYPE_VALUE_ARRAY. <!-- ##### FUNCTION g_value_array_get_nth ##### --> <para> -Return a pointer to the value at @index containd in @value_array. +Return a pointer to the value at @index_ containd in @value_array. </para> @value_array: #GValueArray to get a value from -@index: index of the value of interest -@Returns: pointer to a value at @index in @value_array +@index_: index of the value of interest +@Returns: pointer to a value at @index_ in @value_array <!-- ##### FUNCTION g_value_array_new ##### --> @@ -88,18 +88,18 @@ Insert a copy of @value at specified position into @value_array. </para> @value_array: #GValueArray to add an element to -@index: insertion position, must be <= value_array->n_values +@index_: insertion position, must be <= value_array->n_values @value: #GValue to copy into #GValueArray @Returns: the #GValueArray passed in as @value_array <!-- ##### FUNCTION g_value_array_remove ##### --> <para> -Remove the value at position @index from @value_array. +Remove the value at position @index_ from @value_array. </para> @value_array: #GValueArray to remove an element from -@index: position of value to remove, must be < value_array->n_values +@index_: position of value to remove, must be < value_array->n_values @Returns: the #GValueArray passed in as @value_array |