1. All Inspections
  2. Kotlin
  3. Other problems
  4. Missing KDoc comments for public declarations

Missing KDoc comments for public declarations

Last modified: 03 December 2024

Reports public declarations that do not have KDoc comments.

Example:

class A

The quick fix generates the comment block above the declaration:

/**
 *
 */
class A

Locating this inspection

By ID

Can be used to locate inspection in e.g. Qodana configuration files, where you can quickly enable or disable it, or adjust its settings.

KDocMissingDocumentation
Via Settings dialog

Path to the inspection settings via IntelliJ Platform IDE Settings dialog, when you need to adjust inspection settings directly from your IDE.

Settings or Preferences | Editor | Inspections | Kotlin | Other problems

Inspection Details

By default bundled with:

IntelliJ IDEA 2024.3, Qodana for JVM 2024.3,

Can be installed with plugin:

Kotlin, 243.23126-IJ