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.
This commit is contained in:
Matthias Clasen 2002-12-05 22:32:20 +00:00
parent 9be4551686
commit 4a2fac6031
14 changed files with 72 additions and 23 deletions

View File

@ -1,3 +1,8 @@
2002-12-05 Matthias Clasen <maclas@gmx.de>
* glib/gstrfuncs.c (g_strncasecmp): Break long deprecation
info into two paragraphs.
Thu Dec 5 15:43:46 2002 Owen Taylor <otaylor@redhat.com>
* configure.in: Fix multiple problems with the programs

View File

@ -1,3 +1,8 @@
2002-12-05 Matthias Clasen <maclas@gmx.de>
* glib/gstrfuncs.c (g_strncasecmp): Break long deprecation
info into two paragraphs.
Thu Dec 5 15:43:46 2002 Owen Taylor <otaylor@redhat.com>
* configure.in: Fix multiple problems with the programs

View File

@ -1,3 +1,8 @@
2002-12-05 Matthias Clasen <maclas@gmx.de>
* glib/gstrfuncs.c (g_strncasecmp): Break long deprecation
info into two paragraphs.
Thu Dec 5 15:43:46 2002 Owen Taylor <otaylor@redhat.com>
* configure.in: Fix multiple problems with the programs

View File

@ -1,3 +1,8 @@
2002-12-05 Matthias Clasen <maclas@gmx.de>
* glib/gstrfuncs.c (g_strncasecmp): Break long deprecation
info into two paragraphs.
Thu Dec 5 15:43:46 2002 Owen Taylor <otaylor@redhat.com>
* configure.in: Fix multiple problems with the programs

View File

@ -1,3 +1,8 @@
2002-12-05 Matthias Clasen <maclas@gmx.de>
* glib/gstrfuncs.c (g_strncasecmp): Break long deprecation
info into two paragraphs.
Thu Dec 5 15:43:46 2002 Owen Taylor <otaylor@redhat.com>
* configure.in: Fix multiple problems with the programs

View File

@ -1,3 +1,8 @@
2002-12-05 Matthias Clasen <maclas@gmx.de>
* glib/gstrfuncs.c (g_strncasecmp): Break long deprecation
info into two paragraphs.
Thu Dec 5 15:43:46 2002 Owen Taylor <otaylor@redhat.com>
* configure.in: Fix multiple problems with the programs

View File

@ -1,3 +1,8 @@
2002-12-05 Matthias Clasen <maclas@gmx.de>
* glib/gstrfuncs.c (g_strncasecmp): Break long deprecation
info into two paragraphs.
Thu Dec 5 15:43:46 2002 Owen Taylor <otaylor@redhat.com>
* configure.in: Fix multiple problems with the programs

View File

@ -1,3 +1,12 @@
2002-12-05 Matthias Clasen <maclas@gmx.de>
* 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 <maclas@gmx.de>
* gobject/tmpl/gtype.sgml: Add docs.

View File

@ -253,7 +253,7 @@ This function is deprecated and will be removed in the next major
release of GLib. It does nothing.
</para>
@hash_table:
@hash_table: a #GHashTable
<!-- ##### MACRO g_hash_table_thaw ##### -->
@ -262,7 +262,7 @@ This function is deprecated and will be removed in the next major
release of GLib. It does nothing.
</para>
@hash_table:
@hash_table: a #GHashTable
<!-- ##### FUNCTION g_hash_table_destroy ##### -->

View File

@ -248,6 +248,7 @@ if (G_LIKELY (random () != 1))
</programlisting></informalexample>
@expr: the expression
@Since: 2.2
<!-- ##### MACRO G_UNLIKELY ##### -->
@ -261,6 +262,7 @@ if (G_UNLIKELY (random () == 1))
</programlisting></informalexample>
@expr: the expression
@Since: 2.2
<!-- ##### MACRO G_STRLOC ##### -->

View File

