Class Index
24 | 25 |
27 |
30 | {+(new Link().toSymbol(thisClass.alias))+}
28 | {+resolveLinks(summarize(thisClass.classDesc))+} 29 |31 |
6 | var x (x < 1);
7 | alert("This 'is' \"code\"");
8 |
9 | * @name My Cool Library
10 | * @author Joe Smith jsmith@company.com
11 | * @version 0.1
12 | */
13 |
14 | /**
15 | * Gets the current foo
16 | * @param {String} fooId The unique identifier for the foo.
17 | * @return {Object} Returns the current foo.
18 | */
19 | function getFoo(fooID){
20 | }
--------------------------------------------------------------------------------
/install.sh:
--------------------------------------------------------------------------------
1 | # SVN
2 | yum install subversion
3 |
4 | # S3CMD
5 | wget http://s3tools.org/repo/RHEL_6/s3tools.repo -o /etc/yum.repos.d/s3tools.repo
6 | yum install -y s3cmd
7 | # s3cmd sync --acl-public --delete-removed ~/prototype-docs/ s3://docs.node.ee/proto/
8 |
9 | # Install PHP + phpdoc
10 | yum -y install php php-pear php-cli php-common
11 | pear update-channels
12 | pear install PhpDocumentor
13 |
14 | # Install Ruby
15 | yum install -y ruby-devel rubygems
16 |
17 | # Install PDOC + JSDuck
18 | gem install json rdiscount pdoc jsduck
19 |
--------------------------------------------------------------------------------
/vendor/jsdoc-toolkit/templates/jsdoc/allclasses.tmpl:
--------------------------------------------------------------------------------
1 | "; 50 | this.footer = ""; 51 | this.showLinenumbers = true; 52 | } 53 | 54 | JsHilite.cache = {}; 55 | 56 | JsHilite.prototype.hilite = function() { 57 | var hilited = this.tokens.join(""); 58 | var line = 1; 59 | if (this.showLinenumbers) hilited = hilited.replace(/(^|\n)/g, function(m){return m+""+((line<10)? " ":"")+((line<100)? " ":"")+(line++)+" "}); 60 | 61 | return this.header+hilited+this.footer; 62 | } -------------------------------------------------------------------------------- /vendor/jsdoc-toolkit/app/frame/Hash.js: -------------------------------------------------------------------------------- 1 | /** 2 | @constructor 3 | @example 4 | var _index = new Hash(); 5 | _index.set("a", "apple"); 6 | _index.set("b", "blue"); 7 | _index.set("c", "coffee"); 8 | 9 | for (var p = _index.first(); p; p = _index.next()) { 10 | print(p.key+" is for "+p.value); 11 | } 12 | 13 | */ 14 | var Hash = function() { 15 | this._map = {}; 16 | this._keys = []; 17 | this._vals = []; 18 | this.reset(); 19 | } 20 | 21 | Hash.prototype.set = function(k, v) { 22 | if (k != "") { 23 | this._keys.push(k); 24 | this._map["="+k] = this._vals.length; 25 | this._vals.push(v); 26 | } 27 | } 28 | 29 | Hash.prototype.replace = function(k, k2, v) { 30 | if (k == k2) return; 31 | 32 | var offset = this._map["="+k]; 33 | this._keys[offset] = k2; 34 | if (typeof v != "undefined") this._vals[offset] = v; 35 | this._map["="+k2] = offset; 36 | delete(this._map["="+k]); 37 | } 38 | 39 | Hash.prototype.drop = function(k) { 40 | if (k != "") { 41 | var offset = this._map["="+k]; 42 | this._keys.splice(offset, 1); 43 | this._vals.splice(offset, 1); 44 | delete(this._map["="+k]); 45 | for (var p in this._map) { 46 | if (this._map[p] >= offset) this._map[p]--; 47 | } 48 | if (this._cursor >= offset && this._cursor > 0) this._cursor--; 49 | } 50 | } 51 | 52 | Hash.prototype.get = function(k) { 53 | if (k != "") { 54 | return this._vals[this._map["="+k]]; 55 | } 56 | } 57 | 58 | Hash.prototype.keys = function() { 59 | return this._keys; 60 | } 61 | 62 | Hash.prototype.hasKey = function(k) { 63 | if (k != "") { 64 | return (typeof this._map["="+k] != "undefined"); 65 | } 66 | } 67 | 68 | Hash.prototype.values = function() { 69 | return this._vals; 70 | } 71 | 72 | Hash.prototype.reset = function() { 73 | this._cursor = 0; 74 | } 75 | 76 | Hash.prototype.first = function() { 77 | this.reset(); 78 | return this.next(); 79 | } 80 | 81 | Hash.prototype.next = function() { 82 | if (this._cursor++ < this._keys.length) 83 | return {key: this._keys[this._cursor-1], value: this._vals[this._cursor-1]}; 84 | } -------------------------------------------------------------------------------- /vendor/jsdoc-toolkit/templates/jsdoc/allfiles.tmpl: -------------------------------------------------------------------------------- 1 | 3 | 4 | 5 | 6 | {! Link.base = ""; /* all generated links will be relative to this */ !} 7 |
4 | This is a lightly modified version of Kevin Jones' JavaScript 5 | library Data.Dump. To download the original visit: 6 | http://openjsan.org/doc/k/ke/kevinj/Data/Dump/ 7 | 8 | AUTHORS 9 | 10 | The Data.Dump JavaScript module is written by Kevin Jones 11 | (kevinj@cpan.org), based on Data::Dump by Gisle Aas (gisle@aas.no), 12 | based on Data::Dumper by Gurusamy Sarathy (gsar@umich.edu). 13 | 14 | COPYRIGHT 15 | 16 | Copyright 2007 Kevin Jones. Copyright 1998-2000,2003-2004 Gisle Aas. 17 | Copyright 1996-1998 Gurusamy Sarathy. 18 | 19 | This program is free software; you can redistribute it and/or modify 20 | it under the terms of the Perl Artistic License 21 | 22 | See http://www.perl.com/perl/misc/Artistic.html 23 |24 | * @static 25 | */ 26 | Dumper = { 27 | /** @param [...] The objects to dump. */ 28 | dump: function () { 29 | if (arguments.length > 1) 30 | return this._dump(arguments); 31 | else if (arguments.length == 1) 32 | return this._dump(arguments[0]); 33 | else 34 | return "()"; 35 | }, 36 | 37 | _dump: function (obj) { 38 | if (typeof obj == 'undefined') return 'undefined'; 39 | var out; 40 | if (obj.serialize) { return obj.serialize(); } 41 | var type = this._typeof(obj); 42 | if (obj.circularReference) obj.circularReference++; 43 | switch (type) { 44 | case 'circular': 45 | out = "{ //circularReference\n}"; 46 | break; 47 | case 'object': 48 | var pairs = new Array; 49 | 50 | for (var prop in obj) { 51 | if (prop != "circularReference" && obj.hasOwnProperty(prop)) { //hide inherited properties 52 | pairs.push(prop + ': ' + this._dump(obj[prop])); 53 | } 54 | } 55 | 56 | out = '{' + this._format_list(pairs) + '}'; 57 | break; 58 | 59 | case 'string': 60 | for (var prop in Dumper.ESC) { 61 | if (Dumper.ESC.hasOwnProperty(prop)) { 62 | obj = obj.replace(prop, Dumper.ESC[prop]); 63 | } 64 | } 65 | 66 | // Escape UTF-8 Strings 67 | if (obj.match(/^[\x00-\x7f]*$/)) { 68 | out = '"' + obj.replace(/\"/g, "\\\"").replace(/([\n\r]+)/g, "\\$1") + '"'; 69 | } 70 | else { 71 | out = "unescape('"+escape(obj)+"')"; 72 | } 73 | break; 74 | 75 | case 'array': 76 | var elems = new Array; 77 | 78 | for (var i=0; i