How to create the API?

[Gabriel Landini]

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.

Thanks in advance,

Gabriel

[Albert Cardona]

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

[Gabriel Landini]

On Monday 21 January 2008 12:14:09 Albert Cardona wrote:
> Just use ant for that:
>
> $ cd ImageJ/
> $ ant javadocs
> Have a look at the build.xml to find other build targets.

Hi Albert,

Great, thanks.

I had to cd /ImageJ/source, otherwise it did not see the build.xml, but it put
docs correctly in the ImageJ/api.

Regards,

Gabriel

[Joachim Wesner]

Hi there,

you actually do not need Ant ( I don´t have it), when you have Sun JDK
javadoc somewehre in the path, simply do

>cd /source or similar  (the toplevel directory of ther source where for
example "build.xml" is located)

and do

>javadoc ij

That should do it

Mit freundlichen Grüßen / Best regards

Joachim Wesner
Projektleiter Optik Technologiesysteme

Ernst Leitz Strasse 17-37 | 35578 Wetzlar (Germany)
Tel.  [phone] | Fax [phone]

____________________________________________

Leica Microsystems CMS GmbH | GmbH mit Sitz in Wetzlar | Amtsgericht
Wetzlar  HRB 2432
Geschäftsführer:  Dr. Stefan Träger | Dr. Wolf-Otto Reuter | Dr. David Roy
Martyr | Colin Davis


                                                                           
             Albert Cardona                                                
             <[hidden email]                                            
             S.ETHZ.CH>                                                 An
             Gesendet von:              [hidden email]                
             ImageJ Interest                                         Kopie
             Group                                                        
             <[hidden email].                                       Thema
             GOV>                       Re: How to create the API?        
                                                                           
                                                                           
             21.01.2008 13:14                                              
                                                                           
                                                                           
              Bitte antworten                                              
                    an                                                    
              ImageJ Interest                                              
                   Group                                                  
             <[hidden email].                                            
                   GOV>                                                    
                                                                           
                                                                           




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



______________________________________________________________________
This email has been scanned by the MessageLabs Email Security System.
For more information please visit http://www.messagelabs.com/email 
______________________________________________________________________

[Gabriel Landini]

On Monday 21 January 2008 12:51:33 Joachim Wesner wrote:
> you actually do not need Ant ( I don´t have it), when you have Sun JDK
> javadoc somewehre in the path, simply do  cd /source or similar  (the
> toplevel directory of ther source where for example "build.xml" is located)
> and do
>
> javadoc ij
>
> That should do it

Thanks for that hint too, Joachim.
I had ant already installed (actually it is convenient to compile the source
code, one needs only to execute the command "ant" in the source directory and
it will compile, put in a jar file and execute it.)

Regards,

Gabriel