JSDOC/TokenReader.js
authorAlan Knowles <alan@akbkhome.com>
Tue, 6 Jul 2010 09:55:23 +0000 (17:55 +0800)
committerAlan Knowles <alan@akbkhome.com>
Tue, 6 Jul 2010 09:55:23 +0000 (17:55 +0800)
JSDOC/TokenReader.js

index 10f6f8c..58859eb 100644 (file)
@@ -27,7 +27,12 @@ TokenReader = XObject.define(
 
         /**
          * tokenize a stream
-         *  @return {Array} of tokens
+         * @return {Array} of tokens
+         * 
+         * ts = new TextStream();
+         * tr = TokenReader({ keepComments : true, keepWhite : true });
+         * tr.tokenize(ts)
+         * 
          */
             @type {JSDOC.Token[]}