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

TSDoc: Support @remarks tag #87

Closed
RunDevelopment opened this issue Feb 13, 2021 · 3 comments
Closed

TSDoc: Support @remarks tag #87

RunDevelopment opened this issue Feb 13, 2021 · 3 comments

Comments

@RunDevelopment
Copy link
Contributor

Support the @remarks and @privateRemarks TSDoc tags. They are similar to the JSDoc @description tag and require MD formatting.
@RunDevelopment RunDevelopment changed the title TSDoc: Support @remarks tags TSDoc: Support @remarks tag Feb 13, 2021
@hosseinmd
Copy link
Owner

We have a rule for formatting descriptions which is not correct. I think we should format all tags description, so we should remove TAGS_NEED_FORMAT_DESCRIPTION

@hosseinmd
Copy link
Owner

What is @remarks and @privateRemarks order in tags.

@RunDevelopment
Copy link
Contributor Author

What is @remarks and @privateRemarks order in tags.

Right under @description would probably be best.

hosseinmd added a commit that referenced this issue Feb 18, 2021
@hosseinmd
feat: add @remarks and @privateRemarks
40cbe4b 
issue: #87
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@RunDevelopment @hosseinmd