glib r6656 - in trunk/docs/reference: . glib/tmpl

[matthiasc svn gnome org]

Author: matthiasc
Date: Mon Mar 10 16:47:58 2008
New Revision: 6656
URL: http://svn.gnome.org/viewvc/glib?rev=6656&view=rev

Log:
Remove inlined docs


Modified:
   trunk/docs/reference/ChangeLog
   trunk/docs/reference/glib/tmpl/linked_lists_double.sgml
   trunk/docs/reference/glib/tmpl/linked_lists_single.sgml

Modified: trunk/docs/reference/glib/tmpl/linked_lists_double.sgml
==============================================================================
--- trunk/docs/reference/glib/tmpl/linked_lists_double.sgml	(original)
+++ trunk/docs/reference/glib/tmpl/linked_lists_double.sgml	Mon Mar 10 16:47:58 2008
@@ -81,160 +81,103 @@
 
 <!-- ##### FUNCTION g_list_append ##### -->
 <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. */
-  list = g_list_append (list, "first");
-  list = g_list_append (list, "second");
-
-  /* This is a list of integers. */
-  number_list = g_list_append (number_list, GINT_TO_POINTER (27));
-  number_list = g_list_append (number_list, GINT_TO_POINTER (14));
-</programlisting></informalexample>
-
- list: a pointer to a #GList.
- data: the data for the new element.
- Returns: the new start of the #GList.
+
+ list:
+ data:
+ Returns:
 
 
 <!-- ##### FUNCTION g_list_prepend ##### -->
 <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.
- data: the data for the new element.
- Returns: the new start of the #GList.
+
+ list: 
+ data: 
+ Returns:
 
 
 <!-- ##### FUNCTION g_list_insert ##### -->
 <para>
-Inserts a new element into the list at the given position.
+
 </para>
 
- list: a pointer to a #GList.
- data: the data for the new element.
- position: the position to insert the element. If this is negative, or is
-larger than the number of elements in the list, the new element is added on
-to the end of the list.
- Returns: the new start of the #GList.
+ list: 
+ data: 
+ position: 
+ Returns: 
 
 
 <!-- ##### FUNCTION g_list_insert_before ##### -->
 <para>
-Inserts a new element into the list before the given position.
+
 </para>
 
- list: a pointer to a #GList.
- sibling: the list element before which the new element is inserted
-  or %NULL to insert at the end of the list.
- data: the data for the new element.
- Returns: the new start of the #GList.
+ list: 
+ sibling: 
+ data: 
+ Returns:
 
 
 <!-- ##### FUNCTION g_list_insert_sorted ##### -->
 <para>
-Inserts a new element into the list, using the given comparison function
-to determine its position.
+
 </para>
 
- list: a pointer to a #GList.
- data: the data for the new element.
- func: the function to compare elements in the list. It should return a
-number > 0 if the first parameter comes after the second parameter in
-the sort order.
- Returns: the new start of the #GList.
+ list: 
+ data: 
+ func: 
+ Returns: 
 
 
 <!-- ##### FUNCTION g_list_remove ##### -->
 <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>
 
- list: a #GList.
- data: the data of the element to remove.
- Returns: the new start of the #GList.
+ list:
+ data:
+ Returns:
 
 
 <!-- ##### FUNCTION g_list_remove_link ##### -->
 <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>
 
- list: a #GList.
- llink: an element in the #GList.
- Returns: the new start of the #GList, without the element.
+ list:
+ llink:
+ Returns:
 
 
 <!-- ##### FUNCTION g_list_delete_link ##### -->
 <para>
-Deletes the node @link_ from @list.
+
 </para>
 
- list: a #GList.
- link_: node to delete from @list.
- Returns: the new head of @list.
+ list: 
+ link_: 
+ Returns:
 
 
 <!-- ##### FUNCTION g_list_remove_all ##### -->
 <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>
 
