Hello, just another viewpoint: put your overview documents with a large number of @links into the package description. This is the best you can do with Javadoc. It is not rerally a good replacement for colaterals like Tutorials or Walk-Throughs (and sample code).
Gruss Bernd Am Sun, 16 Nov 2014 11:28:22 -0800 schrieb Kevin Burton <bur...@spinn3r.com>: > 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. > --------------------------------------------------------------------- To unsubscribe, e-mail: users-unsubscr...@maven.apache.org For additional commands, e-mail: users-h...@maven.apache.org
