Updated class and method javadoc handling #1579
Merged
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
Closed
dto's class javadoc: added as description for the schema controller's class javadoc: added as description of the tag controller's method javadoc: first line as summary everything as description filters the generic responses by the declared exceptions: only if override-with-generic-response-if-declared is true @throws in method javadoc: overrides the @return of the ExceptionHandler's method only if override-with-generic-response-if-declared is true
Summary is only filled using javadoc if there is no description from annotation. Failing test update (missing summary or schema description and ordering).
gebezs
force-pushed
the
javadoc-enhancement
branch
from
afe6f16 to
338574d
Compare
Collaborator
|
Thank you for your contribution! |
bnasslahsen
added a commit
that referenced
this pull request
Apr 20, 2022
mpleine
pushed a commit
to mpleine/springdoc-openapi
that referenced
this pull request
May 17, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
dto's class javadoc:
controller's class javadoc:
controller's method javadoc:
filters the generic responses by the declared exceptions:
override-with-generic-response-if-declaredistrue@throwsin method javadoc:@returnof theExceptionHandler's methodoverride-with-generic-response-if-declaredistrueFormatting
Test update for existing tests