Menu

#4 web-accessible javadocs for convenience

open
nobody
None
5
2012-09-20
2010-01-21
No

This request is for documentation, which I guess should fall under the "support" category in Tracker.

It would be great if we could post up-to-date javadocs on either the Genoviz project Web site or some other easy-to-find location.

Developers can of course use NetBeans to generate the latest greatest javadocs, but they first must check out a copy of the repository before they can do that. Some developers considering using some of our code may first wish to scan over the compiled javadocs before getting a copy of the code. As a convenience to developers, students, and grant reviewers, it would be good I think to publish the javadocs on-line.

For this to be most useful, we should probably publish javadocs corresponding to the latest stable release (e.g., 6.1 as of this moment) as well as javadocs corresponding to the latest trunk. If we could automate the latter process, so much the better.

We could look to other open source projects (e.g., Tomcat, BioJava?) Web-accessible javadocs for ideas on what to do.

-Ann
-Ann

Discussion


Log in to post a comment.