sc-docs 0.0.2 → 0.0.3

data/lib/sc_docs/templates/docs.sproutcore.com/publish.js

@@ -1,200 +1,200 @@
 /** Called automatically by JsDoc Toolkit. */
 function publish(symbolSet) {
-	publish.conf = {  // trailing slash expected for dirs
-		ext:         ".html",
-		outDir:      JSDOC.opt.d || SYS.pwd+"../out/jsdoc/",
-		templatesDir: JSDOC.opt.t || SYS.pwd+"../templates/jsdoc/",
-		symbolsDir:  "symbols/",
-		srcDir:      "symbols/src/"
-	};
-	
-	// is source output is suppressed, just display the links to the source file
-	if (JSDOC.opt.s && defined(Link) && Link.prototype._makeSrcLink) {
-		Link.prototype._makeSrcLink = function(srcFilePath) {
-			return "<"+srcFilePath+">";
-		}
-	}
-	
-	// create the folders and subfolders to hold the output
-	IO.mkPath((publish.conf.outDir+"symbols/src").split("/"));
-		
-	// used to allow Link to check the details of things being linked to
-	Link.symbolSet = symbolSet;
-
-	// create the required templates
-	try {
-		var classTemplate = new JSDOC.JsPlate(publish.conf.templatesDir+"class.tmpl");
-		var classesTemplate = new JSDOC.JsPlate(publish.conf.templatesDir+"allclasses.tmpl");
-	}
-	catch(e) {
-		print("Couldn't create the required templates: "+e);
-		quit();
-	}
-	
-	// some ustility filters
-	function hasNoParent($) {return ($.memberOf == "")}
-	function isaFile($) {return ($.is("FILE"))}
-	function isaClass($) {return ($.is("CONSTRUCTOR") || $.isNamespace)}
-	
-	// get an array version of the symbolset, useful for filtering
-	var symbols = symbolSet.toArray();
-	
-	// create the hilited source code files
-	var files = JSDOC.opt.srcFiles;
- 	for (var i = 0, l = files.length; i < l; i++) {
- 		var file = files[i];
- 		var srcDir = publish.conf.outDir + "symbols/src/";
-		makeSrcFile(file, srcDir);
- 	}
- 	
- 	// get a list of all the classes in the symbolset
- 	var classes = symbols.filter(isaClass).sort(makeSortby("alias"));
-	
-	// create a filemap in which outfiles must be to be named uniquely, ignoring case
-	if (JSDOC.opt.u) {
-		var filemapCounts = {};
-		Link.filemap = {};
-		for (var i = 0, l = classes.length; i < l; i++) {
-			var lcAlias = classes[i].alias.toLowerCase();
-			
-			if (!filemapCounts[lcAlias]) filemapCounts[lcAlias] = 1;
-			else filemapCounts[lcAlias]++;
-			
-			Link.filemap[classes[i].alias] = 
-				(filemapCounts[lcAlias] > 1)?
-				lcAlias+"_"+filemapCounts[lcAlias] : lcAlias;
-		}
-	}
-	
-	// create a class index, displayed in the left-hand column of every class page
-	Link.base = "../";
- 	publish.classesIndex = classesTemplate.process(classes); // kept in memory
-	
-	// create each of the class pages
-	for (var i = 0, l = classes.length; i < l; i++) {
-		var symbol = classes[i];
-		
-		symbol.events = symbol.getEvents();   // 1 order matters
-		symbol.methods = symbol.getMethods(); // 2
-		
-		var output = "";
-		output = classTemplate.process(symbol);
-		
-		IO.saveFile(publish.conf.outDir+"symbols/", ((JSDOC.opt.u)? Link.filemap[symbol.alias] : symbol.alias) + publish.conf.ext, output);
-	}
-	
-	// regenerate the index with different relative links, used in the index pages
-	Link.base = "";
-	publish.classesIndex = classesTemplate.process(classes);
-	
-	// create the class index page
-	try {
-		var classesindexTemplate = new JSDOC.JsPlate(publish.conf.templatesDir+"index.tmpl");
-	}
-	catch(e) { print(e.message); quit(); }
-	
-	var classesIndex = classesindexTemplate.process(classes);
-	IO.saveFile(publish.conf.outDir, "index"+publish.conf.ext, classesIndex);
-	classesindexTemplate = classesIndex = classes = null;
-	
-	// create the file index page
-	try {
-		var fileindexTemplate = new JSDOC.JsPlate(publish.conf.templatesDir+"allfiles.tmpl");
-	}
-	catch(e) { print(e.message); quit(); }
-	
-	var documentedFiles = symbols.filter(isaFile); // files that have file-level docs
-	var allFiles = []; // not all files have file-level docs, but we need to list every one
-	
-	for (var i = 0; i < files.length; i++) {
-		allFiles.push(new JSDOC.Symbol(files[i], [], "FILE", new JSDOC.DocComment("/** */")));
-	}
-	
-	for (var i = 0; i < documentedFiles.length; i++) {
-		var offset = files.indexOf(documentedFiles[i].alias);
-		allFiles[offset] = documentedFiles[i];
-	}
-		
-	allFiles = allFiles.sort(makeSortby("name"));
-
-	// output the file index page
-	var filesIndex = fileindexTemplate.process(allFiles);
-	IO.saveFile(publish.conf.outDir, "files"+publish.conf.ext, filesIndex);
-	fileindexTemplate = filesIndex = files = null;
+  publish.conf = {  // trailing slash expected for dirs
+    ext:         ".html",
+    outDir:      JSDOC.opt.d || SYS.pwd+"../out/jsdoc/",
+    templatesDir: JSDOC.opt.t || SYS.pwd+"../templates/jsdoc/",
+    symbolsDir:  "symbols/",
+    srcDir:      "symbols/src/"
+  };
+
+  // is source output is suppressed, just display the links to the source file
+  if (JSDOC.opt.s && defined(Link) && Link.prototype._makeSrcLink) {
+    Link.prototype._makeSrcLink = function(srcFilePath) {
+      return "&lt;"+srcFilePath+"&gt;";
+    }
+  }
+
+  // create the folders and subfolders to hold the output
+  IO.mkPath((publish.conf.outDir+"symbols/src").split("/"));
+
+  // used to allow Link to check the details of things being linked to
+  Link.symbolSet = symbolSet;
+
+  // create the required templates
+  try {
+    var classTemplate = new JSDOC.JsPlate(publish.conf.templatesDir+"class.tmpl");
+    var classesTemplate = new JSDOC.JsPlate(publish.conf.templatesDir+"allclasses.tmpl");
+  }
+  catch(e) {
+    print("Couldn't create the required templates: "+e);
+    quit();
+  }
+
+  // some ustility filters
+  function hasNoParent($) {return ($.memberOf == "")}
+  function isaFile($) {return ($.is("FILE"))}
+  function isaClass($) {return ($.is("CONSTRUCTOR") || $.isNamespace)}
+
+  // get an array version of the symbolset, useful for filtering
+  var symbols = symbolSet.toArray();
+
+  // create the hilited source code files
+  var files = JSDOC.opt.srcFiles;
+   for (var i = 0, l = files.length; i < l; i++) {
+     var file = files[i];
+     var srcDir = publish.conf.outDir + "symbols/src/";
+    makeSrcFile(file, srcDir);
+   }
+
+   // get a list of all the classes in the symbolset
+   var classes = symbols.filter(isaClass).sort(makeSortby("alias"));
+
+  // create a filemap in which outfiles must be to be named uniquely, ignoring case
+  if (JSDOC.opt.u) {
+    var filemapCounts = {};
+    Link.filemap = {};
+    for (var i = 0, l = classes.length; i < l; i++) {
+      var lcAlias = classes[i].alias.toLowerCase();
+
+      if (!filemapCounts[lcAlias]) filemapCounts[lcAlias] = 1;
+      else filemapCounts[lcAlias]++;
+
+      Link.filemap[classes[i].alias] =
+        (filemapCounts[lcAlias] > 1)?
+        lcAlias+"_"+filemapCounts[lcAlias] : lcAlias;
+    }
+  }
+
+  // create a class index, displayed in the left-hand column of every class page
+  Link.base = "../";
+   publish.classesIndex = classesTemplate.process(classes); // kept in memory
+
+  // create each of the class pages
+  for (var i = 0, l = classes.length; i < l; i++) {
+    var symbol = classes[i];
+
+    symbol.events = symbol.getEvents();   // 1 order matters
+    symbol.methods = symbol.getMethods(); // 2
+
+    var output = "";
+    output = classTemplate.process(symbol);
+
+    IO.saveFile(publish.conf.outDir+"symbols/", ((JSDOC.opt.u)? Link.filemap[symbol.alias] : symbol.alias) + publish.conf.ext, output);
+  }
+
+  // regenerate the index with different relative links, used in the index pages
+  Link.base = "";
+  publish.classesIndex = classesTemplate.process(classes);
+
+  // create the class index page
+  try {
+    var classesindexTemplate = new JSDOC.JsPlate(publish.conf.templatesDir+"index.tmpl");
+  }
+  catch(e) { print(e.message); quit(); }
+
+  var classesIndex = classesindexTemplate.process(classes);
+  IO.saveFile(publish.conf.outDir, "index"+publish.conf.ext, classesIndex);
+  classesindexTemplate = classesIndex = classes = null;
+
+  // create the file index page
+  try {
+    var fileindexTemplate = new JSDOC.JsPlate(publish.conf.templatesDir+"allfiles.tmpl");
+  }
+  catch(e) { print(e.message); quit(); }
+
+  var documentedFiles = symbols.filter(isaFile); // files that have file-level docs
+  var allFiles = []; // not all files have file-level docs, but we need to list every one
+
+  for (var i = 0; i < files.length; i++) {
+    allFiles.push(new JSDOC.Symbol(files[i], [], "FILE", new JSDOC.DocComment("/** */")));
+  }
+
+  for (var i = 0; i < documentedFiles.length; i++) {
+    var offset = files.indexOf(documentedFiles[i].alias);
+    allFiles[offset] = documentedFiles[i];
+  }
+
+  allFiles = allFiles.sort(makeSortby("name"));
+
+  // output the file index page
+  var filesIndex = fileindexTemplate.process(allFiles);
+  IO.saveFile(publish.conf.outDir, "files"+publish.conf.ext, filesIndex);
+  fileindexTemplate = filesIndex = files = null;
 }
 
 
 /** Just the first sentence (up to a full stop). Should not break on dotted variable names. */
 function summarize(desc) {
-	if (typeof desc != "undefined")
-		return desc.match(/([\w\W]+?\.)[^a-z0-9_$]/i)? RegExp.$1 : desc;
+  if (typeof desc != "undefined")
+    return desc.match(/([\w\W]+?\.)[^a-z0-9_$]/i)? RegExp.$1 : desc;
 }
 
 /** Make a symbol sorter by some attribute. */
 function makeSortby(attribute) {
-	return function(a, b) {
-		if (a[attribute] != undefined && b[attribute] != undefined) {
-			a = a[attribute].toLowerCase();
-			b = b[attribute].toLowerCase();
-			if (a < b) return -1;
-			if (a > b) return 1;
-			return 0;
-		}
-	}
+  return function(a, b) {
+    if (a[attribute] != undefined && b[attribute] != undefined) {
+      a = a[attribute].toLowerCase();
+      b = b[attribute].toLowerCase();
+      if (a < b) return -1;
+      if (a > b) return 1;
+      return 0;
+    }
+  }
 }
 
 /** Pull in the contents of an external file at the given path. */
 function include(path) {
-	var path = publish.conf.templatesDir+path;
-	return IO.readFile(path);
+  var path = publish.conf.templatesDir+path;
+  return IO.readFile(path);
 }
 
 /** Turn a raw source file into a code-hilited page in the docs. */
 function makeSrcFile(path, srcDir, name) {
-	if (JSDOC.opt.s) return;
-	
-	if (!name) {
-		name = path.replace(/\.\.?[\\\/]/g, "").replace(/[\\\/]/g, "_");
-		name = name.replace(/\:/g, "_");
-	}
-	
-	var src = {path: path, name:name, charset: IO.encoding, hilited: ""};
-	
-	if (defined(JSDOC.PluginManager)) {
-		JSDOC.PluginManager.run("onPublishSrc", src);
-	}
-
-	if (src.hilited) {
-		IO.saveFile(srcDir, name+publish.conf.ext, src.hilited);
-	}
+  if (JSDOC.opt.s) return;
+
+  if (!name) {
+    name = path.replace(/\.\.?[\\\/]/g, "").replace(/[\\\/]/g, "_");
+    name = name.replace(/\:/g, "_");
+  }
+
+  var src = {path: path, name:name, charset: IO.encoding, hilited: ""};
+
+  if (defined(JSDOC.PluginManager)) {
+    JSDOC.PluginManager.run("onPublishSrc", src);
+  }
+
+  if (src.hilited) {
+    IO.saveFile(srcDir, name+publish.conf.ext, src.hilited);
+  }
 }
 
 /** Build output for displaying function parameters. */
 function makeSignature(params) {
-	if (!params) return "()";
-	var signature = "("
-	+
-	params.filter(
-		function($) {
-			return $.name.indexOf(".") == -1; // don't show config params in signature
-		}
-	).map(
-		function($) {
-			return $.name;
-		}
-	).join(", ")
-	+
-	")";
-	return signature;
+  if (!params) return "()";
+  var signature = "("
+  +
+  params.filter(
+    function($) {
+      return $.name.indexOf(".") == -1; // don't show config params in signature
+    }
+  ).map(
+    function($) {
+      return $.name;
+    }
+  ).join(", ")
+  +
+  ")";
+  return signature;
 }
 
 /** Find symbol {@link ...} strings in text and turn into html links */
 function resolveLinks(str, from) {
-	str = str.replace(/\{@link ([^} ]+) ?\}/gi,
-		function(match, symbolName) {
-			return new Link().toSymbol(symbolName);
-		}
-	);
-	
-	return str;
+  str = str.replace(/\{@link ([^} ]+) ?\}/gi,
+    function(match, symbolName) {
+      return new Link().toSymbol(symbolName);
+    }
+  );
+
+  return str;
 }

