javadoc
greg
and a few in the distribution, but no javadoc.
Sriram Srinivasan
On Sep 23, 2010, at 10:28 AM, greg wrote:
> I'm new to Kilim. Is there Javadoc? I've found examples on the web
> and a few in the distribution, but no javadoc.
No, the javadoc is not generated. Most Java developers use Eclipse or
IDEA etc, and the documentation is visible without having to generate
HTML.
This is a bit of a dilemma for me. I personally find javadocs (and
other tools such as DOxygen) somewhat overwhelming, in that there is
no way to hide inessential detail. The amount exposed to a newbie
ought to be different than a more experienced user (but someone who
still looks at it as a blackbox), which is different from someone who
is going to inherit and extend, and finally for someone who is fixing
the source itself. javadoc just lumps all of these together. One
could have a doclet generate a smarter HTML file, which interactively
permits different one to change the level of detail in different
packages (similar to java logging).
Meanwhile, since you need it, you can just do the following in the
kilim root dir.
javadoc -d javadocs -sourcepath src/ kilim kilim.nio kilim.http
kilim.analysis kilim.tools