Inspectopedia Help

HTML problems in Javadoc (DocLint)

Reports the same HTML issues in the Javadoc comments that have been reported by DocLint since Java 8.

The inspection detects the following issues:

  • Self-closed, unclosed, unknown, misplaced, or empty tag

  • Unknown or wrong attribute

  • Misplaced text

Example:

/** * Unknown tag: List<String> * Unclosed tag: error</b> * Misplaced text or tag: <ul><li>one</li>, <li>two</li></ul> * Wrong or empty attribute: <a href=""></a> * Self-closed tag: <br/> * ... */ void sample(){ }

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.

JavadocHtmlLint
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 | Java | Javadoc

Availability

By default bundled with

IntelliJ IDEA 2024.1, Qodana for JVM 2024.1,

Can be installed with plugin

Java, 241.18072

Last modified: 18 June 2024