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