luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-08-09 18:54:04 +02:00
Code Issues Packages Projects Releases Wiki Activity

Remove inlined docs

Browse Source 
svn path=/trunk/; revision=6656
This commit is contained in:
Matthias Clasen
2008-03-10 16:47:58 +00:00
parent 83ba7b5fba
commit ff4685caa0
3 changed files with 223 additions and 375 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/reference/ChangeLog
View File

@@ -1,3 +1,9 @@
2008-03-10 Matthias Clasen <mclasen@redhat.com>
* glib/tmpl/linked_lists_double.sgml:
* glib/tmpl/linked_lists_single.sgml: Remove docs that have
been inlined.
2008-03-10 Matthias Clasen <mclasen@redhat.com> 2008-03-10 Matthias Clasen <mclasen@redhat.com>
* glib/tmpl/types.sgml: Add a Since marker for goffset (#521013, * glib/tmpl/types.sgml: Add a Since marker for goffset (#521013,

309
docs/reference/glib/tmpl/linked_lists_double.sgml
View File

@@ -81,160 +81,103 @@ The #GList struct is used for each element in a doubly-linked list.
<!-- ##### FUNCTION g_list_append ##### --> <!-- ##### FUNCTION g_list_append ##### -->
<para> <para>
Adds a new element on to the end of the list.
</para>
<note>
<para>
The return value is the new start of the list, which may have changed, so
make sure you store the new value.
</para>
</note>
<note>
<para>
Note that g_list_append() has to traverse the entire list to find the end,
which is inefficient when adding multiple elements. A common idiom to
avoid the inefficiency is to prepend the elements and reverse the list
when all elements have been added.
</para>
</note>
<informalexample><programlisting>
/* Notice that these are initialized to the empty list. */
GList *list = NULL, *number_list = NULL;
/* This is a list of strings. */ </para>
list = g_list_append (list, "first");
list = g_list_append (list, "second");
/* This is a list of integers. */ @list:
number_list = g_list_append (number_list, GINT_TO_POINTER (27)); @data:
number_list = g_list_append (number_list, GINT_TO_POINTER (14)); @Returns:
</programlisting></informalexample>
@list: a pointer to a #GList.
@data: the data for the new element.
@Returns: the new start of the #GList.
<!-- ##### FUNCTION g_list_prepend ##### --> <!-- ##### FUNCTION g_list_prepend ##### -->
<para> <para>
Adds a new element on to the start of the list.
</para>
<note>
<para>
The return value is the new start of the list, which may have changed, so
make sure you store the new value.
</para>
</note>
<informalexample><programlisting>
/* Notice that it is initialized to the empty list. */
GList *list = NULL;
list = g_list_prepend (list, "last");
list = g_list_prepend (list, "first");
</programlisting></informalexample>
@list: a pointer to a #GList. </para>
@data: the data for the new element.
@Returns: the new start of the #GList. @list:
@data:
@Returns:
<!-- ##### FUNCTION g_list_insert ##### --> <!-- ##### FUNCTION g_list_insert ##### -->
<para> <para>
Inserts a new element into the list at the given position.
</para> </para>
@list: a pointer to a #GList. @list:
@data: the data for the new element. @data:
@position: the position to insert the element. If this is negative, or is @position:
larger than the number of elements in the list, the new element is added on @Returns:
to the end of the list.
@Returns: the new start of the #GList.
<!-- ##### FUNCTION g_list_insert_before ##### --> <!-- ##### FUNCTION g_list_insert_before ##### -->
<para> <para>
Inserts a new element into the list before the given position.
</para> </para>
@list: a pointer to a #GList. @list:
@sibling: the list element before which the new element is inserted @sibling:
or %NULL to insert at the end of the list. @data:
@data: the data for the new element. @Returns:
@Returns: the new start of the #GList.
<!-- ##### FUNCTION g_list_insert_sorted ##### --> <!-- ##### FUNCTION g_list_insert_sorted ##### -->
<para> <para>
Inserts a new element into the list, using the given comparison function
to determine its position.
</para> </para>
@list: a pointer to a #GList. @list:
@data: the data for the new element. @data:
@func: the function to compare elements in the list. It should return a @func:
number > 0 if the first parameter comes after the second parameter in @Returns:
the sort order.
@Returns: the new start of the #GList.
<!-- ##### FUNCTION g_list_remove ##### --> <!-- ##### FUNCTION g_list_remove ##### -->
<para> <para>
Removes an element from a #GList.
If two elements contain the same data, only the first is removed.
If none of the elements contain the data, the #GList is unchanged.
</para> </para>
@list: a #GList. @list:
@data: the data of the element to remove. @data:
@Returns: the new start of the #GList. @Returns:
<!-- ##### FUNCTION g_list_remove_link ##### --> <!-- ##### FUNCTION g_list_remove_link ##### -->
<para> <para>
Removes an element from a #GList, without freeing the element.
The removed element's prev and next links are set to %NULL, so that it becomes a
self-contained list with one element.
</para> </para>
@list: a #GList. @list:
@llink: an element in the #GList. @llink:
@Returns: the new start of the #GList, without the element. @Returns:
<!-- ##### FUNCTION g_list_delete_link ##### --> <!-- ##### FUNCTION g_list_delete_link ##### -->
<para> <para>
Deletes the node @link_ from @list.
</para> </para>
@list: a #GList. @list:
@link_: node to delete from @list. @link_:
@Returns: the new head of @list. @Returns:
<!-- ##### FUNCTION g_list_remove_all ##### --> <!-- ##### FUNCTION g_list_remove_all ##### -->
<para> <para>
Removes all list nodes with data equal to @data. Returns the new
head of the list. Contrast with g_list_remove() which removes only
the first node matching the given data.
</para> </para>
@list: a #GList. @list:
@data: data to remove. @data:
@Returns: new head of @list. @Returns:
<!-- ##### FUNCTION g_list_free ##### --> <!-- ##### FUNCTION g_list_free ##### -->
<para> <para>
Frees all of the memory used by a #GList.
The freed elements are returned to the slice allocator.
</para>
<note>
<para>
If list elements contain dynamically-allocated memory, they should be freed
first.
</para>
</note>
@list: a #GList. </para>
@list:
<!-- ##### FUNCTION g_list_alloc ##### --> <!-- ##### FUNCTION g_list_alloc ##### -->
@@ -249,11 +192,10 @@ g_list_insert_sorted() and so is rarely used on its own.
<!-- ##### FUNCTION g_list_free_1 ##### --> <!-- ##### FUNCTION g_list_free_1 ##### -->
<para> <para>
Frees one #GList element.
It is usually used after g_list_remove_link().
</para> </para>
@list: a #GList element. @list:
<!-- ##### MACRO g_list_free1 ##### --> <!-- ##### MACRO g_list_free1 ##### -->
@@ -265,48 +207,39 @@ Another name for g_list_free_1().
<!-- ##### FUNCTION g_list_length ##### --> <!-- ##### FUNCTION g_list_length ##### -->
<para> <para>
Gets the number of elements in a #GList.
</para> </para>
@list: a #GList. @list:
@Returns: the number of elements in the #GList. @Returns:
<!-- ##### FUNCTION g_list_copy ##### --> <!-- ##### FUNCTION g_list_copy ##### -->
<para> <para>
Copies a #GList.
</para>
<para>
Note that this is a "shallow" copy. If the list elements consist of pointers
to data, the pointers are copied but the actual data isn't.
</para> </para>
@list: a #GList. @list:
@Returns: a copy of @list. @Returns:
<!-- ##### FUNCTION g_list_reverse ##### --> <!-- ##### FUNCTION g_list_reverse ##### -->
<para> <para>
Reverses a #GList.
It simply switches the next and prev pointers of each element.
</para> </para>
@list: a #GList. @list:
@Returns: the start of the reversed #GList. @Returns:
<!-- ##### FUNCTION g_list_sort ##### --> <!-- ##### FUNCTION g_list_sort ##### -->
<para> <para>
Sorts a #GList using the given comparison function.
</para> </para>
@list: a #GList. @list:
@compare_func: the comparison function used to sort the #GList. @compare_func:
This function is passed the data from 2 elements of the #GList and should @Returns:
return 0 if they are equal, a negative value if the first element
comes before the second, or a positive value if the first element
comes after the second.
@Returns: the start of the sorted #GList.
<!-- ##### USER_FUNCTION GCompareFunc ##### --> <!-- ##### USER_FUNCTION GCompareFunc ##### -->
@@ -325,29 +258,25 @@ if @a > @b.
<!-- ##### FUNCTION g_list_insert_sorted_with_data ##### --> <!-- ##### FUNCTION g_list_insert_sorted_with_data ##### -->
<para> <para>
Inserts a new element into the list, using the given comparison function
to determine its position.
</para> </para>
@list: a pointer to a #GList. @list:
@data: the data for the new element. @data:
@func: the function to compare elements in the list. It should return a @func:
number > 0 if the first parameter comes after the second parameter in @user_data:
the sort order. @Returns:
@user_data: user data to pass to comparison function.
@Returns: the new start of the #GList.
@Since 2.10
<!-- ##### FUNCTION g_list_sort_with_data ##### --> <!-- ##### FUNCTION g_list_sort_with_data ##### -->
<para> <para>
Like g_list_sort(), but the comparison function accepts a user data argument.
</para> </para>
@list: a #GList. @list:
@compare_func: comparison function. @compare_func:
@user_data: user data to pass to comparison function. @user_data:
@Returns: the new head of @list. @Returns:
<!-- ##### USER_FUNCTION GCompareDataFunc ##### --> <!-- ##### USER_FUNCTION GCompareDataFunc ##### -->
@@ -367,24 +296,22 @@ if @a > @b.
<!-- ##### FUNCTION g_list_concat ##### --> <!-- ##### FUNCTION g_list_concat ##### -->
<para> <para>
Adds the second #GList onto the end of the first #GList.
Note that the elements of the second #GList are not copied.
They are used directly.
</para> </para>
@list1: a #GList. @list1:
@list2: the #GList to add to the end of the first #GList. @list2:
@Returns: the start of the new #GList. @Returns:
<!-- ##### FUNCTION g_list_foreach ##### --> <!-- ##### FUNCTION g_list_foreach ##### -->
<para> <para>
Calls a function for each element of a #GList.
</para> </para>
@list: a #GList. @list:
@func: the function to call with each element's data. @func:
@user_data: user data to pass to the function. @user_data:
<!-- ##### USER_FUNCTION GFunc ##### --> <!-- ##### USER_FUNCTION GFunc ##### -->
@@ -399,21 +326,20 @@ g_slist_foreach().
<!-- ##### FUNCTION g_list_first ##### --> <!-- ##### FUNCTION g_list_first ##### -->
<para> <para>
Gets the first element in a #GList.
</para> </para>
@list: a #GList. @list:
@Returns: the first element in a #GList, or %NULL if the #GList has no elements. @Returns:
<!-- ##### FUNCTION g_list_last ##### --> <!-- ##### FUNCTION g_list_last ##### -->
<para> <para>
Gets the last element in a #GList.
</para> </para>
@list: a #GList. @list:
@Returns: the last element in the #GList, or %NULL if the #GList has no @Returns:
elements.
<!-- ##### MACRO g_list_previous ##### --> <!-- ##### MACRO g_list_previous ##### -->
@@ -436,82 +362,73 @@ A convenience macro to gets the next element in a #GList.
<!-- ##### FUNCTION g_list_nth ##### --> <!-- ##### FUNCTION g_list_nth ##### -->
<para> <para>
Gets the element at the given position in a #GList.
</para> </para>
@list: a #GList. @list:
@n: the position of the element, counting from 0. @n:
@Returns: the element, or %NULL if the position is off the end of the #GList. @Returns:
<!-- ##### FUNCTION g_list_nth_data ##### --> <!-- ##### FUNCTION g_list_nth_data ##### -->
<para> <para>
Gets the data of the element at the given position.
</para> </para>
@list: a #GList. @list:
@n: the position of the element. @n:
@Returns: the element's data, or %NULL if the position is off the end of the @Returns:
#GList.
<!-- ##### FUNCTION g_list_nth_prev ##### --> <!-- ##### FUNCTION g_list_nth_prev ##### -->
<para> <para>
Gets the element @n places before @list.
</para> </para>
@list: a #GList. @list:
@n: the position of the element, counting from 0. @n:
@Returns: the element, or %NULL if the position is off the end of the #GList. @Returns:
<!-- ##### FUNCTION g_list_find ##### -->
<para> <para>
Finds the element in a #GList which contains the given data.
</para> </para>
@list: a #GList. @list:
@data: the element data to find. @data:
@Returns: the found #GList element, or %NULL if it is not found. @Returns:
<!-- ##### FUNCTION g_list_find_custom ##### --> <!-- ##### FUNCTION g_list_find_custom ##### -->
<para> <para>
Finds an element in a #GList, using a supplied function to find the desired
element.
It iterates over the list, calling the given function which should return 0
when the desired element is found.
The function takes two #gconstpointer arguments, the #GList element's data as
the first argument and the given user data.
</para> </para>
@list: a #GList. @list:
@data: user data passed to the function. @data:
@func: the function to call for each element. It should return 0 when the @func:
desired element is found. @Returns:
@Returns: the found #GList element, or %NULL if it is not found.
<!-- ##### FUNCTION g_list_position ##### --> <!-- ##### FUNCTION g_list_position ##### -->
<para> <para>
Gets the position of the given element in the #GList (starting from 0).
</para> </para>
@list: a #GList. @list:
@llink: an element in the #GList. @llink:
@Returns: the position of the element in the #GList, or -1 if the element is @Returns:
not found.
<!-- ##### FUNCTION g_list_index ##### --> <!-- ##### FUNCTION g_list_index ##### -->
<para> <para>
Gets the position of the element containing the given data (starting from 0).
</para> </para>
@list: a #GList. @list:
@data: the data to find. @data:
@Returns: the index of the element containing the data, or -1 if the data @Returns:
is not found.
<!-- ##### FUNCTION g_list_push_allocator ##### --> <!-- ##### FUNCTION g_list_push_allocator ##### -->

283
docs/reference/glib/tmpl/linked_lists_single.sgml
View File

@@ -90,162 +90,111 @@ g_slist_insert_sorted() functions and so is rarely used on its own.
<!-- ##### FUNCTION g_slist_append ##### --> <!-- ##### FUNCTION g_slist_append ##### -->
<para> <para>
Adds a new element on to the end of the list.
</para>
<note>
<para>
The return value is the new start of the list, which may have changed, so
make sure you store the new value.
</para>
</note>
<note>
<para>
Note that g_slist_append() has to traverse the entire list to find the end,
which is inefficient when adding multiple elements. A common idiom to
avoid the inefficiency is to prepend the elements and reverse the list
when all elements have been added.
</para>
</note>
<informalexample><programlisting>
/* Notice that these are initialized to the empty list. */
GSList *list = NULL, *number_list = NULL;
/* This is a list of strings. */ </para>
list = g_slist_append (list, "first");
list = g_slist_append (list, "second");
/* This is a list of integers. */ @list:
number_list = g_slist_append (number_list, GINT_TO_POINTER (27)); @data:
number_list = g_slist_append (number_list, GINT_TO_POINTER (14)); @Returns:
</programlisting></informalexample>
@list: a #GSList.
@data: the data for the new element.
@Returns: the new start of the #GSList.
<!-- ##### FUNCTION g_slist_prepend ##### --> <!-- ##### FUNCTION g_slist_prepend ##### -->
<para> <para>
Adds a new element on to the start of the list.
</para>
<note>
<para>
The return value is the new start of the list, which may have changed, so
make sure you store the new value.
</para>
</note>
<informalexample><programlisting>
/* Notice that it is initialized to the empty list. */
GSList *list = NULL;
list = g_slist_prepend (list, "last");
list = g_slist_prepend (list, "first");
</programlisting></informalexample>
@list: a #GSList. </para>
@data: the data for the new element.
@Returns: the new start of the #GSList. @list:
@data:
@Returns:
<!-- ##### FUNCTION g_slist_insert ##### --> <!-- ##### FUNCTION g_slist_insert ##### -->
<para> <para>
Inserts a new element into the list at the given position.
</para> </para>
@list: a #GSList. @list:
@data: the data for the new element. @data:
@position: the position to insert the element. If this is negative, or is @position:
larger than the number of elements in the list, the new element is added on @Returns:
to the end of the list.
@Returns: the new start of the #GSList.
<!-- ##### FUNCTION g_slist_insert_before ##### --> <!-- ##### FUNCTION g_slist_insert_before ##### -->
<para> <para>
Inserts a node before @sibling containing @data. Returns the new head of the list.
</para> </para>
@slist: a #GSList. @slist:
@sibling: node to insert @data before. @sibling:
@data: data to put in the newly-inserted node. @data:
@Returns: new head of the list. @Returns:
<!-- ##### FUNCTION g_slist_insert_sorted ##### --> <!-- ##### FUNCTION g_slist_insert_sorted ##### -->
<para> <para>
Inserts a new element into the list, using the given comparison function
to determine its position.
</para> </para>
@list: a #GSList. @list:
@data: the data for the new element. @data:
@func: the function to compare elements in the list. It should return a @func:
number > 0 if the first parameter comes after the second parameter in @Returns:
the sort order.
@Returns: the new start of the #GSList.
<!-- ##### FUNCTION g_slist_remove ##### --> <!-- ##### FUNCTION g_slist_remove ##### -->
<para> <para>
Removes an element from a #GSList.
If two elements contain the same data, only the first is removed.
If none of the elements contain the data, the #GSList is unchanged.
</para> </para>
@list: a #GSList.
@data: the data of the element to remove. @data:
@Returns: the new start of the #GSList. @Returns:
<!-- ##### FUNCTION g_slist_remove_link ##### --> <!-- ##### FUNCTION g_slist_remove_link ##### -->
<para> <para>
Removes an element from a #GSList, without freeing the element.
The removed element's next link is set to %NULL, so that it becomes a
self-contained list with one element.
</para> </para>
@list: a #GSList. @list:
@link_: an element in the #GSList. @link_:
@Returns: the new start of the #GSList, without the element. @Returns:
<!-- ##### FUNCTION g_slist_delete_link ##### --> <!-- ##### FUNCTION g_slist_delete_link ##### -->
<para> <para>
Deletes a node of @list. Returns the new list head.
</para> </para>
@list: a #GSList. @list:
@link_: node to delete. @link_:
@Returns: new head of @list. @Returns:
<!-- ##### FUNCTION g_slist_remove_all ##### --> <!-- ##### FUNCTION g_slist_remove_all ##### -->
<para> <para>
Removes all list nodes with data equal to @data. Returns the new
head of the list. Contrast with g_slist_remove() which removes only
the first node matching the given data.
</para> </para>
@list: a #GSList. @list:
@data: data to remove. @data:
@Returns: new head of @list. @Returns:
<!-- ##### FUNCTION g_slist_free ##### --> <!-- ##### FUNCTION g_slist_free ##### -->
<para> <para>
Frees all of the memory used by a #GSList.
The freed elements are returned to the slice allocator.
</para> </para>
@list: a #GSList. @list:
<!-- ##### FUNCTION g_slist_free_1 ##### --> <!-- ##### FUNCTION g_slist_free_1 ##### -->
<para> <para>
Frees one #GSList element.
It is usually used after g_slist_remove_link().
</para> </para>
@list: a #GSList element. @list:
<!-- ##### MACRO g_slist_free1 ##### --> <!-- ##### MACRO g_slist_free1 ##### -->
@@ -258,106 +207,91 @@ A macro which does the same as g_slist_free_1().
<!-- ##### FUNCTION g_slist_length ##### --> <!-- ##### FUNCTION g_slist_length ##### -->
<para> <para>
Gets the number of elements in a #GSList.
</para> </para>
@list: a #GSList. @list:
@Returns: the number of elements in the #GSList. @Returns:
<!-- ##### FUNCTION g_slist_copy ##### --> <!-- ##### FUNCTION g_slist_copy ##### -->
<para> <para>
Copies a #GSList.
</para>
<para>
Note that this is a "shallow" copy. If the list elements consist of pointers
to data, the pointers are copied but the actual data isn't.
</para> </para>
@list: a #GSList. @list:
@Returns: a copy of @list. @Returns:
<!-- ##### FUNCTION g_slist_reverse ##### --> <!-- ##### FUNCTION g_slist_reverse ##### -->
<para> <para>
Reverses a #GSList.
</para> </para>
@list: a #GSList. @list:
@Returns: the start of the reversed #GSList. @Returns:
<!-- ##### FUNCTION g_slist_insert_sorted_with_data ##### --> <!-- ##### FUNCTION g_slist_insert_sorted_with_data ##### -->
<para> <para>
Inserts a new element into the list, using the given comparison function
to determine its position.
</para> </para>
@list: a #GSList. @list:
@data: the data for the new element. @data:
@func: the function to compare elements in the list. It should return a @func:
number > 0 if the first parameter comes after the second parameter in @user_data:
the sort order. @Returns:
@user_data: data to pass to comparison function.
@Returns: the new start of the #GSList.
@Since 2.10
<!-- ##### FUNCTION g_slist_sort ##### --> <!-- ##### FUNCTION g_slist_sort ##### -->
<para> <para>
Sorts a #GSList using the given comparison function.
</para> </para>
@list: a #GSList. @list:
@compare_func: the comparison function used to sort the #GSList. @compare_func:
This function is passed the data from 2 elements of the #GSList and should @Returns:
return 0 if they are equal, a negative value if the first element
comes before the second, or a positive value if the first element
comes after the second.
@Returns: the start of the sorted #GSList.
<!-- ##### FUNCTION g_slist_sort_with_data ##### --> <!-- ##### FUNCTION g_slist_sort_with_data ##### -->
<para> <para>
Like g_slist_sort(), but the sort function accepts a user data argument.
</para> </para>
@list: a #GSList @list:
@compare_func: comparison function. @compare_func:
@user_data: data to pass to comparison function. @user_data:
@Returns: new head of the list. @Returns:
<!-- ##### FUNCTION g_slist_concat ##### --> <!-- ##### FUNCTION g_slist_concat ##### -->
<para> <para>
Adds the second #GSList onto the end of the first #GSList.
Note that the elements of the second #GSList are not copied.
They are used directly.
</para> </para>
@list1: a #GSList. @list1:
@list2: the #GSList to add to the end of the first #GSList. @list2:
@Returns: the start of the new #GSList. @Returns:
<!-- ##### FUNCTION g_slist_foreach ##### --> <!-- ##### FUNCTION g_slist_foreach ##### -->
<para> <para>
Calls a function for each element of a #GSList.
</para> </para>
@list: a #GSList. @list:
@func: the function to call with each element's data. @func:
@user_data: user data to pass to the function. @user_data:
<!-- ##### FUNCTION g_slist_last ##### --> <!-- ##### FUNCTION g_slist_last ##### -->
<para> <para>
Gets the last element in a #GSList.
</para> </para>
@list: a #GSList. @list:
@Returns: the last element in the #GSList, or %NULL if the #GSList has no @Returns:
elements.
<!-- ##### MACRO g_slist_next ##### --> <!-- ##### MACRO g_slist_next ##### -->
@@ -371,72 +305,63 @@ A convenience macro to gets the next element in a #GSList.
<!-- ##### FUNCTION g_slist_nth ##### --> <!-- ##### FUNCTION g_slist_nth ##### -->
<para> <para>
Gets the element at the given position in a #GSList.
</para> </para>
@list: a #GSList. @list:
@n: the position of the element, counting from 0. @n:
@Returns: the element, or %NULL if the position is off the end of the #GSList. @Returns:
<!-- ##### FUNCTION g_slist_nth_data ##### --> <!-- ##### FUNCTION g_slist_nth_data ##### -->
<para> <para>
Gets the data of the element at the given position.
</para> </para>
@list: a #GSList. @list:
@n: the position of the element. @n:
@Returns: the element's data, or %NULL if the position is off the end of the @Returns:
#GSList.
<!-- ##### FUNCTION g_slist_find ##### --> <!-- ##### FUNCTION g_slist_find ##### -->
<para> <para>
Finds the element in a #GSList which contains the given data.
</para> </para>
@list: a #GSList. @list:
@data: the element data to find. @data:
@Returns: the found #GSList element, or %NULL if it is not found. @Returns:
<!-- ##### FUNCTION g_slist_find_custom ##### --> <!-- ##### FUNCTION g_slist_find_custom ##### -->
<para> <para>
Finds an element in a #GSList, using a supplied function to find the desired
element.
It iterates over the list, calling the given function which should return 0
when the desired element is found.
The function takes two #gconstpointer arguments, the #GSList element's data as
the first argument and the given user data.
</para> </para>
@list: a #GSList. @list:
@data: user data passed to the function. @data:
@func: the function to call for each element. It should return 0 when the @func:
desired element is found. @Returns:
@Returns: the found #GSList element, or %NULL if it is not found.
<!-- ##### FUNCTION g_slist_position ##### --> <!-- ##### FUNCTION g_slist_position ##### -->
<para> <para>
Gets the position of the given element in the #GSList (starting from 0).
</para> </para>
@list: a #GSList. @list:
@llink: an element in the #GSList. @llink:
@Returns: the position of the element in the #GSList, or -1 if the element @Returns:
is not found.
<!-- ##### FUNCTION g_slist_index ##### --> <!-- ##### FUNCTION g_slist_index ##### -->
<para> <para>
Gets the position of the element containing the given data (starting from 0).
</para> </para>
@list: a #GSList. @list:
@data: the data to find. @data:
@Returns: the index of the element containing the data, or -1 if the data @Returns:
is not found.
<!-- ##### FUNCTION g_slist_push_allocator ##### --> <!-- ##### FUNCTION g_slist_push_allocator ##### -->