Document the JSDoc @overload tag
#3482
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The description and example are mostly copied and rephrased from the 5.0 Release Note and /docs/handbook/2/functions.html#function-overloads. It is placed after `@param` and `@returns` because it also concerns functions.
Author
|
@microsoft-github-policy-service agree |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The tag is currently only documented in the 5.0 Release Note and not referenced in the JSDoc reference. That's hard to find: I only found it after stumbling onto it on typedoc's website.
This PR adds the tag to the reference. The description and example are mostly copied and rephrased from the 5.0 Release Note and /docs/handbook/2/functions.html#function-overloads. It is placed after
@paramand@returnsbecause it also concerns functions.