When building an API for a customer, the public javadoc has to contain just what you want to show the customer. Which is a shame, as it the javadoc is also, in some ways, the obvious target for some kinds of internal design documentation. One might imagine a custom doclet or some other trickery to allow the two types of information to coexist in the source. Anybody been there?
- Anybody can ask a question
- Anybody can answer
- The best answers are voted up and rise to the top
You could document internals in javadoc comments for
Without some kind of preprocessing your options are limited. If you need to add internal class level information you either have to add an unused private member to hang the apidoc comment onto, like:
Or if you would allow some preprocessing via an ant build script, you can do something like:
and use a replace action from ant: