Improving the Javadocs

["Noel J. Bergman" <no...@devtech.com>]

Don't hold up this releae for it, but at some point you'll want to go
through the code and update the javadocs.

For example, things like org.apache.log.output.db.NormalizedJDBCTarget have
no docs that tell you how to use them if they are what you find using a
search for "Avalon JDBC log".  There ought to be something that tells you to
keep looking for a suitable factory, such as
org.apache.avalon.excalibur.logger.factory.JDBCTargetFactory, which does
have the appropriate docs.

The docs for JDBCTargetFactory are pretty spare.

Actually, since no one probably is itching to do the docs, it might make
sense to setup a structure on the Wiki where docs an accumulate from people
using those classes, until you've time to incorporate them into the
Javadocs.  Then sites like ours can inter-link to that part of your Wiki,
too.

	--- Noel


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@avalon.apache.org
For additional commands, e-mail: dev-help@avalon.apache.org