diff options
author | Richard M. Stallman <rms@gnu.org> | 2001-11-25 10:57:45 +0000 |
---|---|---|
committer | Richard M. Stallman <rms@gnu.org> | 2001-11-25 10:57:45 +0000 |
commit | c04ea66eaf4e5bd83f6c7d3b1a1b923a7cae79b6 (patch) | |
tree | 09bceb7f6921020f649ca8df1f28a54354f3d3a4 /lispref | |
parent | 9768e20850a4c8d232000e6e0edc1e3aafe084b6 (diff) | |
download | emacs-c04ea66eaf4e5bd83f6c7d3b1a1b923a7cae79b6.tar.gz |
Clarify behavior of forward-comment.
Diffstat (limited to 'lispref')
-rw-r--r-- | lispref/syntax.texi | 16 |
1 files changed, 12 insertions, 4 deletions
diff --git a/lispref/syntax.texi b/lispref/syntax.texi index e4c0384ccff..1135ff14d34 100644 --- a/lispref/syntax.texi +++ b/lispref/syntax.texi @@ -769,10 +769,18 @@ You can use @code{forward-comment} to move forward or backward over one comment or several comments. @defun forward-comment count -This function moves point forward across @var{count} comments (backward, -if @var{count} is negative). If it finds anything other than a comment -or whitespace, it stops, leaving point at the place where it stopped. -It also stops after satisfying @var{count}. +This function moves point forward across @var{count} complete comments +(that is, including the starting delimiter and the terminating +delimiter if any). It moves backward if @var{count} is negative. If +it encounters anything other than a comment or whitespace, it stops, +leaving point at the place where it stopped. This includes (for +instance) finding the end of a comment when moving forward and +expecting the beginning of one. The function also stops immediately +after moving over the specified number of complete comments. + +This function cannot tell whether the ``comments'' it traverses are +embedded within a string. If they look like comments, it treats them +as comments. @end defun To move forward over all comments and whitespace following point, use |