aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorChong Yidong2008-08-11 21:38:17 +0000
committerChong Yidong2008-08-11 21:38:17 +0000
commit6957495d278a4934ecf100f8fb5560cac0cfeb8a (patch)
treeb8a68e0edc9f004d1b5ba04854fc269366a6b647
parent14e10fb314f34f7c2c8dea912cd8632d2576cdbe (diff)
downloademacs-6957495d278a4934ecf100f8fb5560cac0cfeb8a.tar.gz
emacs-6957495d278a4934ecf100f8fb5560cac0cfeb8a.zip
(beginning-of-defun): Doc fix.
-rw-r--r--lisp/emacs-lisp/lisp.el37
1 files changed, 21 insertions, 16 deletions
diff --git a/lisp/emacs-lisp/lisp.el b/lisp/emacs-lisp/lisp.el
index 3fe2fd1813c..da1b53cc06e 100644
--- a/lisp/emacs-lisp/lisp.el
+++ b/lisp/emacs-lisp/lisp.el
@@ -181,22 +181,27 @@ the body of the defun.")
181 181
182(defun beginning-of-defun (&optional arg) 182(defun beginning-of-defun (&optional arg)
183 "Move backward to the beginning of a defun. 183 "Move backward to the beginning of a defun.
184With ARG, do it that many times. Negative arg -N 184With ARG, do it that many times. Negative ARG means move forward
185means move forward to Nth following beginning of defun. 185to the ARGth following beginning of defun.
186Returns t unless search stops due to beginning or end of buffer. 186
187 187If search is successful, return t; point ends up at the beginning
188If variable `beginning-of-defun-function' is non-nil, its value 188of the line where the search succeeded. Otherwise, return nil.
189is called as a function to find the defun's beginning. 189
190 190When `open-paren-in-column-0-is-defun-start' is non-nil, a defun
191Normally a defun is assumed to start where there is a char with 191is assumed to start where there is a char with open-parenthesis
192open-parenthesis syntax at the beginning of a line. If 192syntax at the beginning of a line. If `defun-prompt-regexp' is
193`defun-prompt-regexp' is non-nil, then a string which matches 193non-nil, then a string which matches that regexp may also precede
194that regexp may precede the open-parenthesis, and point ends up 194the open-parenthesis. If `defun-prompt-regexp' and
195at the beginning of the line. 195`open-paren-in-column-0-is-defun-start' are both nil, this
196 196function instead finds an open-paren at the outermost level.
197If `defun-prompt-regexp' and `open-paren-in-column-0-is-defun-start' 197
198are both nil, the function instead finds an open-paren at the 198If the variable `beginning-of-defun-function' is non-nil, its
199outermost level." 199value is called as a function, with argument ARG, to find the
200defun's beginning.
201
202Regardless of the values of `defun-prompt-regexp' and
203`beginning-of-defun-function', point always moves to the
204beginning of the line whenever the search is successful."
200 (interactive "p") 205 (interactive "p")
201 (or (not (eq this-command 'beginning-of-defun)) 206 (or (not (eq this-command 'beginning-of-defun))
202 (eq last-command 'beginning-of-defun) 207 (eq last-command 'beginning-of-defun)