New Rule COMMENTS_BY_KDOC was implemented #1350
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
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
There was a problem hiding this comment.
Found 96 potential problems in the proposed changes. Check the Files changed tab for more details.
There was a problem hiding this comment.
Found 96 potential problems in the proposed changes. Check the Files changed tab for more details.
Codecov Report
@@ Coverage Diff @@
## master #1350 +/- ##
============================================
+ Coverage 83.56% 83.59% +0.02%
- Complexity 2564 2567 +3
============================================
Files 106 106
Lines 7278 7291 +13
Branches 2017 2018 +1
============================================
+ Hits 6082 6095 +13
Misses 353 353
Partials 843 843
Flags with carried forward coverage won't be shown. Click here to find out more.
Continue to review full report at Codecov.
|
### What's done: * New Rule COMMENTS_BY_KDOC was added to check if code block contains kdoc comments * and fix it by converting to block comment * tests and docs were added * Closes: #828
icemachined
force-pushed
the
feature/kdoc-to-block-comments
branch
from
524acba
to
34efd45
Compare
diktat-rules/src/test/kotlin/org/cqfn/diktat/ruleset/chapter2/KdocCommentsWarnTest.kt
Fixed
Show fixed
Hide fixed
orchestr7
reviewed
Jun 8, 2022
| |/** | ||
| | * right place for kdoc | ||
| | */ | ||
| |class Example { |
There was a problem hiding this comment.
could you please also check top-level methods (in Kotlin you can do it without a class and from AST perspective they can differ)?
fun foo() {
/**
*/
}
orchestr7
approved these changes
Jun 8, 2022
|
lgtm |
diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/rules/chapter2/kdoc/KdocComments.kt
Fixed
Show fixed
Hide fixed
diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/rules/chapter2/kdoc/KdocComments.kt
Fixed
Show fixed
Hide fixed
diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/rules/chapter2/kdoc/KdocComments.kt
Fixed
Show fixed
Hide fixed
diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/utils/AstNodeUtils.kt
Fixed
Show fixed
Hide fixed
diktat-rules/src/test/kotlin/org/cqfn/diktat/ruleset/chapter2/KdocCommentsWarnTest.kt
Fixed
Show fixed
Hide fixed
diktat-rules/src/test/kotlin/org/cqfn/diktat/ruleset/chapter2/KdocCommentsWarnTest.kt
Fixed
Show fixed
Hide fixed
diktat-rules/src/test/kotlin/org/cqfn/diktat/ruleset/chapter2/KdocCommentsWarnTest.kt
Fixed
Show fixed
Hide fixed
diktat-rules/src/test/kotlin/org/cqfn/diktat/ruleset/chapter2/KdocCommentsWarnTest.kt
Fixed
Show fixed
Hide fixed
diktat-rules/src/test/kotlin/org/cqfn/diktat/ruleset/chapter2/KdocCommentsWarnTest.kt
Fixed
Show fixed
Hide fixed
diktat-rules/src/test/kotlin/org/cqfn/diktat/ruleset/chapter2/KdocCommentsWarnTest.kt
Fixed
Show fixed
Hide fixed
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:
Which rule and warnings did you add?
This pull request closes
Actions checklist
Fixme