-
Notifications
You must be signed in to change notification settings - Fork 131
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
Add more standard tag definitions #50
Conversation
…n the standard definitions
…tiple, since in practice most tags are single-usage
tsdoc/src/details/StandardTags.ts
Outdated
* Example implementations: API Extractor | ||
*/ | ||
public static readonly internalRemarks: TSDocTagDefinition = StandardTags._defineTag({ | ||
tagName: '@internalRemarks', |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
internal [](start = 15, length = 8)
@privateRemarks
? #Resolved
tsdoc/src/details/StandardTags.ts
Outdated
* | ||
* Example implementations: API Extractor | ||
*/ | ||
public static readonly preapproved: TSDocTagDefinition = StandardTags._defineTag({ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
preapproved [](start = 25, length = 11)
This is too obscure to be in the standard. #Resolved
tsdoc/src/details/StandardTags.ts
Outdated
StandardTags.param, | ||
StandardTags.readonly, | ||
StandardTags.remarks, | ||
StandardTags.returns |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There are a few missing here. #Resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This PR was published as @microsoft/tsdoc version 0.2.0. |
Rename the
CoreTags
API toStandardTags
and introduce a distinction between "core", "extended", and "discretionary" standard tags.