- list: a #GList.
- data: data to remove.
- Returns: new head of @list.
+ list: 
+ data: 
+ Returns: 
 
 
 <!-- ##### FUNCTION g_list_free ##### -->
 <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.
+ list: 
 
 
 <!-- ##### FUNCTION g_list_alloc ##### -->
@@ -249,11 +192,10 @@
 
 <!-- ##### FUNCTION g_list_free_1 ##### -->
 <para>
-Frees one #GList element.
-It is usually used after g_list_remove_link().
+
 </para>
 
- list: a #GList element.
+ list: 
 
 
 <!-- ##### MACRO g_list_free1 ##### -->
@@ -265,48 +207,39 @@
 
 <!-- ##### FUNCTION g_list_length ##### -->
 <para>
-Gets the number of elements in a #GList.
+
 </para>
 
- list: a #GList.
- Returns: the number of elements in the #GList.
+ list: 
+ Returns: 
 
 
 <!-- ##### FUNCTION g_list_copy ##### -->
 <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>
 
- list: a #GList.
- Returns: a copy of @list.
+ list: 
+ Returns:
 
 
 <!-- ##### FUNCTION g_list_reverse ##### -->
 <para>
-Reverses a #GList.
-It simply switches the next and prev pointers of each element.
+
 </para>
 
- list: a #GList.
- Returns: the start of the reversed #GList.
+ list: 
+ Returns: 
 
 
 <!-- ##### FUNCTION g_list_sort ##### -->
 <para>
-Sorts a #GList using the given comparison function.
+
 </para>
 
- list: a #GList.
- compare_func: the comparison function used to sort the #GList. 
-This function is passed the data from 2 elements of the #GList and should 
-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.
+ list: 
+ compare_func: 
+ Returns: 
 
 
 <!-- ##### USER_FUNCTION GCompareFunc ##### -->
@@ -325,29 +258,25 @@
 
 <!-- ##### FUNCTION g_list_insert_sorted_with_data ##### -->
 <para>
-Inserts a new element into the list, using the given comparison function
-to determine its position.
+
 </para>
 
- list: a pointer to a #GList.
- data: the data for the new element.
- func: the function to compare elements in the list. It should return a
-number > 0 if the first parameter comes after the second parameter in
-the sort order.
- user_data: user data to pass to comparison function.
- Returns: the new start of the #GList.
- Since 2.10
+ list:
+ data:
+ func: 
+ user_data: 
+ Returns: 
 
 
 <!-- ##### FUNCTION g_list_sort_with_data ##### -->
 <para>
-Like g_list_sort(), but the comparison function accepts a user data argument.
+
 </para>
 
- list: a #GList.
- compare_func: comparison function.
- user_data: user data to pass to comparison function.
- Returns: the new head of @list.
+ list:
+ compare_func:
+ user_data: 
+ Returns: 
 
 
 <!-- ##### USER_FUNCTION GCompareDataFunc ##### -->
@@ -367,24 +296,22 @@
 
 <!-- ##### FUNCTION g_list_concat ##### -->
 <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>
 
- list1: a #GList.
- list2: the #GList to add to the end of the first #GList.
- Returns: the start of the new #GList.
+ list1:
+ list2:
+ Returns:
 
 
 <!-- ##### FUNCTION g_list_foreach ##### -->
 <para>
-Calls a function for each element of a #GList.
+
 </para>
 
- list: a #GList.
- func: the function to call with each element's data.
- user_data: user data to pass to the function.
+ list:
+ func:
+ user_data: 
 
 
 <!-- ##### USER_FUNCTION GFunc ##### -->
@@ -399,21 +326,20 @@
 
 <!-- ##### FUNCTION g_list_first ##### -->
 <para>
-Gets the first element in a #GList.
+
 </para>
 
- list: a #GList.
- Returns: the first element in a #GList, or %NULL if the #GList has no elements.
+ list: 
+ Returns:
 
 
 <!-- ##### FUNCTION g_list_last ##### -->
 <para>
-Gets the last element in a #GList.
+
 </para>
 
