Opened 22 months ago

Last modified 21 months ago

#2170 open defect

Convert package.html files to package-info.java

Reported by: str4d Owned by:
Priority: maintenance Milestone: undecided
Component: other Version: 0.9.33
Keywords: easy, docs, cleanup Cc:
Parent Tickets: Sensitive: no

Description

Of the (currently) ~1,100 issues reported by SonarCloud, almost 200 of them are due to package.html files missing DOCTYPE and title elements. We *could* fix them (though it is unclear to me whether those elements get used or not), but instead we should just convert them all to the package-info.java format introduced in JDK 5. This would also enable us to annotate packages.

Subtickets

Change History (3)

comment:1 Changed 22 months ago by str4d

Keywords: easy docs cleanup added

comment:2 Changed 22 months ago by zzz

Component: unspecifiedother
Priority: minormaintenance

low priority and do we really want 200 package-info.class files in our jars? Ofc we could strip them all out in the build with excludes="package-info.class" in all the build.xml files.

Might be nice to @since a package but I generally put that in the package description anyway. Unless there's some other use case for annotating a package, this seems like more trouble than it's worth.

comment:3 Changed 21 months ago by str4d

Status: newopen

See this StackOverflow question for various ways in which package annotations can be used at runtime. For those usages, the package-info.class files would be left in the JARs. Whether or not we might find them useful is another question.

Note: See TracTickets for help on using tickets.