diff options
author | Matthias Clasen <mclasen@redhat.com> | 2011-10-16 16:52:24 -0400 |
---|---|---|
committer | Matthias Clasen <mclasen@redhat.com> | 2011-10-16 16:52:24 -0400 |
commit | 45f221c32f7c88e487fe260eefb3be8d1c2443af (patch) | |
tree | 41c75dc48d94b4c3a4ecf5b531981ec5560ecf57 /docs | |
parent | 6ab1c772705560f62b3f302ee0d396eed06eefb4 (diff) |
Move GTrashStack out of gutils.[hc]
Reducing the mess in gutils, and moving docs inline
at the same time. Double win.
Diffstat (limited to 'docs')
-rw-r--r-- | docs/reference/glib/tmpl/.gitignore | 1 | ||||
-rw-r--r-- | docs/reference/glib/tmpl/trash_stack.sgml | 77 |
2 files changed, 1 insertions, 77 deletions
diff --git a/docs/reference/glib/tmpl/.gitignore b/docs/reference/glib/tmpl/.gitignore index 661ce928c..9a533ae2f 100644 --- a/docs/reference/glib/tmpl/.gitignore +++ b/docs/reference/glib/tmpl/.gitignore @@ -53,6 +53,7 @@ threads-deprecated.sgml threads.sgml timers.sgml timezone.sgml +trash_stack.sgml trees-binary.sgml trees-nary.sgml unicode.sgml diff --git a/docs/reference/glib/tmpl/trash_stack.sgml b/docs/reference/glib/tmpl/trash_stack.sgml deleted file mode 100644 index d9c3d7c24..000000000 --- a/docs/reference/glib/tmpl/trash_stack.sgml +++ /dev/null @@ -1,77 +0,0 @@ -<!-- ##### SECTION Title ##### --> -Trash Stacks - -<!-- ##### SECTION Short_Description ##### --> -maintain a stack of unused allocated memory chunks - -<!-- ##### SECTION Long_Description ##### --> -<para> -A #GTrashStack is an efficient way to keep a stack of unused allocated -memory chunks. Each memory chunk is required to be large enough to hold -a #gpointer. This allows the stack to be maintained without any space -overhead, since the stack pointers can be stored inside the memory chunks. -</para> -<para> -There is no function to create a #GTrashStack. A %NULL #GTrashStack* -is a perfectly valid empty stack. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### SECTION Image ##### --> - - -<!-- ##### STRUCT GTrashStack ##### --> -<para> -Each piece of memory that is pushed onto the stack -is cast to a <structname>GTrashStack*</structname>. -</para> - -@next: pointer to the previous element of the stack, -gets stored in the first <literal>sizeof (gpointer)</literal> -bytes of the element. - -<!-- ##### FUNCTION g_trash_stack_push ##### --> -<para> -Pushes a piece of memory onto a #GTrashStack. -</para> - -@stack_p: a pointer to a #GTrashStack. -@data_p: the piece of memory to push on the stack. - - -<!-- ##### FUNCTION g_trash_stack_pop ##### --> -<para> -Pops a piece of memory off a #GTrashStack. -</para> - -@stack_p: a pointer to a #GTrashStack. -@Returns: the element at the top of the stack. - - -<!-- ##### FUNCTION g_trash_stack_peek ##### --> -<para> -Returns the element at the top of a #GTrashStack which may be %NULL. -</para> - -@stack_p: a pointer to a #GTrashStack. -@Returns: the element at the top of the stack. - - -<!-- ##### FUNCTION g_trash_stack_height ##### --> -<para> -Returns the height of a #GTrashStack. -Note that execution of this function is of O(N) complexity -where N denotes the number of items on the stack. -</para> - -@stack_p: a pointer to a #GTrashStack. -@Returns: the height of the stack. - - |