- list: a #GList.
- Returns: the last element in the #GList, or %NULL if the #GList has no
-elements.
+ list: 
+ Returns: 
 
 
 <!-- ##### MACRO g_list_previous ##### -->
@@ -436,82 +362,73 @@
 
 <!-- ##### FUNCTION g_list_nth ##### -->
 <para>
-Gets the element at the given position in a #GList.
+
 </para>
 
- list: a #GList.
- n: the position of the element, counting from 0.
- Returns: the element, or %NULL if the position is off the end of the #GList.
+ list: 
+ n: 
+ Returns:
 
 
 <!-- ##### FUNCTION g_list_nth_data ##### -->
 <para>
-Gets the data of the element at the given position.
+
 </para>
 
- list: a #GList.
- n: the position of the element.
- Returns: the element's data, or %NULL if the position is off the end of the
-#GList.
+ list: 
+ n: 
+ Returns: 
 
 
 <!-- ##### FUNCTION g_list_nth_prev ##### -->
 <para>
-Gets the element @n places before @list.
+
 </para>
 
- list: a #GList.
- n: the position of the element, counting from 0.
- Returns: the element, or %NULL if the position is off the end of the #GList.
+ list: 
+ n: 
+ Returns:
+
 
 
-<!-- ##### FUNCTION g_list_find ##### -->
 <para>
-Finds the element in a #GList which contains the given data.
+
 </para>
 
- list: a #GList.
- data: the element data to find.
- Returns: the found #GList element, or %NULL if it is not found.
+ list:
+ data:
+ Returns: 
 
 
 <!-- ##### FUNCTION g_list_find_custom ##### -->
 <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>
 
- list: a #GList.
- data: user data passed to the function.
- func: the function to call for each element. It should return 0 when the
-desired element is found.
- Returns: the found #GList element, or %NULL if it is not found.
+ list: 
+ data: 
+ func: 
+ Returns: 
 
 
 <!-- ##### FUNCTION g_list_position ##### -->
 <para>
-Gets the position of the given element in the #GList (starting from 0).
+
 </para>
 
- list: a #GList.
- llink: an element in the #GList.
- Returns: the position of the element in the #GList, or -1 if the element is
-not found.
+ list:
+ llink: 
+ Returns:
 
 
 <!-- ##### FUNCTION g_list_index ##### -->
 <para>
-Gets the position of the element containing the given data (starting from 0).
+
 </para>
 
- list: a #GList.
- data: the data to find.
- Returns: the index of the element containing the data, or -1 if the data
-is not found.
+ list: 
+ data: 
+ Returns: 
 
 
 <!-- ##### FUNCTION g_list_push_allocator ##### -->

Modified: trunk/docs/reference/glib/tmpl/linked_lists_single.sgml
==============================================================================
--- trunk/docs/reference/glib/tmpl/linked_lists_single.sgml	(original)
+++ trunk/docs/reference/glib/tmpl/linked_lists_single.sgml	Mon Mar 10 16:47:58 2008
@@ -90,162 +90,111 @@
 
 <!-- ##### FUNCTION g_slist_append ##### -->
 <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. */
-  list = g_slist_append (list, "first");
-  list = g_slist_append (list, "second");
-
-  /* This is a list of integers. */
-  number_list = g_slist_append (number_list, GINT_TO_POINTER (27));
-  number_list = g_slist_append (number_list, GINT_TO_POINTER (14));
-</programlisting></informalexample>
-
- list: a #GSList.
- data: the data for the new element.
- Returns: the new start of the #GSList.
+
+ list: 
+ data:
+ Returns: 
 
 
 <!-- ##### FUNCTION g_slist_prepend ##### -->
 <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.
- data: the data for the new element.
- Returns: the new start of the #GSList.
+
+ list: 
+ data:
+ Returns:
 
 
 <!-- ##### FUNCTION g_slist_insert ##### -->
 <para>
