Detect undocumented protected classes, properties, and functions #5083
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
refs detekt#4633 Signed-off-by: Kengo TODA <skypencil@gmail.com>
refs detekt#4633 Signed-off-by: Kengo TODA <skypencil@gmail.com>
Signed-off-by: Kengo TODA <skypencil@gmail.com>
Signed-off-by: Kengo TODA <skypencil@gmail.com>
cortinico
reviewed
Jul 16, 2022
Signed-off-by: Kengo TODA <skypencil@gmail.com>
detekt#5083 (comment) Signed-off-by: Kengo TODA <skypencil@gmail.com>
Signed-off-by: Kengo TODA <skypencil@gmail.com>
BraisGabin
reviewed
Jul 18, 2022
Signed-off-by: Kengo TODA <skypencil@gmail.com>
BraisGabin
approved these changes
Jul 18, 2022
schalkms
approved these changes
Jul 20, 2022
...n/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/documentation/UndocumentedPublicClass.kt
Outdated
Show resolved
Hide resolved
...rc/main/kotlin/io/gitlab/arturbosch/detekt/rules/documentation/UndocumentedPublicFunction.kt
Outdated
Show resolved
Hide resolved
...rc/main/kotlin/io/gitlab/arturbosch/detekt/rules/documentation/UndocumentedPublicProperty.kt
Outdated
Show resolved
Hide resolved
…urbosch/detekt/rules/documentation/UndocumentedPublicClass.kt Co-authored-by: schalkms <30376729+schalkms@users.noreply.github.com>
…urbosch/detekt/rules/documentation/UndocumentedPublicFunction.kt Co-authored-by: schalkms <30376729+schalkms@users.noreply.github.com>
…urbosch/detekt/rules/documentation/UndocumentedPublicProperty.kt Co-authored-by: schalkms <30376729+schalkms@users.noreply.github.com>
cortinico
approved these changes
Jul 22, 2022
|
Thank you! |
VitalyVPinchuk
pushed a commit
to VitalyVPinchuk/detekt
that referenced
this pull request
Jul 25, 2022
…ekt#5083) * feat: UndocumentedPublicFunction supports protected functions refs detekt#4633 * feat: UndocumentedPublicProperty supports protected properties refs detekt#4633 Signed-off-by: Kengo TODA <skypencil@gmail.com> * feat: UndocumentedPublicClass supports protected classes refs detekt#4633 Signed-off-by: Kengo TODA <skypencil@gmail.com> * chore: apply detekt rules Signed-off-by: Kengo TODA <skypencil@gmail.com> * docs: update the document Signed-off-by: Kengo TODA <skypencil@gmail.com> * fix: update the API file to pass pre-merge checks Signed-off-by: Kengo TODA <skypencil@gmail.com> * fix: rename a config based on the review comment detekt#5083 (comment) Signed-off-by: Kengo TODA <skypencil@gmail.com> * test: make test snippets compilable Signed-off-by: Kengo TODA <skypencil@gmail.com> * fix: broken binary compatibility Signed-off-by: Kengo TODA <skypencil@gmail.com> * docs: Update detekt-rules-documentation/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/documentation/UndocumentedPublicClass.kt Co-authored-by: schalkms <30376729+schalkms@users.noreply.github.com> * docs: Update detekt-rules-documentation/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/documentation/UndocumentedPublicFunction.kt Co-authored-by: schalkms <30376729+schalkms@users.noreply.github.com> * docs: Update detekt-rules-documentation/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/documentation/UndocumentedPublicProperty.kt Co-authored-by: schalkms <30376729+schalkms@users.noreply.github.com> Co-authored-by: schalkms <30376729+schalkms@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hello 👋 thanks for making such a great product open and shared!
My team is using Detekt and I want to learn more about, so today I want to suggest a PR that can close #4633
I simply follow the discussion in #4633, so added a configuration to each existing rule.
Honestly speaking, I have less confidence in the naming of configurations, hope that we will have a discussion about it in this PR.