Skip to content

Commit 7a6a436

Browse files
authored
fixes simonmar#146
Documents that monad wrappers expects you to define an `alexEOF` variable.
1 parent 11042db commit 7a6a436

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

doc/alex.xml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1408,6 +1408,13 @@ alexError :: String -> Alex a
14081408
alexGetStartCode :: Alex Int
14091409
alexSetStartCode :: Int -> Alex ()</programlisting>
14101410

1411+
<para>The <literal>monad</literal> wrapper expects that you
1412+
define a variable <literal>alexEOF</literal> with the following
1413+
signature:</para>
1414+
1415+
<programlisting>alexEOF :: Alex result</programlisting>
1416+
1417+
14111418
<para>To invoke a scanner under the <literal>monad</literal>
14121419
wrapper, use <literal>alexMonadScan</literal>:</para>
14131420

0 commit comments

Comments
 (0)