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

improve error message when "-d console" isn't used (closes #174); JSHint cleanup

Browse Source
This commit is contained in:
Jeff Williams 2012-09-08 18:15:20 -07:00
parent 7675640537
commit d22d59b315
1 changed files with 11 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
templates/haruki/publish.js
View File

@ -10,7 +10,10 @@ function graft(parentNode, childNodes, parentLongname, parentName) {
.filter(function (element) { .filter(function (element) {
return (element.memberof === parentLongname); return (element.memberof === parentLongname);
}) })
.forEach(function (element, i) { .forEach(function (element, index) {
var i,
len;
if (element.kind === 'namespace') { if (element.kind === 'namespace') {
if (! parentNode.namespaces) { if (! parentNode.namespaces) {
parentNode.namespaces = []; parentNode.namespaces = [];
@ -67,13 +70,13 @@ function graft(parentNode, childNodes, parentLongname, parentName) {
} }
if (element.examples) { if (element.examples) {
for (var i = 0, len = element.examples.length; i < len; i++) { for (i = 0, len = element.examples.length; i < len; i++) {
thisFunction.examples.push(element.examples[i]); thisFunction.examples.push(element.examples[i]);
} }
} }
if (element.params) { if (element.params) {
for (var i = 0, len = element.params.length; i < len; i++) { for (i = 0, len = element.params.length; i < len; i++) {
thisFunction.parameters.push({ thisFunction.parameters.push({
'name': element.params[i].name, 'name': element.params[i].name,
'type': element.params[i].type? (element.params[i].type.names.length === 1? element.params[i].type.names[0] : element.params[i].type.names) : '', 'type': element.params[i].type? (element.params[i].type.names.length === 1? element.params[i].type.names[0] : element.params[i].type.names) : '',
@ -122,13 +125,13 @@ function graft(parentNode, childNodes, parentLongname, parentName) {
} }
if (element.examples) { if (element.examples) {
for (var i = 0, len = element.examples.length; i < len; i++) { for (i = 0, len = element.examples.length; i < len; i++) {
thisEvent.examples.push(element.examples[i]); thisEvent.examples.push(element.examples[i]);
} }
} }
if (element.params) { if (element.params) {
for (var i = 0, len = element.params.length; i < len; i++) { for (i = 0, len = element.params.length; i < len; i++) {
thisEvent.parameters.push({ thisEvent.parameters.push({
'name': element.params[i].name, 'name': element.params[i].name,
'type': element.params[i].type? (element.params[i].type.names.length === 1? element.params[i].type.names[0] : element.params[i].type.names) : '', 'type': element.params[i].type? (element.params[i].type.names.length === 1? element.params[i].type.names[0] : element.params[i].type.names) : '',
@ -164,13 +167,13 @@ function graft(parentNode, childNodes, parentLongname, parentName) {
parentNode.classes.push(thisClass); parentNode.classes.push(thisClass);
if (element.examples) { if (element.examples) {
for (var i = 0, len = element.examples.length; i < len; i++) { for (i = 0, len = element.examples.length; i < len; i++) {
thisClass.constructor.examples.push(element.examples[i]); thisClass.constructor.examples.push(element.examples[i]);
} }
} }
if (element.params) { if (element.params) {
for (var i = 0, len = element.params.length; i < len; i++) { for (i = 0, len = element.params.length; i < len; i++) {
thisClass.constructor.parameters.push({ thisClass.constructor.parameters.push({
'name': element.params[i].name, 'name': element.params[i].name,
'type': element.params[i].type? (element.params[i].type.names.length === 1? element.params[i].type.names[0] : element.params[i].type.names) : '', 'type': element.params[i].type? (element.params[i].type.names.length === 1? element.params[i].type.names[0] : element.params[i].type.names) : '',
@ -211,7 +214,7 @@ exports.publish = function(data, opts) {
} }
} }
else { else {
console.log('The only -d destination option currently supported is "console"!'); console.log('This template only supports output to the console. Use the option "-d console" when you run JSDoc.');
} }
}; };