diff options
| author | Chong Yidong | 2008-08-11 21:38:17 +0000 |
|---|---|---|
| committer | Chong Yidong | 2008-08-11 21:38:17 +0000 |
| commit | 6957495d278a4934ecf100f8fb5560cac0cfeb8a (patch) | |
| tree | b8a68e0edc9f004d1b5ba04854fc269366a6b647 | |
| parent | 14e10fb314f34f7c2c8dea912cd8632d2576cdbe (diff) | |
| download | emacs-6957495d278a4934ecf100f8fb5560cac0cfeb8a.tar.gz emacs-6957495d278a4934ecf100f8fb5560cac0cfeb8a.zip | |
(beginning-of-defun): Doc fix.
| -rw-r--r-- | lisp/emacs-lisp/lisp.el | 37 |
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. |
| 184 | With ARG, do it that many times. Negative arg -N | 184 | With ARG, do it that many times. Negative ARG means move forward |
| 185 | means move forward to Nth following beginning of defun. | 185 | to the ARGth following beginning of defun. |
| 186 | Returns t unless search stops due to beginning or end of buffer. | 186 | |
| 187 | 187 | If search is successful, return t; point ends up at the beginning | |
| 188 | If variable `beginning-of-defun-function' is non-nil, its value | 188 | of the line where the search succeeded. Otherwise, return nil. |
| 189 | is called as a function to find the defun's beginning. | 189 | |
| 190 | 190 | When `open-paren-in-column-0-is-defun-start' is non-nil, a defun | |
| 191 | Normally a defun is assumed to start where there is a char with | 191 | is assumed to start where there is a char with open-parenthesis |
| 192 | open-parenthesis syntax at the beginning of a line. If | 192 | syntax at the beginning of a line. If `defun-prompt-regexp' is |
| 193 | `defun-prompt-regexp' is non-nil, then a string which matches | 193 | non-nil, then a string which matches that regexp may also precede |
| 194 | that regexp may precede the open-parenthesis, and point ends up | 194 | the open-parenthesis. If `defun-prompt-regexp' and |
| 195 | at the beginning of the line. | 195 | `open-paren-in-column-0-is-defun-start' are both nil, this |
| 196 | 196 | function instead finds an open-paren at the outermost level. | |
| 197 | If `defun-prompt-regexp' and `open-paren-in-column-0-is-defun-start' | 197 | |
| 198 | are both nil, the function instead finds an open-paren at the | 198 | If the variable `beginning-of-defun-function' is non-nil, its |
| 199 | outermost level." | 199 | value is called as a function, with argument ARG, to find the |
| 200 | defun's beginning. | ||
| 201 | |||
| 202 | Regardless of the values of `defun-prompt-regexp' and | ||
| 203 | `beginning-of-defun-function', point always moves to the | ||
| 204 | beginning 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) |