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

Fix for @returns type and description not appearing in the output.

Browse Source
This commit is contained in:
Michael Mathews 2012-05-29 20:19:07 +01:00
parent 84f4e54c55
commit 59655252e1
2 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
templates/haruki/README.md
View File

@ -12,6 +12,7 @@ Currently Haruki only supports a subset of the tags supported by the default tem
* @function (or @method) * @function (or @method)
* @var (or @member) * @var (or @member)
* @class * @class
* @mixin
* @event * @event
* @param * @param
* @returns * @returns

9
templates/haruki/publish.js
View File

@ -5,7 +5,6 @@
./jsdoc scratch/jsdoc_test.js -t templates/haruki -d console -q format=xml ./jsdoc scratch/jsdoc_test.js -t templates/haruki -d console -q format=xml
*/ */
//var dumper = require('jsdoc/util/dumper');
(function() { (function() {
/** /**
@ -45,7 +44,7 @@
}) })
.forEach(function (element, i) { .forEach(function (element, i) {
//console.log((i+1)+': '+element.kind+' '+element.longname+' ('+element.name+')'); //console.log((i+1)+': '+element.kind+' '+element.longname+' ('+element.name+')');
if (element.kind === 'namespace') { if (element.kind === 'namespace') {
if (! parentNode.namespaces) { if (! parentNode.namespaces) {
parentNode.namespaces = { }; parentNode.namespaces = { };
@ -87,11 +86,11 @@
'parameters': [ ], 'parameters': [ ],
'examples': [] 'examples': []
}; };
if (element.returns) { if (element.returns) {
parentNode.functions[element.name].returns = { parentNode.functions[element.name].returns = {
'type': element.returns.type? (element.returns.type.names.length === 1? element.returns.type.names[0] : element.returns.type.names) : '', 'type': element.returns[0].type? (element.returns[0].type.names.length === 1? element.returns[0].type.names[0] : element.returns[0].type.names) : '',
'description': element.returns.description || '' 'description': element.returns[0].description || ''
}; };
} }