Mercurial > emacs
changeset 74724:80f7458bbb20
(syntax-ppss-toplevel-pos): Improve docstring.
| author | Stefan Monnier <monnier@iro.umontreal.ca> |
|---|---|
| date | Mon, 18 Dec 2006 14:02:30 +0000 |
| parents | c6c8c744f694 |
| children | 7bf99b0f8330 |
| files | lisp/emacs-lisp/syntax.el |
| diffstat | 1 files changed, 6 insertions(+), 4 deletions(-) [+] |
line wrap: on
line diff
--- a/lisp/emacs-lisp/syntax.el Mon Dec 18 11:53:08 2006 +0000 +++ b/lisp/emacs-lisp/syntax.el Mon Dec 18 14:02:30 2006 +0000 @@ -53,10 +53,12 @@ (nth 0 ppss)) (defun syntax-ppss-toplevel-pos (ppss) - "Return the last preceding position at toplevel. -\"At toplevel\" means that it is outside of any syntactic entity: -outside of any parentheses, or comments, or strings. -Returns nil iff PPSS itself corresponds to a toplevel position." + "Get the latest syntactically outermost position found in a syntactic scan. +PPSS is a scan state, as returned by `partial-parse-sexp' or `syntax-ppss'. +An \"outermost position\" means one that it is outside of any syntactic entity: +outside of any parentheses, comments, or strings encountered in the scan. +If no such position is recorded in PPSS (because the end of the scan was +itself at the outermost level), return nil." (or (car (nth 9 ppss)) (nth 8 ppss)))