Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add option for OutdatedDocumentation to allow param in constructor pr… #4453

Merged
merged 1 commit into from
Jan 7, 2022

Conversation

matejdro
Copy link
Contributor

@matejdro matejdro commented Jan 5, 2022

This fixes #4366

Ideally, all constructor parameters should be marked as @property (since they are properties), but currently IntelliJ does not display parameter docs for these: https://youtrack.jetbrains.com/issue/KTIJ-12948

as a workaround until this is fixed on Jetbrains side, we add a property to the OutdatedDocumentation that allows @param on constructor properties.

@codecov
Copy link

codecov bot commented Jan 5, 2022

Codecov Report

Merging #4453 (3a2825c) into main (40efb62) will increase coverage by 0.01%.
The diff coverage is 100.00%.

Impacted file tree graph

@@             Coverage Diff              @@
##               main    #4453      +/-   ##
============================================
+ Coverage     84.34%   84.35%   +0.01%     
- Complexity     3299     3306       +7     
============================================
  Files           473      473              
  Lines         10532    10541       +9     
  Branches       1885     1888       +3     
============================================
+ Hits           8883     8892       +9     
  Misses          671      671              
  Partials        978      978              
Impacted Files Coverage Δ
...etekt/rules/documentation/OutdatedDocumentation.kt 88.75% <100.00%> (+1.42%) ⬆️

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 40efb62...3a2825c. Read the comment docs.

@matejdro matejdro force-pushed the param_outdated_documentation branch from 9f92973 to 3a2825c Compare January 5, 2022 10:59
@cortinico cortinico added this to the 1.20.0 milestone Jan 5, 2022
@cortinico cortinico added the rules label Jan 5, 2022
Copy link
Member

@cortinico cortinico left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍

@cortinico cortinico merged commit b274fea into detekt:main Jan 7, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

OutdatedDocumentation should allow us to use @param even when constructor properties have val
3 participants