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

Fix JSdocs in new components #2366

Closed
3 tasks done
robyngit opened this issue Apr 17, 2024 · 0 comments · Fixed by #2407
Closed
3 tasks done

Fix JSdocs in new components #2366

robyngit opened this issue Apr 17, 2024 · 0 comments · Fixed by #2407
Assignees
Labels
documentation Creating and enhancing app documentation Priority: Low
Milestone

Comments

@robyngit
Copy link
Member

robyngit commented Apr 17, 2024

Noticed a few minor with the jsdoc comments in the new 2.28.0 models, views, and collections. This issue is to track fixing those for the next release.

  • @classdes --> @classdesc - doesn't break the jsdoc build, but description doesn't show up on the docs site
  • add missing @lends classname.prototype - without this, the method documentation doesn't show up in the class documentation on the docs site
  • add missing @extends Backbone.Model, or which ever class it extends

For example, see the ViewfinderModel docs. Even though this class has a description and documented methods, they don't show up on the docs site because of the missing @lends tag and the typo in the @classdes tag.

MetacatUI is missing JSdocs in many of the older components as well, but this issue is just to fix the new components so that we can continue the practice of adding complete documentation for new or modified components going forward.

@robyngit robyngit added Priority: Low documentation Creating and enhancing app documentation labels Apr 17, 2024
@robyngit robyngit added this to the 2.29.0 milestone Apr 17, 2024
@robyngit robyngit self-assigned this Apr 17, 2024
robyngit added a commit that referenced this issue May 6, 2024
- @classdes --> @classdesc
- add missing @Lends classname.prototype
- add missing @extends

Issue #2366
@robyngit robyngit linked a pull request May 6, 2024 that will close this issue
@robyngit robyngit closed this as completed May 6, 2024
ianguerin pushed a commit that referenced this issue May 17, 2024
- @classdes --> @classdesc
- add missing @Lends classname.prototype
- add missing @extends

Issue #2366
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Creating and enhancing app documentation Priority: Low
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant