feat(docs): public api kdocs (#658)
- 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>
This commit is contained in:
parent
e5e5ec206f
commit
33923bc7c9
1 changed files with 260 additions and 27 deletions
|
|
@ -22,3 +22,22 @@ 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
|
||||
|
|
|
|||
Loading…
Reference in a new issue