saxophonit: Add missing documentation.
authorJean-Christophe Beaupré <jcbrinfo@users.noreply.github.com>
Fri, 28 Nov 2014 17:30:17 +0000 (12:30 -0500)
committerJean-Christophe Beaupré <jcbrinfo@users.noreply.github.com>
Fri, 28 Nov 2014 19:06:59 +0000 (14:06 -0500)
Signed-off-by: Jean-Christophe Beaupré <jcbrinfo@users.noreply.github.com>

lib/saxophonit/lexer.nit
lib/saxophonit/reader_model.nit

index 4f77ab8..07277ef 100644 (file)
@@ -20,8 +20,14 @@ import reader_model
 # They both foward the cursor to the next byte on success, but only `expect`
 # functions fire a fatal error on mismatch.
 class XophonLexer
+
+       # The model.
        var reader_model: XophonReaderModel
+
+       # The input to read from.
        var input: IStream is writable
+
+       # Alias to `reader_model.locator`.
        private var locator: SAXLocatorImpl is noinit
 
        init do
index ff2299a..a5e1365 100644 (file)
@@ -36,6 +36,7 @@ class XophonReaderModel
        # “Namespaces in XML”.
        private var qname_re: Regex = "^[^:]+(:[^:]+)?$".to_re
 
+       # The locator that is used to indicate the current location.
        var locator: nullable SAXLocatorImpl = null is writable