data/lib/sc_docs/version.rb

@@ -1,4 +1,4 @@
 module ScDocs
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end
 

data/vendor/jsdoc/app/plugins/smartdown.js

@@ -0,0 +1,23 @@
+IO.include("plugins/smartdown/smartdown.js");
+
+JSDOC.useSmartdown = false;
+
+JSDOC.PluginManager.registerPlugin(
+  "JSDOC.smartdown",
+  {
+    onInit: function(opts){
+      if (opts.smartdown) { JSDOC.useSmartdown = true; }
+    },
+    onDocTag: function(docTag) {
+      if (!JSDOC.useSmartdown) { return; }
+
+      var exclude = "type param see inherits lends extends scope link base augments memberOf".split(' ');
+      if (exclude.indexOf(docTag.title) < 0) {
+        var desc = docTag.desc.trim();
+        desc = Smartdown.render(desc);
+        docTag.desc = desc;
+      }
+    }
+  }
+);
+

data/vendor/jsdoc/app/plugins/smartdown/koala.js

@@ -0,0 +1,46 @@
+
+// Koala - Core - Copyright TJ Holowaychuk <tj@vision-media.ca> (MIT Licensed)
+/*global IO*/
+
+var Koala = {
+
+  /**
+   * Version.
+   */  
+  version: '0.0.1',
+  
+  lexers: {},
+  formatters: {},
+  
+  
+  
+
+  /**
+   * Render _str_ as _type_, with optional _formatter_ 
+   * defaulting to HTML. _str_ should be a filename or
+   * extension such as '.js'.
+   *
+   * @param  {string} type
+   * @param  {string} str
+   * @param  {Formatter} formatter
+   * @return {string}
+   * @api public
+   */
+
+  render: function(type, str, formatter) {
+    var grammar = this.lexers[type];
+    formatter = formatter || this.formatters.HTML;
+    
+    if (!grammar) throw new Error("syntax highlighting for `" + type + "' is not supported");
+    return formatter.render(grammar, str);
+  }
+  
+};
+
+IO.include('plugins/smartdown/koala/formatter.js');
+IO.include('plugins/smartdown/koala/lexer.js');
+IO.include('plugins/smartdown/koala/formatters/html.js');
+IO.include('plugins/smartdown/koala/grammars/javascript.js');
+IO.include('plugins/smartdown/koala/grammars/ruby.js');
+
+ 

data/vendor/jsdoc/app/plugins/smartdown/koala/formatter.js

@@ -0,0 +1,28 @@
+
+// Koala - Formatter - Copyright TJ Holowaychuk <tj@vision-media.ca> (MIT Licensed)
+/*global Koala*/
+/**
+ * Initialize with formatter function.
+ */
+
+Koala.Formatter = function(fn) {
+  if (typeof fn !== 'function') throw new TypeError('Formatter requires a function');
+  this.fn = fn;
+};
+
+/**
+ * Render _str_ using the given _lexer_.
+ *
+ * @param  {Lexer} lexer
+ * @param  {string} str
+ * @return {string}
+ * @api public
+ */
+
+Koala.Formatter.prototype.render = function(lexer, str) {
+  var self = this;
+  if (typeof lexer.scan !== 'function') throw new TypeError('Formatter#render() requires a lexer to be passed');
+  return lexer.scan(str).map(function(token){
+    return self.fn.call(self, token[0], token[1]);
+  }).join('');
+};