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

docs: use TSDoc - instead of JSDoc #318

Merged
merged 4 commits into from
Jan 29, 2023
Merged

docs: use TSDoc - instead of JSDoc #318

merged 4 commits into from
Jan 29, 2023

Conversation

jkowalleck
Copy link
Member

@jkowalleck jkowalleck commented Nov 5, 2022 •
edited
Loading

on the long run i would prefer TSDoc is ts-files, and JsDoc in js files ....

supports #57

OUTDATED:

unfortunatelty the IDEs I tested do not know TSDoc. they know JsDOC instead ... therefore: #319
Hope this changes in the future. see https://youtrack.jetbrains.com/issue/WEB-36309/Integrate-TSDOC-to-webstorm

  • have validator(eslint-plugin) for TSDOc
  • have all JSDoc in tyescript files converted to TSDOc

@jkowalleck jkowalleck added the enhancement New feature or request label Nov 5, 2022
@jkowalleck jkowalleck mentioned this pull request Nov 5, 2022
Merged
2 tasks
@jkowalleck jkowalleck changed the title eslink check for tsdoc TSDoc - instead of JSDoc Nov 5, 2022
@jkowalleck jkowalleck mentioned this pull request Nov 5, 2022
Closed
@jkowalleck jkowalleck changed the title TSDoc - instead of JSDoc [IDEA] TSDoc - instead of JSDoc Nov 5, 2022
@jkowalleck jkowalleck force-pushed the tsdoc-eslint branch 2 times, most recently from c8a920c to 05c1d64 Compare November 7, 2022 18:09
@jkowalleck
eslink check for tsdoc
19b05f7 
Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>
@jkowalleck
history
0114add 
Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>
@jkowalleck
docs improvements
c3e80aa 
Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>
@jkowalleck jkowalleck marked this pull request as ready for review January 29, 2023 11:57
@jkowalleck jkowalleck requested a review from a team as a code owner January 29, 2023 11:57
@jkowalleck jkowalleck changed the title [IDEA] TSDoc - instead of JSDoc docs: use TSDoc - instead of JSDoc Jan 29, 2023
@jkowalleck jkowalleck added documentation Improvements or additions to documentation and removed enhancement New feature or request labels Jan 29, 2023
@jkowalleck
docs improvements
04cd977 
Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>
@jkowalleck jkowalleck merged commit b3b983d into main Jan 29, 2023
@jkowalleck jkowalleck deleted the tsdoc-eslint branch January 29, 2023 12:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@jkowalleck