@ -172,49 +172,51 @@ representing the main event loop of a GLib or GTK+ application.
<!-- ##### MACRO g_main_new ##### -->
<para>
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.
</para>
@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.
<!-- ##### MACRO g_main_destroy ##### -->
<para>
Frees the memory allocated for the #GMainLoop. A compatibility macro, see
g_main_loop_unref().
Frees the memory allocated for the #GMainLoop.
</para>
@loop: a #GMainLoop.
@Deprecated: Use g_main_loop_unref() instead.
<!-- ##### MACRO g_main_run ##### -->
<para>
Runs a main loop until it stops running. A compatibility macro, see g_main_loop_run().
Runs a main loop until it stops running.
</para>
@loop: a #GMainLoop.
@Deprecated: Use g_main_loop_run() instead.
<!-- ##### MACRO g_main_quit ##### -->
<para>
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.
</para>
@loop: a #GMainLoop.
@Deprecated: Use g_main_loop_quit() instead.
<!-- ##### MACRO g_main_is_running ##### -->
<para>
Checks if the main loop is running. A compatibility macro, see
g_main_loop_is_running().
Checks if the main loop is running.
</para>
@loop: a #GMainLoop.
@Returns: %TRUE if the main loop is running.
@Deprecated: USe g_main_loop_is_running() instead.
<!-- ##### MACRO G_PRIORITY_HIGH ##### -->
@ -314,7 +316,6 @@ representing a set of sources to be handled in a main loop.
<!-- ##### MACRO g_main_iteration ##### -->
<para>
Runs a single iteration for the default #GMainContext.
A compatibility macro, see g_main_context_iteration().
</para>
@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.
<!-- ##### FUNCTION g_main_context_pending ##### -->
@ -336,11 +338,11 @@ processed.
<!-- ##### MACRO g_main_pending ##### -->
<para>
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).
</para>
@Returns: %TRUE if any events are pending.
@Deprecated: Use g_main_context_pending() instead.
<!-- ##### FUNCTION g_main_context_find_source_by_id ##### -->
@ -475,7 +477,7 @@ g_main_context_pending().
<!-- ##### USER_FUNCTION GPollFunc ##### -->
<para>
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
<function>poll()</function> system call.
</para>
@ -510,11 +512,11 @@ or -1 if an error occurred.
<!-- ##### MACRO g_main_set_poll_func ##### -->
<para>
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.
</para>
@func: the function to call to poll all file descriptors.
@Deprecated: Use g_main_context_set_poll_func() instead.
<!-- ##### FUNCTION g_timeout_source_new ##### -->

View File

@ -556,32 +556,32 @@ Used for specifying valid identifier characters in #GScannerConfig.
<!-- ##### MACRO g_scanner_add_symbol ##### -->
<para>
Adds a symbol to the default scope.
Deprecated in favour of g_scanner_scope_add_symbol().
</para>
@scanner: a #GScanner.
@symbol: the symbol to add.
@value: the value of the symbol.
@Deprecated: Use g_scanner_scope_add_symbol() instead.
<!-- ##### MACRO g_scanner_remove_symbol ##### -->
<para>
Removes a symbol from the default scope.
Deprecated in favour of g_scanner_scope_remove_symbol().
</para>
@scanner: a #GScanner.
@symbol: the symbol to remove.
@Deprecated: Use g_scanner_scope_remove_symbol() instead.
<!-- ##### MACRO g_scanner_foreach_symbol ##### -->
<para>
Calls a function for each symbol in the default scope.
Deprecated in favour of g_scanner_scope_foreach_symbol().
</para>
@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.

View File

@ -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 <function>sprintf()</function> 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.
</para>
@Deprecated: This function has been renamed to g_string_printf().
<!-- # Unused Parameters # -->
@string: a #GString.
@format: the string format. See the <function>sprintf()</function>
@ -99,10 +99,10 @@ documentation.
<para>
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.
</para>
@Deprecated: This function has been renamed to g_string_append_printf().
<!-- # Unused Parameters # -->
@string: a #GString.
@format: the string format. See the <function>sprintf()</function>

View File

@ -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.