archive-gh-me/jsdoc
1
0
Fork 0
mirror of https://github.com/jsdoc/jsdoc.git synced 2025-12-08 19:46:11 +00:00
Code Issues Projects Releases Wiki Activity

Add support for mixins to appear in haruki output.

Browse Source
This commit is contained in:
Michael Mathews 2010-12-17 10:53:50 +00:00
parent 684e22f90d
commit f97a8b5f64
1 changed files with 77 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

112
templates/haruki/publish.js
View File

@ -12,38 +12,51 @@
to.namespaces = {};
}
var thisNamespace = to.namespaces[element.name] = {
"name" : element.name,
"description" : element.desc || ""
'name': element.name,
'description': element.desc || '',
'access': element.access || ''
};
addDocNode(thisNamespace, from, element.path, element.name);
}
else if (element.kind === 'mixin') {
if (! to.mixins) {
to.mixins = {};
}
var thisMixin = to.mixins[element.name] = {
'name': element.name,
'description': element.desc || '',
'access': element.access || ''
};
addDocNode(thisMixin, from, element.path, element.name);
}
else if (element.kind === 'method') {
var _to = to;
if (element.scope === 'static') {
if (to.constructor) { // like a class
to = to.constructor;
}
}
// if (element.scope === 'static') {
// if (to.constructor) { // like a class
// to = to.constructor;
// }
// }
if (! to.functions) {
to.functions = {};
}
var thisFunction = to.functions[element.name] = {
"name" : element.name,
"access": element.access || "",
"description" : element.desc || "",
"parameters": [
]
'name': element.name,
'access': element.access || '',
'description': element.desc || '',
'parameters': [
],
'returns': element.returns
};
if (element.param) for (var i = 0, len = element.param.length; i < len; i++) {
thisFunction.parameters.push({
"name": element.param[i].name,
"type": element.param[i].type? (element.param[i].type.length === 1? element.param[i].type[0] : element.param[i].type) : "",
"description": element.param[i].description || "",
"default": element.param[i].defaultvalue || "",
"optional": typeof element.param[i].optional === 'boolean'? element.param[i].optional : "",
"nullable": typeof element.param[i].nullable === 'boolean'? element.param[i].nullable : ""
'name': element.param[i].name,
'type': element.param[i].type? (element.param[i].type.length === 1? element.param[i].type[0] : element.param[i].type) : '',
'description': element.param[i].desc || '',
'default': element.param[i].defaultvalue || '',
'optional': typeof element.param[i].optional === 'boolean'? element.param[i].optional : '',
'nullable': typeof element.param[i].nullable === 'boolean'? element.param[i].nullable : ''
});
}
to = _to;
@ -60,37 +73,66 @@
to.properties = {};
}
to.properties[element.name] = {
"name" : element.name,
"access": element.access || "",
"description" : element.desc || "",
"type": element.type? (element.type.length === 1? element.type[0] : element.type) : ""
'name': element.name,
'access': element.access || '',
'description': element.desc || '',
'type': element.type? (element.type.length === 1? element.type[0] : element.type) : ''
};
to = _to;
}
else if (element.kind === 'event') {
var _to = to;
if (! to.events) {
to.events = {};
}
var thisEvent = to.events[element.name] = {
'name': element.name,
'access': element.access || '',
'description': element.desc || '',
'parameters': [
],
'returns': element.returns
};
if (element.param) for (var i = 0, len = element.param.length; i < len; i++) {
thisEvent.parameters.push({
'name': element.param[i].name,
'type': element.param[i].type? (element.param[i].type.length === 1? element.param[i].type[0] : element.param[i].type) : '',
'description': element.param[i].desc || '',
'default': element.param[i].defaultvalue || '',
'optional': typeof element.param[i].optional === 'boolean'? element.param[i].optional : '',
'nullable': typeof element.param[i].nullable === 'boolean'? element.param[i].nullable : ''
});
}
to = _to;
}
else if (element.kind === 'constructor') {
if (! to.classes) {
to.classes = {};
}
var thisClass = to.classes[element.name] = {
"name" : element.name,
"description" : element.classdesc || "",
"access": element.access || "",
"constructor": {
"name" : element.name,
"description" : element.desc || "",
"parameters": [
'name': element.name,
'description': element.classdesc || '',
'extends': element.augments || [],
'access': element.access || '',
'fires': element.fires || '',
'constructor': {
'name': element.name,
'description': element.desc || '',
'parameters': [
]
}
};
if (element.param) for (var i = 0, len = element.param.length; i < len; i++) {
thisClass.constructor.parameters.push({
"name": element.param[i].name,
"type": element.param[i].type? (element.param[i].type.length === 1? element.param[i].type[0] : element.param[i].type) : "",
"description": element.param[i].description || "",
"default": element.param[i].defaultvalue || "",
"optional": typeof element.param[i].optional === 'boolean'? element.param[i].optional : "",
"nullable": typeof element.param[i].nullable === 'boolean'? element.param[i].nullable : ""
'name': element.param[i].name,
'type': element.param[i].type? (element.param[i].type.length === 1? element.param[i].type[0] : element.param[i].type) : '',
'description': element.param[i].desc || '',
'default': element.param[i].defaultvalue || '',
'optional': typeof element.param[i].optional === 'boolean'? element.param[i].optional : '',
'nullable': typeof element.param[i].nullable === 'boolean'? element.param[i].nullable : ''
});
}
addDocNode(thisClass, from, element.path, element.name);