From 4a2fac6031e7e59435326c8bfd36eaf4ad35f06d Mon Sep 17 00:00:00 2001 From: Matthias Clasen Date: Thu, 5 Dec 2002 22:32:20 +0000 Subject: [PATCH] Add Since and Deprecation info for symbols documented in the templates. * glib/tmpl/strings.sgml: * glib/tmpl/scanner.sgml: * glib/tmpl/main.sgml: * glib/tmpl/macros_misc.sgml: * glib/tmpl/hash_tables.sgml: Add Since and Deprecation info for symbols documented in the templates. * glib/gstrfuncs.c (g_strncasecmp): Break long deprecation info into two paragraphs. --- ChangeLog | 5 ++++ ChangeLog.pre-2-10 | 5 ++++ ChangeLog.pre-2-12 | 5 ++++ ChangeLog.pre-2-2 | 5 ++++ ChangeLog.pre-2-4 | 5 ++++ ChangeLog.pre-2-6 | 5 ++++ ChangeLog.pre-2-8 | 5 ++++ docs/reference/ChangeLog | 9 +++++++ docs/reference/glib/tmpl/hash_tables.sgml | 4 +-- docs/reference/glib/tmpl/macros_misc.sgml | 2 ++ docs/reference/glib/tmpl/main.sgml | 30 ++++++++++++----------- docs/reference/glib/tmpl/scanner.sgml | 6 ++--- docs/reference/glib/tmpl/strings.sgml | 8 +++--- glib/gstrfuncs.c | 1 + 14 files changed, 72 insertions(+), 23 deletions(-) diff --git a/ChangeLog b/ChangeLog index 51b196ba..93c70dc1 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,8 @@ +2002-12-05 Matthias Clasen + + * glib/gstrfuncs.c (g_strncasecmp): Break long deprecation + info into two paragraphs. + Thu Dec 5 15:43:46 2002 Owen Taylor * configure.in: Fix multiple problems with the programs diff --git a/ChangeLog.pre-2-10 b/ChangeLog.pre-2-10 index 51b196ba..93c70dc1 100644 --- a/ChangeLog.pre-2-10 +++ b/ChangeLog.pre-2-10 @@ -1,3 +1,8 @@ +2002-12-05 Matthias Clasen + + * glib/gstrfuncs.c (g_strncasecmp): Break long deprecation + info into two paragraphs. + Thu Dec 5 15:43:46 2002 Owen Taylor * configure.in: Fix multiple problems with the programs diff --git a/ChangeLog.pre-2-12 b/ChangeLog.pre-2-12 index 51b196ba..93c70dc1 100644 --- a/ChangeLog.pre-2-12 +++ b/ChangeLog.pre-2-12 @@ -1,3 +1,8 @@ +2002-12-05 Matthias Clasen + + * glib/gstrfuncs.c (g_strncasecmp): Break long deprecation + info into two paragraphs. + Thu Dec 5 15:43:46 2002 Owen Taylor * configure.in: Fix multiple problems with the programs diff --git a/ChangeLog.pre-2-2 b/ChangeLog.pre-2-2 index 51b196ba..93c70dc1 100644 --- a/ChangeLog.pre-2-2 +++ b/ChangeLog.pre-2-2 @@ -1,3 +1,8 @@ +2002-12-05 Matthias Clasen + + * glib/gstrfuncs.c (g_strncasecmp): Break long deprecation + info into two paragraphs. + Thu Dec 5 15:43:46 2002 Owen Taylor * configure.in: Fix multiple problems with the programs diff --git a/ChangeLog.pre-2-4 b/ChangeLog.pre-2-4 index 51b196ba..93c70dc1 100644 --- a/ChangeLog.pre-2-4 +++ b/ChangeLog.pre-2-4 @@ -1,3 +1,8 @@ +2002-12-05 Matthias Clasen + + * glib/gstrfuncs.c (g_strncasecmp): Break long deprecation + info into two paragraphs. + Thu Dec 5 15:43:46 2002 Owen Taylor * configure.in: Fix multiple problems with the programs diff --git a/ChangeLog.pre-2-6 b/ChangeLog.pre-2-6 index 51b196ba..93c70dc1 100644 --- a/ChangeLog.pre-2-6 +++ b/ChangeLog.pre-2-6 @@ -1,3 +1,8 @@ +2002-12-05 Matthias Clasen + + * glib/gstrfuncs.c (g_strncasecmp): Break long deprecation + info into two paragraphs. + Thu Dec 5 15:43:46 2002 Owen Taylor * configure.in: Fix multiple problems with the programs diff --git a/ChangeLog.pre-2-8 b/ChangeLog.pre-2-8 index 51b196ba..93c70dc1 100644 --- a/ChangeLog.pre-2-8 +++ b/ChangeLog.pre-2-8 @@ -1,3 +1,8 @@ +2002-12-05 Matthias Clasen + + * glib/gstrfuncs.c (g_strncasecmp): Break long deprecation + info into two paragraphs. + Thu Dec 5 15:43:46 2002 Owen Taylor * configure.in: Fix multiple problems with the programs diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog index d0c582f9..a696f1c0 100644 --- a/docs/reference/ChangeLog +++ b/docs/reference/ChangeLog @@ -1,3 +1,12 @@ +2002-12-05 Matthias Clasen + + * glib/tmpl/strings.sgml: + * glib/tmpl/scanner.sgml: + * glib/tmpl/main.sgml: + * glib/tmpl/macros_misc.sgml: + * glib/tmpl/hash_tables.sgml: Add Since and Deprecation info + for symbols documented in the templates. + 2002-12-04 Matthias Clasen * gobject/tmpl/gtype.sgml: Add docs. diff --git a/docs/reference/glib/tmpl/hash_tables.sgml b/docs/reference/glib/tmpl/hash_tables.sgml index 31b77859..cf5d7da0 100644 --- a/docs/reference/glib/tmpl/hash_tables.sgml +++ b/docs/reference/glib/tmpl/hash_tables.sgml @@ -253,7 +253,7 @@ This function is deprecated and will be removed in the next major release of GLib. It does nothing. -@hash_table: +@hash_table: a #GHashTable @@ -262,7 +262,7 @@ This function is deprecated and will be removed in the next major release of GLib. It does nothing. -@hash_table: +@hash_table: a #GHashTable diff --git a/docs/reference/glib/tmpl/macros_misc.sgml b/docs/reference/glib/tmpl/macros_misc.sgml index d16bc170..893c33a4 100644 --- a/docs/reference/glib/tmpl/macros_misc.sgml +++ b/docs/reference/glib/tmpl/macros_misc.sgml @@ -248,6 +248,7 @@ if (G_LIKELY (random () != 1)) @expr: the expression +@Since: 2.2 @@ -261,6 +262,7 @@ if (G_UNLIKELY (random () == 1)) @expr: the expression +@Since: 2.2 diff --git a/docs/reference/glib/tmpl/main.sgml b/docs/reference/glib/tmpl/main.sgml index 67d68ad8..7f1ef425 100644 --- a/docs/reference/glib/tmpl/main.sgml +++ b/docs/reference/glib/tmpl/main.sgml @@ -172,49 +172,51 @@ representing the main event loop of a GLib or GTK+ application. -Creates a new #GMainLoop for the default main loop. A compatibility -macro, see g_main_loop_new(). +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. -Frees the memory allocated for the #GMainLoop. A compatibility macro, see -g_main_loop_unref(). +Frees the memory allocated for the #GMainLoop. @loop: a #GMainLoop. +@Deprecated: Use g_main_loop_unref() instead. -Runs a main loop until it stops running. A compatibility macro, see g_main_loop_run(). +Runs a main loop until it stops running. @loop: a #GMainLoop. +@Deprecated: Use g_main_loop_run() instead. Stops the #GMainLoop. If g_main_run() was called to run the #GMainLoop, -it will now return. A compatibility macro, see g_main_loop_quit(). +it will now return. @loop: a #GMainLoop. +@Deprecated: Use g_main_loop_quit() instead. -Checks if the main loop is running. A compatibility macro, see -g_main_loop_is_running(). +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. @@ -314,7 +316,6 @@ representing a set of sources to be handled in a main loop. Runs a single iteration for the default #GMainContext. -A compatibility macro, see g_main_context_iteration(). @may_block: set to %TRUE if it should block (i.e. wait) until an event source @@ -322,6 +323,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. @@ -336,11 +338,11 @@ processed. Checks if any events are pending for the default #GMainContext -(i.e. ready to be processed). A compatibility macro, see -g_main_context_pending(). +(i.e. ready to be processed). @Returns: %TRUE if any events are pending. +@Deprecated: Use g_main_context_pending() instead. @@ -475,7 +477,7 @@ g_main_context_pending(). -Specifies the type of function passed to g_main_set_poll_func(). +Specifies the type of function passed to g_main_context_set_poll_func(). The semantics of the function should match those of the poll() system call. @@ -510,11 +512,11 @@ or -1 if an error occurred. Sets the function to use for the handle polling of file descriptors -for the default main context. This is a compatability macro, see -g_main_context_set_poll_func() for full details. +for the default main context. @func: the function to call to poll all file descriptors. +@Deprecated: Use g_main_context_set_poll_func() instead. diff --git a/docs/reference/glib/tmpl/scanner.sgml b/docs/reference/glib/tmpl/scanner.sgml index 9b0ed99f..bac9d601 100644 --- a/docs/reference/glib/tmpl/scanner.sgml +++ b/docs/reference/glib/tmpl/scanner.sgml @@ -556,32 +556,32 @@ Used for specifying valid identifier characters in #GScannerConfig. Adds a symbol to the default scope. -Deprecated in favour of g_scanner_scope_add_symbol(). @scanner: a #GScanner. @symbol: the symbol to add. @value: the value of the symbol. +@Deprecated: Use g_scanner_scope_add_symbol() instead. Removes a symbol from the default scope. -Deprecated in favour of g_scanner_scope_remove_symbol(). @scanner: a #GScanner. @symbol: the symbol to remove. +@Deprecated: Use g_scanner_scope_remove_symbol() instead. Calls a function for each symbol in the default scope. -Deprecated in favour of g_scanner_scope_foreach_symbol(). @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. diff --git a/docs/reference/glib/tmpl/strings.sgml b/docs/reference/glib/tmpl/strings.sgml index bc5cb2aa..a3f69b1b 100644 --- a/docs/reference/glib/tmpl/strings.sgml +++ b/docs/reference/glib/tmpl/strings.sgml @@ -84,10 +84,10 @@ you do not have to worry about having enough space to copy the string. Writes a formatted string into a #GString. This is similar to the standard sprintf() function, except that the #GString buffer automatically expands to contain the results. -The previous contents of the #GString are destroyed. This -function has been renamaed to g_string_printf(). +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() @@ -99,10 +99,10 @@ documentation. Appends a formatted string onto the end of a #GString. This function is is similar to g_string_sprintf() except that -the text is appended to the #GString. The function has been -renamed to g_string_append_printf(). +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() diff --git a/glib/gstrfuncs.c b/glib/gstrfuncs.c index dab25047..9d1bf7d6 100644 --- a/glib/gstrfuncs.c +++ b/glib/gstrfuncs.c @@ -1856,6 +1856,7 @@ g_strcasecmp (const gchar *s1, * locale-sensitive, and it's broken if your string is localized, since * it doesn't work on many encodings at all, including UTF-8, EUC-JP, * etc. + * * There are therefore two replacement functions: g_ascii_strncasecmp(), * which only works on ASCII and is not locale-sensitive, and * g_utf8_casefold(), which is good for case-insensitive sorting of UTF-8. -- 2.34.1