changeset 61801:063380bc7803

(Syntax Table Internals): Elaborate documentation of syntax-after and syntax-class.
author Eli Zaretskii <eliz@gnu.org>
date Sun, 24 Apr 2005 15:04:35 +0000
parents 0b99c3114499
children 771d6fce67b1
files lispref/syntax.texi
diffstat 1 files changed, 16 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- a/lispref/syntax.texi	Sun Apr 24 14:50:42 2005 +0000
+++ b/lispref/syntax.texi	Sun Apr 24 15:04:35 2005 +0000
@@ -940,11 +940,25 @@
 @defun syntax-after pos
 This function returns the syntax code of the character in the buffer
 after position @var{pos}, taking account of syntax properties as well
-as the syntax table.
+as the syntax table.  If @var{pos} is outside the buffer's accessible
+portion (@pxref{Narrowing, accessible portion}), this function returns
+@code{nil}.
 @end defun
 
 @defun syntax-class syntax
-This function returns the syntax class of a syntax code.
+This function returns the syntax class of the syntax code
+@var{syntax}.  (It masks off the high 16 bits that hold the flags
+encoded in the syntax descriptor.)  If @var{syntax} is @code{nil}, it
+returns @code{nil}; this is so evaluating the expression
+
+@example
+(syntax-class (syntax-after pos))
+@end example
+
+@noindent
+where @code{pos} is outside the buffer's accessible portion, will
+yield @code{nil} without throwing errors or producing wrong syntax
+class codes.
 @end defun
 
 @node Categories