Commit 0b5560da authored by Matthias Clasen's avatar Matthias Clasen

Add versioned deprecation information

parent a1279204
2005-12-05 Matthias Clasen <mclasen@redhat.com>
* glib/gdate.c:
* glib/gutils.c:
* glib/gtree.c:
* glib/gstring.c:
* glib/giochannel.c:
* glib/gstrfuncs.c: Add versioned deprecation docs.
2005-12-05 Martyn Russell <martyn@imendio.com>
* docs/reference/glib/glib-sections.txt:
......
2005-12-05 Matthias Clasen <mclasen@redhat.com>
* glib/gdate.c:
* glib/gutils.c:
* glib/gtree.c:
* glib/gstring.c:
* glib/giochannel.c:
* glib/gstrfuncs.c: Add versioned deprecation docs.
2005-12-05 Martyn Russell <martyn@imendio.com>
* docs/reference/glib/glib-sections.txt:
......
2005-12-05 Matthias Clasen <mclasen@redhat.com>
* glib/gdate.c:
* glib/gutils.c:
* glib/gtree.c:
* glib/gstring.c:
* glib/giochannel.c:
* glib/gstrfuncs.c: Add versioned deprecation docs.
2005-12-05 Martyn Russell <martyn@imendio.com>
* docs/reference/glib/glib-sections.txt:
......
2005-12-05 Matthias Clasen <mclasen@redhat.com>
* glib/tmpl/trees-nary.sgml:
* glib/tmpl/linked_lists_single.sgml:
* glib/tmpl/linked_lists_double.sgml:
* glib/tmpl/caches.sgml:
* glib/tmpl/strings.sgml:
* glib/tmpl/scanner.sgml:
* glib/tmpl/main.sgml: Add versioned deprecation.
Mon Dec 5 15:53:37 2005 Tim Janik <timj@imendio.com>
* glib/tmpl/memory_slices.sgml: updates to new g_slice API
......
......@@ -123,8 +123,8 @@ 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: Since it passes pointers to internal data structures
to @func; use g_cache_key_foreach() instead
@Deprecated:2.10: The reason is that it passes pointers to internal data
structures to @func; use g_cache_key_foreach() instead
<!-- ##### USER_FUNCTION GCacheDestroyFunc ##### -->
......
......@@ -502,7 +502,7 @@ with <option>--disable-mem-pools</option>
</para>
@allocator: the #GAllocator to use when allocating #GList elements.
@Deprecated: Since 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>
......@@ -515,8 +515,7 @@ Note that this function is not available if GLib has been compiled
with <option>--disable-mem-pools</option>
</para>
@Deprecated: Since 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>
......@@ -434,7 +434,7 @@ with <option>--disable-mem-pools</option>
</para>
@dummy: the #GAllocator to use when allocating #GSList elements.
@Deprecated: Since 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>
......@@ -447,8 +447,7 @@ Note that this function is not available if GLib has been compiled
with <option>--disable-mem-pools</option>
</para>
@Deprecated: Since 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>
......@@ -180,7 +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: Use g_main_loop_new() instead.
@Deprecated:2.2: Use g_main_loop_new() instead.
<!-- ##### MACRO g_main_destroy ##### -->
......@@ -189,7 +189,7 @@ Frees the memory allocated for the #GMainLoop.
</para>
@loop: a #GMainLoop.
@Deprecated: Use g_main_loop_unref() instead.
@Deprecated:2.2: Use g_main_loop_unref() instead.
<!-- ##### MACRO g_main_run ##### -->
......@@ -198,7 +198,7 @@ Runs a main loop until it stops running.
</para>
@loop: a #GMainLoop.
@Deprecated: Use g_main_loop_run() instead.
@Deprecated:2.2: Use g_main_loop_run() instead.
<!-- ##### MACRO g_main_quit ##### -->
......@@ -208,7 +208,7 @@ it will now return.
</para>
@loop: a #GMainLoop.
@Deprecated: Use g_main_loop_quit() instead.
@Deprecated:2.2: Use g_main_loop_quit() instead.
<!-- ##### MACRO g_main_is_running ##### -->
......@@ -218,7 +218,7 @@ Checks if the main loop is running.
@loop: a #GMainLoop.
@Returns: %TRUE if the main loop is running.
@Deprecated: USe g_main_loop_is_running() instead.
@Deprecated:2.2: USe g_main_loop_is_running() instead.
<!-- ##### MACRO G_PRIORITY_HIGH ##### -->
......@@ -326,7 +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: Use g_main_context_iteration() instead.
@Deprecated:2.2: Use g_main_context_iteration() instead.
<!-- ##### FUNCTION g_main_context_pending ##### -->
......@@ -345,7 +345,7 @@ Checks if any events are pending for the default #GMainContext
</para>
@Returns: %TRUE if any events are pending.
@Deprecated: Use g_main_context_pending() instead.
@Deprecated:2.2: Use g_main_context_pending() instead.
<!-- ##### FUNCTION g_main_context_find_source_by_id ##### -->
......@@ -527,7 +527,7 @@ for the default main context.
</para>
@func: the function to call to poll all file descriptors.
@Deprecated: Use g_main_context_set_poll_func() instead.
@Deprecated:2.2: Use g_main_context_set_poll_func() instead.
<!-- ##### FUNCTION g_timeout_source_new ##### -->
......
......@@ -386,20 +386,18 @@ Removes a symbol from a scope.
<!-- ##### MACRO g_scanner_freeze_symbol_table ##### -->
<para>
This function is deprecated and will be removed in the next major
release of GLib. It does nothing.
</para>
@scanner: a #GScanner.
@Deprecated:2.2: This macro does nothing.
<!-- ##### MACRO g_scanner_thaw_symbol_table ##### -->
<para>
This function is deprecated and will be removed in the next major
release of GLib. It does nothing.
</para>
@scanner: a #GScanner.
@Deprecated:2.2: This macro does nothing.
<!-- ##### FUNCTION g_scanner_lookup_symbol ##### -->
......@@ -564,7 +562,7 @@ Adds a symbol to the default scope.
@scanner: a #GScanner.
@symbol: the symbol to add.
@value: the value of the symbol.
@Deprecated: Use g_scanner_scope_add_symbol() instead.
@Deprecated:2.2: Use g_scanner_scope_add_symbol() instead.
<!-- ##### MACRO g_scanner_remove_symbol ##### -->
......@@ -574,7 +572,7 @@ Removes a symbol from the default scope.
@scanner: a #GScanner.
@symbol: the symbol to remove.
@Deprecated: Use g_scanner_scope_remove_symbol() instead.
@Deprecated:2.2: Use g_scanner_scope_remove_symbol() instead.
<!-- ##### MACRO g_scanner_foreach_symbol ##### -->
......@@ -585,6 +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: Use g_scanner_scope_foreach_symbol() instead.
@Deprecated:2.2: Use g_scanner_scope_foreach_symbol() instead.
......@@ -528,8 +528,8 @@ with <option>--disable-mem-pools</option>
</para>
@dummy: the #GAllocator to use when allocating #GNode elements.
@Deprecated: Since 2.10, it does nothing, since #GNode has been
converted to the <link linkend="glib-Memory-Slices">slice allocator</link>
@Deprecated:2.10: It does nothing, since #GNode has been converted
to the <link linkend="glib-Memory-Slices">slice allocator</link>
<!-- ##### FUNCTION g_node_pop_allocator ##### -->
......@@ -541,7 +541,7 @@ Note that this function is not available if GLib has been compiled
with <option>--disable-mem-pools</option>
</para>
@Deprecated: Since 2.10, it does nothing, since #GNode has been
converted to the <link linkend="glib-Memory-Slices">slice allocator</link>
@Deprecated:2.10: It does nothing, since #GNode has been converted
to the <link linkend="glib-Memory-Slices">slice allocator</link>
......@@ -1129,7 +1129,7 @@ This is an internal function introduced mainly for C marshallers.
@value: a valid #GValue of type %G_TYPE_STRING
@v_string: duplicated unowned string to be set
@Deprecated: Use g_value_take_string() instead.
@Deprecated:2.4: Use g_value_take_string() instead.
<!-- ##### FUNCTION g_value_get_string ##### -->
......@@ -1236,7 +1236,7 @@ This is an internal function introduced mainly for C marshallers.
@value: a valid #GValue of type %G_TYPE_PARAM
@param: the #GParamSpec to be set
@Deprecated: Use g_value_take_param() instead.
@Deprecated:2.4: Use g_value_take_param() instead.
<!-- ##### FUNCTION g_value_get_param ##### -->
......@@ -1351,7 +1351,7 @@ This is an internal function introduced mainly for C marshallers.
@value: a valid #GValue of %G_TYPE_BOXED derived type
@v_boxed: duplicated unowned boxed value to be set
@Deprecated: Use g_value_take_boxed() instead.
@Deprecated:2.4: Use g_value_take_boxed() instead.
<!-- ##### FUNCTION g_value_get_boxed ##### -->
......@@ -1528,7 +1528,7 @@ This is an internal function introduced mainly for C marshallers.
@value: a valid #GValue of %G_TYPE_OBJECT derived type
@v_object: object value to be set
@Deprecated: Use g_value_take_object() instead.
@Deprecated:2.4: Use g_value_take_object() instead.
<!-- ##### FUNCTION g_value_get_object ##### -->
......
......@@ -924,7 +924,7 @@ g_date_set_time_t (GDate *date,
*
* Sets the value of a date from a #GTime value.
*
* @Deprecated: Use g_date_set_time_t() instead.
* @Deprecated:2.10: Use g_date_set_time_t() instead.
*/
void
g_date_set_time (GDate *date,
......
......@@ -174,7 +174,7 @@ g_io_error_get_from_g_error (GIOStatus status,
*
* Return value: %G_IO_ERROR_NONE if the operation was successful.
*
* Deprecated: Use g_io_channel_read_chars() instead.
* Deprecated:2.2: Use g_io_channel_read_chars() instead.
**/
GIOError
g_io_channel_read (GIOChannel *channel,
......@@ -219,7 +219,7 @@ g_io_channel_read (GIOChannel *channel,
*
* Return value: %G_IO_ERROR_NONE if the operation was successful.
*
* Deprecated: Use g_io_channel_write_chars() instead.
* Deprecated:2.2: Use g_io_channel_write_chars() instead.
**/
GIOError
g_io_channel_write (GIOChannel *channel,
......@@ -257,7 +257,7 @@ g_io_channel_write (GIOChannel *channel,
*
* Return value: %G_IO_ERROR_NONE if the operation was successful.
*
* Deprecated: Use g_io_channel_seek_position() instead.
* Deprecated:2.2: Use g_io_channel_seek_position() instead.
**/
GIOError
g_io_channel_seek (GIOChannel *channel,
......@@ -320,7 +320,7 @@ g_io_channel_seek (GIOChannel *channel,
* flushed, ignoring errors. The channel will not be freed until the
* last reference is dropped using g_io_channel_unref().
*
* Deprecated: Use g_io_channel_shutdown() instead.
* Deprecated:2.2: Use g_io_channel_shutdown() instead.
**/
void
g_io_channel_close (GIOChannel *channel)
......
......@@ -1559,8 +1559,8 @@ g_ascii_strup (const gchar *str,
*
* Return value: the string
*
* Deprecated: This function is totally broken for the reasons discussed in
* the g_strncasecmp() docs - use g_ascii_strdown() or g_utf8_strdown()
* Deprecated:2.2: This function is totally broken for the reasons discussed
* in the g_strncasecmp() docs - use g_ascii_strdown() or g_utf8_strdown()
* instead.
**/
gchar*
......@@ -1590,8 +1590,8 @@ g_strdown (gchar *string)
*
* Return value: the string
*
* Deprecated: This function is totally broken for the reasons discussed in
* the g_strncasecmp() docs - use g_ascii_strup() or g_utf8_strup() instead.
* Deprecated:2.2: This function is totally broken for the reasons discussed
* in the g_strncasecmp() docs - use g_ascii_strup() or g_utf8_strup() instead.
**/
gchar*
g_strup (gchar *string)
......@@ -1832,8 +1832,8 @@ g_ascii_strncasecmp (const gchar *s1,
* Return value: 0 if the strings match, a negative value if @s1 &lt; @s2,
* or a positive value if @s1 &gt; @s2.
*
* Deprecated: See g_strncasecmp() for a discussion of why this function is
* deprecated and how to replace it.
* Deprecated:2.2: See g_strncasecmp() for a discussion of why this function
* is deprecated and how to replace it.
**/
gint
g_strcasecmp (const gchar *s1,
......@@ -1880,7 +1880,7 @@ g_strcasecmp (const gchar *s1,
* Return value: 0 if the strings match, a negative value if @s1 &lt; @s2,
* or a positive value if @s1 &gt; @s2.
*
* Deprecated: The problem with g_strncasecmp() is that it does the
* Deprecated:2.2: The problem with g_strncasecmp() is that it does the
* comparison by calling toupper()/tolower(). These functions are
* locale-specific and operate on single bytes. However, it is impossible
* to handle things correctly from an I18N standpoint by operating on
......
......@@ -827,7 +827,7 @@ g_string_ascii_up (GString *string)
*
* Returns: the #GString.
*
* Deprecated: This function uses the locale-specific tolower() function,
* Deprecated:2.2: This function uses the locale-specific tolower() function,
* which is almost never the right thing. Use g_string_ascii_down() or
* g_utf8_strdown() instead.
*/
......@@ -861,7 +861,7 @@ g_string_down (GString *string)
*
* Return value: the #GString
*
* Deprecated: This function uses the locale-specific toupper() function,
* Deprecated:2.2: This function uses the locale-specific toupper() function,
* which is almost never the right thing. Use g_string_ascii_up() or
* g_utf8_strup() instead.
**/
......
......@@ -462,7 +462,7 @@ g_tree_foreach (GTree *tree,
*
* Calls the given function for each node in the #GTree.
*
* Deprecated: The order of a balanced tree is somewhat arbitrary. If you
* Deprecated:2.2: The order of a balanced tree is somewhat arbitrary. If you
* just want to visit all nodes in sorted order, use g_tree_foreach()
* instead. If you really need to visit nodes in a different order, consider
* using an <link linkend="glib-N-ary-Trees">N-ary Tree</link>.
......
......@@ -618,7 +618,7 @@ g_parse_debug_string (const gchar *string,
*
* Return value: the name of the file without any leading directory components.
*
* Deprecated: Use g_path_get_basename() instead, but notice that
* Deprecated:2.2: Use g_path_get_basename() instead, but notice that
* g_path_get_basename() allocates new memory for the returned string, unlike
* this function which returns a pointer into the argument.
**/
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment