jsdoc-toolkit 0.1.1 → 0.1.2

data/Rakefile

@@ -11,6 +11,7 @@ begin
     gem.homepage = "http://github.com/gabrielg/jsdoc-toolkit"
     gem.authors = ["ggironda"]
     gem.add_development_dependency "riot"
+    gem.files = (gem.files + FileList["src/**/*"]).uniq
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.1.2

data/jsdoc-toolkit.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{jsdoc-toolkit}
-  s.version = "0.1.1"
+  s.version = "0.1.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["ggironda"]
@@ -28,6 +28,113 @@ Gem::Specification.new do |s|
      "lib/jsdoc-toolkit.rb",
      "lib/jsdoc-toolkit/doc_task.rb",
      "lib/jsdoc-toolkit/generator.rb",
+     "src/jsdoc-toolkit/jsdoc-toolkit/README.txt",
+     "src/jsdoc-toolkit/jsdoc-toolkit/app/frame.js",
+     "src/jsdoc-toolkit/jsdoc-toolkit/app/frame/Chain.js",
+     "src/jsdoc-toolkit/jsdoc-toolkit/app/frame/Dumper.js",
+     "src/jsdoc-toolkit/jsdoc-toolkit/app/frame/Hash.js",
+     "src/jsdoc-toolkit/jsdoc-toolkit/app/frame/Link.js",
+     "src/jsdoc-toolkit/jsdoc-toolkit/app/frame/Namespace.js",
+     "src/jsdoc-toolkit/jsdoc-toolkit/app/frame/Opt.js",
+     "src/jsdoc-toolkit/jsdoc-toolkit/app/frame/Reflection.js",
+     "src/jsdoc-toolkit/jsdoc-toolkit/app/frame/String.js",
+     "src/jsdoc-toolkit/jsdoc-toolkit/app/frame/Testrun.js",
+     "src/jsdoc-toolkit/jsdoc-toolkit/app/handlers/FOODOC.js",
+     "src/jsdoc-toolkit/jsdoc-toolkit/app/handlers/XMLDOC.js",
+     "src/jsdoc-toolkit/jsdoc-toolkit/app/handlers/XMLDOC/DomReader.js",
+     "src/jsdoc-toolkit/jsdoc-toolkit/app/handlers/XMLDOC/XMLDoc.js",
+     "src/jsdoc-toolkit/jsdoc-toolkit/app/handlers/XMLDOC/XMLParse.js",
+     "src/jsdoc-toolkit/jsdoc-toolkit/app/lib/JSDOC.js",
+     "src/jsdoc-toolkit/jsdoc-toolkit/app/lib/JSDOC/DocComment.js",
+     "src/jsdoc-toolkit/jsdoc-toolkit/app/lib/JSDOC/DocTag.js",
+     "src/jsdoc-toolkit/jsdoc-toolkit/app/lib/JSDOC/JsDoc.js",
+     "src/jsdoc-toolkit/jsdoc-toolkit/app/lib/JSDOC/JsPlate.js",
+     "src/jsdoc-toolkit/jsdoc-toolkit/app/lib/JSDOC/Lang.js",
+     "src/jsdoc-toolkit/jsdoc-toolkit/app/lib/JSDOC/Parser.js",
+     "src/jsdoc-toolkit/jsdoc-toolkit/app/lib/JSDOC/PluginManager.js",
+     "src/jsdoc-toolkit/jsdoc-toolkit/app/lib/JSDOC/Symbol.js",
+     "src/jsdoc-toolkit/jsdoc-toolkit/app/lib/JSDOC/SymbolSet.js",
+     "src/jsdoc-toolkit/jsdoc-toolkit/app/lib/JSDOC/TextStream.js",
+     "src/jsdoc-toolkit/jsdoc-toolkit/app/lib/JSDOC/Token.js",
+     "src/jsdoc-toolkit/jsdoc-toolkit/app/lib/JSDOC/TokenReader.js",
+     "src/jsdoc-toolkit/jsdoc-toolkit/app/lib/JSDOC/TokenStream.js",
+     "src/jsdoc-toolkit/jsdoc-toolkit/app/lib/JSDOC/Util.js",
+     "src/jsdoc-toolkit/jsdoc-toolkit/app/lib/JSDOC/Walker.js",
+     "src/jsdoc-toolkit/jsdoc-toolkit/app/main.js",
+     "src/jsdoc-toolkit/jsdoc-toolkit/app/plugins/commentSrcJson.js",
+     "src/jsdoc-toolkit/jsdoc-toolkit/app/plugins/frameworkPrototype.js",
+     "src/jsdoc-toolkit/jsdoc-toolkit/app/plugins/functionCall.js",
+     "src/jsdoc-toolkit/jsdoc-toolkit/app/plugins/publishSrcHilite.js",
+     "src/jsdoc-toolkit/jsdoc-toolkit/app/plugins/symbolLink.js",
+     "src/jsdoc-toolkit/jsdoc-toolkit/app/plugins/tagParamConfig.js",
+     "src/jsdoc-toolkit/jsdoc-toolkit/app/plugins/tagSynonyms.js",
+     "src/jsdoc-toolkit/jsdoc-toolkit/app/run.js",
+     "src/jsdoc-toolkit/jsdoc-toolkit/app/t/TestDoc.js",
+     "src/jsdoc-toolkit/jsdoc-toolkit/app/t/runner.js",
+     "src/jsdoc-toolkit/jsdoc-toolkit/app/test.js",
+     "src/jsdoc-toolkit/jsdoc-toolkit/app/test/addon.js",
+     "src/jsdoc-toolkit/jsdoc-toolkit/app/test/anon_inner.js",
+     "src/jsdoc-toolkit/jsdoc-toolkit/app/test/augments.js",
+     "src/jsdoc-toolkit/jsdoc-toolkit/app/test/augments2.js",
+     "src/jsdoc-toolkit/jsdoc-toolkit/app/test/borrows.js",
+     "src/jsdoc-toolkit/jsdoc-toolkit/app/test/borrows2.js",
+     "src/jsdoc-toolkit/jsdoc-toolkit/app/test/config.js",
+     "src/jsdoc-toolkit/jsdoc-toolkit/app/test/constructs.js",
+     "src/jsdoc-toolkit/jsdoc-toolkit/app/test/encoding.js",
+     "src/jsdoc-toolkit/jsdoc-toolkit/app/test/encoding_other.js",
+     "src/jsdoc-toolkit/jsdoc-toolkit/app/test/event.js",
+     "src/jsdoc-toolkit/jsdoc-toolkit/app/test/exports.js",
+     "src/jsdoc-toolkit/jsdoc-toolkit/app/test/functions_anon.js",
+     "src/jsdoc-toolkit/jsdoc-toolkit/app/test/functions_nested.js",
+     "src/jsdoc-toolkit/jsdoc-toolkit/app/test/global.js",
+     "src/jsdoc-toolkit/jsdoc-toolkit/app/test/globals.js",
+     "src/jsdoc-toolkit/jsdoc-toolkit/app/test/ignore.js",
+     "src/jsdoc-toolkit/jsdoc-toolkit/app/test/inner.js",
+     "src/jsdoc-toolkit/jsdoc-toolkit/app/test/jsdoc_test.js",
+     "src/jsdoc-toolkit/jsdoc-toolkit/app/test/lend.js",
+     "src/jsdoc-toolkit/jsdoc-toolkit/app/test/memberof.js",
+     "src/jsdoc-toolkit/jsdoc-toolkit/app/test/memberof_constructor.js",
+     "src/jsdoc-toolkit/jsdoc-toolkit/app/test/module.js",
+     "src/jsdoc-toolkit/jsdoc-toolkit/app/test/name.js",
+     "src/jsdoc-toolkit/jsdoc-toolkit/app/test/namespace_nested.js",
+     "src/jsdoc-toolkit/jsdoc-toolkit/app/test/nocode.js",
+     "src/jsdoc-toolkit/jsdoc-toolkit/app/test/oblit_anon.js",
+     "src/jsdoc-toolkit/jsdoc-toolkit/app/test/overview.js",
+     "src/jsdoc-toolkit/jsdoc-toolkit/app/test/param_inline.js",
+     "src/jsdoc-toolkit/jsdoc-toolkit/app/test/params_optional.js",
+     "src/jsdoc-toolkit/jsdoc-toolkit/app/test/prototype.js",
+     "src/jsdoc-toolkit/jsdoc-toolkit/app/test/prototype_nested.js",
+     "src/jsdoc-toolkit/jsdoc-toolkit/app/test/prototype_oblit.js",
+     "src/jsdoc-toolkit/jsdoc-toolkit/app/test/prototype_oblit_constructor.js",
+     "src/jsdoc-toolkit/jsdoc-toolkit/app/test/public.js",
+     "src/jsdoc-toolkit/jsdoc-toolkit/app/test/scripts/code.js",
+     "src/jsdoc-toolkit/jsdoc-toolkit/app/test/scripts/notcode.txt",
+     "src/jsdoc-toolkit/jsdoc-toolkit/app/test/shared.js",
+     "src/jsdoc-toolkit/jsdoc-toolkit/app/test/shared2.js",
+     "src/jsdoc-toolkit/jsdoc-toolkit/app/test/shortcuts.js",
+     "src/jsdoc-toolkit/jsdoc-toolkit/app/test/static_this.js",
+     "src/jsdoc-toolkit/jsdoc-toolkit/app/test/synonyms.js",
+     "src/jsdoc-toolkit/jsdoc-toolkit/app/test/tosource.js",
+     "src/jsdoc-toolkit/jsdoc-toolkit/app/test/variable_redefine.js",
+     "src/jsdoc-toolkit/jsdoc-toolkit/changes.txt",
+     "src/jsdoc-toolkit/jsdoc-toolkit/conf/sample.conf",
+     "src/jsdoc-toolkit/jsdoc-toolkit/java/build.xml",
+     "src/jsdoc-toolkit/jsdoc-toolkit/java/build_1.4.xml",
+     "src/jsdoc-toolkit/jsdoc-toolkit/java/classes/js.jar",
+     "src/jsdoc-toolkit/jsdoc-toolkit/java/src/JsDebugRun.java",
+     "src/jsdoc-toolkit/jsdoc-toolkit/java/src/JsRun.java",
+     "src/jsdoc-toolkit/jsdoc-toolkit/jsdebug.jar",
+     "src/jsdoc-toolkit/jsdoc-toolkit/jsrun.jar",
+     "src/jsdoc-toolkit/jsdoc-toolkit/jsrun.sh",
+     "src/jsdoc-toolkit/jsdoc-toolkit/templates/jsdoc/allclasses.tmpl",
+     "src/jsdoc-toolkit/jsdoc-toolkit/templates/jsdoc/allfiles.tmpl",
+     "src/jsdoc-toolkit/jsdoc-toolkit/templates/jsdoc/class.tmpl",
+     "src/jsdoc-toolkit/jsdoc-toolkit/templates/jsdoc/index.tmpl",
+     "src/jsdoc-toolkit/jsdoc-toolkit/templates/jsdoc/publish.js",
+     "src/jsdoc-toolkit/jsdoc-toolkit/templates/jsdoc/static/default.css",
+     "src/jsdoc-toolkit/jsdoc-toolkit/templates/jsdoc/static/header.html",
+     "src/jsdoc-toolkit/jsdoc-toolkit/templates/jsdoc/static/index.html",
+     "src/jsdoc-toolkit/jsdoc-toolkit/templates/jsdoc/symbol.tmpl",
      "test/doc_task_test.rb",
      "test/generator_test.rb",
      "test/input/bar/foo.js",

