luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-08-03 07:53:39 +02:00
Code Issues Packages Projects Releases Wiki Activity

Document the recently deprecated functions as such.

Browse Source 
2000-10-27  Sebastian Wilhelmi  <wilhelmi@ira.uka.de>

	* glib/glib-sections.txt, glib/tmpl/hash_tables.sgml,
	glib/tmpl/macros_misc.sgml, glib/tmpl/misc_utils.sgml,
	glib/tmpl/scanner.sgml: Document the recently deprecated functions
	as such.
This commit is contained in:
Sebastian Wilhelmi
2000-10-27 12:34:49 +00:00
committed by Sebastian Wilhelmi
parent 1e46cf8099
commit b6b00bab53
6 changed files with 48 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
docs/reference/ChangeLog
View File

@@ -1,3 +1,10 @@
2000-10-27 Sebastian Wilhelmi <wilhelmi@ira.uka.de>
* glib/glib-sections.txt, glib/tmpl/hash_tables.sgml,
glib/tmpl/macros_misc.sgml, glib/tmpl/misc_utils.sgml,
glib/tmpl/scanner.sgml: Document the recently deprecated functions
as such.
2000-10-15 Raja R Harinath <harinath@cs.umn.edu>
'make distcheck' fixes.

2
docs/reference/glib/glib-sections.txt
View File

@@ -883,8 +883,8 @@ g_basename
g_dirname
g_path_is_absolute
g_path_skip_root
g_path_get_dirname
g_path_get_basename
g_path_get_dirname
g_filename_to_utf8
g_filename_from_utf8

16
docs/reference/glib/tmpl/hash_tables.sgml
View File

@@ -252,24 +252,20 @@ It should return TRUE if the key/value pair should be removed from the
<!-- ##### FUNCTION g_hash_table_freeze ##### -->
<para>
Disable resizing of a #GHashTable.
</para>
<para>
This should be used if you need to make a lot of changes to a #GHashTable
at once, as it reduces the number of times that the #GHashTable is rebuilt.
You should call g_hash_table_thaw() after updating the #GHashTable to
enable resizing again.
This function is deprecated and will be removed in the next major
release of GLib. It does nothing.
</para>
@hash_table: a #GHashTable.
@hash_table:
<!-- ##### FUNCTION g_hash_table_thaw ##### -->
<para>
Enables resizing of a #GHashTable.
This function is deprecated and will be removed in the next major
release of GLib. It does nothing.
</para>
@hash_table: a #GHashTable.
@hash_table:
<!-- ##### FUNCTION g_hash_table_destroy ##### -->

1
docs/reference/glib/tmpl/macros_misc.sgml
View File

@@ -66,7 +66,6 @@ only one statement is expected by the compiler.
Portable way to copy <type>va_list</type> variables.
</para>
<!-- # Unused Parameters # -->
@ap1: the <type>va_list</type> variable to place a copy of @ap2 in.
@ap2: a <type>va_list</type>.

38
docs/reference/glib/tmpl/misc_utils.sgml
View File

@@ -91,8 +91,14 @@ The returned string should be freed when no longer needed.
<!-- ##### FUNCTION g_basename ##### -->
<para>
Gets the name of the file without any leading directory components.
It returns a pointer into the given file name string.
This function is deprecated and will be removed in the next major
release of GLib. Use g_path_get_basename() instead.
</para>
<para>
Gets the name of the file without any leading
directory components. It returns a pointer into the given file name
string.
</para>
@file_name: the name of the file.
@@ -100,6 +106,11 @@ It returns a pointer into the given file name string.
<!-- ##### FUNCTION g_dirname ##### -->
<para>
This function is deprecated and will be removed in the next major
release of GLib. Use g_path_get_dirname() instead.
</para>
<para>
Gets the directory components of a file name.
If the file name has no directory components "." is returned.
@@ -134,20 +145,31 @@ path it returns NULL.
<!-- ##### FUNCTION g_path_get_dirname ##### -->
<para>
Gets the directory components of a file name. If the file name has no
directory components "." is returned. The returned string should be
freed when no longer needed.
</para>
@file_name:
@Returns:
@file_name: the name of the file.
@Returns: the directory components of the file.
<!-- ##### FUNCTION g_path_get_basename ##### -->
<para>
Gets the name of the file without any leading directory components.
The returned string should be freed when no longer needed.
</para>
@file_name:
@Returns:
<note>
<para>
This function allocates new memory for the returned string. This is
different from the old g_basename() function, which returned a pointer
into the argument.
</para>
</note>
@file_name: the name of the file.
@Returns: the name of the file without any leading directory components.
<!-- ##### FUNCTION g_filename_to_utf8 ##### -->

6
docs/reference/glib/tmpl/scanner.sgml
View File

@@ -308,7 +308,8 @@ Adds a symbol to the given scope.
<!-- ##### FUNCTION 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:
@@ -316,7 +317,8 @@ Adds a symbol to the given scope.
<!-- ##### FUNCTION 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: