From 86f1c798b27fcfd9e1c4edc9632dc288e6a1f32c Mon Sep 17 00:00:00 2001 From: Matthias Clasen Date: Tue, 20 Dec 2005 04:44:25 +0000 Subject: [PATCH] Updates --- docs/reference/ChangeLog | 2 + docs/reference/glib/tmpl/allocators.sgml | 4 +- docs/reference/glib/tmpl/caches.sgml | 3 +- .../glib/tmpl/linked_lists_double.sgml | 13 ++++-- .../glib/tmpl/linked_lists_single.sgml | 6 +-- docs/reference/glib/tmpl/main.sgml | 24 ++++------- docs/reference/glib/tmpl/memory_chunks.sgml | 42 +++++++++---------- docs/reference/glib/tmpl/messages.sgml | 20 +++++++++ docs/reference/glib/tmpl/scanner.sgml | 15 +++---- docs/reference/glib/tmpl/strings.sgml | 2 - docs/reference/glib/tmpl/trees-nary.sgml | 6 +-- 11 files changed, 72 insertions(+), 65 deletions(-) diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog index b54672b74..48085407c 100644 --- a/docs/reference/ChangeLog +++ b/docs/reference/ChangeLog @@ -1,5 +1,7 @@ 2005-12-19 Matthias Clasen + * glib/tmpl/*.sgml: Update versioned deprecation + * gobject/tmpl/gboxed.sgml: Document G_TYPE_HASH_TABLE. * glib/glib-sections.txt: Add g_list_free1 diff --git a/docs/reference/glib/tmpl/allocators.sgml b/docs/reference/glib/tmpl/allocators.sgml index 4c17583ae..038f63e79 100644 --- a/docs/reference/glib/tmpl/allocators.sgml +++ b/docs/reference/glib/tmpl/allocators.sgml @@ -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 and 65535. @Returns: a new #GAllocator. -@Deprecated: Use the slice allocator +@Deprecated: 2.10: Use the slice allocator instead @@ -51,7 +51,7 @@ Frees all of the memory allocated by the #GAllocator. @allocator: a #GAllocator. -@Deprecated: Use the slice allocator +@Deprecated: 2.10: Use the slice allocator instead diff --git a/docs/reference/glib/tmpl/caches.sgml b/docs/reference/glib/tmpl/caches.sgml index 8d663b4c1..ebac3d0b4 100644 --- a/docs/reference/glib/tmpl/caches.sgml +++ b/docs/reference/glib/tmpl/caches.sgml @@ -123,8 +123,7 @@ Calls the given function for each of the values in the #GCache. @cache: a #GCache. @func: the function to call with each #GCache value. @user_data: user data to pass to the function. - -@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 diff --git a/docs/reference/glib/tmpl/linked_lists_double.sgml b/docs/reference/glib/tmpl/linked_lists_double.sgml index 48a297598..15c9871f0 100644 --- a/docs/reference/glib/tmpl/linked_lists_double.sgml +++ b/docs/reference/glib/tmpl/linked_lists_double.sgml @@ -256,6 +256,13 @@ It is usually used after g_list_remove_link(). @list: a #GList element. + + + + + + + Gets the number of elements in a #GList. @@ -518,8 +525,7 @@ with @allocator: the #GAllocator to use when allocating #GList elements. - -@Deprecated:2.10: It does nothing, since #GList has been +@Deprecated: 2.10: It does nothing, since #GList has been converted to the slice allocator @@ -532,8 +538,7 @@ Note that this function is not available if GLib has been compiled with - -@Deprecated:2.10: It does nothing, since #GList has been +@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 index ec5698d35..ec56c08c9 100644 --- a/docs/reference/glib/tmpl/linked_lists_single.sgml +++ b/docs/reference/glib/tmpl/linked_lists_single.sgml @@ -450,8 +450,7 @@ with @dummy: the #GAllocator to use when allocating #GSList elements. - -@Deprecated:2.10: It does nothing, since #GSList has been +@Deprecated: 2.10: It does nothing, since #GSList has been converted to the slice allocator @@ -464,8 +463,7 @@ Note that this function is not available if GLib has been compiled with - -@Deprecated:2.10: It does nothing, since #GSList has been +@Deprecated: 2.10: It does nothing, since #GSList has been converted to the slice allocator diff --git a/docs/reference/glib/tmpl/main.sgml b/docs/reference/glib/tmpl/main.sgml index 19040891c..4c5cdd7c6 100644 --- a/docs/reference/glib/tmpl/main.sgml +++ b/docs/reference/glib/tmpl/main.sgml @@ -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 very important since calling g_main_run() will set this to %TRUE anyway. @Returns: a new #GMainLoop. - -@Deprecated:2.2: Use g_main_loop_new() instead. +@Deprecated: 2.2: Use g_main_loop_new() instead. @@ -190,8 +189,7 @@ Frees the memory allocated for the #GMainLoop. @loop: a #GMainLoop. - -@Deprecated:2.2: Use g_main_loop_unref() instead. +@Deprecated: 2.2: Use g_main_loop_unref() instead. @@ -200,8 +198,7 @@ Runs a main loop until it stops running. @loop: a #GMainLoop. - -@Deprecated:2.2: Use g_main_loop_run() instead. +@Deprecated: 2.2: Use g_main_loop_run() instead. @@ -211,8 +208,7 @@ it will now return. @loop: a #GMainLoop. - -@Deprecated:2.2: Use g_main_loop_quit() instead. +@Deprecated: 2.2: Use g_main_loop_quit() instead. @@ -222,8 +218,7 @@ Checks if the main loop is running. @loop: a #GMainLoop. @Returns: %TRUE if the main loop is running. - -@Deprecated:2.2: USe g_main_loop_is_running() instead. +@Deprecated: 2.2: USe g_main_loop_is_running() instead. @@ -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 processed. @Returns: %TRUE if more events are pending. - -@Deprecated:2.2: Use g_main_context_iteration() instead. +@Deprecated: 2.2: Use g_main_context_iteration() instead. @@ -351,8 +345,7 @@ Checks if any events are pending for the default #GMainContext @Returns: %TRUE if any events are pending. - -@Deprecated:2.2: Use g_main_context_pending() instead. +@Deprecated: 2.2: Use g_main_context_pending() instead. @@ -534,8 +527,7 @@ for the default main context. @func: the function to call to poll all file descriptors. - -@Deprecated:2.2: Use g_main_context_set_poll_func() instead. +@Deprecated: 2.2: Use g_main_context_set_poll_func() instead. diff --git a/docs/reference/glib/tmpl/memory_chunks.sgml b/docs/reference/glib/tmpl/memory_chunks.sgml index 8335c408a..08c2e2ed6 100644 --- a/docs/reference/glib/tmpl/memory_chunks.sgml +++ b/docs/reference/glib/tmpl/memory_chunks.sgml @@ -170,7 +170,7 @@ the 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. @Returns: the new #GMemChunk. -@Deprecated: Use the slice allocator +@Deprecated: 2.10: Use the slice allocator instead @@ -181,7 +181,7 @@ Allocates an atom of memory from a #GMemChunk. @mem_chunk: a #GMemChunk. @Returns: a pointer to the allocated atom. -@Deprecated: Use g_slice_alloc() instead +@Deprecated: 2.10: Use g_slice_alloc() instead @@ -191,7 +191,7 @@ Allocates an atom of memory from a #GMemChunk, setting the memory to 0. @mem_chunk: a #GMemChunk. @Returns: a pointer to the allocated atom. -@Deprecated: Use g_slice_alloc0() instead +@Deprecated: 2.10: Use g_slice_alloc0() instead @@ -203,7 +203,7 @@ This should only be called if the #GMemChunk was created with @mem_chunk: a #GMemChunk. @mem: a pointer to the atom to free. -@Deprecated: Use g_slice_free1() instead +@Deprecated: 2.10: Use g_slice_free1() instead @@ -212,8 +212,8 @@ Frees all of the memory allocated for a #GMemChunk. @mem_chunk: a #GMemChunk. -@Deprecated: Use the slice allocator - instead +@Deprecated: 2.10: Use the slice + allocator instead @@ -233,8 +233,8 @@ the atom size. #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. @Returns: the new #GMemChunk. -@Deprecated: Use the slice allocator - instead +@Deprecated: 2.10: Use the slice + allocator instead @@ -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. @chunk: a #GMemChunk. @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 @@ -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. @chunk: a #GMemChunk. @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 @@ -273,7 +273,7 @@ and g_chunk_new0(). @mem: a pointer to the atom to be freed. @mem_chunk: a #GMemChunk. -@Deprecated: Use g_slice_free() instead +@Deprecated: 2.10: Use g_slice_free() instead @@ -283,8 +283,8 @@ It frees all of the currently allocated blocks of memory. @mem_chunk: a #GMemChunk. -@Deprecated: Use the slice allocator - instead +@Deprecated: 2.10: Use the slice + allocator instead @@ -293,8 +293,8 @@ Frees any blocks in a #GMemChunk which are no longer being used. @mem_chunk: a #GMemChunk. -@Deprecated: Use the slice allocator - instead +@Deprecated: 2.10: Use the slice + allocator instead @@ -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. -@Deprecated: Use the slice allocator - instead +@Deprecated: 2.10: Use the slice + allocator instead @@ -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. -@Deprecated: Use the slice allocator - instead +@Deprecated: 2.10: Use the slice + allocator instead @@ -325,7 +325,7 @@ the number of bytes used, and the number of blocks of memory allocated. @mem_chunk: a #GMemChunk. -@Deprecated: Use the slice allocator - instead +@Deprecated: 2.10: Use the slice + allocator instead diff --git a/docs/reference/glib/tmpl/messages.sgml b/docs/reference/glib/tmpl/messages.sgml index 3854f3002..3286bea64 100644 --- a/docs/reference/glib/tmpl/messages.sgml +++ b/docs/reference/glib/tmpl/messages.sgml @@ -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()) +@...: + +@...: + @@ -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()) +@...: + +@...: + @@ -136,6 +144,10 @@ example. @...: format string, followed by parameters to insert into the format string (as with printf()) +@...: + +@...: + @@ -149,6 +161,10 @@ assertion failure. @...: the parameters to insert into the format string. +@...: + +@...: + @@ -156,6 +172,10 @@ A convenience function/macro to log a debug message. @...: format string, followed by parameters to insert into the format string (as with printf()) + +@...: + +@...: @Since: 2.6 diff --git a/docs/reference/glib/tmpl/scanner.sgml b/docs/reference/glib/tmpl/scanner.sgml index bdec1de0c..518fec60c 100644 --- a/docs/reference/glib/tmpl/scanner.sgml +++ b/docs/reference/glib/tmpl/scanner.sgml @@ -389,8 +389,7 @@ Removes a symbol from a scope. @scanner: a #GScanner. - -@Deprecated:2.2: This macro does nothing. +@Deprecated: 2.2: This macro does nothing. @@ -398,8 +397,7 @@ Removes a symbol from a scope. @scanner: a #GScanner. - -@Deprecated:2.2: This macro does nothing. +@Deprecated: 2.2: This macro does nothing. @@ -564,8 +562,7 @@ Adds a symbol to the default scope. @scanner: a #GScanner. @symbol: the symbol to add. @value: the value of the symbol. - -@Deprecated:2.2: Use g_scanner_scope_add_symbol() instead. +@Deprecated: 2.2: Use g_scanner_scope_add_symbol() instead. @@ -575,8 +572,7 @@ Removes a symbol from the default scope. @scanner: a #GScanner. @symbol: the symbol to remove. - -@Deprecated:2.2: Use g_scanner_scope_remove_symbol() instead. +@Deprecated: 2.2: Use g_scanner_scope_remove_symbol() instead. @@ -587,7 +583,6 @@ Calls a function for each symbol in the default scope. @scanner: a #GScanner. @func: the function to call with each symbol. @data: data to pass to the function. - -@Deprecated:2.2: Use g_scanner_scope_foreach_symbol() instead. +@Deprecated: 2.2: Use g_scanner_scope_foreach_symbol() instead. diff --git a/docs/reference/glib/tmpl/strings.sgml b/docs/reference/glib/tmpl/strings.sgml index 8a35eeb2e..21570df17 100644 --- a/docs/reference/glib/tmpl/strings.sgml +++ b/docs/reference/glib/tmpl/strings.sgml @@ -91,7 +91,6 @@ The previous contents of the #GString are destroyed. @Deprecated: This function has been renamed to g_string_printf(). - @string: a #GString. @format: the string format. See the sprintf() documentation. @Varargs: the parameters to insert into the format string. @@ -105,7 +104,6 @@ the text is appended to the #GString. @Deprecated: This function has been renamed to g_string_append_printf(). - @string: a #GString. @format: the string format. See the sprintf() documentation. @Varargs: the parameters to insert into the format string. diff --git a/docs/reference/glib/tmpl/trees-nary.sgml b/docs/reference/glib/tmpl/trees-nary.sgml index b6ae5a084..95df79a80 100644 --- a/docs/reference/glib/tmpl/trees-nary.sgml +++ b/docs/reference/glib/tmpl/trees-nary.sgml @@ -528,8 +528,7 @@ with @dummy: the #GAllocator to use when allocating #GNode elements. - -@Deprecated:2.10: It does nothing, since #GNode has been converted +@Deprecated: 2.10: It does nothing, since #GNode has been converted to the slice allocator @@ -542,8 +541,7 @@ Note that this function is not available if GLib has been compiled with - -@Deprecated:2.10: It does nothing, since #GNode has been converted +@Deprecated: 2.10: It does nothing, since #GNode has been converted to the slice allocator