Remark: I started writing this this afternoon, but didn't get to finish the mail until now. ;)
On 11 Oct 2010, at 16:04 , Ivo Ladage-van Doorn wrote: > In most Apache projects it is standard to use the root package for public API > classes (for example service interfaces). > Now this causes an issue with automated javadoc generation. When using the > maven-javadoc-plugin it seems that you cannot specify to include javadoc for > the root package but omit javadoc of all subpackages without explicitly > excluding all existing subpackages. Formally, there is no such thing as a subpackage, packages are a "flat" namespace. But basically the problem you're trying to solve is to generate only JavaDoc for the API, in other words all exported packages? To properly do that we have to have a plugin that really understands OSGi bundles and gets the metadata from the pom.xml. Anything else is probably too easy to break. So, in short, I really would like to solve this in the plugin instead of enforcing conventions on package names. Also, reading the other responses right now, I'm not so sure why it's important to create just Javadoc for our API. We have already defined what our API is in other places, so people should be able to figure out what they can use. If we really want to create docs for our APIs, my workaround (if we don't fix the plugin) would be to explicitly list all packages. Greetings, Marcel -------------- next part -------------- An HTML attachment was scrubbed... URL: http://lists.amdatu.org/pipermail/amdatu-developers/attachments/20101011/b665fc9f/attachment.html
