Mercurial > hg > xemacs-beta
diff 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 |
line wrap: on
line diff
--- a/lisp/lisp-mode.el Thu Jan 28 02:48:45 2010 -0600 +++ b/lisp/lisp-mode.el Thu Jan 28 03:32:18 2010 -0600 @@ -863,12 +863,24 @@ (defvar lisp-body-indent 2 "Number of columns to indent the second line of a `(def...)' form.") +;; Calculate the appropriate indentation for a special form (e.g. defun) or +;; a macro that behaves like a special form (e.g. with-temp-buffer). +;; Return value is as for `calculate-lisp-indent' (q.v.). +;; ;; COUNT is the number of "distinguished" forms (e.g. arguments before the -;; "body", in a macro taking a body as its last argument). STATE is -;; #### DOCUMENT-ME. INDENT-POINT is #### DOCUMENT-ME. NORMAL-INDENT -;; is the amount of "full" indentation used for arguments that aren't given -;; some special indentation (usually less), and normally it lines up with -;; the first word after the function name. forms are indented as follows: +;; "body", in a macro taking a body as its last argument). +;; +;; INDENT-POINT is usually the value of (point) at the beginning of the +;; line containing the form to be indented. +;; +;; STATE is the result of calling (parse-partial-sexp (point) INDENT-POINT) +;; when (point) is sitting on (i.e. just before) the outermost containing +;; left paren for the form to be indented. +;; +;; NORMAL-INDENT is the amount of "full" indentation used for arguments +;; that aren't given some special indentation (usually less), and normally +;; it lines up with the first word after the function name. forms are +;; indented as follows: ;; ;; -- The first and second distinguished forms are given 2 times body indent ;; (determined by `lisp-body-indent')