Skip to content

Replace @active KDoc tag with @ActiveByDefault annotation#3592

Merged
chao2zhang merged 13 commits intodetekt:mainfrom
marschwar:annotations-active-by-default
Mar 28, 2021
Merged

Replace @active KDoc tag with @ActiveByDefault annotation#3592
chao2zhang merged 13 commits intodetekt:mainfrom
marschwar:annotations-active-by-default

Conversation

@marschwar
Copy link
Contributor

Following up on #3562 this replaces the @active¸ kdoc tag with an @ActiveByDefault` annotation.

@marschwar marschwar changed the title Annotations active by default Replace @active KDoc tag with @ActiveByDefault annotation Mar 22, 2021
@codecov
Copy link

codecov bot commented Mar 22, 2021

Codecov Report

Merging #3592 (a31528f) into main (92b6a01) will increase coverage by 0.01%.
The diff coverage is 82.85%.

❗ Current head a31528f differs from pull request most recent head adc79ae. Consider uploading reports for the commit adc79ae to get more accurate results
Impacted file tree graph

@@             Coverage Diff              @@
##               main    #3592      +/-   ##
============================================
+ Coverage     78.21%   78.22%   +0.01%     
+ Complexity     2829     2826       -3     
============================================
  Files           465      466       +1     
  Lines          9121     9136      +15     
  Branches       1722     1724       +2     
============================================
+ Hits           7134     7147      +13     
  Misses         1059     1059              
- Partials        928      930       +2     
Impacted Files Coverage Δ Complexity Δ
...arturbosch/detekt/formatting/FormattingProvider.kt 100.00% <ø> (ø) 3.00 <0.00> (ø)
...rbosch/detekt/formatting/wrappers/ChainWrapping.kt 100.00% <ø> (ø) 3.00 <0.00> (ø)
...bosch/detekt/formatting/wrappers/CommentSpacing.kt 100.00% <ø> (ø) 3.00 <0.00> (ø)
.../arturbosch/detekt/formatting/wrappers/Filename.kt 100.00% <ø> (ø) 3.00 <0.00> (ø)
...urbosch/detekt/formatting/wrappers/FinalNewline.kt 100.00% <ø> (ø) 4.00 <0.00> (ø)
...ch/detekt/formatting/wrappers/MaximumLineLength.kt 87.50% <ø> (ø) 5.00 <0.00> (ø)
...sch/detekt/formatting/wrappers/ModifierOrdering.kt 100.00% <ø> (ø) 3.00 <0.00> (ø)
...osch/detekt/formatting/wrappers/MultiLineIfElse.kt 100.00% <ø> (ø) 3.00 <0.00> (ø)
...ekt/formatting/wrappers/NoBlankLineBeforeRbrace.kt 100.00% <ø> (ø) 3.00 <0.00> (ø)
...ekt/formatting/wrappers/NoConsecutiveBlankLines.kt 100.00% <ø> (ø) 3.00 <0.00> (ø)
... and 130 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 92b6a01...adc79ae. Read the comment docs.

@marschwar
Copy link
Contributor Author

Just wondering - do we need to still support the kdoc tag as well in order to work for custom rules that have not made the switch?

@cortinico
Copy link
Member

Just wondering - do we need to still support the kdoc tag as well in order to work for custom rules that have not made the switch?

To my knowledge, not: the detekt-generator is the only part of the code where we effectively read the KDoc annotations and we don't generated docs for external rules.

@marschwar marschwar force-pushed the annotations-active-by-default branch from 69e9717 to 64cc5a0 Compare March 25, 2021 15:40
@marschwar marschwar force-pushed the annotations-active-by-default branch 3 times, most recently from 9929b26 to 43f19dc Compare March 27, 2021 21:41
@marschwar marschwar force-pushed the annotations-active-by-default branch from 43f19dc to 8053965 Compare March 27, 2021 21:44
@chao2zhang chao2zhang merged commit 36edd4c into detekt:main Mar 28, 2021
@marschwar marschwar deleted the annotations-active-by-default branch March 28, 2021 18:54
@cortinico cortinico added this to the 1.17.0 milestone Apr 12, 2021
@cortinico cortinico added the notable changes Marker for notable changes in the changelog label May 1, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

notable changes Marker for notable changes in the changelog

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants