Updates
authorMatthias Clasen <matthiasc@src.gnome.org>
Tue, 20 Dec 2005 04:44:25 +0000 (04:44 +0000)
committerMatthias Clasen <matthiasc@src.gnome.org>
Tue, 20 Dec 2005 04:44:25 +0000 (04:44 +0000)
docs/reference/ChangeLog
docs/reference/glib/tmpl/allocators.sgml
docs/reference/glib/tmpl/caches.sgml
docs/reference/glib/tmpl/linked_lists_double.sgml
docs/reference/glib/tmpl/linked_lists_single.sgml
docs/reference/glib/tmpl/main.sgml
docs/reference/glib/tmpl/memory_chunks.sgml
docs/reference/glib/tmpl/messages.sgml
docs/reference/glib/tmpl/scanner.sgml
docs/reference/glib/tmpl/strings.sgml
docs/reference/glib/tmpl/trees-nary.sgml

index b54672b..4808540 100644 (file)
@@ -1,5 +1,7 @@
 2005-12-19  Matthias Clasen  <mclasen@redhat.com>
 
+       * glib/tmpl/*.sgml: Update versioned deprecation
+
        * gobject/tmpl/gboxed.sgml: Document G_TYPE_HASH_TABLE.
 
        * glib/glib-sections.txt: Add g_list_free1
index 4c17583..038f63e 100644 (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
 and 65535.
 @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
 
 
@@ -51,7 +51,7 @@ Frees all of the memory allocated by the #GAllocator.
 </para>
 
 @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
 
 
index 8d663b4..ebac3d0 100644 (file)
@@ -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.
-<!-- # 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
 
 
index 48a2975..15c9871 100644 (file)
@@ -256,6 +256,13 @@ It is usually used after g_list_remove_link().
 @list: a #GList element.
 
 
+<!-- ##### MACRO g_list_free1 ##### -->
+<para>
+
+</para>
+
+
+
 <!-- ##### FUNCTION g_list_length ##### -->
 <para>
 Gets the number of elements in a #GList.
@@ -518,8 +525,7 @@ with <option>--disable-mem-pools</option>
 </para>
 
 @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>
 
 
@@ -532,8 +538,7 @@ Note that this function is not available if GLib has been compiled
 with <option>--disable-mem-pools</option>
 </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>
 
 
index ec5698d..ec56c08 100644 (file)
@@ -450,8 +450,7 @@ with <option>--disable-mem-pools</option>
 </para>
 
 @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>
 
 
@@ -464,8 +463,7 @@ Note that this function is not available if GLib has been compiled
 with <option>--disable-mem-pools</option>
 </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>
 
 
index 1904089..4c5cdd7 100644 (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
 very important since calling g_main_run() will set this to %TRUE anyway.
 @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 ##### -->
@@ -190,8 +189,7 @@ Frees the memory allocated for the #GMainLoop.
 </para>
 
 @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 ##### -->
@@ -200,8 +198,7 @@ Runs a main loop until it stops running.
 </para>
 
 @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 ##### -->
@@ -211,8 +208,7 @@ it will now return.
 </para>
 
 @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 ##### -->
@@ -222,8 +218,7 @@ Checks if the main loop is running.
 
 @loop: a #GMainLoop.
 @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 ##### -->
@@ -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.
-<!-- # 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 ##### -->
@@ -351,8 +345,7 @@ Checks if any events are pending for the default #GMainContext
 </para>
 
 @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 ##### -->
@@ -534,8 +527,7 @@ for the default main context.
 </para>
 
 @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 ##### -->
index 8335c40..08c2e2e 100644 (file)
@@ -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 <link linkend="glib-Memory-Slices">slice allocator</link>
+@Deprecated: 2.10: Use the <link linkend="glib-Memory-Slices">slice allocator</link>
   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
 
 
 <!-- ##### 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.
 @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 ##### -->
@@ -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
 
 
 <!-- ##### FUNCTION g_mem_chunk_destroy ##### -->
@@ -212,8 +212,8 @@ Frees all of the memory allocated for a #GMemChunk.
 </para>
 
 @mem_chunk: a #GMemChunk.
-@Deprecated: Use the <link linkend="glib-Memory-Slices">slice allocator</link>
-  instead
+@Deprecated: 2.10: Use the <link linkend="glib-Memory-Slices">slice 
+  allocator</link> instead
 
 
 <!-- ##### 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,
 but it obviously wastes memory if you no longer need many of the atoms.
 @Returns: the new #GMemChunk.
-@Deprecated: Use the <link linkend="glib-Memory-Slices">slice allocator</link>
-  instead
+@Deprecated: 2.10: Use the <link linkend="glib-Memory-Slices">slice 
+  allocator</link> instead
 
 
 <!-- ##### 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.
 @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
 
 
 <!-- ##### 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.
 @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
 
 
 <!-- ##### MACRO g_chunk_free ##### -->
@@ -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
 
 
 <!-- ##### FUNCTION g_mem_chunk_reset ##### -->
@@ -283,8 +283,8 @@ It frees all of the currently allocated blocks of memory.
 </para>
 
 @mem_chunk: a #GMemChunk.
-@Deprecated: Use the <link linkend="glib-Memory-Slices">slice allocator</link>
-  instead
+@Deprecated: 2.10: Use the <link linkend="glib-Memory-Slices">slice 
+  allocator</link> instead
 
 
 <!-- ##### FUNCTION g_mem_chunk_clean ##### -->
@@ -293,8 +293,8 @@ Frees any blocks in a #GMemChunk which are no longer being used.
 </para>
 
 @mem_chunk: a #GMemChunk.
-@Deprecated: Use the <link linkend="glib-Memory-Slices">slice allocator</link>
-  instead
+@Deprecated: 2.10: Use the <link linkend="glib-Memory-Slices">slice 
+  allocator</link> instead
 
 
 <!-- ##### 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.
 </para>
 
-@Deprecated: Use the <link linkend="glib-Memory-Slices">slice allocator</link>
-  instead
+@Deprecated: 2.10: Use the <link linkend="glib-Memory-Slices">slice 
+  allocator</link> instead
 
 
 <!-- ##### 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.
 </para>
 
-@Deprecated: Use the <link linkend="glib-Memory-Slices">slice allocator</link>
-  instead
+@Deprecated: 2.10: Use the <link linkend="glib-Memory-Slices">slice 
+  allocator</link> instead
 
 
 <!-- ##### FUNCTION g_mem_chunk_print ##### -->
@@ -325,7 +325,7 @@ the number of bytes used, and the number of blocks of memory allocated.
 </para>
 
 @mem_chunk: a #GMemChunk.
-@Deprecated: Use the <link linkend="glib-Memory-Slices">slice allocator</link>
-  instead
+@Deprecated: 2.10: Use the <link linkend="glib-Memory-Slices">slice 
+  allocator</link> instead
 
 
index 3854f30..3286bea 100644 (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())
 
+@...:
+
+@...: 
+
 
 <!-- ##### MACRO g_warning ##### -->
 <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())
 
+@...:
+
+@...: 
+
 
 <!-- ##### MACRO g_critical ##### -->
 <para>
@@ -136,6 +144,10 @@ example.
 
 @...: format string, followed by parameters to insert into the format string (as with printf())
 
+@...:
+
+@...: 
+
 
 <!-- ##### MACRO g_error ##### -->
 <para>
@@ -149,6 +161,10 @@ assertion failure.
 
 @...: the parameters to insert into the format string.
 
+@...:
+
+@...: 
+
 
 <!-- ##### MACRO g_debug ##### -->
 <para>
@@ -156,6 +172,10 @@ A convenience function/macro to log a debug message.
 </para>
 
 @...: format string, followed by parameters to insert into the format string (as with printf())
+
+@...:
+
+@...: 
 @Since: 2.6
 
 
index bdec1de..518fec6 100644 (file)
@@ -389,8 +389,7 @@ Removes a symbol from a scope.
 </para>
 
 @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 ##### -->
@@ -398,8 +397,7 @@ Removes a symbol from a scope.
 </para>
 
 @scanner: a #GScanner.
-<!-- # Unused Parameters # -->
-@Deprecated:2.2: This macro does nothing.
+@Deprecated: 2.2: This macro does nothing.
 
 
 <!-- ##### FUNCTION g_scanner_lookup_symbol ##### -->
@@ -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.
-<!-- # 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 ##### -->
@@ -575,8 +572,7 @@ Removes a symbol from the default scope.
 
 @scanner: a #GScanner.
 @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 ##### -->
@@ -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.
-<!-- # Unused Parameters # -->
-@Deprecated:2.2: Use g_scanner_scope_foreach_symbol() instead.
+@Deprecated: 2.2: Use g_scanner_scope_foreach_symbol() instead.
 
 
index 8a35eeb..21570df 100644 (file)
@@ -91,7 +91,6 @@ The previous contents of the #GString are destroyed.
 </para>
 
 @Deprecated: This function has been renamed to g_string_printf().
-<!-- # Unused Parameters # -->
 @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.
 </para>
 
 @Deprecated: This function has been renamed to g_string_append_printf().
-<!-- # Unused Parameters # -->
 @string: a #GString.
 @format: the string format. See the sprintf() documentation.
 @Varargs: the parameters to insert into the format string.
index b6ae5a0..95df79a 100644 (file)
@@ -528,8 +528,7 @@ with <option>--disable-mem-pools</option>
 </para>
 
 @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>
 
 
@@ -542,8 +541,7 @@ Note that this function is not available if GLib has been compiled
 with <option>--disable-mem-pools</option>
 </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>