luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2024-12-27 07:56:14 +01:00
Code Issues Packages Projects Releases Wiki Activity

Updates

Browse Source
This commit is contained in:
Matthias Clasen 2005-12-20 04:44:25 +00:00
parent ce4648d362
commit 86f1c798b2
11 changed files with 72 additions and 65 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/reference/ChangeLog
View File

@ -1,5 +1,7 @@
2005-12-19 Matthias Clasen <mclasen@redhat.com> 2005-12-19 Matthias Clasen <mclasen@redhat.com>
* glib/tmpl/*.sgml: Update versioned deprecation
* gobject/tmpl/gboxed.sgml: Document G_TYPE_HASH_TABLE. * gobject/tmpl/gboxed.sgml: Document G_TYPE_HASH_TABLE.
* glib/glib-sections.txt: Add g_list_free1 * glib/glib-sections.txt: Add g_list_free1

4
docs/reference/glib/tmpl/allocators.sgml
View File

@ -41,7 +41,7 @@ Larger blocks mean less calls to g_malloc(), but some memory may be wasted.
(GLib uses 128 elements per block by default.) The value must be between 1 (GLib uses 128 elements per block by default.) The value must be between 1
and 65535. and 65535.
@Returns: a new #GAllocator. @Returns: a new #GAllocator.
@Deprecated: Use the <link linkend="glib-Memory-Slices">slice allocator</link> @Deprecated: 2.10: Use the <link linkend="glib-Memory-Slices">slice allocator</link>
instead instead
@ -51,7 +51,7 @@ Frees all of the memory allocated by the #GAllocator.
</para> </para>
@allocator: a #GAllocator. @allocator: a #GAllocator.
@Deprecated: Use the <link linkend="glib-Memory-Slices">slice allocator</link> @Deprecated: 2.10: Use the <link linkend="glib-Memory-Slices">slice allocator</link>
instead instead

3
docs/reference/glib/tmpl/caches.sgml
View File

@ -123,8 +123,7 @@ Calls the given function for each of the values in the #GCache.
@cache: a #GCache. @cache: a #GCache.
@func: the function to call with each #GCache value. @func: the function to call with each #GCache value.
@user_data: user data to pass to the function. @user_data: user data to pass to the function.
<!-- # Unused Parameters # --> @Deprecated: 2.10: The reason is that it passes pointers to internal data
@Deprecated:2.10: The reason is that it passes pointers to internal data
structures to @func; use g_cache_key_foreach() instead structures to @func; use g_cache_key_foreach() instead

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

@ -256,6 +256,13 @@ It is usually used after g_list_remove_link().
@list: a #GList element. @list: a #GList element.
<!-- ##### MACRO g_list_free1 ##### -->
<para>
</para>
<!-- ##### FUNCTION g_list_length ##### --> <!-- ##### FUNCTION g_list_length ##### -->
<para> <para>
Gets the number of elements in a #GList. Gets the number of elements in a #GList.
@ -518,8 +525,7 @@ with <option>--disable-mem-pools</option>
</para> </para>
@allocator: the #GAllocator to use when allocating #GList elements. @allocator: the #GAllocator to use when allocating #GList elements.
<!-- # Unused Parameters # --> @Deprecated: 2.10: It does nothing, since #GList has been
@Deprecated:2.10: It does nothing, since #GList has been
converted to the <link linkend="glib-Memory-Slices">slice allocator</link> converted to the <link linkend="glib-Memory-Slices">slice allocator</link>
@ -532,8 +538,7 @@ Note that this function is not available if GLib has been compiled
with <option>--disable-mem-pools</option> with <option>--disable-mem-pools</option>
</para> </para>
<!-- # Unused Parameters # --> @Deprecated: 2.10: It does nothing, since #GList has been
@Deprecated:2.10: It does nothing, since #GList has been
converted to the <link linkend="glib-Memory-Slices">slice allocator</link> converted to the <link linkend="glib-Memory-Slices">slice allocator</link>

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

@ -450,8 +450,7 @@ with <option>--disable-mem-pools</option>
</para> </para>
@dummy: the #GAllocator to use when allocating #GSList elements. @dummy: the #GAllocator to use when allocating #GSList elements.
<!-- # Unused Parameters # --> @Deprecated: 2.10: It does nothing, since #GSList has been
@Deprecated:2.10: It does nothing, since #GSList has been
converted to the <link linkend="glib-Memory-Slices">slice allocator</link> converted to the <link linkend="glib-Memory-Slices">slice allocator</link>
@ -464,8 +463,7 @@ Note that this function is not available if GLib has been compiled
with <option>--disable-mem-pools</option> with <option>--disable-mem-pools</option>
</para> </para>
<!-- # Unused Parameters # --> @Deprecated: 2.10: It does nothing, since #GSList has been
@Deprecated:2.10: It does nothing, since #GSList has been
converted to the <link linkend="glib-Memory-Slices">slice allocator</link> converted to the <link linkend="glib-Memory-Slices">slice allocator</link>

24
docs/reference/glib/tmpl/main.sgml
View File

@ -180,8 +180,7 @@ Creates a new #GMainLoop for the default main loop.
@is_running: set to %TRUE to indicate that the loop is running. This is not @is_running: set to %TRUE to indicate that the loop is running. This is not
very important since calling g_main_run() will set this to %TRUE anyway. very important since calling g_main_run() will set this to %TRUE anyway.
@Returns: a new #GMainLoop. @Returns: a new #GMainLoop.
<!-- # Unused Parameters # --> @Deprecated: 2.2: Use g_main_loop_new() instead.
@Deprecated:2.2: Use g_main_loop_new() instead.
<!-- ##### MACRO g_main_destroy ##### --> <!-- ##### MACRO g_main_destroy ##### -->
@ -190,8 +189,7 @@ Frees the memory allocated for the #GMainLoop.
</para> </para>
@loop: a #GMainLoop. @loop: a #GMainLoop.
<!-- # Unused Parameters # --> @Deprecated: 2.2: Use g_main_loop_unref() instead.
@Deprecated:2.2: Use g_main_loop_unref() instead.
<!-- ##### MACRO g_main_run ##### --> <!-- ##### MACRO g_main_run ##### -->
@ -200,8 +198,7 @@ Runs a main loop until it stops running.
</para> </para>
@loop: a #GMainLoop. @loop: a #GMainLoop.
<!-- # Unused Parameters # --> @Deprecated: 2.2: Use g_main_loop_run() instead.
@Deprecated:2.2: Use g_main_loop_run() instead.
<!-- ##### MACRO g_main_quit ##### --> <!-- ##### MACRO g_main_quit ##### -->
@ -211,8 +208,7 @@ it will now return.
</para> </para>
@loop: a #GMainLoop. @loop: a #GMainLoop.
<!-- # Unused Parameters # --> @Deprecated: 2.2: Use g_main_loop_quit() instead.
@Deprecated:2.2: Use g_main_loop_quit() instead.
<!-- ##### MACRO g_main_is_running ##### --> <!-- ##### MACRO g_main_is_running ##### -->
@ -222,8 +218,7 @@ Checks if the main loop is running.
@loop: a #GMainLoop. @loop: a #GMainLoop.
@Returns: %TRUE if the main loop is running. @Returns: %TRUE if the main loop is running.
<!-- # Unused Parameters # --> @Deprecated: 2.2: USe g_main_loop_is_running() instead.
@Deprecated:2.2: USe g_main_loop_is_running() instead.
<!-- ##### MACRO G_PRIORITY_HIGH ##### --> <!-- ##### MACRO G_PRIORITY_HIGH ##### -->
@ -331,8 +326,7 @@ becomes ready. It will return after an event source has been processed.
If set to %FALSE it will return immediately if no event source is ready to be If set to %FALSE it will return immediately if no event source is ready to be
processed. processed.
@Returns: %TRUE if more events are pending. @Returns: %TRUE if more events are pending.
<!-- # Unused Parameters # --> @Deprecated: 2.2: Use g_main_context_iteration() instead.
@Deprecated:2.2: Use g_main_context_iteration() instead.
<!-- ##### FUNCTION g_main_context_pending ##### --> <!-- ##### FUNCTION g_main_context_pending ##### -->
@ -351,8 +345,7 @@ Checks if any events are pending for the default #GMainContext
</para> </para>
@Returns: %TRUE if any events are pending. @Returns: %TRUE if any events are pending.
<!-- # Unused Parameters # --> @Deprecated: 2.2: Use g_main_context_pending() instead.
@Deprecated:2.2: Use g_main_context_pending() instead.
<!-- ##### FUNCTION g_main_context_find_source_by_id ##### --> <!-- ##### FUNCTION g_main_context_find_source_by_id ##### -->
@ -534,8 +527,7 @@ for the default main context.
</para> </para>
@func: the function to call to poll all file descriptors. @func: the function to call to poll all file descriptors.
<!-- # Unused Parameters # --> @Deprecated: 2.2: Use g_main_context_set_poll_func() instead.
@Deprecated:2.2: Use g_main_context_set_poll_func() instead.
<!-- ##### FUNCTION g_timeout_source_new ##### --> <!-- ##### FUNCTION g_timeout_source_new ##### -->

42
docs/reference/glib/tmpl/memory_chunks.sgml
View File

@ -170,7 +170,7 @@ the atoms.
#G_ALLOC_ONLY is quicker, since it does not need to track free atoms, #G_ALLOC_ONLY is quicker, since it does not need to track free atoms,
but it obviously wastes memory if you no longer need many of the atoms. but it obviously wastes memory if you no longer need many of the atoms.
@Returns: the new #GMemChunk. @Returns: the new #GMemChunk.
@Deprecated: Use the <link linkend="glib-Memory-Slices">slice allocator</link> @Deprecated: 2.10: Use the <link linkend="glib-Memory-Slices">slice allocator</link>
instead instead
@ -181,7 +181,7 @@ Allocates an atom of memory from a #GMemChunk.
@mem_chunk: a #GMemChunk. @mem_chunk: a #GMemChunk.
@Returns: a pointer to the allocated atom. @Returns: a pointer to the allocated atom.
@Deprecated: Use g_slice_alloc() instead @Deprecated: 2.10: Use g_slice_alloc() instead
<!-- ##### FUNCTION g_mem_chunk_alloc0 ##### --> <!-- ##### FUNCTION g_mem_chunk_alloc0 ##### -->
@ -191,7 +191,7 @@ Allocates an atom of memory from a #GMemChunk, setting the memory to 0.
@mem_chunk: a #GMemChunk. @mem_chunk: a #GMemChunk.
@Returns: a pointer to the allocated atom. @Returns: a pointer to the allocated atom.
@Deprecated: Use g_slice_alloc0() instead @Deprecated: 2.10: Use g_slice_alloc0() instead
<!-- ##### FUNCTION g_mem_chunk_free ##### --> <!-- ##### FUNCTION g_mem_chunk_free ##### -->
@ -203,7 +203,7 @@ This should only be called if the #GMemChunk was created with
@mem_chunk: a #GMemChunk. @mem_chunk: a #GMemChunk.
@mem: a pointer to the atom to free. @mem: a pointer to the atom to free.
@Deprecated: Use g_slice_free1() instead @Deprecated: 2.10: Use g_slice_free1() instead
<!-- ##### FUNCTION g_mem_chunk_destroy ##### --> <!-- ##### FUNCTION g_mem_chunk_destroy ##### -->
@ -212,8 +212,8 @@ Frees all of the memory allocated for a #GMemChunk.
</para> </para>
@mem_chunk: a #GMemChunk. @mem_chunk: a #GMemChunk.
@Deprecated: Use the <link linkend="glib-Memory-Slices">slice allocator</link> @Deprecated: 2.10: Use the <link linkend="glib-Memory-Slices">slice
instead allocator</link> instead
<!-- ##### MACRO g_mem_chunk_create ##### --> <!-- ##### MACRO g_mem_chunk_create ##### -->
@ -233,8 +233,8 @@ the atom size.
#G_ALLOC_ONLY is quicker, since it does not need to track free atoms, #G_ALLOC_ONLY is quicker, since it does not need to track free atoms,
but it obviously wastes memory if you no longer need many of the atoms. but it obviously wastes memory if you no longer need many of the atoms.
@Returns: the new #GMemChunk. @Returns: the new #GMemChunk.
@Deprecated: Use the <link linkend="glib-Memory-Slices">slice allocator</link> @Deprecated: 2.10: Use the <link linkend="glib-Memory-Slices">slice
instead allocator</link> instead
<!-- ##### MACRO g_chunk_new ##### --> <!-- ##### MACRO g_chunk_new ##### -->
@ -247,7 +247,7 @@ the given type, avoiding a type cast in the source code.
@type: the type of the #GMemChunk atoms, typically a structure name. @type: the type of the #GMemChunk atoms, typically a structure name.
@chunk: a #GMemChunk. @chunk: a #GMemChunk.
@Returns: a pointer to the allocated atom, cast to a pointer to @type. @Returns: a pointer to the allocated atom, cast to a pointer to @type.
@Deprecated: Use g_slice_new() instead @Deprecated: 2.10: Use g_slice_new() instead
<!-- ##### MACRO g_chunk_new0 ##### --> <!-- ##### MACRO g_chunk_new0 ##### -->
@ -260,7 +260,7 @@ the given type, avoiding a type cast in the source code.
@type: the type of the #GMemChunk atoms, typically a structure name. @type: the type of the #GMemChunk atoms, typically a structure name.
@chunk: a #GMemChunk. @chunk: a #GMemChunk.
@Returns: a pointer to the allocated atom, cast to a pointer to @type. @Returns: a pointer to the allocated atom, cast to a pointer to @type.
@Deprecated: Use g_slice_new0() instead @Deprecated: 2.10: Use g_slice_new0() instead
<!-- ##### MACRO g_chunk_free ##### --> <!-- ##### MACRO g_chunk_free ##### -->
@ -273,7 +273,7 @@ and g_chunk_new0().
@mem: a pointer to the atom to be freed. @mem: a pointer to the atom to be freed.
@mem_chunk: a #GMemChunk. @mem_chunk: a #GMemChunk.
@Deprecated: Use g_slice_free() instead @Deprecated: 2.10: Use g_slice_free() instead
<!-- ##### FUNCTION g_mem_chunk_reset ##### --> <!-- ##### FUNCTION g_mem_chunk_reset ##### -->
@ -283,8 +283,8 @@ It frees all of the currently allocated blocks of memory.
</para> </para>
@mem_chunk: a #GMemChunk. @mem_chunk: a #GMemChunk.
@Deprecated: Use the <link linkend="glib-Memory-Slices">slice allocator</link> @Deprecated: 2.10: Use the <link linkend="glib-Memory-Slices">slice
instead allocator</link> instead
<!-- ##### FUNCTION g_mem_chunk_clean ##### --> <!-- ##### FUNCTION g_mem_chunk_clean ##### -->
@ -293,8 +293,8 @@ Frees any blocks in a #GMemChunk which are no longer being used.
</para> </para>
@mem_chunk: a #GMemChunk. @mem_chunk: a #GMemChunk.
@Deprecated: Use the <link linkend="glib-Memory-Slices">slice allocator</link> @Deprecated: 2.10: Use the <link linkend="glib-Memory-Slices">slice
instead allocator</link> instead
<!-- ##### FUNCTION g_blow_chunks ##### --> <!-- ##### FUNCTION g_blow_chunks ##### -->
@ -302,8 +302,8 @@ Frees any blocks in a #GMemChunk which are no longer being used.
Calls g_mem_chunk_clean() on all #GMemChunk objects. Calls g_mem_chunk_clean() on all #GMemChunk objects.
</para> </para>
@Deprecated: Use the <link linkend="glib-Memory-Slices">slice allocator</link> @Deprecated: 2.10: Use the <link linkend="glib-Memory-Slices">slice
instead allocator</link> instead
<!-- ##### FUNCTION g_mem_chunk_info ##### --> <!-- ##### FUNCTION g_mem_chunk_info ##### -->
@ -313,8 +313,8 @@ It outputs the number of #GMemChunk objects currently allocated,
and calls g_mem_chunk_print() to output information on each one. and calls g_mem_chunk_print() to output information on each one.
</para> </para>
@Deprecated: Use the <link linkend="glib-Memory-Slices">slice allocator</link> @Deprecated: 2.10: Use the <link linkend="glib-Memory-Slices">slice
instead allocator</link> instead
<!-- ##### FUNCTION g_mem_chunk_print ##### --> <!-- ##### FUNCTION g_mem_chunk_print ##### -->
@ -325,7 +325,7 @@ the number of bytes used, and the number of blocks of memory allocated.
</para> </para>
@mem_chunk: a #GMemChunk. @mem_chunk: a #GMemChunk.
@Deprecated: Use the <link linkend="glib-Memory-Slices">slice allocator</link> @Deprecated: 2.10: Use the <link linkend="glib-Memory-Slices">slice
instead allocator</link> instead

20
docs/reference/glib/tmpl/messages.sgml
View File

@ -116,6 +116,10 @@ A convenience function/macro to log a normal message.
@...: format string, followed by parameters to insert into the format string (as with printf()) @...: format string, followed by parameters to insert into the format string (as with printf())
@...:
@...:
<!-- ##### MACRO g_warning ##### --> <!-- ##### MACRO g_warning ##### -->
<para> <para>
@ -124,6 +128,10 @@ A convenience function/macro to log a warning message.
@...: format string, followed by parameters to insert into the format string (as with printf()) @...: format string, followed by parameters to insert into the format string (as with printf())
@...:
@...:
<!-- ##### MACRO g_critical ##### --> <!-- ##### MACRO g_critical ##### -->
<para> <para>
@ -136,6 +144,10 @@ example.
@...: format string, followed by parameters to insert into the format string (as with printf()) @...: format string, followed by parameters to insert into the format string (as with printf())
@...:
@...:
<!-- ##### MACRO g_error ##### --> <!-- ##### MACRO g_error ##### -->
<para> <para>
@ -149,6 +161,10 @@ assertion failure.
@...: the parameters to insert into the format string. @...: the parameters to insert into the format string.
@...:
@...:
<!-- ##### MACRO g_debug ##### --> <!-- ##### MACRO g_debug ##### -->
<para> <para>
@ -156,6 +172,10 @@ A convenience function/macro to log a debug message.
</para> </para>
@...: format string, followed by parameters to insert into the format string (as with printf()) @...: format string, followed by parameters to insert into the format string (as with printf())
@...:
@...:
@Since: 2.6 @Since: 2.6

15
docs/reference/glib/tmpl/scanner.sgml
View File

@ -389,8 +389,7 @@ Removes a symbol from a scope.
</para> </para>
@scanner: a #GScanner. @scanner: a #GScanner.
<!-- # Unused Parameters # --> @Deprecated: 2.2: This macro does nothing.
@Deprecated:2.2: This macro does nothing.
<!-- ##### MACRO g_scanner_thaw_symbol_table ##### --> <!-- ##### MACRO g_scanner_thaw_symbol_table ##### -->
@ -398,8 +397,7 @@ Removes a symbol from a scope.
</para> </para>
@scanner: a #GScanner. @scanner: a #GScanner.
<!-- # Unused Parameters # --> @Deprecated: 2.2: This macro does nothing.
@Deprecated:2.2: This macro does nothing.
<!-- ##### FUNCTION g_scanner_lookup_symbol ##### --> <!-- ##### FUNCTION g_scanner_lookup_symbol ##### -->
@ -564,8 +562,7 @@ Adds a symbol to the default scope.
@scanner: a #GScanner. @scanner: a #GScanner.
@symbol: the symbol to add. @symbol: the symbol to add.
@value: the value of the symbol. @value: the value of the symbol.
<!-- # Unused Parameters # --> @Deprecated: 2.2: Use g_scanner_scope_add_symbol() instead.
@Deprecated:2.2: Use g_scanner_scope_add_symbol() instead.
<!-- ##### MACRO g_scanner_remove_symbol ##### --> <!-- ##### MACRO g_scanner_remove_symbol ##### -->
@ -575,8 +572,7 @@ Removes a symbol from the default scope.
@scanner: a #GScanner. @scanner: a #GScanner.
@symbol: the symbol to remove. @symbol: the symbol to remove.
<!-- # Unused Parameters # --> @Deprecated: 2.2: Use g_scanner_scope_remove_symbol() instead.
@Deprecated:2.2: Use g_scanner_scope_remove_symbol() instead.
<!-- ##### MACRO g_scanner_foreach_symbol ##### --> <!-- ##### MACRO g_scanner_foreach_symbol ##### -->
@ -587,7 +583,6 @@ Calls a function for each symbol in the default scope.
@scanner: a #GScanner. @scanner: a #GScanner.
@func: the function to call with each symbol. @func: the function to call with each symbol.
@data: data to pass to the function. @data: data to pass to the function.
<!-- # Unused Parameters # --> @Deprecated: 2.2: Use g_scanner_scope_foreach_symbol() instead.
@Deprecated:2.2: Use g_scanner_scope_foreach_symbol() instead.

2
docs/reference/glib/tmpl/strings.sgml
View File

@ -91,7 +91,6 @@ The previous contents of the #GString are destroyed.
</para> </para>
@Deprecated: This function has been renamed to g_string_printf(). @Deprecated: This function has been renamed to g_string_printf().
<!-- # Unused Parameters # -->
@string: a #GString. @string: a #GString.
@format: the string format. See the sprintf() documentation. @format: the string format. See the sprintf() documentation.
@Varargs: the parameters to insert into the format string. @Varargs: the parameters to insert into the format string.
@ -105,7 +104,6 @@ the text is appended to the #GString.
</para> </para>
@Deprecated: This function has been renamed to g_string_append_printf(). @Deprecated: This function has been renamed to g_string_append_printf().
<!-- # Unused Parameters # -->
@string: a #GString. @string: a #GString.
@format: the string format. See the sprintf() documentation. @format: the string format. See the sprintf() documentation.
@Varargs: the parameters to insert into the format string. @Varargs: the parameters to insert into the format string.

6
docs/reference/glib/tmpl/trees-nary.sgml
View File

@ -528,8 +528,7 @@ with <option>--disable-mem-pools</option>
</para> </para>
@dummy: the #GAllocator to use when allocating #GNode elements. @dummy: the #GAllocator to use when allocating #GNode elements.
<!-- # Unused Parameters # --> @Deprecated: 2.10: It does nothing, since #GNode has been converted
@Deprecated:2.10: It does nothing, since #GNode has been converted
to the <link linkend="glib-Memory-Slices">slice allocator</link> to the <link linkend="glib-Memory-Slices">slice allocator</link>
@ -542,8 +541,7 @@ Note that this function is not available if GLib has been compiled
with <option>--disable-mem-pools</option> with <option>--disable-mem-pools</option>
</para> </para>
<!-- # Unused Parameters # --> @Deprecated: 2.10: It does nothing, since #GNode has been converted
@Deprecated:2.10: It does nothing, since #GNode has been converted
to the <link linkend="glib-Memory-Slices">slice allocator</link> to the <link linkend="glib-Memory-Slices">slice allocator</link>