If your project contains a large number of classes, perhaps for summation purposes you could wrap these up into a higher level project with fewer classes that expose the essentials with documentation?
Another alternative I'm seeing "out there" is a docs folder alongside src that holds information for web site publication. Static site generators can then kick in during the build and publish. On 16 November 2014 19:28, Kevin Burton <[email protected]> wrote: > This is slightly off topic so I apologize. > > Javadoc is great for the developer but the main problem is that important > documents can be hidden in a sea of classes. > > My Javadoc tends to have say 20-40 important documents on the design of a > system but the rest of the Javadoc just tends to have an overview. > > I’d like a way to organize it more as a book, maybe even by the length of > the documentation instead of being organized as a table of contents. > > This way my ops guys and other members of the team can find the > documentation they’re looking for and not necessarily how a specific > component behaves. > > -- > > Founder/CEO Spinn3r.com > Location: *San Francisco, CA* > blog: http://burtonator.wordpress.com > … or check out my Google+ profile > <https://plus.google.com/102718274791889610666/posts> > <http://spinn3r.com> >
