Javadoc tags parsing #242
Open
Javadoc tags parsing #242
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
# Conflicts: # openapi-maven-plugin/src/main/java/io/github/kbuntrock/yaml/YamlWriter.java
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.
This PR adds the feature to parse javadoc tags in the following way:
@summary -> goes into the summary field in yaml
https://github.com/code -> adds markdown tick marks to denote a piece of inline code
https://github.com/link -> adds markdown to generate a clickable link (so far only links)
@see -> adds markdown to emphasize the content
The tag itself is stripped from the description
For some reason, updating my branch closed the MR. I've created a clean new one