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

Reworked JSON generation for haruki schema.

Browse Source
This commit is contained in:
Thomas Yandell 2010-08-09 16:54:21 +08:00 committed by Michael Mathews
parent 37e0ea50f3
commit f382b16003
1 changed files with 46 additions and 69 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

115
templates/haruki/publish.js
View File

@ -1,73 +1,50 @@
(function() {
var fs = require('common/fs');
publish = function(docs, opts) { // global
var classes;
classes = docs.doc.filter(function(element, index, array) {
return (element.kind === 'constructor');
});
// add properties and methods
classes.forEach(function(classElement) {
classElement.properties = docs.doc.filter(function(memberElement) {
return (
memberElement.kind === 'property'
&& memberElement.memberof === classElement.path
);
});
classElement.methods = docs.doc.filter(function(memberElement) {
return (
memberElement.kind === 'method'
&& memberElement.memberof === classElement.path
);
});
});
// templates!
var normal = require('normal/template'),
src = fs.read( BASEDIR + 'templates/haruki/tmpl/docs.json' ),
template = normal.compile(src,
{
'filters': {
'json': function(str) {
return str.replace(/\\/g, "\\\\")
.replace(/"/g, '\\"')
.replace(/\f/g, "\\f")
.replace(/\n/g, "\\n")
.replace(/\r/g, "\\r")
.replace(/\t/g, "\\t");
}
}
}
);
print( template( {classes: classes} ) );
}
function getDoc(docpath) {
var i, doc;
if ( doc = getDoc.cache[docpath] ) {
return doc;
}
i = docs.doc.length;
while (i--) {
if (docs.doc[i].path === docpath) {
return docs.doc[i];
}
}
}
getDoc.cache = {};
// helpers
publish.summarize = function(desc) { // just the first line
return /(.*)/.test(desc), RegExp.$1;
}
var dumper = require('flesler/jsdump');
publish = function(docs, opts) { // global
function addNamespaces (to, from, parentPath, parentName) {
from.filter(function (element) {
return (element.memberof === parentPath);
}).forEach(function (element) {
if (element.kind === 'namespace') {
if (! to.namespaces) {
to.namespaces = {};
}
var nestedNamespace = to.namespaces[element.name] = {
"name" : element.name,
"description" : element.desc
};
addNamespaces(nestedNamespace, from, element.path, element.name);
}
else if (element.kind === 'method') {
if (! to.functions) {
to.functions = {};
}
to.functions[element.name] = {
"name" : element.name,
"description" : element.desc
};
}
else if (element.kind === 'property') {
if (! to.properties) {
to.properties = {};
}
to.properties[element.name] = {
"name" : element.name,
"description" : element.desc
};
}
});
}
var rootNamespace = {};
addNamespaces(rootNamespace, docs.doc, undefined);
print(dumper.jsDump.parse(rootNamespace));
}
})();
})();