From: Richard M. Stallman <rms@gnu.org>
Date: Sun, 25 Nov 2001 10:57:45 +0000 (+0000)
Subject: Clarify behavior of forward-comment.
X-Git-Tag: ttn-vms-21-2-B4~18202
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=47eda1bda927d418f99cea9b50361daae99797e5;p=emacs.git

Clarify behavior of forward-comment.
---

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