Inspectopedia 2024.3 Help

'package.html' may be converted to 'package-info.java'

Reports any package.html files which are used for documenting packages.

Since JDK 1.5, it is recommended that you use package-info.java files instead, as such files can also contain package annotations. This way, package-info.java becomes a sole repository for package level annotations and documentation.

Example: package.html

<html> <body> Documentation example. </body> </html>

After the quick-fix is applied: package-info.java

/** * Documentation example. */ package com.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.

PackageDotHtmlMayBePackageInfo
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

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