-Inserts a new element into the list at the given position.
+
 </para>
 
- list: a #GSList.
- data: the data for the new element.
- position: the position to insert the element. If this is negative, or is
-larger than the number of elements in the list, the new element is added on
-to the end of the list.
- Returns: the new start of the #GSList.
+ list:
+ data:
+ position:
+ Returns: 
 
 
 <!-- ##### FUNCTION g_slist_insert_before ##### -->
 <para>
-Inserts a node before @sibling containing @data. Returns the new head of the list.
+
 </para>
 
- slist: a #GSList.
- sibling: node to insert @data before.
- data: data to put in the newly-inserted node.
- Returns: new head of the list.
+ slist:
+ sibling:
+ data: 
+ Returns: 
 
 
 <!-- ##### FUNCTION g_slist_insert_sorted ##### -->
 <para>
-Inserts a new element into the list, using the given comparison function
-to determine its position.
+
 </para>
 
- list: a #GSList.
- data: the data for the new element.
- func: the function to compare elements in the list. It should return a
-number > 0 if the first parameter comes after the second parameter in
-the sort order.
- Returns: the new start of the #GSList.
+ list:
+ data:
+ func:
+ Returns: 
 
 
 <!-- ##### FUNCTION g_slist_remove ##### -->
 <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>
 
- list: a #GSList.
- data: the data of the element to remove.
- Returns: the new start of the #GSList.
+
+ data:
+ Returns:
 
 
 <!-- ##### FUNCTION g_slist_remove_link ##### -->
 <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>
 
- list: a #GSList.
- link_: an element in the #GSList.
- Returns: the new start of the #GSList, without the element.
+ list:
+ link_:
+ Returns:
 
 
 <!-- ##### FUNCTION g_slist_delete_link ##### -->
 <para>
-Deletes a node of @list. Returns the new list head.
+
 </para>
 
- list: a #GSList.
- link_: node to delete.
- Returns: new head of @list.
+ list: 
+ link_:
+ Returns:
 
 
 <!-- ##### FUNCTION g_slist_remove_all ##### -->
 <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>
 
- list: a #GSList.
- data: data to remove.
- Returns: new head of @list.
+ list: 
+ data: 
+ Returns:
 
 
 <!-- ##### FUNCTION g_slist_free ##### -->
 <para>
-Frees all of the memory used by a #GSList.
-The freed elements are returned to the slice allocator.
+
 </para>
 
- list: a #GSList.
+ list: 
 
 
 <!-- ##### FUNCTION g_slist_free_1 ##### -->
 <para>
-Frees one #GSList element.
-It is usually used after g_slist_remove_link().
+
 </para>
 
- list: a #GSList element.
+ list: 
 
 
 <!-- ##### MACRO g_slist_free1 ##### -->
@@ -258,106 +207,91 @@
 
 <!-- ##### FUNCTION g_slist_length ##### -->
 <para>
-Gets the number of elements in a #GSList.
+
 </para>
 
- list: a #GSList.
- Returns: the number of elements in the #GSList.
+ list:
+ Returns: 
 
 
 <!-- ##### FUNCTION g_slist_copy ##### -->
 <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>
 
- list: a #GSList.
- Returns: a copy of @list.
+ list:
+ Returns:
 
 
 <!-- ##### FUNCTION g_slist_reverse ##### -->
 <para>
-Reverses a #GSList.
+
 </para>
 
- list: a #GSList.
- Returns: the start of the reversed #GSList.
+ list: 
+ Returns: 
 
 
 <!-- ##### FUNCTION g_slist_insert_sorted_with_data ##### -->
 <para>
-Inserts a new element into the list, using the given comparison function
-to determine its position.
+
 </para>
 
- list: a #GSList.
- data: the data for the new element.
- func: the function to compare elements in the list. It should return a
-number > 0 if the first parameter comes after the second parameter in
-the sort order.
- user_data: data to pass to comparison function.
- Returns: the new start of the #GSList.
- Since 2.10
+ list: 
+ data: 
+ func: 
+ user_data: 
+ Returns: 
 
 
 <!-- ##### FUNCTION g_slist_sort ##### -->
 <para>
