Allow JSDoc-style @link inline tags #514
Closed
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
|
Closing this as it needs some adjustments after seeing http://usejsdoc.org/about-namepaths.html#namepaths-in-jsdoc-3 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR is meant to allow for standard JSDoc syntax of @link tags to be parsed by TypeDoc. JSDoc tags follow the standards laid out here: http://usejsdoc.org/tags-inline-link.html. The main difference between the current TypeDoc implementation (which remains as is), and JSDoc is the use of '#' rather than '.'.
See also #488. This is also resolved by this PR. Converting any instance of '#.' in a tag (valid JSDoc syntax to reference a static function) to '.@static', which can then be used to distinguish members of the same name and select the static version.
The last minor change is including 'static-' in the anchor of static members, which didn't work before. It is now done at the alias level to avoid unnecessary suffixes in names.
The overlying goal here is to allow users coming from JS/JSDoc environments to more quickly get up and running with TS/TypeDoc.
As a side note, this is my first PR for this project, so in addition to any flaws, let me know about style issues.