You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@mahout.apache.org by Isabel Drost-Fromm <is...@apache.org> on 2013/11/20 16:21:57 UTC

JavaDoc for collections

Hi,

I'm in the process of pulling all our docs together for the new site. I think it makes sense to give users an option to browse all our JavaDocs online. I found javadocs for all modules as part of our QA Jenkins Job (though a bit hidden in the workspace, in the target dir of each module):

https://builds.apache.org/job/Mahout-Quality/ws/trunk/core/target/site/apidocs/index.html

https://builds.apache.org/job/Mahout-Quality/ws/trunk/examples/target/site/apidocs/index.html

Essentially the schema is:

https://builds.apache.org/job/Mahout-Quality/ws/trunk/[module-name]/target/site/apidocs/index.html


I didn't find any published docs of our collections module though there is still a build job setup and running regularly for it. Should I look someplace else or create is that something for a new JIRA issue?

As a side note: Most of our packages really could do with better package documentation - this is obvious even when just briefly scanning our JavaDoc output. I guess this is definitely something for a JIRA issue - I would guess that with most of the important classes and packages this would be a great place for contributors and users to get familiar with the general patch process.


Isabel