jlengrand/detekt
1
0
Fork 0
mirror of https://github.com/jlengrand/detekt.git synced 2026-03-10 08:11:23 +00:00
Code Issues Packages Projects Releases Wiki Activity

#4169 OutdatedDocumentation rule (#4185)

Browse Source 
* Introduce OutdatedDocumentation rule

Basic implementation covers:
- class primary constructor parameters
- class primary constructor property parameters
- function parameters

* OutdatedDocumentation rule - type parameters matching

* OutdatedDocumentation rule - refactor and add more tests

* OutdatedDocumentation rule - report for secondary constructors

* OutdatedDocumentation rule - do not report when KDoc does not contain any @param or @property tag

* OutdatedDocumentation rule - add description

* OutdatedDocumentation rule - add configuration for type parameters and declarations order

* OutdatedDocumentation rule - refactor

* OutdatedDocumentation rule - fix CI

* OutdatedDocumentation rule - additional test cases

* OutdatedDocumentation rule - fix rule reporting for incorrect declarations order
This commit is contained in:
lukaszosowicki
2021-10-19 15:41:39 +02:00
committed by GitHub
parent 50b9314aa6
commit 844a97104f
5 changed files with 572 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@@ -228,8 +228,8 @@ If you contributed to detekt but your name is not in the list, please feel free
- [George Poothicottu Jacob](https://github.com/geojakes) - Bug fix: Rule deactivation
- [Mohamed Elmahdi](https://github.com/mohamed-elmahdi) - Rule Improvement: Add descriptive alias
- [Michael McCormick](https://github.com/MichaelM97) - Documentation improvement
- [Hans-Martin Schuller](https://github.com/hmSchuller) - Rule Improvement: ForbiddenComment
- [Lukasz Osowicki](https://github.com/lukaszosowicki) - New rule: OutdatedDocumentation
### Mentions