luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-03-31 12:53:07 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: Describe GCompletion item memory management

Browse Source 
https://bugzilla.gnome.org/show_bug.cgi?id=600751
This commit is contained in:
David King 2012-02-17 11:15:08 +00:00
parent b13a79aeb4
commit 86a4fd6fa9
1 changed files with 13 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
glib/deprecated/gcompletion.c
View File

@ -138,7 +138,7 @@ g_completion_new (GCompletionFunc func)
/** /**
* g_completion_add_items: * g_completion_add_items:
* @cmp: the #GCompletion. * @cmp: the #GCompletion.
* @items: the list of items to add. * @items: (transfer none): the list of items to add.
* *
* Adds items to the #GCompletion. * Adds items to the #GCompletion.
* *
@ -176,9 +176,11 @@ g_completion_add_items (GCompletion* cmp,
/** /**
* g_completion_remove_items: * g_completion_remove_items:
* @cmp: the #GCompletion. * @cmp: the #GCompletion.
* @items: the items to remove. * @items: (transfer none): the items to remove.
* *
* Removes items from a #GCompletion. * Removes items from a #GCompletion. The items are not freed, so if the memory
* was dynamically allocated, free @items with g_list_free_full() after calling
* this function.
* *
* Deprecated: 2.26: Rarely used API * Deprecated: 2.26: Rarely used API
**/ **/
@ -209,7 +211,9 @@ g_completion_remove_items (GCompletion* cmp,
* g_completion_clear_items: * g_completion_clear_items:
* @cmp: the #GCompletion. * @cmp: the #GCompletion.
* *
* Removes all items from the #GCompletion. * Removes all items from the #GCompletion. The items are not freed, so if the
* memory was dynamically allocated, it should be freed after calling this
* function.
* *
* Deprecated: 2.26: Rarely used API * Deprecated: 2.26: Rarely used API
**/ **/
@ -332,8 +336,8 @@ g_completion_complete_utf8 (GCompletion *cmp,
* common to all items that matched @prefix, or %NULL if * common to all items that matched @prefix, or %NULL if
* no items matched @prefix. This string should be freed * no items matched @prefix. This string should be freed
* when no longer needed. * when no longer needed.
* @Returns: the list of items whose strings begin with @prefix. This * @Returns: (transfer none): the list of items whose strings begin with
* should not be changed. * @prefix. This should not be changed.
* *
* Attempts to complete the string @prefix using the #GCompletion * Attempts to complete the string @prefix using the #GCompletion
* target items. * target items.
@ -406,7 +410,9 @@ g_completion_complete (GCompletion* cmp,
* g_completion_free: * g_completion_free:
* @cmp: the #GCompletion. * @cmp: the #GCompletion.
* *
* Frees all memory used by the #GCompletion. * Frees all memory used by the #GCompletion. The items are not freed, so if
* the memory was dynamically allocated, it should be freed after calling this
* function.
* *
* Deprecated: 2.26: Rarely used API * Deprecated: 2.26: Rarely used API
**/ **/