Minor refactoring in SimpleCommentBuildr and CustomJavaDocCommentBuilder #788
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
Damtev
requested changes
Aug 25, 2022
Comment on lines
48
to
56
| val exceptionThrow: String? = if (thrownException == null) { | ||
| traceTag.result.exceptionOrNull()?.let { it::class.qualifiedName } | ||
| } else { | ||
| val thrownExceptionDescription: String? = thrownException?.let { | ||
| val exceptionName = thrownException.javaClass.name | ||
| val reason = findExceptionReason(currentMethod, thrownException) | ||
| "{@link $exceptionName} $reason" | ||
| } | ||
|
|
||
| if (exceptionThrow != null) { | ||
| customJavaDocComment.throwsException = exceptionThrow | ||
| if (thrownExceptionDescription != null) { | ||
| customJavaDocComment.throwsException = thrownExceptionDescription | ||
| } |
There was a problem hiding this comment.
I guess, it could be a little simplified:
if (thrownException != null) {
val exceptionName = thrownException.javaClass.name
val reason = findExceptionReason(currentMethod, thrownException)
customJavaDocComment.throwsException = "{@link $exceptionName} $reason"
}
Damtev
approved these changes
Aug 26, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
There are expressions that are always null in
SimpleCommentBuilder#buildThrownExceptionInfo()line 49 andCustomJavaDocCommentBuilder#buildCustomJavaDocComment()line 62.This PR contains minor refactoring of these methods.
Fixes #787
Type of Change
Please delete options that are not relevant.
How Has This Been Tested?
Run tests in summaries-test.
Automated Testing
Run tests in summaries-test.
Checklist (remove irrelevant options):