/plugins/InspectionGadgets/src/inspectionDescriptions/PackageDotHtmlMayBePackageInfo.html

https://bitbucket.org/nbargnesi/idea · HTML · 15 lines · 14 code · 0 blank · 1 comment · 0 complexity · 732d22ddcad89aba8a67ac2f0b390c0f MD5 · raw file 

    

  1. <html>
    2. 

  2. <body>
    3. 

  3. This inspection reports any package.html files. These files are used for documenting
    4. 

  4. packages. Since J2SE 5 it is recommended to use package-info.java files instead, since such
    5. 

  5. files can also contain package annotations.  In this way, package-info.java becomes the
    6. 

  6. sole repository for package level annotations and documentation.
    7. 

  7. <p>
    8. 

  8. This inspection provides a quickfix to convert the package.html file to a package-info.java file.
    9. 

  9. If a package-info.java file is already present this inspection provides a quickfix to delete
    10. 

  10. the package.html file, since the Javadoc tool would ignore it then anyway.
    11. 

  11. <!-- tooltip end -->
    12. 

  12. <p>
    13. 

  13. <small>New in 10.0.3, Powered by InspectionGadgets</small>
    14. 

  14. </body>
    15. 

  15. </html>
    16.