Fixed KdocComments for types in generic classes
#1832
Merged
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
### What's done: - fixed case when `KDOC_EXTRA_PROPERTY` warning generation didn't take into account types in generic classes. - added configuration `isParamTagsForGenericTypes` for `@param` tags creation for types in generic classes. - added fixed warnings `KDOC_NO_CONSTRUCTOR_PROPERTY` for cases when configuration option are on, and then generic types must have `@param` tags in class-KDoc. Additionally added logic for replacing incorrect tag with correct one regardless of whether configuration is enabled or not. - added new warning and fix tests. Closes saveourtool#1825
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
diktat-rules/src/main/kotlin/com/saveourtool/diktat/ruleset/rules/chapter2/kdoc/KdocComments.kt
Fixed
Show fixed
Hide fixed
diktat-rules/src/main/kotlin/com/saveourtool/diktat/ruleset/rules/chapter2/kdoc/KdocComments.kt
Fixed
Show fixed
Hide fixed
diktat-rules/src/main/kotlin/com/saveourtool/diktat/ruleset/rules/chapter2/kdoc/KdocComments.kt
Fixed
Show fixed
Hide fixed
diktat-rules/src/main/kotlin/com/saveourtool/diktat/ruleset/rules/chapter2/kdoc/KdocComments.kt
Fixed
Show fixed
Hide fixed
diktat-rules/src/main/kotlin/com/saveourtool/diktat/ruleset/rules/chapter2/kdoc/KdocComments.kt
Fixed
Show fixed
Hide fixed
kgevorkyan
reviewed
Nov 29, 2023
diktat-rules/src/main/kotlin/com/saveourtool/diktat/ruleset/rules/chapter2/kdoc/KdocComments.kt
Outdated
Show resolved
Hide resolved
Codecov ReportAttention:
Additional details and impacted files@@ Coverage Diff @@
## master #1832 +/- ##
============================================
+ Coverage 78.15% 78.18% +0.02%
+ Complexity 2432 2425 -7
============================================
Files 131 131
Lines 8616 8631 +15
Branches 2174 2174
============================================
+ Hits 6734 6748 +14
- Misses 916 917 +1
Partials 966 966 ☔ View full report in Codecov by Sentry. |
nulls
approved these changes
Nov 29, 2023
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:
KDOC_EXTRA_PROPERTYwarning generation didn't take into account types in generic classes.isParamTagsForGenericTypesfor@paramtags creation for types in generic classes.KDOC_NO_CONSTRUCTOR_PROPERTYfor cases when configuration option are on, and then generic types must have@paramtags in class-KDoc. Additionally added logic for replacing incorrect tag with correct one regardless of whether configuration is enabled or not.Closes #1825