Fixed KdocComments and KdocFormatting
#1892
Open
Conversation
This file contains 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
…es in class KDoc at the same time
…aven't empty line before them - added smoke test for class kdoc
Codecov ReportAttention:
Additional details and impacted files@@ Coverage Diff @@
## master #1892 +/- ##
============================================
+ Coverage 78.28% 78.31% +0.03%
+ Complexity 2471 2458 -13
============================================
Files 134 134
Lines 8712 8698 -14
Branches 2210 2199 -11
============================================
- Hits 6820 6812 -8
+ Misses 905 903 -2
+ Partials 987 983 -4 ☔ View full report in Codecov by Sentry. |
akuleshov7
reviewed
Dec 24, 2023
...t-rules/src/main/kotlin/com/saveourtool/diktat/ruleset/rules/chapter2/kdoc/KdocFormatting.kt
Show resolved
Hide resolved
akuleshov7
reviewed
Dec 24, 2023
...t-rules/src/main/kotlin/com/saveourtool/diktat/ruleset/rules/chapter2/kdoc/KdocFormatting.kt
Show resolved
Hide resolved
akuleshov7
reviewed
Dec 24, 2023
| @@ -306,7 +263,8 @@ class KdocComments(configRules: List<RulesConfig>) : DiktatRule( | |||
|
|
|||
| KDOC_NO_CONSTRUCTOR_PROPERTY.warnAndFix(configRules, emitWarn, isFixMode, warningText, node.startOffset, node) { | |||
| val classNode = node.parent { it.elementType == CLASS }!! | |||
| val newKdocText = if (isParamTagNeeded) "/**\n * @param $parameterName\n */" else "/**\n * @property $parameterName\n */" | |||
| val paramOrPropertyTagText = if (isParamTagNeeded) "@param" else "@property" | |||
There was a problem hiding this comment.
Kotlin parser definitely has all these enum constants like param and property inside already. Use them.
akuleshov7
reviewed
Dec 24, 2023
| ) { | ||
| val wrongTagText = if (isParamTagNeeded) "* @property $parameterName" else "* @param $parameterName" | ||
| val replaceText = if (isParamTagNeeded) "* @param $parameterName" else "* @property $parameterName" | ||
| val paramOrPropertySwitchText = if (isParamTagNeeded) "@property" to "@param" else "@param" to "@property" |
There was a problem hiding this comment.
I see this code in 3+ places: can you please rework it as common functions?
fun replace(isParamTagNeeded, parameterName) {
val (wrongTag, replacementTag) = if(isParamTagNeeded) (property, param) else (param, property)
val wrongTagText = ...
val replaceText = ...
changeTagInKdoc(kdocBeforeClass, wrongTagText, replaceText)
}
akuleshov7
approved these changes
Dec 24, 2023
akuleshov7
reviewed
Dec 24, 2023
| * kdoc | ||
| * class | ||
| * comment | ||
| * |
There was a problem hiding this comment.
Can you please check our codestyle document. Do we mention this newline?
akuleshov7
reviewed
Dec 24, 2023
| class A<K : Any, P: Any, G: Any> constructor( | ||
| //single-line comment | ||
| class A<K : Any, P : Any, G : Any> constructor( | ||
| // single-line comment |
There was a problem hiding this comment.
I thought that test was checking how this space is fixed
akuleshov7
reviewed
Dec 24, 2023
| * @param K | ||
| * @property openName single-line comment | ||
| * @property openLastName | ||
| * block |
There was a problem hiding this comment.
I think it was moved to a newline with a some purpose? Isn't it a newline rule that split long lines?
nulls
reviewed
Dec 25, 2023
| @@ -5,7 +5,7 @@ class A constructor( | |||
| ) {} | |||
|
|
|||
| class A constructor( | |||
| //single-line comment | |||
| // single-line comment | |||
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.
What's done:
KdocComments.KdocFormattingfor case when@propertyand@constructorbasic tags haven't empty line before them.@propertytag.Closes #1884