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
We should provide some non-module examples that show how to use JSDoc with code wrapped in IIFEs. See jsdoc/jsdoc#456 for more context.
The text was updated successfully, but these errors were encountered:
So what is the workaround now to let jsdoc generate documentation if you encapsulate your function?
I'm encapsulating my function like this:
(function() { // some code with functions and documentation })();
Which generates output if I leave out the encapsulation.
Sorry, something went wrong.
I've found out that you may use annotations on IIFE's (@Class or @method for example) to generate the docs.
Something like this:
/** * @class className */ (function(){ /** * @name #init * @function * @memberOf className */ function init() { }; })();
No branches or pull requests
We should provide some non-module examples that show how to use JSDoc with code wrapped in IIFEs. See jsdoc/jsdoc#456 for more context.
The text was updated successfully, but these errors were encountered: