In the "Documenting Shared Components" in http://wiki.apache.org/db-derby/SharedComponentVersioningGuidelines there is this section:
<quote> We will provide a top-level README file under java/org/apache/derby/common that describes the shared components guidelines (once they are approved) and lists the available components. </quote> I would suggest a minor change to not have a README file, but instead use package.html which will then tie into the javadoc (or more generally ensure it is documented so that it appears as part of the javadoc). Dan.
