On Nov 21, 9:46 am, "Tom Bostelmann" <[EMAIL PROTECTED]> wrote:
> it might not be working.  also, there isn't a big need for javadocs right
> now since all of code is available to the developers who would need it.
[...]

I'd tend to disagree... while having the source code is definitely
helpful, some documentation is necessary in addition to code. Javadoc
is a great place for this. I realize there isn't currently much
Javadoc, but that can (and should!) change.

For example, I can get the source code for all the libraries Mifos
uses, but I'd almost always rather refer to the Javadoc for reference.

Here's a tiny patch to allow the building of javadoc. There are some
warnings about problems with the javadoc, but it does build a complete
javadoc set and this should allow us to find and fix errors with the
javadoc (any volunteers??).

I moved the dir for generated API documentation into the 'dist'
directory since it seemed to make sense that API documentation would
possibly be distributed at some point. Also, the 'dist' dir is only
deleted during a 'clean_all', which seemed to be the right time to
clean out generated Javadoc, too. "clean_all" contained commented-out
code to delete the src, test, and sql dirs. This doesn't make any
sense (why would you ever remove those directories?) so I took that
out too.

http://adammonsen.com/tmp/build_javadoc.patch.gz

Hope this helps,
-Adam

--
Adam Monsen

-------------------------------------------------------------------------
This SF.net email is sponsored by: Microsoft
Defy all challenges. Microsoft(R) Visual Studio 2005.
http://clk.atdmt.com/MRT/go/vse0120000070mrt/direct/01/

Reply via email to