-Sorts a #GSList using the given comparison function.
+
 </para>
 
- list: a #GSList.
- compare_func: the comparison function used to sort the #GSList. 
-This function is passed the data from 2 elements of the #GSList and should 
-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.
+ list: 
+ compare_func: 
+ Returns:
 
 
 <!-- ##### FUNCTION g_slist_sort_with_data ##### -->
 <para>
-Like g_slist_sort(), but the sort function accepts a user data argument.
+
 </para>
 
- list: a #GSList
- compare_func: comparison function.
- user_data: data to pass to comparison function.
- Returns: new head of the list.
+ list: 
+ compare_func: 
+ user_data: 
+ Returns: 
 
 
 <!-- ##### FUNCTION g_slist_concat ##### -->
 <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>
 
- list1: a #GSList.
- list2: the #GSList to add to the end of the first #GSList.
- Returns: the start of the new #GSList.
+ list1:
+ list2:
+ Returns:
 
 
 <!-- ##### FUNCTION g_slist_foreach ##### -->
 <para>
-Calls a function for each element of a #GSList.
+
 </para>
 
- list: a #GSList.
- func: the function to call with each element's data.
- user_data: user data to pass to the function.
+ list: 
+ func: 
+ user_data:
 
 
 <!-- ##### FUNCTION g_slist_last ##### -->
 <para>
-Gets the last element in a #GSList.
+
 </para>
 
- list: a #GSList.
- Returns: the last element in the #GSList, or %NULL if the #GSList has no
-elements.
+ list: 
+ Returns: 
 
 
 <!-- ##### MACRO g_slist_next ##### -->
@@ -371,72 +305,63 @@
 
 <!-- ##### FUNCTION g_slist_nth ##### -->
 <para>
-Gets the element at the given position in a #GSList.
+
 </para>
 
- list: a #GSList.
- n: the position of the element, counting from 0.
- Returns: the element, or %NULL if the position is off the end of the #GSList.
+ list:
+ n: 
+ Returns: 
 
 
 <!-- ##### FUNCTION g_slist_nth_data ##### -->
 <para>
-Gets the data of the element at the given position.
+
 </para>
 
- list: a #GSList.
- n: the position of the element.
- Returns: the element's data, or %NULL if the position is off the end of the
-#GSList.
+ list:
+ n: 
+ Returns:
 
 
 <!-- ##### FUNCTION g_slist_find ##### -->
 <para>
-Finds the element in a #GSList which contains the given data.
+
 </para>
 
- list: a #GSList.
- data: the element data to find.
- Returns: the found #GSList element, or %NULL if it is not found.
+ list:
+ data:
+ Returns:
 
 
 <!-- ##### FUNCTION g_slist_find_custom ##### -->
 <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>
 
- list: a #GSList.
- data: user data passed to the function.
- func: the function to call for each element. It should return 0 when the
-desired element is found.
- Returns: the found #GSList element, or %NULL if it is not found.
+ list:
+ data:
+ func:
+ Returns:
 
 
 <!-- ##### FUNCTION g_slist_position ##### -->
 <para>
-Gets the position of the given element in the #GSList (starting from 0).
+
 </para>
 
- list: a #GSList.
- llink: an element in the #GSList.
- Returns: the position of the element in the #GSList, or -1 if the element
-is not found.
+ list:
+ llink:
+ Returns:
 
 
 <!-- ##### FUNCTION g_slist_index ##### -->
 <para>
-Gets the position of the element containing the given data (starting from 0).
+
 </para>
 
- list: a #GSList.
- data: the data to find.
- Returns: the index of the element containing the data, or -1 if the data
-is not found.
+ list:
+ data:
+ Returns:
 
 
 <!-- ##### FUNCTION g_slist_push_allocator ##### -->