comparison lisp/syntax.el @ 4945:99e465e2da2e

(main branch) Update make-syntax-table doc -------------------- ChangeLog entries follow: -------------------- lisp/ChangeLog addition: 2010-01-24 Ben Wing <ben@xemacs.org> * syntax.el: * syntax.el (make-syntax-table): Expand doc string.
author Ben Wing <ben@xemacs.org>
date Sun, 24 Jan 2010 00:26:10 -0600
parents fd36a980d701
children 308d34e9f07d
comparison
equal deleted inserted replaced
4944:6af9b2e79451 4945:99e465e2da2e
1 ;; syntax.el --- Syntax-table hacking stuff, moved from syntax.c 1 ;; syntax.el --- Syntax-table hacking stuff, moved from syntax.c
2 2
3 ;; Copyright (C) 1993, 1997 Free Software Foundation, Inc. 3 ;; Copyright (C) 1993, 1997 Free Software Foundation, Inc.
4 ;; Copyright (C) 1995 Sun Microsystems. 4 ;; Copyright (C) 1995 Sun Microsystems.
5 ;; Copyright (C) 2005 Ben Wing. 5 ;; Copyright (C) 2005, 2010 Ben Wing.
6 6
7 ;; This file is part of XEmacs. 7 ;; This file is part of XEmacs.
8 8
9 ;; XEmacs is free software; you can redistribute it and/or modify it 9 ;; XEmacs is free software; you can redistribute it and/or modify it
10 ;; under the terms of the GNU General Public License as published by 10 ;; under the terms of the GNU General Public License as published by
34 34
35 ;;; Code: 35 ;;; Code:
36 36
37 (defun make-syntax-table (&optional oldtable) 37 (defun make-syntax-table (&optional oldtable)
38 "Return a new syntax table. 38 "Return a new syntax table.
39 It inherits all characters from the standard syntax table." 39
40 It inherits all characters from the standard syntax table.
41
42 A syntax table is a char table of type `syntax' (see `make-char-table').
43 The valid values are integers (intended to be syntax codes as generated by
44 `syntax-string-to-code'), and the default result given by `get-char-table'
45 is the syntax code for `word'. (Note: In 21.4 and prior, it was the code
46 for `inherit'.)
47
48 To modify a syntax table, you should normally use `modify-syntax-entry'
49 rather than directly modify the table with `put-char-table'.
50
51 See `modify-syntax-entry' for a description of the character codes used
52 to indicate the various syntax classes."
40 (make-char-table 'syntax)) 53 (make-char-table 'syntax))
41 54
42 (defun syntax-after (pos) 55 (defun syntax-after (pos)
43 "Return the raw syntax of the char after POS. 56 "Return the raw syntax of the char after POS.
44 If POS is outside the buffer's accessible portion, return nil." 57 If POS is outside the buffer's accessible portion, return nil."