tui.tree icon indicating copy to clipboard operation
tui.tree copied to clipboard

fix: errors in jsdoc comments, return type of isLeaf()

Open pastelmind opened this issue 2 years ago • 0 comments

Please check if the PR fulfills these requirements

  • [x] It's submitted to right branch according to our branching model
  • [x] It's right issue type on title
  • [ ] When resolving a specific issue, it's referenced in the PR's title (e.g. fix #xxx[,#xxx], where "xxx" is the issue number)
  • [x] The commit message follows our guidelines
  • [ ] Tests for the changes have been added (for bug fixes/features)
  • [x] Docs have been added/updated (for bug fixes/features)
  • [ ] It does not introduce a breaking change or has description for the breaking change

Description

I found and fixed several incorrect JSDoc comments, such as:

  • Incorrect return types (e.g. returns null instead of undefined, or vice versa)
  • Function parameters that no longer exist
  • Function parameters whose shape has changed
  • Incorrect code in @example

I also fixed Tree#isLeaf() so that it always returns a boolean.


Thank you for your contribution to TOAST UI product. 🎉 😘 ✨

pastelmind avatar Oct 24 '22 04:10 pastelmind