Mercurial > hg > xemacs-beta
comparison lisp/lisp-mode.el @ 4958:e4bbe5622a80
finish doc comment on `lisp-indent-specform'
-------------------- ChangeLog entries follow: --------------------
lisp/ChangeLog addition:
2010-01-28 Ben Wing <ben@xemacs.org>
* lisp-mode.el: Finish documenting `lisp-indent-specform',
on Mike Sperber's request.
author | Ben Wing <ben@xemacs.org> |
---|---|
date | Thu, 28 Jan 2010 03:32:18 -0600 |
parents | 46f0df723e09 |
children | 77907bd57d25 |
comparison
equal
deleted
inserted
replaced
4957:db2db229ee82 | 4958:e4bbe5622a80 |
---|---|
861 (+ 1 (current-column))))) | 861 (+ 1 (current-column))))) |
862 | 862 |
863 (defvar lisp-body-indent 2 | 863 (defvar lisp-body-indent 2 |
864 "Number of columns to indent the second line of a `(def...)' form.") | 864 "Number of columns to indent the second line of a `(def...)' form.") |
865 | 865 |
866 ;; Calculate the appropriate indentation for a special form (e.g. defun) or | |
867 ;; a macro that behaves like a special form (e.g. with-temp-buffer). | |
868 ;; Return value is as for `calculate-lisp-indent' (q.v.). | |
869 ;; | |
866 ;; COUNT is the number of "distinguished" forms (e.g. arguments before the | 870 ;; COUNT is the number of "distinguished" forms (e.g. arguments before the |
867 ;; "body", in a macro taking a body as its last argument). STATE is | 871 ;; "body", in a macro taking a body as its last argument). |
868 ;; #### DOCUMENT-ME. INDENT-POINT is #### DOCUMENT-ME. NORMAL-INDENT | 872 ;; |
869 ;; is the amount of "full" indentation used for arguments that aren't given | 873 ;; INDENT-POINT is usually the value of (point) at the beginning of the |
870 ;; some special indentation (usually less), and normally it lines up with | 874 ;; line containing the form to be indented. |
871 ;; the first word after the function name. forms are indented as follows: | 875 ;; |
876 ;; STATE is the result of calling (parse-partial-sexp (point) INDENT-POINT) | |
877 ;; when (point) is sitting on (i.e. just before) the outermost containing | |
878 ;; left paren for the form to be indented. | |
879 ;; | |
880 ;; NORMAL-INDENT is the amount of "full" indentation used for arguments | |
881 ;; that aren't given some special indentation (usually less), and normally | |
882 ;; it lines up with the first word after the function name. forms are | |
883 ;; indented as follows: | |
872 ;; | 884 ;; |
873 ;; -- The first and second distinguished forms are given 2 times body indent | 885 ;; -- The first and second distinguished forms are given 2 times body indent |
874 ;; (determined by `lisp-body-indent') | 886 ;; (determined by `lisp-body-indent') |
875 ;; -- Other distinguished forms are given normal indent | 887 ;; -- Other distinguished forms are given normal indent |
876 ;; -- The first nondistinguished form (the body, usually) is given body indent | 888 ;; -- The first nondistinguished form (the body, usually) is given body indent |