33923bc7c9- enable rule for checking undocumented public api - add kdoc skill ## How Has This Been Tested? ./gradlew detekt ## Breaking Changes none ## Types of changes - [ ] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to change) - [x] Documentation update ## Checklist - [x] I have read the [MCP Documentation](https://modelcontextprotocol.io) - [x] My code follows the repository's style guidelines - [x] New and existing tests pass locally - [ ] I have added appropriate error handling - [x] I have added or updated documentation as needed --------- Co-authored-by: Konstantin Pavlov <1517853+kpavlov@users.noreply.github.com>
43 lines
977 B
YAML
43 lines
977 B
YAML
config:
|
|
validation: true
|
|
warningsAsErrors: false
|
|
checkExhaustiveness: false
|
|
|
|
complexity:
|
|
LargeClass:
|
|
excludes: &testFolders
|
|
- '**/test/**'
|
|
- '**/commonTest/**'
|
|
- '**/jvmTest/**'
|
|
- '**/jsTest/**'
|
|
- '**/iosTest/**'
|
|
LongMethod:
|
|
excludes: *testFolders
|
|
|
|
coroutines:
|
|
InjectDispatcher:
|
|
excludes: *testFolders
|
|
|
|
empty-blocks:
|
|
EmptyFunctionBlock:
|
|
excludes: *testFolders
|
|
|
|
comments:
|
|
UndocumentedPublicClass:
|
|
active: true
|
|
excludes: &testAndGeneratedFolders
|
|
- '**/test/**'
|
|
- '**/commonTest/**'
|
|
- '**/jvmTest/**'
|
|
- '**/jsTest/**'
|
|
- '**/iosTest/**'
|
|
- '**/generated-sources/**'
|
|
ignoreDefaultCompanionObject: true
|
|
UndocumentedPublicFunction:
|
|
active: true
|
|
excludes: *testAndGeneratedFolders
|
|
UndocumentedPublicProperty:
|
|
active: true
|
|
excludes: *testAndGeneratedFolders
|
|
searchProtectedProperty: false
|
|
ignoreEnumEntries: true
|