docs: update format of javadoc to produce a functional link#5182
Open
Mattias-Sehlstedt wants to merge 1 commit into
Open
docs: update format of javadoc to produce a functional link#5182Mattias-Sehlstedt wants to merge 1 commit into
Mattias-Sehlstedt wants to merge 1 commit into
Conversation
| * ServerVariables | ||
| * | ||
| * @see "https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#server-variables-object" | ||
| * @see <a href="https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#server-variable-object">ServerVariables (OpenAPI 3.0 specification)</a> |
Contributor
Author
There was a problem hiding this comment.
The old link was incorrect, see https://github.com/OAI/OpenAPI-Specification/blob/3.0.4/versions/3.0.4.md#server-variable-object
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
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.
Pull Request
Thank you for contributing to swagger-core!
Please fill out the following information to help us review your PR efficiently.
Description
Updates the javadoc
@seeso that it properly produce navigable links. See current javadoc to see the current non-functioning doc.This aligns the behavior with javadoc best-practices and with how
@seeis used elsewhere in the repository.Fixes:
Type of Change
Checklist
Screenshots / Additional Context
Old behavior/look:
New behavior/look:
