summaryrefslogtreecommitdiff
path: root/lex/parse.go
diff options
context:
space:
mode:
authorJoop Kiefte <ikojba@gmail.com>2018-12-31 23:52:21 +0100
committerJoop Kiefte <ikojba@gmail.com>2018-12-31 23:52:21 +0100
commit9bfc11edbfcbe24fbd462ff9501fb4e036e1ca9b (patch)
tree201dfd9191169c97a454a487ab0d588e5e8fb662 /lex/parse.go
parentd24f9890bb7b6253568235c2df4dc2c405badba8 (diff)
Add some comments
Diffstat (limited to 'lex/parse.go')
-rw-r--r--lex/parse.go4
1 files changed, 4 insertions, 0 deletions
diff --git a/lex/parse.go b/lex/parse.go
index ebd4dda..e105a22 100644
--- a/lex/parse.go
+++ b/lex/parse.go
@@ -6,6 +6,10 @@ import (
"strings"
)
+//Parse walks through the lex file, which contains the element of a screenplay,
+//optionally followed by a colon and space and the actual contents of that element.
+//Special elements exist: newpage, titlepage and metasection.
+//These elements trigger pdf creation instructions.
func Parse(file io.Reader) (out Screenplay) {
f := bufio.NewReader(file)
var err error