UIMA Javadocs in Eclipse

[Thilo Goetz <tw...@gmx.de>]

Is it just me, or is the following from section 1.1 of the Tutorial and Guide out of context:

Note

In Eclipse 3.1, if you highlight a UIMA class or method defined in the UIMA SDK JavaDocs, you can
conveniently have Eclipse open the corresponding JavaDoc for that class or method in a browser, by
pressing Shift + F2.

I was unable to find any instructions that tell me how to set things up so this works.
Should we add something to section 3.2 of the Overview?  Did I miss anything?

I also didn't find a description on how to set up things in Eclipse so I have the
UIMA source code linked up to my classpath, so that F3 works.  It would be convenient
if we had a src.jar, like I see done in other projects.  Does Maven have an easy
way to create that?

--Thilo

Re: UIMA Javadocs in Eclipse

[Marshall Schor <ms...@schor.com>]

Thilo Goetz wrote:
> Is it just me, or is the following from section 1.1 of the Tutorial and Guide out of context:
>
> Note
>
> In Eclipse 3.1, if you highlight a UIMA class or method defined in the UIMA SDK JavaDocs, you can
> conveniently have Eclipse open the corresponding JavaDoc for that class or method in a browser, by
> pressing Shift + F2.
>
> I was unable to find any instructions that tell me how to set things up so this works.
> Should we add something to section 3.2 of the Overview?  Did I miss anything?
>   
Probably should add something.  There's a bit about this in the Javadocs 
chapter - Ch 1 of the References.
> I also didn't find a description on how to set up things in Eclipse so I have the
> UIMA source code linked up to my classpath, so that F3 works.  It would be convenient
> if we had a src.jar, like I see done in other projects.  
I agree.  see Jira http://issues.apache.org/jira/browse/UIMA-248
> Does Maven have an easy
> way to create that?
>   
Probably just another assembly step

--Marshall

Re: UIMA Javadocs in Eclipse

[Thilo Goetz <tw...@gmx.de>]

Jörn Kottmann wrote:
> Hi Thilo,
> 
> the source code lookup does not work, because there is simply no source
> code in
> our jars.
> 
> Creating a src.jar is one way to add source code in eclipse, but I
> always prefer
> to include the source code in the jar directly.

I prefer the other way ;-)  The reason is that this keeps your jar files
leaner, and you only add the source code for development.  If you look
around Apache, I think that's what a lot of projects do.

> 
> To include the source code in a jar with the classes just put the .java
> files in the package
> hierarchy like the .class files.
> 
> Jörn

Re: UIMA Javadocs in Eclipse

[Jörn Kottmann <ko...@gmail.com>]

Hi Thilo,

the source code lookup does not work, because there is simply no  
source code in
our jars.

Creating a src.jar is one way to add source code in eclipse, but I  
always prefer
to include the source code in the jar directly.

To include the source code in a jar with the classes just put  
the .java files in the package
hierarchy like the .class files.

Jörn