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

add better documentation for the LongParameterList ignoreAnnotated (#2714)

Browse Source 
* add better documentation for the LongParameterList ignoreAnnotated

* make LongParameterList doc changes in the right place

* Checkin documentation

Co-authored-by: Ken Yee <kyee@wayfair.com>
Co-authored-by: Artur Bosch <arturbosch@gmx.de>
This commit is contained in:
Ken Yee
2020-06-01 11:53:31 -04:00
committed by GitHub
parent a7637493ac
commit d672a1abc7
2 changed files with 4 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
detekt-rules/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/complexity/LongParameterList.kt
View File

@@ -32,7 +32,8 @@ import org.jetbrains.kotlin.psi.psiUtil.containingClassOrObject
* @configuration ignoreDefaultParameters - ignore parameters that have a default value (default: `false`)
* @configuration ignoreDataClasses - ignore long constructor parameters list for data classes (default: `true`)
* @configuration ignoreAnnotated - ignore long parameters list for constructors or functions in the context of these
* annotation class names (default: `[]`)
* annotation class names (default: `[]`); (e.g. ['Inject', 'Module', 'Suppress']);
* the most common case is for dependency injection where constructors are annotated with @Inject.
*
* @active since v1.0.0
*/

3
docs/pages/documentation/complexity.md
View File

@@ -243,7 +243,8 @@ Reports functions and constructors which have more parameters than a certain thr
* ``ignoreAnnotated`` (default: ``[]``)
ignore long parameters list for constructors or functions in the context of these
annotation class names
annotation class names ; (e.g. ['Inject', 'Module', 'Suppress']);
the most common case is for dependency injection where constructors are annotated with @Inject.
### MethodOverloading