We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
The very first example of the jsDoc @param page shows that the type is optional:
@param
/** * @param somebody */ function sayHello(somebody) { alert('Hello ' + somebody); }
And yet dox chokes when no type is given:
$ cat <<——— | dox --raw --debug /** * @param [a] */ ——— [ { tags: [ { type: 'param', // … optional: false } ], /* … */ } ]
Everything is ok when you pass a type:
$ cat <<——— | dox --raw --debug /** * @param {any} [a] */ ——— [ { tags: [ { type: 'param', // … optional: true } ], /* … */ } ]
The text was updated successfully, but these errors were encountered:
No branches or pull requests
The very first example of the jsDoc
@param
page shows that the type is optional:And yet dox chokes when no type is given:
Everything is ok when you pass a type:
The text was updated successfully, but these errors were encountered: