Javadocs for the Sakai API

Information

This describes how to get javadocs for Sakai releases or make your own javadocs from the sakai source code (which you have to do if you want up to date APIs for trunk for example).

Where to find online Javadoc APIs

The online Sakai Javadoc API is available in svn and based on the release number:

http://source.sakaiproject.org/release/<release number>/apidocs/

Example: http://source.sakaiproject.org/release/2.6.2/apidocs/

The kernel javadocs (all the core services will be here so this is likely what you want) are available based on the released version:

http://source.sakaiproject.org/release/kernel/<version>/apidocs/

Example: http://source.sakaiproject.org/release/kernel/1.1.2/apidocs/

You can also start here and get to the javadocs for the current release (scroll down the page):
http://source.sakaiproject.org/release

The javadocs for the nightly build of Sakai are constantly rebuilt at the following URL: http://nightly2.sakaiproject.org/javadoc/sakai-javadoc/index.html (best source of up-to-date information)

Generating Javadocs from the Sakai source code

Check out the sakai source code using SVN
- Example: svn co https://source.sakaiproject.org/svn/sakai/trunk/
To generate javadocs from sakai source run the following command in the sakai source directory
```
mvn javadoc:javadoc
```
- You'll find the javadocs in <sakai source>/target/site/apidocs