Javadoc for components


I like the add-on directory.
But what I am greatly missing is a link to the corresponding javadoc of the components…

Would it be possible to include a javadoc link for the components listed in the directory ?


Add-on authors have to create the Javadoc to start with, I suspect that’s where the rub lies.

For authors that have source control with a browsable public site and use Maven, publishing the Javadoc can actually be surprisingly easy:

  • run the Maven javadoc:javadoc goal
  • commit the javadoc tree,
  • add a link from the add-on to the newly committed javadoc directory in the repository.

That’s how I created the Javadoc link on the JPA Criteria Lazy Container add-on.