Skip to main content

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
Re: [jdt-dev] Javadocs Configuration

NB : Not sure this is the good list to post this, since it is suppose to be relative to jdt development (i.e. internal way eclipse handle java source and project -at least, it's the way i've understood the subject of this list...-).

Anyway, the source path is used for javadoc tooltips (pressing F2 on an element -and also while navigating to source using Control+Click-) and the javadoc sourcepath is for opening the full javadoc page in an external browser (i.e. the first one is for navigating source and retrieving the associated comments/javadoc, the second is for browsing javadoc).

AFAIK, Eclipse can't retrieve javadoc comment of a single java element from javadoc documentation. That's quite annoying when you only have the javadoc, but since the javadoc templates are left to the generator (event if most of javadoc i've seen simply use the default templates), i guess it would be quite perilous to try to browse html. Moreover, you can reference an external javadoc source (on a remote web server), so extracting the javadoc from a web would be quite hazardous (either trigger a hit on every request, but that could be too laggy, or try to cach somehow the javadoc, and enter the "when-to-uncache" nightmare).

Have a nice Day,
Seb C.

NB: even if RC1 is really quite stable (As a matter of fact, i've used 3.0 milestones in a production environment since M5 without noticing any bug) you should definitely upgrade to 3.0.1 (or at least 3.0.0 final which have been out for a few months now).

Durham David R Jr Contr 805 CSPTS/SCE wrote:
Hi,

I'm new to the list, so bare with me while I get acclimated to the
environment.  I'm using Eclipse 3.0rc1 to setup my first project using
Eclipse.  I'm familiar with Java IDE's so I'm not having any trouble
navigating to the project properties and adding libraries.  Along with
adding a library, I have the option to specify source and javadocs
references.  It appears that once I set the source attribute of a
library, the javadocs show up in the code editor.  That's what I'd
expect and that's great.  Now to my problem, the javadoc reference --
what does it do?  

I'm trying to add a JSF 1.1 library to my project.  I've got the JSF 1.1
javadocs, but no source.  Consequently, when I go to a JSF reference in
the code editor, I don't see any javadocs.  It seems like I'm
misunderstanding the use of the Javadocs library reference, but couldn't
find anything in the help system that explains this feature.  Thanks for
any assistance.


- Dave

_______________________________________________
jdt-dev mailing list
jdt-dev@xxxxxxxxxxx
http://dev.eclipse.org/mailman/listinfo/jdt-dev
  


Back to the top