Add @property, @receiver, and @exception to the list of essential tags
#1468
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
…al tags ### What's done: * All the above KDoc tags are essential because they document the signature of a function. Therefore, they should be grouped together with other signature-specific tags (`@param`, `@return`, `@throws`). * We also include the `@constructor` tag into the list (see, for example, how `kotlin.Pair` is documented). * This fixes #1465.
Codecov Report
@@ Coverage Diff @@
## master #1468 +/- ##
============================================
+ Coverage 83.30% 83.33% +0.02%
- Complexity 2561 2562 +1
============================================
Files 107 107
Lines 7607 7614 +7
Branches 2100 2100
============================================
+ Hits 6337 6345 +8
Misses 384 384
+ Partials 886 885 -1
Flags with carried forward coverage won't be shown. Click here to find out more.
Continue to review full report at Codecov.
|
sanyavertolet
approved these changes
Jul 21, 2022
diktat-rules/src/main/kotlin/org/cqfn/diktat/ruleset/rules/chapter2/kdoc/KdocFormatting.kt
Show resolved
Hide resolved
petertrr
approved these changes
Jul 21, 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.
What's done:
a function. Therefore, they should be grouped together with other
signature-specific tags (
@param,@return,@throws).@constructortag into the list (see, for example, howkotlin.Pairis documented).KDOC_NEWLINES_BEFORE_BASIC_TAGSfalse positives after@propertyand@receivertags #1465.