Parser options are now properties of a Parser instance

Author: Gozala

lib/jsdocs/js-doc.js

@@ -89,21 +89,20 @@ function getSourceFiles(paths, extensions, exclude, depth) {
  * @param {Path[]} files                Files to be parsed
  */
 function parseSourceFiles(options) {
-    var parser = new Parser(options);
+    var parser = Parser(options);
         files = options.files, l = files.length;
     while (l--) {
         var file = files[l];
-        var path = file.absolute();
         console.debug("Parsing file: " + file.toString());
         try {
-            var src = file.read().toString();
+            var source = file.read().toString();
         } catch(e) {
             console.warn("Can't read source file '" + file.toString() + "': " + e.message);
             continue;
         }
-        var tr = new TokenReader();
-        var ts = new TokenStream(tr.tokenize(new TextStream(src)));
-        parser.parse(ts, path);
+        var tokenReader = new TokenReader();
+        var ts = new TokenStream(tokenReader.tokenize(new TextStream(source)));
+        parser.parse(ts, file.toString());
     }
     var symbols = parser.symbols;
     parser.finish();

lib/jsdocs/parser.js

@@ -11,17 +11,49 @@ var console = require("system").log;
     @requires DocComment
 */
 var Parser = exports.Parser = function Parser(options) {
-    this.conf = options;
-    this.init();
+    if (!(this instanceof Parser)) return new Parser(options);
+    for (var key in options) this[key] = options[key];
+    this.symbols = new SymbolSet(this);
+    this.walker = new Walker(this);
 };
 Parser.prototype = {
     constructor: Parser,
-    init: function init() {
-        this.symbols = new SymbolSet(this);
-        this.walker = new Walker(this);
-    },
+    /**
+     * Identify secure modules while parseing source code
+     * @type {Boolean}
+     */
+    securemodules: true,
+    /**
+     * If true will include all functions, even anonymus ones.
+     * @type {Boolean}
+     */
+    ignoreAnonymous: true,
+    /**
+     * Treat properties starting with underscore as privates.
+     * @type {Boolean}
+     */
+    treatUnderscoredAsPrivate: true,
+    /**
+     * Include symbols tagged as private, underscored and inner symbols.
+     * @type {Boolean}
+     */
+    includePrivates: true,
+    /**
+     * Dump detail on found symbols
+     * @type {Boolean}
+     */
+    explain: false,
+    /**
+     * Include all functions, even undocumented ones.
+     * @type {Boolean}
+     */
+    allfunctions: false,
+    /**
+     * Ignore all code, only document comments with @name tags.
+     * @type {Boolean}
+     */
+    ignoreCode: false,
     addSymbol: function addSymbol(symbol) {
-        var conf = this.conf;
         var rename = this.rename;
         if (rename) {
             for (var name in rename) {
@@ -33,7 +65,7 @@ Parser.prototype = {
                 }
             }
         }
-        if (conf.securemodules) {
+        if (this.securemodules) {
             if (typeof this.secureModules == "undefined") this.secureModules = {};
             if (/^exports\./.test(symbol.alias)) {
                 symbol.srcFile.match(/(^|[\\\/])([^\\\/]+)\.js/i);
@@ -62,27 +94,26 @@ Parser.prototype = {
         // if a symbol alias is documented more than once the last one with the user docs wins
         var symbols = this.symbols;
         if (symbols.hasSymbol(symbol.alias)) {
-             var oldSymbol = symbols.getSymbol(symbol.alias);
+            var oldSymbol = symbols.getSymbol(symbol.alias);
             if (oldSymbol.comment.isUserComment) {
                 if (symbol.comment.isUserComment) { // old and new are both documented
                     console.warn("The symbol '" + symbol.alias + "' is documented more than once.");
-                }
-                else { // old is documented but new isn't
+                } else { // old is documented but new isn't
                     return;
                 }
             }
         }
 
         // we don't document anonymous things
-        if (conf.ignoreAnonymous && symbol.name.match(/\$anonymous\b/)) return;
+        if (this.ignoreAnonymous && symbol.name.match(/\$anonymous\b/)) return;
 
         // uderscored things may be treated as if they were marked private, this cascades
-        if (conf.treatUnderscoredAsPrivate && symbol.name.match(/[.#-]_[^.#-]+$/)) {
+        if (this.treatUnderscoredAsPrivate && symbol.name.match(/[.#-]_[^.#-]+$/)) {
             if (!symbol.comment.getTag("public").length > 0) symbol.isPrivate = true;
         }
 
         // -p flag is required to document private things
-        if (!conf.includePrivates && symbol.isPrivate) return; // issue #161 fixed by mcbain.asm
+        if (!this.includePrivates && symbol.isPrivate) return; // issue #161 fixed by mcbain.asm
 
         // ignored things are not documented, this doesn't cascade
         if (symbol.isIgnored) return;
@@ -101,7 +132,7 @@ Parser.prototype = {
         symbolsSet.relate();
 
         // make a litle report about what was found
-        if (this.conf.explain) {
+        if (this.explain) {
             var symbols = symbolsSet.toArray();
             var srcFile = "";
             for (var i = 0, l = symbols.length; i < l; i++) {
@@ -115,14 +146,15 @@ Parser.prototype = {
             print("-------------------\n");
         }
     },
+    /**
+     * Parses specified source. Optionally specidies source uri.
+     */
     parse: function pase(/**TokenStream*/ts, /**String*/srcPath) {
-        var conf = this.conf;
         var symbols = this.symbols;
         // TODO: Check why we need to add this to the calsses
         Symbol.srcFile = (srcPath || "");
         DocComment.shared = ""; // shared comments don't cross file boundaries
 
-        if (!this.walker) this.init();
         this.walker.walk(ts); // adds to our symbols
 
         // filter symbols by option
@@ -132,7 +164,7 @@ Parser.prototype = {
             if (symbol.is("FILE") || symbol.is("GLOBAL")) {
                 continue;
             }
-            else if (!conf.allfunctions && !symbol.comment.isUserComment) {
+            else if (!this.allfunctions && !symbol.comment.isUserComment) {
                 symbols.deleteSymbol(symbol.alias);
             }
             if (/#$/.test(symbol.alias)) { // we don't document prototypes

lib/jsdocs/walker.js

@@ -7,10 +7,8 @@ var console = require("system").log;
 var Walker = exports.Walker = function Walker(/**Parser*/parser, /**TokenStream*/ts) {
     this.parser = parser;
     this.init();
-    if (typeof ts != "undefined") {
-            this.walk(ts);
-    }
-}
+    if (typeof ts != "undefined") this.walk(ts);
+};
 Walker.prototype = {
     constructor: Walker,
     init: function() {
@@ -83,9 +81,9 @@ Walker.prototype = {
             } else if (doc.meta) { // it's a meta doclet
                 if (doc.meta == "@+") DocComment.shared = doc.src;
                 else if (doc.meta == "@-") DocComment.shared = "";
-                else if (doc.meta == "nocode+") Parser.conf.ignoreCode = true;
-                else if (doc.meta == "nocode-") Parser.conf.ignoreCode = JSDOC.opt.n;
-                else throw "Unrecognized meta comment: "+doc.meta;
+                else if (doc.meta == "nocode+") this.parser.ignoreCode = true;
+                else if (doc.meta == "nocode-") this.parser.ignoreCode = false;
+                else throw "Unrecognized meta comment: " + doc.meta;
                 this.lastDoc = null;
                 return true;
             } else if (doc.getTag("overview").length > 0) { // it's a file overview
@@ -97,7 +95,7 @@ Walker.prototype = {
                 this.lastDoc = doc;
                 return false;
             }
-        } else if (!this.parser.conf.ignoreCode) { // it's code
+        } else if (!this.parser.ignoreCode) { // it's code
             if (this.token.is("NAME")) { // it's the name of something
                 var symbol;
                 var name = this.token.data;