Files
openide/java/java-impl/resources/inspectionDescriptions/PackageDotHtmlMayBePackageInfo.html
Leonid Shalupov 40795fe787 IJI-2422: community/java: move resources under resources root
GitOrigin-RevId: 8b2b63fc6db476ca0c2cfe5cadd84db6c4236d0f
2025-02-05 04:43:28 +00:00

23 lines
673 B
HTML

<html>
<body>
Reports any <code>package.html</code> files which are used for documenting packages.
<p>Since JDK 1.5, it is recommended that you use <code>package-info.java</code> 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.</p>
<p>Example: <code>package.html</code></p>
<pre><code>
&lt;html&gt;
&lt;body&gt;
Documentation example.
&lt;/body&gt;
&lt;/html&gt;
</code></pre>
<p>After the quick-fix is applied: <code>package-info.java</code></p>
<pre><code>
/**
* Documentation example.
*/
package com.sample;
</code></pre>
</body>
</html>