sproutcore 0.9.13 → 0.9.14

data/jsdoc/app/main.js

@@ -0,0 +1,74 @@
+/**
+ * @version $Id: main.js 570 2008-04-07 23:54:50Z micmath $
+ */
+
+function main() {
+  IO.include("lib/JSDOC.js");
+  IO.includeDir("plugins/");
+  
+  if (JSDOC.opt.v) LOG.verbose = true;
+  if (JSDOC.opt.o) LOG.out = IO.open(JSDOC.opt.o);
+  
+  if (JSDOC.opt.T) {
+    LOG.inform("JsDoc Toolkit running in test mode at "+new Date()+".");
+    IO.include("frame/Testrun.js");
+    IO.include("test.js");
+  }
+  else {
+    LOG.inform("JsDoc Toolkit main() running at "+new Date()+".");
+    LOG.inform("With options: ");
+    for (var o in JSDOC.opt) {
+      LOG.inform("    "+o+": "+JSDOC.opt[o]);
+    }
+    
+    var jsdoc = new JSDOC.JsDoc();
+  
+    if (JSDOC.opt.Z) { // secret debugging option
+      LOG.warn("So you want to see the data structure, eh? This might hang if you have circular refs...");
+      IO.include("frame/Dumper.js");
+      var symbols = jsdoc.symbolSet.toArray();
+      for (var i = 0, l = symbols.length; i < l; i++) {
+        var symbol = symbols[i];
+        print("// symbol: " + symbol.alias);
+        print(symbol.serialize());
+      }
+    }
+    else {
+      var template = JSDOC.opt.t || System.getProperty("jsdoc.template.dir");
+
+      var handler = jsdoc.symbolSet.handler;
+      if (handler && handler.publish) {
+        handler.publish(jsdoc.symbolSet);
+      }
+      else {
+        if (typeof template != "undefined") {
+          try {
+            load(template+"/publish.js");
+            if (!publish) {
+              LOG.warn("No publish() function is defined in that template so nothing to do.");
+            }
+            else {
+              publish(jsdoc.symbolSet);
+            }
+          }
+          catch(e) {
+            LOG.warn("Sorry, that doesn't seem to be a valid template: "+template+"/publish.js : "+e);
+          }
+        }
+        else {
+          LOG.warn("No template or handlers given. Might as well read the usage notes.");
+          JSDOC.usage();
+        }
+      }
+    }
+  }
+  
+  if (LOG.warnings.length) {
+    print(LOG.warnings.length+" warning"+(LOG.warnings.length != 1? "s":"")+".");
+  }
+  
+  if (LOG.out) {
+    LOG.out.flush();
+    LOG.out.close();
+  }
+}

data/jsdoc/app/plugins/commentSrcJson.js

@@ -0,0 +1,19 @@
+JSDOC.PluginManager.registerPlugin(
+  "JSDOC.commentSrcJson",
+  {
+    onDocCommentSrc: function(commentSrc) {
+      var json;
+      if (/^\s*@json\b/.test(commentSrc)) {
+        commentSrc = commentSrc.replace("@json", "");
+        eval("json = "+commentSrc);
+        var tagged = "";
+        for (var i in json) {
+          var tag = json[i];
+          // todo handle cases where tag is an object
+          tagged += "@"+i+" "+tag+"\n";
+        }
+        return tagged;
+      }
+    }
+  }
+);

data/jsdoc/app/plugins/frameworkPrototype.js

@@ -0,0 +1,16 @@
+JSDOC.PluginManager.registerPlugin(
+  "JSDOC.frameworkPrototype",
+  {
+    onPrototypeClassCreate: function(classCreator) {
+      var desc = "";
+      if (classCreator.comment) {
+        desc = classCreator.comment;
+      }
+      var insert = desc+"/** @name "+classCreator.name+"\n@constructor\n@scope "+classCreator.name+".prototype */"
+      
+      insert = insert.replace(/\*\/\/\*\*/g, "\n");
+      /*DEBUG*///print("insert is "+insert);
+      classCreator.addComment.data = insert;
+    }
+  }
+);

data/jsdoc/app/plugins/functionCall.js

@@ -0,0 +1,10 @@
+JSDOC.PluginManager.registerPlugin(
+  "JSDOC.functionCall",
+  {
+    onFunctionCall: function(functionCall) {
+      if (functionCall.name == "dojo.define" && functionCall.arg1) {
+        functionCall.doc = "/** @lends "+eval(functionCall.arg1)+".prototype */";
+      }
+    }
+  }
+);

data/jsdoc/app/plugins/publishSrcHilite.js

