Pattern: Use of KDoc comment for non-public prop
Issue: -
This rule will report any KDoc comments that refer to non-public properties of a class. Clients do not need to know the implementation details.
Example of incorrect code:
/**
* Comment
* [prop1] - non-public property
* [prop2] - public property
*/
class Test {
private val prop1 = 0
val prop2 = 0
}Example of correct code:
/**
* Comment
* [prop2] - public property
*/
class Test {
private val prop1 = 0
val prop2 = 0
}