Suggest using @property tag in KDoc #332
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:
Added rule
### What's done: Fixed rule
### What's done: Made rule, tests
### What's done: Fixed all suppress
Codecov Report
@@ Coverage Diff @@
## master #332 +/- ##
============================================
- Coverage 83.18% 83.14% -0.04%
- Complexity 1295 1331 +36
============================================
Files 65 65
Lines 3164 3246 +82
Branches 1004 1027 +23
============================================
+ Hits 2632 2699 +67
- Misses 168 176 +8
- Partials 364 371 +7
Flags with carried forward coverage won't be shown. Click here to find out more.
Continue to review full report at Codecov.
|
petertrr
reviewed
Sep 28, 2020
diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/constants/Warnings.kt
Outdated
Show resolved
Hide resolved
diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/rules/kdoc/KdocComments.kt
Outdated
Show resolved
Hide resolved
diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/utils/KDocUtils.kt
Outdated
Show resolved
Hide resolved
diktat-rules/src/test/kotlin/org/cqfn/diktat/ruleset/chapter2/KdocWarnTest.kt
Outdated
Show resolved
Hide resolved
### What's done: Fixed after review
### What's done: Fixed error
petertrr
reviewed
Sep 28, 2020
diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/rules/kdoc/KdocComments.kt
Outdated
Show resolved
Hide resolved
diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/rules/kdoc/KdocComments.kt
Outdated
Show resolved
Hide resolved
diktat-rules/src/test/kotlin/org/cqfn/diktat/ruleset/chapter2/KdocWarnTest.kt
Show resolved
Hide resolved
diktat-rules/src/test/resources/test/paragraph2/kdoc/ConstructorCommentNoKDocExpected.kt
Outdated
Show resolved
Hide resolved
diktat-rules/src/test/resources/test/paragraph2/kdoc/ConstructorCommentNoKDocExpected.kt
Show resolved
Hide resolved
| /** | ||
| * text | ||
| */ | ||
| @param:JsonProperty("shortName") private val shortName: String |
There was a problem hiding this comment.
Because this property is private
There was a problem hiding this comment.
Yes, but placing documentation in @property tag should be preferable if documentation already exists even for private properties.
diktat-rules/src/test/resources/test/paragraph2/kdoc/ConstructorCommentExpected.kt
Show resolved
Hide resolved
### What's done:
Change rule's logic
### What's done:
renamed variable
petertrr
requested changes
Oct 8, 2020
diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/rules/kdoc/KdocComments.kt
Outdated
Show resolved
Hide resolved
diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/rules/kdoc/KdocComments.kt
Outdated
Show resolved
Hide resolved
diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/rules/kdoc/KdocComments.kt
Show resolved
Hide resolved
diktat-rules/src/test/kotlin/org/cqfn/diktat/ruleset/chapter2/KdocWarnTest.kt
Outdated
Show resolved
Hide resolved
diktat-rules/src/test/kotlin/org/cqfn/diktat/ruleset/chapter2/KdocWarnTest.kt
Show resolved
Hide resolved
### What's done: Fixed bugs after review
…g-KDoc # Conflicts: # diktat-analysis.yml # diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/utils/KDocUtils.kt # diktat-rules/src/main/resources/diktat-analysis-huawei.yml # diktat-rules/src/main/resources/diktat-analysis.yml
petertrr
requested changes
Oct 9, 2020
diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/rules/kdoc/KdocComments.kt
Outdated
Show resolved
Hide resolved
### What's done: Changed smoke test
### What's done: Changed warn message
### What's done: Changed test warn message
…g-KDoc # Conflicts: # diktat-analysis.yml # diktat-rules/src/main/kotlin/generated/WarningNames.kt # diktat-rules/src/main/resources/diktat-analysis-huawei.yml # diktat-rules/src/main/resources/diktat-analysis.yml
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.
Which rule and warnings did you add?
Actions checklist
*[x] closes Suggest using @property tag in KDoc instead of putting comment before property in constructor #302