@@ -0,0 +1,62 @@
+JSDOC.PluginManager.registerPlugin(
+  "JSDOC.publishSrcHilite",
+  {
+    onPublishSrc: function(src) {
+      if (src.path in JsHilite.cache) {
+        return; // already generated src code
+      }
+      else JsHilite.cache[src.path] = true;
+    
+      try {
+        var sourceCode = IO.readFile(src.path);
+      }
+      catch(e) {
+        print(e.message);
+        quit();
+      }
+
+      var hiliter = new JsHilite(sourceCode, src.charset);
+      src.hilited = hiliter.hilite();
+    }
+  }
+);
+
+function JsHilite(src, charset) {
+
+  var tr = new JSDOC.TokenReader();
+  
+  tr.keepComments = true;
+  tr.keepDocs = true;
+  tr.keepWhite = true;
+  
+  this.tokens = tr.tokenize(new JSDOC.TextStream(src));
+  
+  // TODO is redefining toString() the best way?
+  JSDOC.Token.prototype.toString = function() { 
+    return "<span class=\""+this.type+"\">"+this.data.replace(/</g, "&lt;")+"</span>";
+  }
+  
+  if (!charset) charset = "utf-8";
+  
+  this.header = '<html><head><meta http-equiv="content-type" content="text/html; charset='+charset+'"> '+
+  "<style>\n\
+  .KEYW {color: #933;}\n\
+  .COMM {color: #bbb; font-style: italic;}\n\
+  .NUMB {color: #393;}\n\
+  .STRN {color: #393;}\n\
+  .REGX {color: #339;}\n\
+  .line {border-right: 1px dotted #666; color: #666; font-style: normal;}\n\
+  </style></head><body><pre>";
+  this.footer = "</pre></body></html>";
+  this.showLinenumbers = true;
+}
+
+JsHilite.cache = {};
+
+JsHilite.prototype.hilite = function() {
+  var hilited = this.tokens.join("");
+  var line = 1;
+  if (this.showLinenumbers) hilited = hilited.replace(/(^|\n)/g, function(m){return m+"<span class='line'>"+((line<10)? " ":"")+((line<100)? " ":"")+(line++)+"</span> "});
+  
+  return this.header+hilited+this.footer;
+}

data/jsdoc/app/plugins/sproutcoreTags.js

@@ -0,0 +1,26 @@
+JSDOC.PluginManager.registerPlugin(
+  "JSDOC.sproutcoreTags",
+  {
+    onDocCommentTags: function(comment) {
+      for (var i = 0, l = comment.tags.length; i < l; i++) {
+        var title = comment.tags[i].title.toLowerCase();
+        var syn;
+        if ((syn = JSDOC.sproutcoreTags.synonyms["="+title])) {
+          comment.tags[i].title = syn;
+        }
+      }
+    }
+  }
+);
+
+new Namespace(
+  "JSDOC.sproutcoreTags",
+  function() {
+    JSDOC.sproutcoreTags.synonyms = {
+      "=method":    "function",
+      "=delegate":  "namespace",
+      "=property":  "field",
+      "=singleton": "class"
+    }
+  }
+);

data/jsdoc/app/plugins/symbolLink.js

@@ -0,0 +1,9 @@
+JSDOC.PluginManager.registerPlugin(
+  "JSDOC.symbolLink",
+  {
+    onSymbolLink: function(link) {
+      // modify link.linkPath
+      // or link.linkText here
+    }
+  }
+);

data/jsdoc/app/plugins/tagParamConfig.js

@@ -0,0 +1,31 @@
+JSDOC.PluginManager.registerPlugin(
+  "JSDOC.tagParamConfig",
+  {
+    onDocCommentTags: function(comment) {
+      var currentParam = null;
+      var tags = comment.tags;
+      for (var i = 0, l = tags.length; i < l; i++) {
+        
+        if (tags[i].title == "param") {
+          if (tags[i].name.indexOf(".") == -1) {
+            currentParam = i;
+          }
+        }
+        else if (tags[i].title == "config") {
+          tags[i].title = "param";
+          if (currentParam == null) {
+            tags[i].name = "arguments"+"."+tags[i].name;
+          }
+          else if (tags[i].name.indexOf(tags[currentParam].name+".") != 0) {
+            tags[i].name = tags[currentParam].name+"."+tags[i].name;
+          }
+          currentParam != null
+          //tags[currentParam].properties.push(tags[i]);
+        }
+        else {
+          currentParam = null;
+        }
+      }
+    }
+  }
+);

data/jsdoc/app/plugins/tagSynonyms.js

@@ -0,0 +1,43 @@
+JSDOC.PluginManager.registerPlugin(
+  "JSDOC.tagSynonyms",
+  {
+    onDocCommentSrc: function(comment) {
+      comment.src = comment.src.replace(/@methodOf\b/i, "@function\n@memberOf");
+      comment.src = comment.src.replace(/@fieldOf\b/i, "@field\n@memberOf");
+    },
+    
+    onDocCommentTags: function(comment) {
+      for (var i = 0, l = comment.tags.length; i < l; i++) {
+        var title = comment.tags[i].title.toLowerCase();
+        var syn;
+        if ((syn = JSDOC.tagSynonyms.synonyms["="+title])) {
+          comment.tags[i].title = syn;
+        }
+      }
+    }
+  }
+);
+
+new Namespace(
+  "JSDOC.tagSynonyms",
+  function() {
+    JSDOC.tagSynonyms.synonyms = {
+      "=member":             "memberOf",
+      "=memberof":           "memberOf",
+      "=description":        "desc",
+      "=exception":          "throws",
+      "=argument":           "param",
+      "=returns":            "return",
+      "=classdescription":   "class",
+      "=fileoverview":       "overview",
+      "=extends":            "augments",
+      "=base":               "augments",
+      "=projectdescription": "overview",
+      "=classdescription":   "class",
+      "=link":               "see",
+      "=borrows":            "inherits",
+      "=scope":              "lends",
+      "=construct":          "constructor"
+    }
+  }
+);