]> git.saurik.com Git - bison.git/commitdiff
doc: fix documentation of YYERROR.
authorAkim Demaille <akim@lrde.epita.fr>
Mon, 2 Apr 2012 14:43:26 +0000 (16:43 +0200)
committerAkim Demaille <akim@lrde.epita.fr>
Wed, 4 Apr 2012 08:10:27 +0000 (10:10 +0200)
* doc/bison.texinfo (Table of Symbols): Fix the documentation
of YYERROR by copying that from "Action Features".

doc/bison.texinfo

index 76a7dbaee432c2c2b501bbb09672caf7b607ccbc..3212be915ad0d3d0640da6d2e456a51b400f3ac4 100644 (file)
@@ -9933,7 +9933,7 @@ Return immediately from the parser, indicating success.
 @end deffn
 
 @deffn {Statement} {return YYERROR;}
-Start error recovery without printing an error message.
+Start error recovery (without printing an error message).
 @xref{Error Recovery}.
 @end deffn
 
@@ -10911,10 +10911,11 @@ after a syntax error.  @xref{Error Recovery}.
 @end deffn
 
 @deffn {Macro} YYERROR
-Macro to pretend that a syntax error has just been detected: call
-@code{yyerror} and then perform normal error recovery if possible
-(@pxref{Error Recovery}), or (if recovery is impossible) make
-@code{yyparse} return 1.  @xref{Error Recovery}.
+Cause an immediate syntax error.  This statement initiates error
+recovery just as if the parser itself had detected an error; however, it
+does not call @code{yyerror}, and does not print any message.  If you
+want to print an error message, call @code{yyerror} explicitly before
+the @samp{YYERROR;} statement.  @xref{Error Recovery}.
 
 For Java parsers, this functionality is invoked using @code{return YYERROR;}
 instead.