Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Detect undocumented protected classes, properties, and functions #5083

Merged
merged 12 commits into from Jul 23, 2022

Conversation

KengoTODA
Copy link
Contributor

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.

@github-actions github-actions bot added the rules label Jul 16, 2022
Signed-off-by: Kengo TODA <skypencil@gmail.com>
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>
Copy link
Collaborator

@BraisGabin BraisGabin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the PR, it looks grear. I just have some concerns with the binary compatibility that should be easily fixable.

detekt-psi-utils/api/detekt-psi-utils.api Outdated Show resolved Hide resolved
detekt-psi-utils/api/detekt-psi-utils.api Outdated Show resolved Hide resolved
Signed-off-by: Kengo TODA <skypencil@gmail.com>
Copy link
Member

@schalkms schalkms left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for this nice PR! 馃憤

KengoTODA and others added 3 commits July 21, 2022 08:23
鈥rbosch/detekt/rules/documentation/UndocumentedPublicClass.kt

Co-authored-by: schalkms <30376729+schalkms@users.noreply.github.com>
鈥rbosch/detekt/rules/documentation/UndocumentedPublicFunction.kt

Co-authored-by: schalkms <30376729+schalkms@users.noreply.github.com>
鈥rbosch/detekt/rules/documentation/UndocumentedPublicProperty.kt

Co-authored-by: schalkms <30376729+schalkms@users.noreply.github.com>
@BraisGabin BraisGabin added this to the 1.22.0 milestone Jul 23, 2022
@BraisGabin BraisGabin enabled auto-merge (squash) July 23, 2022 11:53
@BraisGabin BraisGabin merged commit e325179 into detekt:main Jul 23, 2022
19 checks passed
@KengoTODA KengoTODA deleted the issue-4633 branch July 24, 2022 00:20
@KengoTODA
Copy link
Contributor Author

Thank you!

VitalyVPinchuk pushed a commit to VitalyVPinchuk/detekt that referenced this pull request Jul 25, 2022
鈥kt#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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Rules for undocumented protected members
4 participants