From: Ryan Lortie Date: Sun, 31 Jan 2010 18:07:16 +0000 (-0500) Subject: GList, GSList: move docs from tmpl to .c X-Git-Tag: 2.23.3~41 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=501a2906d3208440a74bebe8736ea39b3f5b5947;p=platform%2Fupstream%2Fglib.git GList, GSList: move docs from tmpl to .c --- diff --git a/docs/reference/glib/tmpl/.gitignore b/docs/reference/glib/tmpl/.gitignore index 03e35ab..a642deb 100644 --- a/docs/reference/glib/tmpl/.gitignore +++ b/docs/reference/glib/tmpl/.gitignore @@ -10,6 +10,8 @@ gurifuncs.sgml gvarianttype.sgml hash_tables.sgml iochannels.sgml +linked_lists_double.sgml +linked_lists_single.sgml memory_chunks.sgml option.sgml patterns.sgml diff --git a/docs/reference/glib/tmpl/linked_lists_double.sgml b/docs/reference/glib/tmpl/linked_lists_double.sgml deleted file mode 100644 index ce96528..0000000 --- a/docs/reference/glib/tmpl/linked_lists_double.sgml +++ /dev/null @@ -1,467 +0,0 @@ - -Doubly-Linked Lists - - -linked lists containing integer values or pointers to data, with the ability -to iterate over the list in both directions - - - -The #GList structure and its associated functions provide a standard -doubly-linked list data structure. - - -Each element in the list contains a piece of data, together with pointers -which link to the previous and next elements in the list. -Using these pointers it is possible to move through the list in both -directions (unlike the -Singly-Linked Lists -which only allows movement through the list in the forward direction). - - -The data contained in each element can be either integer values, by using one -of the -Type Conversion Macros, -or simply pointers to any type of data. - - -List elements are allocated from the slice -allocator, which is more efficient than allocating elements -individually. - - -Note that most of the #GList functions expect to be passed a pointer to -the first element in the list. The functions which insert elements return -the new start of the list, which may have changed. - - -There is no function to create a #GList. %NULL is considered to be the empty -list so you simply set a #GList* to %NULL. - - -To add elements, use g_list_append(), g_list_prepend(), g_list_insert() -and g_list_insert_sorted(). - - -To remove elements, use g_list_remove(). - - -To find elements in the list use g_list_first(), g_list_last(), g_list_next(), -g_list_previous(), g_list_nth(), g_list_nth_data(), g_list_find() and -g_list_find_custom(). - - -To find the index of an element use g_list_position() and g_list_index(). - - -To call a function for each element in the list use g_list_foreach(). - - -To free the entire list, use g_list_free(). - - - - - - - - - - - - -The #GList struct is used for each element in a doubly-linked list. - - -@data: holds the element's data, which can be a pointer to any kind of data, - or any integer value using the - Type Conversion Macros. -@next: contains the link to the next element in the list. -@prev: contains the link to the previous element in the list. - - - - - - -@list: -@data: -@Returns: - - - - - - - -@list: -@data: -@Returns: - - - - - - - -@list: -@data: -@position: -@Returns: - - - - - - - -@list: -@sibling: -@data: -@Returns: - - - - - - - -@list: -@data: -@func: -@Returns: - - - - - - - -@list: -@data: -@Returns: - - - - - - - -@list: -@llink: -@Returns: - - - - - - - -@list: -@link_: -@Returns: - - - - - - - -@list: -@data: -@Returns: - - - - - - - -@list: - - - - -Allocates space for one #GList element. -It is called by g_list_append(), g_list_prepend(), g_list_insert() and -g_list_insert_sorted() and so is rarely used on its own. - - -@Returns: a pointer to the newly-allocated #GList element. - - - - - - - -@list: - - - - -Another name for g_list_free_1(). - - - - - - - - - -@list: -@Returns: - - - - - - - -@list: -@Returns: - - - - - - - -@list: -@Returns: - - - - - - - -@list: -@compare_func: -@Returns: - - - - -Specifies the type of a comparison function used to compare two -values. The function should return a negative integer if the first -value comes before the second, 0 if they are equal, or a positive -integer if the first value comes after the second. - - -@a: a value. -@b: a value to compare with. -@Returns: negative value if @a < @b; zero if @a = @b; positive value -if @a > @b. - - - - - - - -@list: -@data: -@func: -@user_data: -@Returns: - - - - - - - -@list: -@compare_func: -@user_data: -@Returns: - - - - -Specifies the type of a comparison function used to compare two -values. The function should return a negative integer if the first -value comes before the second, 0 if they are equal, or a positive -integer if the first value comes after the second. - - -@a: a value. -@b: a value to compare with. -@user_data: user data to pass to comparison function. -@Returns: negative value if @a < @b; zero if @a = @b; positive value -if @a > @b. - - - - - - - -@list1: -@list2: -@Returns: - - - - - - - -@list: -@func: -@user_data: - - - - -Specifies the type of functions passed to g_list_foreach() and -g_slist_foreach(). - - -@data: the element's data. -@user_data: user data passed to g_list_foreach() or g_slist_foreach(). - - - - - - - -@list: -@Returns: - - - - - - - -@list: -@Returns: - - - - -A convenience macro to get the previous element in a #GList. - - -@list: an element in a #GList. -@Returns: the previous element, or %NULL if there are no previous elements. - - - - -A convenience macro to get the next element in a #GList. - - -@list: an element in a #GList. -@Returns: the next element, or %NULL if there are no more elements. - - - - - - - -@list: -@n: -@Returns: - - - - - - - -@list: -@n: -@Returns: - - - - - - - -@list: -@n: -@Returns: - - - - - - - - - - - - - -@list: -@data: -@Returns: - - - - - - - -@list: -@data: -@func: -@Returns: - - - - - - - -@list: -@llink: -@Returns: - - - - - - - -@list: -@data: -@Returns: - - - - -Sets the allocator to use to allocate #GList elements. -Use g_list_pop_allocator() to restore the previous allocator. - - -Note that this function is not available if GLib has been compiled -with - - -@allocator: the #GAllocator to use when allocating #GList elements. -@Deprecated: 2.10: It does nothing, since #GList has been -converted to the slice allocator - - - - -Restores the previous #GAllocator, used when allocating #GList elements. - - -Note that this function is not available if GLib has been compiled -with - - -@Deprecated: 2.10: It does nothing, since #GList has been -converted to the slice allocator - - diff --git a/docs/reference/glib/tmpl/linked_lists_single.sgml b/docs/reference/glib/tmpl/linked_lists_single.sgml deleted file mode 100644 index 5b59c46..0000000 --- a/docs/reference/glib/tmpl/linked_lists_single.sgml +++ /dev/null @@ -1,394 +0,0 @@ - -Singly-Linked Lists - - -linked lists containing integer values or pointers to data, limited to -iterating over the list in one direction - - - -The #GSList structure and its associated functions provide a standard -singly-linked list data structure. - - -Each element in the list contains a piece of data, together with a pointer -which links to the next element in the list. -Using this pointer it is possible to move through the list in one -direction only (unlike the -Doubly-Linked Lists -which allow movement in both directions). - - -The data contained in each element can be either integer values, by using one -of the -Type Conversion Macros, -or simply pointers to any type of data. - - -List elements are allocated from the slice -allocator, which is more efficient than allocating elements -individually. - - -Note that most of the #GSList functions expect to be passed a pointer to -the first element in the list. The functions which insert elements return -the new start of the list, which may have changed. - - -There is no function to create a #GSList. %NULL is considered to be the empty -list so you simply set a #GSList* to %NULL. - - -To add elements, use g_slist_append(), g_slist_prepend(), g_slist_insert() -and g_slist_insert_sorted(). - - -To remove elements, use g_slist_remove(). - - -To find elements in the list use g_slist_last(), g_slist_next(), -g_slist_nth(), g_slist_nth_data(), g_slist_find() and -g_slist_find_custom(). - - -To find the index of an element use g_slist_position() and g_slist_index(). - - -To call a function for each element in the list use g_slist_foreach(). - - -To free the entire list, use g_slist_free(). - - - - - - - - - - - - -The #GSList struct is used for each element in the singly-linked list. - - -@data: holds the element's data, which can be a pointer to any kind of data, - or any integer value using the - Type Conversion Macros. -@next: contains the link to the next element in the list. - - - -Allocates space for one #GSList element. -It is called by the g_slist_append(), g_slist_prepend(), g_slist_insert() and -g_slist_insert_sorted() functions and so is rarely used on its own. - - -@Returns: a pointer to the newly-allocated #GSList element. - - - - - - - -@list: -@data: -@Returns: - - - - - - - -@list: -@data: -@Returns: - - - - - - - -@list: -@data: -@position: -@Returns: - - - - - - - -@slist: -@sibling: -@data: -@Returns: - - - - - - - -@list: -@data: -@func: -@Returns: - - - - - - - -@list: -@data: -@Returns: - - - - - - - -@list: -@link_: -@Returns: - - - - - - - -@list: -@link_: -@Returns: - - - - - - - -@list: -@data: -@Returns: - - - - - - - -@list: - - - - - - - -@list: - - - - -A macro which does the same as g_slist_free_1(). - - -@Since: 2.10 - - - - - - - -@list: -@Returns: - - - - - - - -@list: -@Returns: - - - - - - - -@list: -@Returns: - - - - - - - -@list: -@data: -@func: -@user_data: -@Returns: - - - - - - - -@list: -@compare_func: -@Returns: - - - - - - - -@list: -@compare_func: -@user_data: -@Returns: - - - - - - - -@list1: -@list2: -@Returns: - - - - - - - -@list: -@func: -@user_data: - - - - - - - -@list: -@Returns: - - - - -A convenience macro to get the next element in a #GSList. - - -@slist: an element in a #GSList. -@Returns: the next element, or %NULL if there are no more elements. - - - - - - - -@list: -@n: -@Returns: - - - - - - - -@list: -@n: -@Returns: - - - - - - - -@list: -@data: -@Returns: - - - - - - - -@list: -@data: -@func: -@Returns: - - - - - - - -@list: -@llink: -@Returns: - - - - - - - -@list: -@data: -@Returns: - - - - -Sets the allocator to use to allocate #GSList elements. -Use g_slist_pop_allocator() to restore the previous allocator. - - -Note that this function is not available if GLib has been compiled -with - - -@dummy: the #GAllocator to use when allocating #GSList elements. -@Deprecated: 2.10: It does nothing, since #GSList has been -converted to the slice allocator - - - - -Restores the previous #GAllocator, used when allocating #GSList elements. - - -Note that this function is not available if GLib has been compiled -with - - -@Deprecated: 2.10: It does nothing, since #GSList has been -converted to the slice allocator - - diff --git a/glib/glist.c b/glib/glist.c index b607abd..252330a 100644 --- a/glib/glist.c +++ b/glib/glist.c @@ -33,14 +33,129 @@ #include "glib.h" #include "galias.h" +/** + * SECTION: linked_lists_double + * @title: Doubly-Linked Lists + * @short_description: linked lists containing integer values or + * pointers to data, with the ability to iterate + * over the list in both directions + * + * The #GList structure and its associated functions provide a standard + * doubly-linked list data structure. + * + * Each element in the list contains a piece of data, together with + * pointers which link to the previous and next elements in the list. + * Using these pointers it is possible to move through the list in both + * directions (unlike the Singly-Linked Lists which + * only allows movement through the list in the forward direction). + * + * The data contained in each element can be either integer values, by + * using one of the Type + * Conversion Macros, or simply pointers to any type of data. + * + * List elements are allocated from the slice allocator, which is more + * efficient than allocating elements individually. + * + * Note that most of the #GList functions expect to be passed a pointer + * to the first element in the list. The functions which insert + * elements return the new start of the list, which may have changed. + * + * There is no function to create a #GList. %NULL is considered to be + * the empty list so you simply set a #GList* to %NULL. + * + * To add elements, use g_list_append(), g_list_prepend(), + * g_list_insert() and g_list_insert_sorted(). + * + * To remove elements, use g_list_remove(). + * + * To find elements in the list use g_list_first(), g_list_last(), + * g_list_next(), g_list_previous(), g_list_nth(), g_list_nth_data(), + * g_list_find() and g_list_find_custom(). + * + * To find the index of an element use g_list_position() and + * g_list_index(). + * + * To call a function for each element in the list use g_list_foreach(). + * + * To free the entire list, use g_list_free(). + **/ + +/** + * GList: + * @data: holds the element's data, which can be a pointer to any kind + * of data, or any integer value using the Type Conversion + * Macros. + * @next: contains the link to the next element in the list. + * @prev: contains the link to the previous element in the list. + * + * The #GList struct is used for each element in a doubly-linked list. + **/ +/** + * g_list_previous: + * @list: an element in a #GList. + * @Returns: the previous element, or %NULL if there are no previous + * elements. + * + * A convenience macro to get the previous element in a #GList. + **/ + +/** + * g_list_next: + * @list: an element in a #GList. + * @Returns: the next element, or %NULL if there are no more elements. + * + * A convenience macro to get the next element in a #GList. + **/ + + + +/** + * g_list_push_allocator: + * @allocator: the #GAllocator to use when allocating #GList elements. + * + * Sets the allocator to use to allocate #GList elements. Use + * g_list_pop_allocator() to restore the previous allocator. + * + * Note that this function is not available if GLib has been compiled + * with + * + * Deprecated:2.10: It does nothing, since #GList has been converted + * to the slice + * allocator + **/ void g_list_push_allocator (gpointer dummy) { /* present for binary compat only */ } + +/** + * g_list_pop_allocator: + * + * Restores the previous #GAllocator, used when allocating #GList + * elements. + * + * Note that this function is not available if GLib has been compiled + * with + * + * Deprecated:2.10: It does nothing, since #GList has been converted + * to the slice + * allocator + **/ void g_list_pop_allocator (void) { /* present for binary compat only */ } #define _g_list_alloc() g_slice_new (GList) #define _g_list_alloc0() g_slice_new0 (GList) #define _g_list_free1(list) g_slice_free (GList, list) +/** + * g_list_alloc: + * @Returns: a pointer to the newly-allocated #GList element. + * + * Allocates space for one #GList element. It is called by + * g_list_append(), g_list_prepend(), g_list_insert() and + * g_list_insert_sorted() and so is rarely used on its own. + **/ GList* g_list_alloc (void) { @@ -72,6 +187,11 @@ g_list_free (GList *list) * Frees one #GList element. * It is usually used after g_list_remove_link(). */ +/** + * g_list_free1: + * + * Another name for g_list_free_1(). + **/ void g_list_free_1 (GList *list) { @@ -778,6 +898,15 @@ g_list_length (GList *list) * * Calls a function for each element of a #GList. */ +/** + * GFunc: + * @data: the element's data. + * @user_data: user data passed to g_list_foreach() or + * g_slist_foreach(). + * + * Specifies the type of functions passed to g_list_foreach() and + * g_slist_foreach(). + **/ void g_list_foreach (GList *list, GFunc func, @@ -968,6 +1097,18 @@ g_list_sort_real (GList *list, * * Returns: the start of the sorted #GList */ +/** + * GCompareFunc: + * @a: a value. + * @b: a value to compare with. + * @Returns: negative value if @a < @b; zero if @a = @b; positive + * value if @a > @b. + * + * Specifies the type of a comparison function used to compare two + * values. The function should return a negative integer if the first + * value comes before the second, 0 if they are equal, or a positive + * integer if the first value comes after the second. + **/ GList * g_list_sort (GList *list, GCompareFunc compare_func) @@ -987,6 +1128,19 @@ g_list_sort (GList *list, * * Returns: the new head of @list */ +/** + * GCompareDataFunc: + * @a: a value. + * @b: a value to compare with. + * @user_data: user data to pass to comparison function. + * @Returns: negative value if @a < @b; zero if @a = @b; positive + * value if @a > @b. + * + * Specifies the type of a comparison function used to compare two + * values. The function should return a negative integer if the first + * value comes before the second, 0 if they are equal, or a positive + * integer if the first value comes after the second. + **/ GList * g_list_sort_with_data (GList *list, GCompareDataFunc compare_func, diff --git a/glib/gslist.c b/glib/gslist.c index 47c5041..5dcbc7f 100644 --- a/glib/gslist.c +++ b/glib/gslist.c @@ -33,14 +33,120 @@ #include "glib.h" #include "galias.h" +/** + * SECTION: linked_lists_single + * @title: Singly-Linked Lists + * @short_description: linked lists containing integer values or + * pointers to data, limited to iterating over the + * list in one direction + * + * The #GSList structure and its associated functions provide a + * standard singly-linked list data structure. + * + * Each element in the list contains a piece of data, together with a + * pointer which links to the next element in the list. Using this + * pointer it is possible to move through the list in one direction + * only (unlike the Doubly-Linked Lists which + * allow movement in both directions). + * + * The data contained in each element can be either integer values, by + * using one of the Type + * Conversion Macros, or simply pointers to any type of data. + * + * List elements are allocated from the slice allocator, which is more + * efficient than allocating elements individually. + * + * Note that most of the #GSList functions expect to be passed a + * pointer to the first element in the list. The functions which insert + * elements return the new start of the list, which may have changed. + * + * There is no function to create a #GSList. %NULL is considered to be + * the empty list so you simply set a #GSList* to %NULL. + * + * To add elements, use g_slist_append(), g_slist_prepend(), + * g_slist_insert() and g_slist_insert_sorted(). + * + * To remove elements, use g_slist_remove(). + * + * To find elements in the list use g_slist_last(), g_slist_next(), + * g_slist_nth(), g_slist_nth_data(), g_slist_find() and + * g_slist_find_custom(). + * + * To find the index of an element use g_slist_position() and + * g_slist_index(). + * + * To call a function for each element in the list use + * g_slist_foreach(). + * + * To free the entire list, use g_slist_free(). + **/ +/** + * GSList: + * @data: holds the element's data, which can be a pointer to any kind + * of data, or any integer value using the Type Conversion + * Macros. + * @next: contains the link to the next element in the list. + * + * The #GSList struct is used for each element in the singly-linked + * list. + **/ + +/** + * g_slist_next: + * @slist: an element in a #GSList. + * @Returns: the next element, or %NULL if there are no more elements. + * + * A convenience macro to get the next element in a #GSList. + **/ + + +/** + * g_slist_push_allocator: + * @dummy: the #GAllocator to use when allocating #GSList elements. + * + * Sets the allocator to use to allocate #GSList elements. Use + * g_slist_pop_allocator() to restore the previous allocator. + * + * Note that this function is not available if GLib has been compiled + * with + * + * Deprecated: 2.10: It does nothing, since #GSList has been converted + * to the slice + * allocator + **/ void g_slist_push_allocator (gpointer dummy) { /* present for binary compat only */ } + +/** + * g_slist_pop_allocator: + * + * Restores the previous #GAllocator, used when allocating #GSList + * elements. + * + * Note that this function is not available if GLib has been compiled + * with + * + * Deprecated: 2.10: It does nothing, since #GSList has been converted + * to the slice + * allocator + **/ void g_slist_pop_allocator (void) { /* present for binary compat only */ } #define _g_slist_alloc0() g_slice_new0 (GSList) #define _g_slist_alloc() g_slice_new (GSList) #define _g_slist_free1(slist) g_slice_free (GSList, slist) +/** + * g_slist_alloc: + * @Returns: a pointer to the newly-allocated #GSList element. + * + * Allocates space for one #GSList element. It is called by the + * g_slist_append(), g_slist_prepend(), g_slist_insert() and + * g_slist_insert_sorted() functions and so is rarely used on its own. + **/ GSList* g_slist_alloc (void) { @@ -67,6 +173,13 @@ g_slist_free (GSList *list) * Frees one #GSList element. * It is usually used after g_slist_remove_link(). */ +/** + * g_slist_free1: + * + * A macro which does the same as g_slist_free_1(). + * + * Since: 2.10 + **/ void g_slist_free_1 (GSList *list) {