I recently used this trick for a mini-DSL. I have various inner classes which I return depending on the context; doing so ensures we only expose relevent commands to the client. Making these classes inner instead of static nested prevents them from distracting from the single entry point class in the package level Javadocs.
Monday, January 22, 2007
Javadoc seems to include static nested classes in the package-level Javadocs but not inner classes (classes which can't stand alone and require an instance of their enclosing class). Keep this in mind if you must expose a class but you also want to semi-hide it within another class's documentation so as not to clutter up the package-level documentation.