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

Changes to support displaying typedef, fixed issue that caused methods with multiple returns to be documented with the last return instead of the first.

Browse Source
This commit is contained in:
Michael Mathews 2011-11-17 06:59:52 +00:00
parent 8952a5ee17
commit 83dffea495
2 changed files with 33 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
templates/default/publish.js
View File

@ -1,6 +1,7 @@
(function() {
var template = require('underscore/template'),
var _ = require('underscore/underscore'),
template = require('underscore/template'),
fs = require('fs'),
helper = require('jsdoc/util/templateHelper'),
scopeToPunc = { 'static': '.', 'inner': '~', 'instance': '#' };
@ -75,12 +76,17 @@
if (f.returns) {
f.returns.forEach(function(r) {
if (r.type && r.type.names) {
returnTypes = r.type.names;
if (! returnTypes.length) { returnTypes = r.type.names; }
}
});
}
f.signature = '<span class="signature">'+(f.signature || '') + '</span>' + '<span class="type-signature">'+htmlsafe(returnTypes.length? ' &rarr; {'+returnTypes.join('|')+'}' : '')+'</span>';
if (returnTypes && returnTypes.length) {
returnTypes = _.map(returnTypes, function(r) {
return linkto(r);
});
}
f.signature = '<span class="signature">'+(f.signature || '') + '</span>' + '<span class="type-signature">'+(returnTypes.length? ' &rarr; {'+returnTypes.join('|')+'}' : '')+'</span>';
}
function addSignatureType(f) {
@ -130,12 +136,6 @@
data.forEach(function(doclet) {
doclet.signature = '';
doclet.attribs = '';
if (doclet.kind === 'function' || doclet.kind === 'class') {
addSignatureParams(doclet);
addSignatureReturns(doclet);
addAttribs(doclet);
}
if (doclet.kind === 'member') {
addSignatureType(doclet);
@ -167,15 +167,12 @@
doclet.see[i] = hashToLink(doclet, seeItem);
});
}
});
data.orderBy(['longname', 'version', 'since']);
// kinds of containers
var globals = find( {kind: ['member', 'function', 'constant'], memberof: {isUndefined: true}} ),
var globals = find( {kind: ['member', 'function', 'constant', 'typedef'], memberof: {isUndefined: true}} ),
modules = find({kind: 'module'}),
externals = find({kind: 'external'}),
mixins = find({kind: 'mixin'}),
@ -218,6 +215,12 @@
else {
doclet.id = doclet.name;
}
if (doclet.kind === 'function' || doclet.kind === 'class') {
addSignatureParams(doclet);
addSignatureReturns(doclet);
addAttribs(doclet);
}
})
// do this after the urls have all been generated
@ -300,12 +303,12 @@
nav = nav + '</ul>';
}
var globalNames = find({kind: ['member', 'function', 'constant'], 'memberof': {'isUndefined': true}});
var globalNames = find({kind: ['member', 'function', 'constant', 'typedef'], 'memberof': {'isUndefined': true}});
if (globalNames.length) {
nav = nav + '<h3>Global</h3><ul>';
globalNames.forEach(function(g) {
if ( !seen.hasOwnProperty(g.longname) ) nav += '<li>'+linkto(g.longname, g.name)+'</li>';
if ( g.kind !== 'typedef' && !seen.hasOwnProperty(g.longname) ) nav += '<li>'+linkto(g.longname, g.name)+'</li>';
seen[g.longname] = true;
});
@ -331,7 +334,7 @@
var externals = find({kind: 'external', longname: longname});
if (externals.length) generate('External: '+externals[0].name, externals, helper.longnameToUrl[longname]);
}
if (globals.length) generate('Global', [{kind: 'globalobj'}], 'global.html');

14
templates/default/tmpl/container.tmpl
View File

@ -191,6 +191,20 @@
<?js } ?>
<?js
var typedefs = find({kind: 'typedef', memberof: doc.longname});
if (typedefs && typedefs.length && typedefs.forEach) {
?>
<h3 class="subsection-title">TypeDefs</h3>
<dl><?js
typedefs.forEach(function(e) {
print(render('members.tmpl', e));
});
?></dl>
<?js } ?>
<?js
var events = find({kind: 'event', memberof: doc.longname});
if (events && events.length && events.forEach) {