summaryrefslogtreecommitdiff
path: root/parser
diff options
context:
space:
mode:
authorMarc Vertes <mvertes@free.fr>2023-08-24 11:00:28 +0200
committerMarc Vertes <mvertes@free.fr>2023-08-24 11:00:28 +0200
commitec8eb9defc7cd68fcd3afa0058773bcbc33ecd63 (patch)
treeb8742524f18e6703006c99c1909e20b5c4cd586c /parser
parent8080afb5a9e38116646d69155365fb6bd09ea40c (diff)
doc: add diagrams to scanner and parser readmes
Diffstat (limited to 'parser')
-rw-r--r--parser/README.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/parser/README.md b/parser/README.md
index 19d8778..2a25fc8 100644
--- a/parser/README.md
+++ b/parser/README.md
@@ -5,6 +5,18 @@ returns a node representing a syntax tree. A node is an object
containing a kind, the corresponding token and the ordered references to
descendent nodes.
+```mermaid
+graph LR
+s[ ] --> |source| a(scanner)
+--> |tokens| b(parser)
+--> |AST| c[ ]
+subgraph parser
+ b
+end
+style s height:0px;
+style c height:0px;
+```
+
A goal is to make the parser generic enough so it can generate syntax
trees for most of existing programming languages (no claim of generality
yet), provided a small set of generating rules per language, and a small