From d88d2713db0260599d37b414244ad8ad419dba77 Mon Sep 17 00:00:00 2001
From: Roland Conybeare <rconybeare@gmail.com>
Date: Tue, 27 Aug 2024 16:20:44 -0400
Subject: [PATCH] xo-reader: doc: ++ comments

---
 include/xo/reader/parserstatemachine.hpp | 3 +++
 include/xo/reader/progress_xs.hpp        | 9 ++++++++-
 src/reader/expect_expr_xs.cpp            | 2 --
 3 files changed, 11 insertions(+), 3 deletions(-)

diff --git a/include/xo/reader/parserstatemachine.hpp b/include/xo/reader/parserstatemachine.hpp
index 3ad71b13..e23cd262 100644
--- a/include/xo/reader/parserstatemachine.hpp
+++ b/include/xo/reader/parserstatemachine.hpp
@@ -50,6 +50,9 @@ namespace xo {
             exprstatestack * p_stack_;
             /** stack of environment frames, one for each enclosing lambda **/
             envframestack * p_env_stack_;
+            /** if non-null,  store next non-nested complete expressions in
+             *  *p_emit_expr
+             **/
             rp<Expression> * p_emit_expr_;
         };
     } /*namespace scm*/
diff --git a/include/xo/reader/progress_xs.hpp b/include/xo/reader/progress_xs.hpp
index b370a1f9..1c985ed3 100644
--- a/include/xo/reader/progress_xs.hpp
+++ b/include/xo/reader/progress_xs.hpp
@@ -11,7 +11,11 @@
 
 namespace xo {
     namespace scm {
-        /* represent an infix operator */
+        /** represent an infix operator.
+         *
+         *  See @ref progress_xs::assemble_expr() for translation
+         *  to Expression
+         **/
         enum class optype {
             invalid = -1,
 
@@ -26,6 +30,9 @@ namespace xo {
         extern const char *
         optype_descr(optype x);
 
+        /** report operator precedence.
+         *  lowest operator precedence is 1
+         **/
         extern int
         precedence(optype x);
 
diff --git a/src/reader/expect_expr_xs.cpp b/src/reader/expect_expr_xs.cpp
index c07c5d42..b4383f0b 100644
--- a/src/reader/expect_expr_xs.cpp
+++ b/src/reader/expect_expr_xs.cpp
@@ -92,8 +92,6 @@ namespace xo {
             constexpr bool c_debug_flag = true;
             scope log(XO_DEBUG(c_debug_flag));
 
-            //constexpr const char * self_name = "exprstate::on_leftparen";
-
             /* push lparen_0 to remember to look for subsequent rightparen. */
             sequence_xs::start(p_psm);
         }