From b6eb9a2e7d80808095af6c735c63f216d778ba1e Mon Sep 17 00:00:00 2001
From: Sebastian Wilhelmi <wilhelmi@ira.uka.de>
Date: Tue, 31 Oct 2000 14:55:23 +0000
Subject: [PATCH] This time the right fix.

2000-10-31  Sebastian Wilhelmi  <wilhelmi@ira.uka.de>

	* glib/tmpl/linked_lists_single.sgml: This time the right fix.

	* glib/tmpl/scanner.sgml, glib/tmpl/strings.sgml: Changed
	parameter names.

	* glib/tmpl/string_utils.sgml: Corrected the documentation of
	g_strescape and added those of g_strcompress.
---
 docs/reference/ChangeLog                      | 10 +++++++
 .../glib/tmpl/linked_lists_single.sgml        |  2 +-
 docs/reference/glib/tmpl/scanner.sgml         |  2 --
 docs/reference/glib/tmpl/string_utils.sgml    | 29 ++++++++++++-------
 docs/reference/glib/tmpl/strings.sgml         |  4 +--
 5 files changed, 31 insertions(+), 16 deletions(-)

diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog
index 35818faae..1eea12564 100644
--- a/docs/reference/ChangeLog
+++ b/docs/reference/ChangeLog
@@ -1,3 +1,13 @@
+2000-10-31  Sebastian Wilhelmi  <wilhelmi@ira.uka.de>
+
+	* glib/tmpl/linked_lists_single.sgml: This time the right fix.
+
+	* glib/tmpl/scanner.sgml, glib/tmpl/strings.sgml: Changed
+	parameter names.
+
+	* glib/tmpl/string_utils.sgml: Corrected the documentation of
+	g_strescape and added those of g_strcompress.
+
 2000-10-30  Sebastian Wilhelmi  <wilhelmi@ira.uka.de>
 
 	* glib/tmpl/limits.sgml: Added documentation for
diff --git a/docs/reference/glib/tmpl/linked_lists_single.sgml b/docs/reference/glib/tmpl/linked_lists_single.sgml
index 81fa7e537..3bb1a4e0d 100644
--- a/docs/reference/glib/tmpl/linked_lists_single.sgml
+++ b/docs/reference/glib/tmpl/linked_lists_single.sgml
@@ -195,7 +195,7 @@ self-contained list with one element.
 </para>
 
 @list: a #GSList.
-@llink: an element in the #GSList.
+@link: an element in the #GSList.
 @Returns: the new start of the #GSList, without the element.
 
 
diff --git a/docs/reference/glib/tmpl/scanner.sgml b/docs/reference/glib/tmpl/scanner.sgml
index 9ba7a3d4f..099924fe3 100644
--- a/docs/reference/glib/tmpl/scanner.sgml
+++ b/docs/reference/glib/tmpl/scanner.sgml
@@ -281,8 +281,6 @@ Adds a symbol to the given scope.
 @scope_id: 
 @func: 
 @user_data: 
-<!-- # Unused Parameters # -->
-@func_data: 
 
 
 <!-- ##### FUNCTION g_scanner_scope_lookup_symbol ##### -->
diff --git a/docs/reference/glib/tmpl/string_utils.sgml b/docs/reference/glib/tmpl/string_utils.sgml
index 4ec417c30..91582c816 100644
--- a/docs/reference/glib/tmpl/string_utils.sgml
+++ b/docs/reference/glib/tmpl/string_utils.sgml
@@ -282,24 +282,33 @@ The standard delimiters, used in #g_strdelimit.
 
 <!-- ##### FUNCTION g_strescape ##### -->
 <para>
-Escapes all backslash characters, '\' in a string, by inserting a second '\'.
+Escapes the special characters '\b', '\f', '\n', '\r', '\t', '\' and
+'&quot;' in the string @source by inserting a '\' before
+them. Additionally all characters in the range 0x01-0x1F (everything
+below SPACE) and in the range 0x80-0xFF (all non-ASCII chars) are
+replaced with a '\' followed by their octal representation. Characters
+supplied in @exceptions are not escaped.
 </para>
 
-@source: 
-@exceptions: 
-@Returns: a newly allocated copy of @string, with all backslash characters
-escaped using a second backslash.
-<!-- # Unused Parameters # -->
-@string: a string to escape the backslashes in.
+<para>
+g_strcompress() does the reverse conversion.
+</para>
+
+@source: a string to escape.
+@exceptions: a string of characters not to escape in @source.
+@Returns: a newly allocated copy of @source with certain
+characters escaped. See above.
 
 
 <!-- ##### FUNCTION g_strcompress ##### -->
 <para>
-
+Replaces all escaped characters with their one byte equivalent. It
+does the reverse conversion of g_strescape(). 
 </para>
 
-@source: 
-@Returns: 
+@source: a string to compress.
+@Returns: a newly allocated copy of @source with all escaped 
+character compressed.
 
 
 <!-- ##### FUNCTION g_strcanon ##### -->
diff --git a/docs/reference/glib/tmpl/strings.sgml b/docs/reference/glib/tmpl/strings.sgml
index 0949983b9..fd4408b5d 100644
--- a/docs/reference/glib/tmpl/strings.sgml
+++ b/docs/reference/glib/tmpl/strings.sgml
@@ -63,11 +63,9 @@ contents. It is rather like the standard strcpy() function, except that
 you do not have to worry about having enough space to copy the string.
 </para>
 
-@string: 
+@string: the destination #GString. Its current contents are destroyed.
 @rval: the source #GString.
 @Returns: the destination #GString.
-<!-- # Unused Parameters # -->
-@lval: the destination #GString. Its current contents are destroyed.
 
 
 <!-- ##### FUNCTION g_string_sprintf ##### -->