Javadoc comment can be Markdown documentation comment

Reports Javadoc comments that can be converted to Markdown documentation comments.

Example:

  /**
   * For blubbering of the florz.
   *
   * Similar to {@link com.deeps.Querp querping} class.
   */
  class FlorzBlubber {
  }

After the quick-fix is applied:

  /// For blubbering of the florz.
  /// Similar to [querping][com.deeps.Querp] class.
  class FlorzBlubber {
  }

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.

MarkdownDocumentationCommentsMigration

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.

New in 2024.2

Inspection Details
By default bundled with:	IntelliJ IDEA 2024.3, Qodana for JVM 2024.3,
Can be installed with plugin:	Java, 243.23126

Last modified: 03 December 2024