Search code examples
mavenkotlingradlejavadockdoc

How to enforce complete documentation on Kotlin code

What plugin or tool should I use to enforce complete kdoc documentation on new Kotlin code? Java code is checked by checkstyle with Sun's rule set, I need a Kotlin's analogue for it.

Solution

  • Look at detekt and its comments rule set. Especially UndocumentedPublicClass, UndocumentedPublicFunction and UndocumentedPublicProperty.

    It integrates with Maven via Ant task.