Re: How to create the API?

Posted by Albert Cardona on
URL: http://imagej.273.s1.nabble.com/How-to-create-the-API-tp3697504p3697505.html

Gabriel,

Just use ant for that:

$ cd ImageJ/
$ ant javadocs


Have a look at the build.xml to find other build targets.


Alternatively, to do it manually, this is my own 'jdoc' script to build
the API for TrakEM2.
All .html files are sent to to the target directory 'api':

$ cd ImageJ/plugins/TrakEM2-src/
$ mkdir api
$ javadoc -d api -classpath ../../ij.jar:$(find . -name "*.jar" -printf
"%h%f:"). $(find -name "*java" -printf "%p ")



Albert

> I am sure some of the resident Java gurus will be able to help.
>
> I have the IJ source in ~/ImageJ/source
>
> How do I create the API documentation, let's say in ~/ImageJ/api
>
> I want to generate something similar to the one in the IJ site, but locally in
> my HD with the latest source, so I do not have to be online to read it.
>
> I am using linux and javadoc is installed, but I cannot get the correct
> syntax.
>  

--
Albert Cardona
http://www.mcdb.ucla.edu/Research/Hartenstein/acardona