Mercurial > hg > xemacs-beta

diff src/chartab.c @ 4469:c661944aa259

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Fill out docstrings for #'translate-region, #'make-char-table. 2008-05-25 Aidan Kehoe <kehoea@parhasard.net> * chartab.c (Fmake_char_table): Document the default return values for the various char table types. * editfns.c (Ftranslate_region): Document why `generic' char tables are preferable to `char' char tables for this function.
author Aidan Kehoe <kehoea@parhasard.net>
date Sun, 25 May 2008 22:54:33 +0200
parents 1b6a5c6e012d
children 1d11ecca9cd0
line wrap: on
line diff
--- a/src/chartab.c	Sun May 25 21:11:35 2008 +0200
+++ b/src/chartab.c	Sun May 25 22:54:33 2008 +0200
@@ -566,25 +566,32 @@
 sorts of values.  The different char table types are
 
 `category'
-	Used for category tables, which specify the regexp categories
-	that a character is in.  The valid values are nil or a
-	bit vector of 95 elements.  Higher-level Lisp functions are
-	provided for working with category tables.  Currently categories
+	Used for category tables, which specify the regexp categories that a
+	character is in.  The valid values are nil or a bit vector of 95
+	elements, and values default to nil.  Higher-level Lisp functions
+	are provided for working with category tables.  Currently categories
 	and category tables only exist when Mule support is present.
 `char'
-	A generalized char table, for mapping from one character to
-	another.  Used for case tables, syntax matching tables,
-	`keyboard-translate-table', etc.  The valid values are characters.
+	A generalized char table, for mapping from one character to another.
+	Used for case tables, syntax matching tables,
+	`keyboard-translate-table', etc.  The valid values are characters,
+	and the default result given by `get-char-table' if a value hasn't
+	been set for a given character or for a range that includes it, is
+	?\x00.
 `generic'
-        An even more generalized char table, for mapping from a
-	character to anything.
+        An even more generalized char table, for mapping from a character to
+	anything. The default result given by `get-char-table' is nil.
 `display'
-	Used for display tables, which specify how a particular character
-	is to appear when displayed.  #### Not yet implemented.
+	Used for display tables, which specify how a particular character is
+	to appear when displayed.  #### Not yet implemented; currently, the
+	display table code uses generic char tables, and it's not clear that
+	implementing this char table type would be useful.
 `syntax'
 	Used for syntax tables, which specify the syntax of a particular
 	character.  Higher-level Lisp functions are provided for
-	working with syntax tables.  The valid values are integers.
+	working with syntax tables.  The valid values are integers, and the
+	default result given by `get-char-table' is the syntax code for
+	`inherit'.
 */
        (type))
 {