quentonc-jsdoc_helper 0.0.2
Sign up to get free protection for your applications and to get access to all the features.
- data/History.txt +13 -0
- data/README.rdoc +64 -0
- data/Rakefile +46 -0
- data/TODO.rdoc +5 -0
- data/bin/jsdoc_helper +8 -0
- data/ext/jsdoc-toolkit/README.txt +146 -0
- data/ext/jsdoc-toolkit/app/frame/Chain.js +102 -0
- data/ext/jsdoc-toolkit/app/frame/Dumper.js +144 -0
- data/ext/jsdoc-toolkit/app/frame/Hash.js +84 -0
- data/ext/jsdoc-toolkit/app/frame/Link.js +148 -0
- data/ext/jsdoc-toolkit/app/frame/Namespace.js +10 -0
- data/ext/jsdoc-toolkit/app/frame/Opt.js +134 -0
- data/ext/jsdoc-toolkit/app/frame/Reflection.js +26 -0
- data/ext/jsdoc-toolkit/app/frame/String.js +93 -0
- data/ext/jsdoc-toolkit/app/frame/Testrun.js +129 -0
- data/ext/jsdoc-toolkit/app/frame.js +33 -0
- data/ext/jsdoc-toolkit/app/handlers/FOODOC.js +26 -0
- data/ext/jsdoc-toolkit/app/handlers/XMLDOC/DomReader.js +159 -0
- data/ext/jsdoc-toolkit/app/handlers/XMLDOC/XMLDoc.js +16 -0
- data/ext/jsdoc-toolkit/app/handlers/XMLDOC/XMLParse.js +292 -0
- data/ext/jsdoc-toolkit/app/handlers/XMLDOC.js +26 -0
- data/ext/jsdoc-toolkit/app/lib/JSDOC/DocComment.js +200 -0
- data/ext/jsdoc-toolkit/app/lib/JSDOC/DocTag.js +294 -0
- data/ext/jsdoc-toolkit/app/lib/JSDOC/JsDoc.js +126 -0
- data/ext/jsdoc-toolkit/app/lib/JSDOC/JsPlate.js +109 -0
- data/ext/jsdoc-toolkit/app/lib/JSDOC/Lang.js +144 -0
- data/ext/jsdoc-toolkit/app/lib/JSDOC/Parser.js +107 -0
- data/ext/jsdoc-toolkit/app/lib/JSDOC/PluginManager.js +33 -0
- data/ext/jsdoc-toolkit/app/lib/JSDOC/Symbol.js +643 -0
- data/ext/jsdoc-toolkit/app/lib/JSDOC/SymbolSet.js +229 -0
- data/ext/jsdoc-toolkit/app/lib/JSDOC/TextStream.js +41 -0
- data/ext/jsdoc-toolkit/app/lib/JSDOC/Token.js +18 -0
- data/ext/jsdoc-toolkit/app/lib/JSDOC/TokenReader.js +332 -0
- data/ext/jsdoc-toolkit/app/lib/JSDOC/TokenStream.js +133 -0
- data/ext/jsdoc-toolkit/app/lib/JSDOC/Util.js +32 -0
- data/ext/jsdoc-toolkit/app/lib/JSDOC/Walker.js +459 -0
- data/ext/jsdoc-toolkit/app/lib/JSDOC.js +101 -0
- data/ext/jsdoc-toolkit/app/main.js +111 -0
- data/ext/jsdoc-toolkit/app/plugins/commentSrcJson.js +20 -0
- data/ext/jsdoc-toolkit/app/plugins/frameworkPrototype.js +16 -0
- data/ext/jsdoc-toolkit/app/plugins/functionCall.js +10 -0
- data/ext/jsdoc-toolkit/app/plugins/publishSrcHilite.js +62 -0
- data/ext/jsdoc-toolkit/app/plugins/symbolLink.js +9 -0
- data/ext/jsdoc-toolkit/app/plugins/tagParamConfig.js +31 -0
- data/ext/jsdoc-toolkit/app/plugins/tagSynonyms.js +43 -0
- data/ext/jsdoc-toolkit/app/run.js +348 -0
- data/ext/jsdoc-toolkit/app/t/TestDoc.js +144 -0
- data/ext/jsdoc-toolkit/app/t/runner.js +13 -0
- data/ext/jsdoc-toolkit/app/test/addon.js +24 -0
- data/ext/jsdoc-toolkit/app/test/anon_inner.js +14 -0
- data/ext/jsdoc-toolkit/app/test/augments.js +31 -0
- data/ext/jsdoc-toolkit/app/test/augments2.js +26 -0
- data/ext/jsdoc-toolkit/app/test/borrows.js +41 -0
- data/ext/jsdoc-toolkit/app/test/borrows2.js +23 -0
- data/ext/jsdoc-toolkit/app/test/config.js +22 -0
- data/ext/jsdoc-toolkit/app/test/constructs.js +18 -0
- data/ext/jsdoc-toolkit/app/test/encoding.js +10 -0
- data/ext/jsdoc-toolkit/app/test/encoding_other.js +12 -0
- data/ext/jsdoc-toolkit/app/test/event.js +54 -0
- data/ext/jsdoc-toolkit/app/test/functions_anon.js +39 -0
- data/ext/jsdoc-toolkit/app/test/functions_nested.js +33 -0
- data/ext/jsdoc-toolkit/app/test/global.js +13 -0
- data/ext/jsdoc-toolkit/app/test/globals.js +25 -0
- data/ext/jsdoc-toolkit/app/test/ignore.js +10 -0
- data/ext/jsdoc-toolkit/app/test/inner.js +16 -0
- data/ext/jsdoc-toolkit/app/test/jsdoc_test.js +477 -0
- data/ext/jsdoc-toolkit/app/test/lend.js +33 -0
- data/ext/jsdoc-toolkit/app/test/memberof.js +19 -0
- data/ext/jsdoc-toolkit/app/test/memberof_constructor.js +17 -0
- data/ext/jsdoc-toolkit/app/test/name.js +19 -0
- data/ext/jsdoc-toolkit/app/test/namespace_nested.js +23 -0
- data/ext/jsdoc-toolkit/app/test/nocode.js +13 -0
- data/ext/jsdoc-toolkit/app/test/oblit_anon.js +20 -0
- data/ext/jsdoc-toolkit/app/test/overview.js +20 -0
- data/ext/jsdoc-toolkit/app/test/param_inline.js +37 -0
- data/ext/jsdoc-toolkit/app/test/params_optional.js +8 -0
- data/ext/jsdoc-toolkit/app/test/prototype.js +17 -0
- data/ext/jsdoc-toolkit/app/test/prototype_nested.js +9 -0
- data/ext/jsdoc-toolkit/app/test/prototype_oblit.js +13 -0
- data/ext/jsdoc-toolkit/app/test/prototype_oblit_constructor.js +24 -0
- data/ext/jsdoc-toolkit/app/test/public.js +10 -0
- data/ext/jsdoc-toolkit/app/test/shared.js +42 -0
- data/ext/jsdoc-toolkit/app/test/shared2.js +2 -0
- data/ext/jsdoc-toolkit/app/test/shortcuts.js +22 -0
- data/ext/jsdoc-toolkit/app/test/static_this.js +13 -0
- data/ext/jsdoc-toolkit/app/test/synonyms.js +31 -0
- data/ext/jsdoc-toolkit/app/test/tosource.js +23 -0
- data/ext/jsdoc-toolkit/app/test/variable_redefine.js +14 -0
- data/ext/jsdoc-toolkit/app/test.js +307 -0
- data/ext/jsdoc-toolkit/changes.txt +75 -0
- data/ext/jsdoc-toolkit/conf/sample.conf +31 -0
- data/ext/jsdoc-toolkit/java/build.xml +36 -0
- data/ext/jsdoc-toolkit/java/build_1.4.xml +36 -0
- data/ext/jsdoc-toolkit/java/classes/js.jar +0 -0
- data/ext/jsdoc-toolkit/java/src/JsDebugRun.java +21 -0
- data/ext/jsdoc-toolkit/java/src/JsRun.java +21 -0
- data/ext/jsdoc-toolkit/jsdebug.jar +0 -0
- data/ext/jsdoc-toolkit/jsrun.jar +0 -0
- data/ext/jsdoc-toolkit/out/jsdoc/files.html +216 -0
- data/ext/jsdoc-toolkit/out/jsdoc/index.html +210 -0
- data/ext/jsdoc-toolkit/out/jsdoc/symbols/_global_.html +306 -0
- data/ext/jsdoc-toolkit/out/jsdoc/symbols/src/lib_test.js.html +13 -0
- data/ext/jsdoc-toolkit/templates/jsdoc/allclasses.tmpl +17 -0
- data/ext/jsdoc-toolkit/templates/jsdoc/allfiles.tmpl +56 -0
- data/ext/jsdoc-toolkit/templates/jsdoc/class.tmpl +646 -0
- data/ext/jsdoc-toolkit/templates/jsdoc/index.tmpl +39 -0
- data/ext/jsdoc-toolkit/templates/jsdoc/publish.js +184 -0
- data/ext/jsdoc-toolkit/templates/jsdoc/static/default.css +162 -0
- data/ext/jsdoc-toolkit/templates/jsdoc/static/header.html +2 -0
- data/ext/jsdoc-toolkit/templates/jsdoc/static/index.html +19 -0
- data/ext/jsdoc-toolkit/templates/jsdoc/symbol.tmpl +35 -0
- data/features/doing_rake_jsdoc.feature +74 -0
- data/features/step_definitions/jsdoc_helper_steps.rb +48 -0
- data/features/support/env.rb +11 -0
- data/features/support/file_helper.rb +68 -0
- data/features/writing_the_rakefile.feature +36 -0
- data/jsdoc_helper.gemspec +41 -0
- data/lib/jsdoc_helper/rake/task/runner.rb +85 -0
- data/lib/jsdoc_helper/rake/task.rb +43 -0
- data/lib/jsdoc_helper.rb +50 -0
- data/spec/jsdoc_helper/jsdoc_helper_spec.rb +4 -0
- data/spec/jsdoc_helper/rake/task/runner_spec.rb +45 -0
- data/spec/jsdoc_helper/support/file_helper_spec.rb +93 -0
- data/spec/spec_helper.rb +25 -0
- data/test/ext/jsdoc-toolkit/README.txt +146 -0
- data/test/ext/jsdoc-toolkit/app/frame/Chain.js +102 -0
- data/test/ext/jsdoc-toolkit/app/frame/Dumper.js +144 -0
- data/test/ext/jsdoc-toolkit/app/frame/Hash.js +84 -0
- data/test/ext/jsdoc-toolkit/app/frame/Link.js +148 -0
- data/test/ext/jsdoc-toolkit/app/frame/Namespace.js +10 -0
- data/test/ext/jsdoc-toolkit/app/frame/Opt.js +134 -0
- data/test/ext/jsdoc-toolkit/app/frame/Reflection.js +26 -0
- data/test/ext/jsdoc-toolkit/app/frame/String.js +93 -0
- data/test/ext/jsdoc-toolkit/app/frame/Testrun.js +129 -0
- data/test/ext/jsdoc-toolkit/app/frame.js +33 -0
- data/test/ext/jsdoc-toolkit/app/handlers/FOODOC.js +26 -0
- data/test/ext/jsdoc-toolkit/app/handlers/XMLDOC/DomReader.js +159 -0
- data/test/ext/jsdoc-toolkit/app/handlers/XMLDOC/XMLDoc.js +16 -0
- data/test/ext/jsdoc-toolkit/app/handlers/XMLDOC/XMLParse.js +292 -0
- data/test/ext/jsdoc-toolkit/app/handlers/XMLDOC.js +26 -0
- data/test/ext/jsdoc-toolkit/app/lib/JSDOC/DocComment.js +200 -0
- data/test/ext/jsdoc-toolkit/app/lib/JSDOC/DocTag.js +294 -0
- data/test/ext/jsdoc-toolkit/app/lib/JSDOC/JsDoc.js +126 -0
- data/test/ext/jsdoc-toolkit/app/lib/JSDOC/JsPlate.js +109 -0
- data/test/ext/jsdoc-toolkit/app/lib/JSDOC/Lang.js +144 -0
- data/test/ext/jsdoc-toolkit/app/lib/JSDOC/Parser.js +107 -0
- data/test/ext/jsdoc-toolkit/app/lib/JSDOC/PluginManager.js +33 -0
- data/test/ext/jsdoc-toolkit/app/lib/JSDOC/Symbol.js +643 -0
- data/test/ext/jsdoc-toolkit/app/lib/JSDOC/SymbolSet.js +229 -0
- data/test/ext/jsdoc-toolkit/app/lib/JSDOC/TextStream.js +41 -0
- data/test/ext/jsdoc-toolkit/app/lib/JSDOC/Token.js +18 -0
- data/test/ext/jsdoc-toolkit/app/lib/JSDOC/TokenReader.js +332 -0
- data/test/ext/jsdoc-toolkit/app/lib/JSDOC/TokenStream.js +133 -0
- data/test/ext/jsdoc-toolkit/app/lib/JSDOC/Util.js +32 -0
- data/test/ext/jsdoc-toolkit/app/lib/JSDOC/Walker.js +459 -0
- data/test/ext/jsdoc-toolkit/app/lib/JSDOC.js +101 -0
- data/test/ext/jsdoc-toolkit/app/main.js +111 -0
- data/test/ext/jsdoc-toolkit/app/plugins/commentSrcJson.js +20 -0
- data/test/ext/jsdoc-toolkit/app/plugins/frameworkPrototype.js +16 -0
- data/test/ext/jsdoc-toolkit/app/plugins/functionCall.js +10 -0
- data/test/ext/jsdoc-toolkit/app/plugins/publishSrcHilite.js +62 -0
- data/test/ext/jsdoc-toolkit/app/plugins/symbolLink.js +9 -0
- data/test/ext/jsdoc-toolkit/app/plugins/tagParamConfig.js +31 -0
- data/test/ext/jsdoc-toolkit/app/plugins/tagSynonyms.js +43 -0
- data/test/ext/jsdoc-toolkit/app/run.js +348 -0
- data/test/ext/jsdoc-toolkit/app/t/TestDoc.js +144 -0
- data/test/ext/jsdoc-toolkit/app/t/runner.js +13 -0
- data/test/ext/jsdoc-toolkit/app/test/addon.js +24 -0
- data/test/ext/jsdoc-toolkit/app/test/anon_inner.js +14 -0
- data/test/ext/jsdoc-toolkit/app/test/augments.js +31 -0
- data/test/ext/jsdoc-toolkit/app/test/augments2.js +26 -0
- data/test/ext/jsdoc-toolkit/app/test/borrows.js +41 -0
- data/test/ext/jsdoc-toolkit/app/test/borrows2.js +23 -0
- data/test/ext/jsdoc-toolkit/app/test/config.js +22 -0
- data/test/ext/jsdoc-toolkit/app/test/constructs.js +18 -0
- data/test/ext/jsdoc-toolkit/app/test/encoding.js +10 -0
- data/test/ext/jsdoc-toolkit/app/test/encoding_other.js +12 -0
- data/test/ext/jsdoc-toolkit/app/test/event.js +54 -0
- data/test/ext/jsdoc-toolkit/app/test/functions_anon.js +39 -0
- data/test/ext/jsdoc-toolkit/app/test/functions_nested.js +33 -0
- data/test/ext/jsdoc-toolkit/app/test/global.js +13 -0
- data/test/ext/jsdoc-toolkit/app/test/globals.js +25 -0
- data/test/ext/jsdoc-toolkit/app/test/ignore.js +10 -0
- data/test/ext/jsdoc-toolkit/app/test/inner.js +16 -0
- data/test/ext/jsdoc-toolkit/app/test/jsdoc_test.js +477 -0
- data/test/ext/jsdoc-toolkit/app/test/lend.js +33 -0
- data/test/ext/jsdoc-toolkit/app/test/memberof.js +19 -0
- data/test/ext/jsdoc-toolkit/app/test/memberof_constructor.js +17 -0
- data/test/ext/jsdoc-toolkit/app/test/name.js +19 -0
- data/test/ext/jsdoc-toolkit/app/test/namespace_nested.js +23 -0
- data/test/ext/jsdoc-toolkit/app/test/nocode.js +13 -0
- data/test/ext/jsdoc-toolkit/app/test/oblit_anon.js +20 -0
- data/test/ext/jsdoc-toolkit/app/test/overview.js +20 -0
- data/test/ext/jsdoc-toolkit/app/test/param_inline.js +37 -0
- data/test/ext/jsdoc-toolkit/app/test/params_optional.js +8 -0
- data/test/ext/jsdoc-toolkit/app/test/prototype.js +17 -0
- data/test/ext/jsdoc-toolkit/app/test/prototype_nested.js +9 -0
- data/test/ext/jsdoc-toolkit/app/test/prototype_oblit.js +13 -0
- data/test/ext/jsdoc-toolkit/app/test/prototype_oblit_constructor.js +24 -0
- data/test/ext/jsdoc-toolkit/app/test/public.js +10 -0
- data/test/ext/jsdoc-toolkit/app/test/shared.js +42 -0
- data/test/ext/jsdoc-toolkit/app/test/shared2.js +2 -0
- data/test/ext/jsdoc-toolkit/app/test/shortcuts.js +22 -0
- data/test/ext/jsdoc-toolkit/app/test/static_this.js +13 -0
- data/test/ext/jsdoc-toolkit/app/test/synonyms.js +31 -0
- data/test/ext/jsdoc-toolkit/app/test/tosource.js +23 -0
- data/test/ext/jsdoc-toolkit/app/test/variable_redefine.js +14 -0
- data/test/ext/jsdoc-toolkit/app/test.js +307 -0
- data/test/ext/jsdoc-toolkit/changes.txt +75 -0
- data/test/ext/jsdoc-toolkit/conf/sample.conf +31 -0
- data/test/ext/jsdoc-toolkit/java/build.xml +36 -0
- data/test/ext/jsdoc-toolkit/java/build_1.4.xml +36 -0
- data/test/ext/jsdoc-toolkit/java/classes/js.jar +0 -0
- data/test/ext/jsdoc-toolkit/java/src/JsDebugRun.java +21 -0
- data/test/ext/jsdoc-toolkit/java/src/JsRun.java +21 -0
- data/test/ext/jsdoc-toolkit/jsdebug.jar +0 -0
- data/test/ext/jsdoc-toolkit/jsrun.jar +0 -0
- data/test/ext/jsdoc-toolkit/templates/jsdoc/allclasses.tmpl +17 -0
- data/test/ext/jsdoc-toolkit/templates/jsdoc/allfiles.tmpl +56 -0
- data/test/ext/jsdoc-toolkit/templates/jsdoc/class.tmpl +646 -0
- data/test/ext/jsdoc-toolkit/templates/jsdoc/index.tmpl +39 -0
- data/test/ext/jsdoc-toolkit/templates/jsdoc/publish.js +184 -0
- data/test/ext/jsdoc-toolkit/templates/jsdoc/static/default.css +162 -0
- data/test/ext/jsdoc-toolkit/templates/jsdoc/static/header.html +2 -0
- data/test/ext/jsdoc-toolkit/templates/jsdoc/static/index.html +19 -0
- data/test/ext/jsdoc-toolkit/templates/jsdoc/symbol.tmpl +35 -0
- data/test/lib/test1.js +0 -0
- data/test/lib/test2.js +0 -0
- metadata +294 -0
@@ -0,0 +1,107 @@
|
|
1
|
+
if (typeof JSDOC == "undefined") JSDOC = {};
|
2
|
+
|
3
|
+
/**
|
4
|
+
@namespace
|
5
|
+
@requires JSDOC.Walker
|
6
|
+
@requires JSDOC.Symbol
|
7
|
+
@requires JSDOC.DocComment
|
8
|
+
*/
|
9
|
+
JSDOC.Parser = {
|
10
|
+
conf: {
|
11
|
+
ignoreCode: JSDOC.opt.n,
|
12
|
+
ignoreAnonymous: true, // factory: true
|
13
|
+
treatUnderscoredAsPrivate: true, // factory: true
|
14
|
+
explain: false // factory: false
|
15
|
+
},
|
16
|
+
|
17
|
+
addSymbol: function(symbol) {
|
18
|
+
// if a symbol alias is documented more than once the last one with the user docs wins
|
19
|
+
if (JSDOC.Parser.symbols.hasSymbol(symbol.alias)) {
|
20
|
+
var oldSymbol = JSDOC.Parser.symbols.getSymbol(symbol.alias);
|
21
|
+
if (oldSymbol.comment.isUserComment) {
|
22
|
+
if (symbol.comment.isUserComment) { // old and new are both documented
|
23
|
+
LOG.warn("The symbol '"+symbol.alias+"' is documented more than once.");
|
24
|
+
}
|
25
|
+
else { // old is documented but new isn't
|
26
|
+
return;
|
27
|
+
}
|
28
|
+
}
|
29
|
+
}
|
30
|
+
|
31
|
+
// we don't document anonymous things
|
32
|
+
if (JSDOC.Parser.conf.ignoreAnonymous && symbol.name.match(/\$anonymous\b/)) return;
|
33
|
+
|
34
|
+
// uderscored things may be treated as if they were marked private, this cascades
|
35
|
+
if (JSDOC.Parser.conf.treatUnderscoredAsPrivate && symbol.name.match(/[.#-]_[^.#-]+$/)) {
|
36
|
+
if (!symbol.comment.getTag("public").length > 0) symbol.isPrivate = true;
|
37
|
+
}
|
38
|
+
|
39
|
+
// -p flag is required to document private things
|
40
|
+
if (!JSDOC.opt.p && symbol.isPrivate) return; // issue #161 fixed by mcbain.asm
|
41
|
+
|
42
|
+
// ignored things are not documented, this doesn't cascade
|
43
|
+
if (symbol.isIgnored) return;
|
44
|
+
JSDOC.Parser.symbols.addSymbol(symbol);
|
45
|
+
},
|
46
|
+
|
47
|
+
addBuiltin: function(name) {
|
48
|
+
var builtin = new JSDOC.Symbol(name, [], "CONSTRUCTOR", new JSDOC.DocComment(""));
|
49
|
+
builtin.isNamespace = true;
|
50
|
+
builtin.srcFile = "";
|
51
|
+
builtin.isPrivate = false;
|
52
|
+
JSDOC.Parser.addSymbol(builtin);
|
53
|
+
return builtin;
|
54
|
+
},
|
55
|
+
|
56
|
+
init: function() {
|
57
|
+
JSDOC.Parser.symbols = new JSDOC.SymbolSet();
|
58
|
+
JSDOC.Parser.walker = new JSDOC.Walker();
|
59
|
+
},
|
60
|
+
|
61
|
+
finish: function() {
|
62
|
+
JSDOC.Parser.symbols.relate();
|
63
|
+
|
64
|
+
// make a litle report about what was found
|
65
|
+
if (JSDOC.Parser.conf.explain) {
|
66
|
+
var symbols = JSDOC.Parser.symbols.toArray();
|
67
|
+
var srcFile = "";
|
68
|
+
for (var i = 0, l = symbols.length; i < l; i++) {
|
69
|
+
var symbol = symbols[i];
|
70
|
+
if (srcFile != symbol.srcFile) {
|
71
|
+
srcFile = symbol.srcFile;
|
72
|
+
print("\n"+srcFile+"\n-------------------");
|
73
|
+
}
|
74
|
+
print(i+":\n alias => "+symbol.alias + "\n name => "+symbol.name+ "\n isa => "+symbol.isa + "\n memberOf => " + symbol.memberOf + "\n isStatic => " + symbol.isStatic + ", isInner => " + symbol.isInner+ ", isPrivate => " + symbol.isPrivate);
|
75
|
+
}
|
76
|
+
print("-------------------\n");
|
77
|
+
}
|
78
|
+
}
|
79
|
+
}
|
80
|
+
|
81
|
+
JSDOC.Parser.parse = function(/**JSDOC.TokenStream*/ts, /**String*/srcFile) {
|
82
|
+
JSDOC.Symbol.srcFile = (srcFile || "");
|
83
|
+
JSDOC.DocComment.shared = ""; // shared comments don't cross file boundaries
|
84
|
+
|
85
|
+
if (!JSDOC.Parser.walker) JSDOC.Parser.init();
|
86
|
+
JSDOC.Parser.walker.walk(ts); // adds to our symbols
|
87
|
+
|
88
|
+
// filter symbols by option
|
89
|
+
for (var p = JSDOC.Parser.symbols._index.first(); p; p = JSDOC.Parser.symbols._index.next()) {
|
90
|
+
var symbol = p.value;
|
91
|
+
|
92
|
+
if (!symbol) continue;
|
93
|
+
|
94
|
+
if (symbol.is("FILE") || symbol.is("GLOBAL")) {
|
95
|
+
continue;
|
96
|
+
}
|
97
|
+
else if (!JSDOC.opt.a && !symbol.comment.isUserComment) {
|
98
|
+
JSDOC.Parser.symbols.deleteSymbol(symbol.alias);
|
99
|
+
}
|
100
|
+
|
101
|
+
if (/#$/.test(symbol.alias)) { // we don't document prototypes
|
102
|
+
JSDOC.Parser.symbols.deleteSymbol(symbol.alias);
|
103
|
+
}
|
104
|
+
}
|
105
|
+
|
106
|
+
return JSDOC.Parser.symbols.toArray();
|
107
|
+
}
|
@@ -0,0 +1,33 @@
|
|
1
|
+
/**
|
2
|
+
@namespace Holds functionality related to running plugins.
|
3
|
+
*/
|
4
|
+
JSDOC.PluginManager = {
|
5
|
+
}
|
6
|
+
|
7
|
+
/**
|
8
|
+
@param name A unique name that identifies that plugin.
|
9
|
+
@param handlers A collection of named functions. The names correspond to hooks in the core code.
|
10
|
+
*/
|
11
|
+
JSDOC.PluginManager.registerPlugin = function(/**String*/name, /**Object*/handlers) {
|
12
|
+
if (!defined(JSDOC.PluginManager.plugins))
|
13
|
+
/** The collection of all plugins. Requires a unique name for each.
|
14
|
+
*/
|
15
|
+
JSDOC.PluginManager.plugins = {};
|
16
|
+
|
17
|
+
|
18
|
+
JSDOC.PluginManager.plugins[name] = handlers;
|
19
|
+
}
|
20
|
+
|
21
|
+
/**
|
22
|
+
@param hook The name of the hook that is being caught.
|
23
|
+
@param target Any object. This will be passed as the only argument to the handler whose
|
24
|
+
name matches the hook name. Handlers cannot return a value, so must modify the target
|
25
|
+
object to have an effect.
|
26
|
+
*/
|
27
|
+
JSDOC.PluginManager.run = function(/**String*/hook, /**Mixed*/target) {
|
28
|
+
for (var name in JSDOC.PluginManager.plugins) {
|
29
|
+
if (defined(JSDOC.PluginManager.plugins[name][hook])) {
|
30
|
+
JSDOC.PluginManager.plugins[name][hook](target);
|
31
|
+
}
|
32
|
+
}
|
33
|
+
}
|