Skip to content
New issue

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

Flags of module members #44

Closed
tineheller opened this issue Aug 16, 2018 · 1 comment
Closed

Flags of module members #44

tineheller opened this issue Aug 16, 2018 · 1 comment

Comments

@tineheller
Copy link
Collaborator

  1. With jsdoc comments it is now possible to mark module members static or inner (see myModule2).

  2. With module.export in javascript code it is now possible to mark module members exported or inner (see myModule1).

Both, the static and the exported members will be exported in the generated file.

But for now it is not quite clear why the @static tag has to be used in jsdoc comments and how the @exports tag can be used.

Additional some tests must be added for module member flags.

@wehrstedt
Copy link
Collaborator

I will close this because its pretty good tested for now. Also, the @static and @inner tags are supported. The @exports tag is used if your module is not an ES 6 module and will be instantiated by an object whose name is not export. Then you have to specify the export variable because jsdoc is not able to determine it. But this is nothing we have to handle because it is handled by jsdoc. See https://jsdoc.app/tags-exports.html

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants