Skip to content
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 "@see" handling and output to documentation #12144

Merged
merged 4 commits into from Jul 25, 2022

Conversation

hasezoey
Copy link
Collaborator

Summary

This PR adds JSDOC @see handling (in mongoose specific way) and output to the documentation

the 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:

  • add : to Parameters list to be consistent with other h5
  • add proper link to Schema.prototype.plugin

As a side-effect, this also addresses some things mentioned in #12111

Copy link
Collaborator

@vkarpov15 vkarpov15 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks 👍

@vkarpov15 vkarpov15 added this to the 6.4.7 milestone Jul 25, 2022
@vkarpov15 vkarpov15 merged commit cacdc02 into Automattic:master Jul 25, 2022
@hasezoey hasezoey deleted the addSee branch July 26, 2022 10:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants