]> git.eshelyaron.com Git - emacs.git/commitdiff
Clarify the documentation of nested comments.
authorAlan Mackenzie <acm@muc.de>
Thu, 10 Mar 2016 11:42:32 +0000 (11:42 +0000)
committerAlan Mackenzie <acm@muc.de>
Thu, 10 Mar 2016 11:42:32 +0000 (11:42 +0000)
* doc/lispref/syntax.texi (Syntax Flags): State that only comments of the same
style are recognized inside nestable comments.
(Low-Level Parsing): Clarify that parsing will stop after the start or end of
UNNESTED comments.

doc/lispref/syntax.texi

index 19782d0fbde805f4feb590226d756cd338c99cfc..d5a7eba13fe774a634f4240cf279e5393e244147 100644 (file)
@@ -331,10 +331,10 @@ alternative ``c'' comment style.  For a two-character comment
 delimiter, @samp{c} on either character makes it of style ``c''.
 
 @item
-@samp{n} on a comment delimiter character specifies
-that this kind of comment can be nested.  For a two-character
-comment delimiter, @samp{n} on either character makes it
-nestable.
+@samp{n} on a comment delimiter character specifies that this kind of
+comment can be nested.  Inside such a comment, only comments of the
+same style will be recognized.  For a two-character comment delimiter,
+@samp{n} on either character makes it nestable.
 
 @cindex comment style
 Emacs supports several comment styles simultaneously in any one syntax
@@ -899,9 +899,10 @@ The depth starts at 0, or at whatever is given in @var{state}.
 If the fourth argument @var{stop-before} is non-@code{nil}, parsing
 stops when it comes to any character that starts a sexp.  If
 @var{stop-comment} is non-@code{nil}, parsing stops when it comes to the
-start of a comment.  If @var{stop-comment} is the symbol
-@code{syntax-table}, parsing stops after the start of a comment or a
-string, or the end of a comment or a string, whichever comes first.
+start of an unnested comment.  If @var{stop-comment} is the symbol
+@code{syntax-table}, parsing stops after the start of an unnested
+comment or a string, or the end of an unnested comment or a string,
+whichever comes first.
 
 If @var{state} is @code{nil}, @var{start} is assumed to be at the top
 level of parenthesis structure, such as the beginning of a function