aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRichard M. Stallman2001-11-25 10:57:45 +0000
committerRichard M. Stallman2001-11-25 10:57:45 +0000
commit47eda1bda927d418f99cea9b50361daae99797e5 (patch)
treef1d463e49015ab42d551bf7bfce0710a1ec9a876
parent3de3f07bc4083af73420566264809af34dd06240 (diff)
downloademacs-47eda1bda927d418f99cea9b50361daae99797e5.tar.gz
emacs-47eda1bda927d418f99cea9b50361daae99797e5.zip
Clarify behavior of forward-comment.
-rw-r--r--lispref/syntax.texi16
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
769one comment or several comments. 769one comment or several comments.
770 770
771@defun forward-comment count 771@defun forward-comment count
772This function moves point forward across @var{count} comments (backward, 772This function moves point forward across @var{count} complete comments
773if @var{count} is negative). If it finds anything other than a comment 773(that is, including the starting delimiter and the terminating
774or whitespace, it stops, leaving point at the place where it stopped. 774delimiter if any). It moves backward if @var{count} is negative. If
775It also stops after satisfying @var{count}. 775it encounters anything other than a comment or whitespace, it stops,
776leaving point at the place where it stopped. This includes (for
777instance) finding the end of a comment when moving forward and
778expecting the beginning of one. The function also stops immediately
779after moving over the specified number of complete comments.
780
781This function cannot tell whether the ``comments'' it traverses are
782embedded within a string. If they look like comments, it treats them
783as comments.
776@end defun 784@end defun
777 785
778To move forward over all comments and whitespace following point, use 786To move forward over all comments and whitespace following point, use