docs: replaced @link
to @see
in jsdoc
#477
Merged
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.
@link
is inline directive. Therefore, using it asis actually a wrong syntax. As a result, some editors do not handle links correctly:
Note that the link is
https://developer.mozilla.org/en-US/docs/Web/API/MutationObserver|MutationObserver
.Also, in rendered mode
@link
are not parsed at all,Because the
@link
is used as a block directive, I replaced it with the@see
directive, and changed the syntax for anchors in some places. Now:Alternatively, you could use the link directive, but in an inline mode: