Add "@see" handling and output to documentation #12144
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.
Summary
This PR adds JSDOC
@see
handling (in mongoose specific way) and output to the documentationthe following matches apply for the custom
@see
handling:# The following is "raw tag" to (->) "text output as listed in the documentation" "@see External Links http://someurl.com/" -> "External Links" "@see External https://someurl.com/" -> "External" "@see Id href #some_Some-method" -> "Id href" "@see Local Absolute /docs/somewhere" -> "Local Absolute" "@see No Href" -> "No Href" "@see https://someurl.com" -> "" (uses fallback "No text") "@see Some#Method #something" -> "Some#Method"
This PR also does some things i noticed while going through:
:
toParameters
list to be consistent with otherh5
Schema.prototype.plugin
As a side-effect, this also addresses some things mentioned in #12111