From 0ef2f4c855abd6a07c175f4ef278569ff8fe0883 Mon Sep 17 00:00:00 2001
From: brettlangdon <brett@blangdon.com>
Date: Sat, 20 Jun 2015 16:41:57 -0400
Subject: [PATCH] add comments to scanner.go

---
 scanner.go | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/scanner.go b/scanner.go
index 9b6b21e..89e0372 100644
--- a/scanner.go
+++ b/scanner.go
@@ -35,6 +35,8 @@ func isInclude(str string) bool {
 	return strings.ToLower(str) == "include"
 }
 
+// Scanner struct used to hold data necessary for parsing tokens
+// from the input reader
 type Scanner struct {
 	curLine int
 	curCol  int
@@ -44,6 +46,7 @@ type Scanner struct {
 	reader  *bufio.Reader
 }
 
+// NewScanner creates and initializes a new *Scanner from an io.Readerx
 func NewScanner(reader io.Reader) *Scanner {
 	scanner := &Scanner{
 		reader:  bufio.NewReader(reader),
@@ -148,6 +151,7 @@ func (scanner *Scanner) skipWhitespace() {
 	}
 }
 
+// NextToken will read in the next valid token from the Scanner
 func (scanner *Scanner) NextToken() token.Token {
 	if isWhitespace(scanner.curCh) {
 		scanner.skipWhitespace()