|
JavaDocs
How to generate JavaDocs
Phase-Implementation At present we don't publish JavaDocs but you can easily create them once you have checked out the source using: javadoc -sourcepath uk.ac.osswatch.simal.core\src\main\java;uk.ac.osswatch.simal.web;uk.ac.osswatch.simal.ssmm;uk.ac.osswatch.simal.rest;uk.ac.osswatch.simal.forrest.plugins -subpackages uk.ac.osswatch.simal | |
► Sign in to add a comment
I got that command a bit wrong - it misses several of the packages. This one is more comprehensive, although it also generates a lot of Java exceptions (I don't know why):
javadoc -J-Xms120m -J-Xmx120m -d doc -sourcepath uk.ac.osswatch.simal.core\src\main\java;uk.ac.osswatch.simal.core\src\test\java;uk.ac.osswatch.simal.web\src\main\java;uk.ac.osswatch.simal.web\src\test\java;uk.ac.osswatch.simal.ssmm\src\main\java;uk.ac.osswatch.simal.ssmm\src\test\java;uk.ac.osswatch.simal.rest\src\main\java;uk.ac.osswatch.s
imal.rest\src\test\java;uk.ac.osswatch.simal.forrest.plugins\src\main\java;uk.ac.osswatch.simal.forrest.plugins\src\test\java -subpackages uk
The exceptions I get seem to be from the JUnit @Test annotations 1? and indeed I don't get these when running javadoc without the test classes.
1? http://stackoverflow.com/questions/44853/why-am-i-getting-a-classcastexception-when-generating-javadocs