data/src/jsdoc-toolkit/jsdoc-toolkit/README.txt

@@ -0,0 +1,183 @@
+======================================================================
+
+DESCRIPTION:
+
+This is the source code for JsDoc Toolkit, an automatic documentation
+generation tool for JavaScript. It is written in JavaScript and is run
+from a command line (or terminal) using Java and Mozilla's Rhino
+JavaScript runtime engine.
+
+Using this tool you can automatically turn JavaDoc-like comments in
+your JavaScript source code into published output files, such as HTML
+or XML.
+
+For more information, to report a bug, or to browse the technical
+documentation for this tool please visit the official JsDoc Toolkit
+project homepage at http://code.google.com/p/jsdoc-toolkit/
+
+For the most up-to-date documentation on JsDoc Toolkit see the 
+official wiki at http://code.google.com/p/jsdoc-toolkit/w/list
+
+======================================================================
+
+REQUIREMENTS:
+
+JsDoc Toolkit is known to work with:
+java version "1.6.0_03"
+Java(TM) SE Runtime Environment (build 1.6.0_03-b05)
+on Windows XP,
+and java version "1.5.0_19"
+Java(TM) 2 Runtime Environment, Standard Edition (build 1.5.0_19-b02-304)
+on Mac OS X 10.5.
+
+Other versions of java may or may not work with JsDoc Toolkit.
+
+======================================================================
+
+USAGE:
+
+Running JsDoc Toolkit requires you to have Java installed on your
+computer. For more information see http://www.java.com/getjava/
+
+Before running the JsDoc Toolkit app you should change your current
+working directory to the jsdoc-toolkit folder. Then follow the
+examples below, or as shown on the project wiki.
+
+On a computer running Windows a valid command line to run JsDoc
+Toolkit might look like this:
+
+> java -jar jsrun.jar app\run.js -a -t=templates\jsdoc mycode.js
+
+On Mac OS X or Linux the same command would look like this:
+
+$ java -jar jsrun.jar app/run.js -a -t=templates/jsdoc mycode.js
+
+The above assumes your current working directory contains jsrun.jar,
+the "app" and "templates" subdirectories from the standard JsDoc
+Toolkit distribution and that the relative path to the code you wish
+to document is "mycode.js".
+
+The output documentation files will be saved to a new directory named
+"out" (by default) in the current directory, or if you specify a
+-d=somewhere_else option, to the somewhere_else directory.
+
+For help (usage notes) enter this on the command line:
+
+$ java -jar jsrun.jar app/run.js --help
+
+More information about the various command line options used by JsDoc
+Toolkit are available on the project wiki.
+
+======================================================================
+
+RUNNING VIA SHELL SCRIPT
+
+Avi Deitcher has contributed the file jsrun.sh with the following usage notes:
+
+A script to simplify running jsdoc from the command-line, especially when
+running from within a development or build environment such as ant.
+
+Normally, to run jsdoc, you need a command-line as the following:
+java -Djsdoc.dir=/some/long/dir/path/to/jsdoc -jar
+/some/long/dir/path/to/jsdoc/jsrun.jar /some/long/dir/path/to/jsdoc/app/run.js
+-t=template -r=4 /some/long/dir/path/to/my/src/code
+
+This can get tedious to redo time and again, and difficult to use from within a build environment.
+
+To simplify the process, jsrun.sh will automatically run this path, as well as passing through any arguments.
+
+Usage: jsrun.sh <run.js arguments>
+
+All <run.js arguments> will be passed through.
+Additionally, jsrun.sh will take the following actions:
+1) If the environment variable JSDOCDIR is set, it will add
+"-Djsdoc.dir=$JSDOCDIR" to the command-line
+2) If the environment variable JSDOCTEMPLATEDIR is set, it will add
+"-Djsdoc.template.dir=$JSDOCTEMPLATEDIR" to the command-line
+3) java with the appropriate path to jsrun.jar and run.js will be instantiated
+
+If not variables are set, it is assumed that the path to jsrun.jar and app/ is in the current working directory.
+
+Example:
+# jsrun.sh ./src/
+Assuming JSDOCDIR=/some/path/to/my/jsdoc will cause the following command to
+execute:
+java -Djsdoc.dir=/some/path/to/my/jsdoc -jar /some/path/to/my/jsdoc/jsrun.jar
+/some/path/to/my/jsdoc/app/run.js ./src/
+
+======================================================================
+
+TESTING:
+
+To run the suite of unit tests included with JsDoc Toolkit enter this
+on the command line:
+
+$ java -jar jsrun.jar app/run.js -T
+
+To see a dump of the internal data structure that JsDoc Toolkit has
+built from your source files use this command:
+
+$ java -jar jsrun.jar app/run.js mycode.js -Z
+
+======================================================================
+
+LICENSE:
+
+JSDoc.pm
+
+This project is based on the JSDoc.pm tool, created by Michael
+Mathews and Gabriel Reid. More information on JsDoc.pm can
+be found on the JSDoc.pm homepage: http://jsdoc.sourceforge.net/
+
+Complete documentation on JsDoc Toolkit can be found on the project
+wiki at http://code.google.com/p/jsdoc-toolkit/w/list
+
+Rhino
+
+Rhino (JavaScript in Java) is open source and licensed by Mozilla
+under the MPL 1.1 or later/GPL 2.0 or later licenses, the text of
+which is available at http://www.mozilla.org/MPL/
+
+You can obtain the source code for Rhino from the Mozilla web site at
+http://www.mozilla.org/rhino/download.html
+
+JsDoc Toolkit is a larger work that uses the Rhino JavaScript engine
+but is not derived from it in any way. The Rhino library is used 
+without modification and without any claims whatsoever.
+
+The Rhino Debugger
+
+You can obtain more information about the Rhino Debugger from the 
+Mozilla web site at http://www.mozilla.org/rhino/debugger.html
+
+JsDoc Toolkit is a larger work that uses the Rhino Debugger but
+is not derived from it in any way. The Rhino Debugger is used
+without modification and without any claims whatsoever.
+
+JsDoc Toolkit
+
+All code specific to JsDoc Toolkit are free, open source and licensed
+for use under the X11/MIT License.
+
+JsDoc Toolkit is Copyright (c)2009 Michael Mathews <micmath@gmail.com>
+
+This program is free software; you can redistribute it and/or
+modify it under the terms below.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions: The above copyright notice and this
+permission notice must be included in all copies or substantial
+portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/src/jsdoc-toolkit/jsdoc-toolkit/app/frame.js

