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.

Sign up for GitHub

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

Jump to bottom

How to omit constructor? #21

Closed
dietergeerts opened this issue Aug 1, 2017 · 5 comments
Closed

How to omit constructor? #21

dietergeerts opened this issue Aug 1, 2017 · 5 comments
Labels
feature-request jsdoc-question v2 ✓ Fixed or implemented. To be released.

Comments

@dietergeerts
Copy link

We are writing AngularJS services, which are classes, and therefore, we don't need to document the constructor, but whatever I do, I can't get then to be not included. @ignore doesn't work for them. Is there a way or setting that I can not include the constructor, but keep the class api doc?
@onury
Copy link
Owner

onury commented Aug 1, 2017

This is not related to Docma, but rather a JSDoc question. Please use StackOverflow or other QA sites for this.

You can take a look at JSDoc documentation. There is a @hideconstructor tag. You could also mark it @private if you're not documenting private symbols.

@onury onury closed this as completed Aug 1, 2017
@onury
Copy link
Owner

onury commented Aug 1, 2017

@hideconstructor tag is supported in JSDoc 3.5.0 and later. Docma currently supports JSDoc v3.4.3. This will be available with new Docma release.

@onury onury reopened this Aug 1, 2017
@dietergeerts
Copy link
Author

Thx.

@onury onury added the v2 label Dec 9, 2017
@onury onury added the ✓ Fixed or implemented. To be released. label Dec 29, 2017
@onury
Copy link
Owner

onury commented Apr 12, 2018

Available with Docma v2.0.0 — just released.
Thanks.

@onury onury closed this as completed Apr 12, 2018
@dietergeerts
Copy link
Author

Thx. The new version is looking good. Sure to try it out, as I still haven't found a good doc builder for my projects (not one that I like the results from and that can work with the crazy FP stuff in it.)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
feature-request jsdoc-question v2 ✓ Fixed or implemented. To be released.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@onury @dietergeerts