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

Added support for globals in the default template.

Browse Source
This commit is contained in:
Michael Mathews 2011-02-27 20:36:41 +00:00
parent 5b5bc59161
commit 98f5751ff7
4 changed files with 27 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
templates/default/publish.js
View File

@ -183,9 +183,9 @@
longnameToUrl = {};
data.forEach(function(doclet) {
if (doclet.memberof && containers.indexOf(doclet.kind) < 0) {
if (containers.indexOf(doclet.kind) < 0) {
var longname = doclet.longname,
urlSafe = doclet.memberof.replace(/[^$a-z0-9._-]/gi, '_'), // TODO handle name collisions
urlSafe = ('global' || doclet.memberof).replace(/[^$a-z0-9._-]/gi, '_'), // TODO handle name collisions
url = urlSafe + '.html#'+doclet.name;
}
else {
@ -241,6 +241,17 @@
nav = nav + '</ul>';
}
var globalNames = data.get( data.find({kind: ['property', 'function'], 'memberof': {'isUndefined': true}}) );
if (globalNames.length) {
nav = nav + '<h3>Global</h3><ul>';
globalNames.forEach(function(g) {
if (!seen[g.longname]) nav += '<li>'+linkto(g.longname, g.name)+'</li>';
seen[g.longname] = true;
});
nav = nav + '</ul>';
}
for (var longname in longnameToUrl) {
var classes = data.get( data.find({kind: 'class', longname: longname}) );
if (classes.length) generate('Class: '+classes[0].name, classes, longnameToUrl[longname]);
@ -249,9 +260,11 @@
if (modules.length) generate('Module: '+modules[0].name, modules, longnameToUrl[longname]);
var namespaces = data.get( data.find({kind: 'namespace', longname: longname}) );
if (namespaces.length) generate('Namespace: '+namespaces[0].name, namespaces, longnameToUrl[longname]);
if (namespaces.length) generate('Namespace: '+namespaces[0].name, namespaces, longnameToUrl[longname]);
}
if (globals.length) generate('Global', [{kind: 'globalobj'}], 'global.html');
function generate(title, docs, filename) {
var data = {

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

@ -117,7 +117,7 @@
<?js
var classes = find({kind: 'class', memberof: doc.longname});
if (classes && classes.length && classes.forEach) {
if (doc.kind !== 'globalobj' && classes && classes.length) {
?>
<h3 class="subsection-title">Classes</h3>
@ -135,7 +135,7 @@
<?js
var namespaces = find({kind: 'namespace', memberof: doc.longname});
if (namespaces && namespaces.length && namespaces.forEach) {
if (doc.kind !== 'globalobj' && namespaces && namespaces.length) {
?>
<h3 class="subsection-title">Namespaces</h3>

2
templates/default/tmpl/details.tmpl
View File

@ -32,8 +32,10 @@
<dd><?js= license ?></dd>
<?js } ?>
<?js if (this.meta) {?>
<dt>Source:</dt>
<dd><?js= meta.filename ?>, line <?js= meta.lineno ?></dd>
<?js } ?>
<?js if (this.see && see.length) {?>
<dt>See:</dt>

6
templates/default/tmpl/method.tmpl
View File

@ -16,6 +16,12 @@
<?js print(render('details.tmpl', this)); ?>
<?js
if (this['this']) {
print('<h5>This:</h5>');
print( '<ul><li>'+linkto(this['this'], this['this'])+'</li></ul>' );
}
?>
<?js
if (this.params && params.length) {