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

if a symbol shares its longname with a module, only show the symbol if it either a) has a description or b) is a class (#853)

Browse Source
This commit is contained in:
Jeff Williams 2014-12-28 12:32:47 -08:00
parent 8d9134015f
commit 0080e5f99f
1 changed files with 13 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
templates/default/publish.js
View File

@ -269,15 +269,21 @@ function attachModuleSymbols(doclets, modules) {
return modules.map(function(module) {
if (symbols[module.longname]) {
module.modules = symbols[module.longname].map(function(symbol) {
symbol = doop(symbol);
module.modules = symbols[module.longname]
// Only show symbols that have a description. Make an exception for classes, because
// we want to show the constructor-signature heading no matter what.
.filter(function(symbol) {
return symbol.description || symbol.kind === 'class';
})
.map(function(symbol) {
symbol = doop(symbol);
if (symbol.kind === 'class' || symbol.kind === 'function') {
symbol.name = symbol.name.replace('module:', '(require("') + '"))';
}
if (symbol.kind === 'class' || symbol.kind === 'function') {
symbol.name = symbol.name.replace('module:', '(require("') + '"))';
}
return symbol;
});
return symbol;
});
}
});
}