@@ -0,0 +1,33 @@
+IO.include("frame/Opt.js");
+IO.include("frame/Chain.js");
+IO.include("frame/Link.js");
+IO.include("frame/String.js");
+IO.include("frame/Hash.js");
+IO.include("frame/Namespace.js");
+//IO.include("frame/Reflection.js");
+
+/** A few helper functions to make life a little easier. */
+
+function defined(o) {
+	return (o !== undefined);
+}
+
+function copy(o) { // todo check for circular refs
+	if (o == null || typeof(o) != 'object') return o;
+	var c = new o.constructor();
+	for(var p in o)	c[p] = copy(o[p]);
+	return c;
+}
+
+function isUnique(arr) {
+	var l = arr.length;
+	for(var i = 0; i < l; i++ ) {
+		if (arr.lastIndexOf(arr[i]) > i) return false;
+	}
+	return true;
+}
+
+/** Returns the given string with all regex meta characters backslashed. */
+RegExp.escapeMeta = function(str) {
+	return str.replace(/([$^\\\/()|?+*\[\]{}.-])/g, "\\$1");
+}

data/src/jsdoc-toolkit/jsdoc-toolkit/app/frame/Chain.js

@@ -0,0 +1,102 @@
+/**@constructor*/
+function ChainNode(object, link) {
+	this.value = object;
+	this.link = link; // describes this node's relationship to the previous node
+}
+
+/**@constructor*/
+function Chain(valueLinks) {
+	this.nodes = [];
+	this.cursor = -1;
+	
+	if (valueLinks && valueLinks.length > 0) {
+		this.push(valueLinks[0], "//");
+		for (var i = 1, l = valueLinks.length; i < l; i+=2) {
+			this.push(valueLinks[i+1], valueLinks[i]);
+		}
+	}
+}
+
+Chain.prototype.push = function(o, link) {
+	if (this.nodes.length > 0 && link) this.nodes.push(new ChainNode(o, link));
+	else this.nodes.push(new ChainNode(o));
+}
+
+Chain.prototype.unshift = function(o, link) {
+	if (this.nodes.length > 0 && link) this.nodes[0].link = link;
+	this.nodes.unshift(new ChainNode(o));
+	this.cursor++;
+}
+
+Chain.prototype.get = function() {
+	if (this.cursor < 0 || this.cursor > this.nodes.length-1) return null;
+	return this.nodes[this.cursor];
+}
+
+Chain.prototype.first = function() {
+	this.cursor = 0;
+	return this.get();
+}
+
+Chain.prototype.last = function() {
+	this.cursor = this.nodes.length-1;
+	return this.get();
+}
+
+Chain.prototype.next = function() {
+	this.cursor++;
+	return this.get();
+}
+
+Chain.prototype.prev = function() {
+	this.cursor--;
+	return this.get();
+}
+
+Chain.prototype.toString = function() {
+	var string = "";
+	for (var i = 0, l = this.nodes.length; i < l; i++) {
+		if (this.nodes[i].link) string += " -("+this.nodes[i].link+")-> ";
+		string += this.nodes[i].value.toString();
+	}
+	return string;
+}
+
+Chain.prototype.joinLeft = function() {
+	var result = "";
+	for (var i = 0, l = this.cursor; i < l; i++) {
+		if (result && this.nodes[i].link) result += this.nodes[i].link;
+		result += this.nodes[i].value.toString();
+	}
+	return result;
+}
+
+
+/* USAGE:
+
+var path = "one/two/three.four/five-six";
+var pathChain = new Chain(path.split(/([\/.-])/));
+print(pathChain);
+
+var lineage = new Chain();
+lineage.push("Port");
+lineage.push("Les", "son");
+lineage.push("Dawn", "daughter");
+lineage.unshift("Purdie", "son");
+
+print(lineage);
+
+// walk left
+for (var node = lineage.last(); node !== null; node = lineage.prev()) {
+	print("< "+node.value);
+}
+
+// walk right
+var node = lineage.first()
+while (node !== null) {
+	print(node.value);
+	node = lineage.next();
+	if (node && node.link) print("had a "+node.link+" named");
+}
+
+*/