Skip to main content



      Home
Home » Eclipse Projects » Eclipse Platform » Common Javadoc location
Common Javadoc location [message #291188] Sun, 11 September 2005 10:08 Go to next message
Eclipse UserFriend
I've been working with Eclipse since it's initial release to the
community from big blue for around 2 to 3 now. The environment is
excellent, really excellent, however it's a major PITA to reconfigure
javadoc locations every time one upgrades/adds/imports a new [external
library]/jar into a new project or a shared project from another
developer/team. This is especially true these days when external library
usage is generally increasing with the ever increasing acceptance of
open source libs in the enterprise.

I've searched through the list and I can't seem to find any mention of
this as either an idea or feature request. I also searched for a plugin
but I didn't find any. Maybe one even exists.

Anyway my question is would it not be possible to add a common javadoc
location to the eclipse help system.

For example

common-javadoc-location-defined-by-the-user-only-once\
\commons-logging\package-list etc...
\commons-httpclient\package-list etc...
\servlet1.4\package-list etc..
\junit3.8.1\package-list etc..
\etc...\etc...


The javadoc help system would then search for javadoc for a given jar,
as it currently does, however if a user has configured his javadoc
directory in the preferences and there is no javadoc associated with a
given jar then it will go to this folder to try to find the javadoc for
the given jar.

It could use the jar file name minus the .jar extension in a folder
defined in the eclipse global preferences. i.e
"common-javadoc-location-defined-by-the-user-only-once\" as I defined above.

Obviously it would be the users onus to setup this directory. Manage
versions correctly etc. A team could also benefit from this by sharing
one directory on the network which developers could add to as they add
new libs.

For correct versioning one could always integrate the version number
into the jar which is already a very common practice.


Cheers
Keith Lynch

p.s I originally posted to the tools.jdt group. I'm not too sure where
this should really belong. If anyone feels to comment please do in the
eclipse.tools.jdt group.
Re: Common Javadoc location [message #294267 is a reply to message #291188] Tue, 08 November 2005 09:57 Go to previous message
Eclipse UserFriend
Originally posted by: paul.paulgalbraith.net

Keith Lynch wrote:
> I've been working with Eclipse since it's initial release to the
> community from big blue for around 2 to 3 now. The environment is
> excellent, really excellent, however it's a major PITA to reconfigure
> javadoc locations every time one upgrades/adds/imports a new [external
> library]/jar into a new project or a shared project from another
> developer/team. This is especially true these days when external library
> usage is generally increasing with the ever increasing acceptance of
> open source libs in the enterprise.
>
> I've searched through the list and I can't seem to find any mention of
> this as either an idea or feature request. I also searched for a plugin
> but I didn't find any. Maybe one even exists.
>
> Anyway my question is would it not be possible to add a common javadoc
> location to the eclipse help system.
>
> For example
>
> common-javadoc-location-defined-by-the-user-only-once\
> \commons-logging\package-list etc...
> \commons-httpclient\package-list etc...
> \servlet1.4\package-list etc..
> \junit3.8.1\package-list etc..
> \etc...\etc...
>
>
> The javadoc help system would then search for javadoc for a given jar,
> as it currently does, however if a user has configured his javadoc
> directory in the preferences and there is no javadoc associated with a
> given jar then it will go to this folder to try to find the javadoc for
> the given jar.
>
> It could use the jar file name minus the .jar extension in a folder
> defined in the eclipse global preferences. i.e
> "common-javadoc-location-defined-by-the-user-only-once\" as I defined
> above.
>
> Obviously it would be the users onus to setup this directory. Manage
> versions correctly etc. A team could also benefit from this by sharing
> one directory on the network which developers could add to as they add
> new libs.
>
> For correct versioning one could always integrate the version number
> into the jar which is already a very common practice.

I've got the same complaint, but want an even simpler solution...I just
want to be able define javadoc locations in some portable way. Eclipse
classpath variables work beautifully for defining library locations, why
wasn't this concept applied to the corresponding source and javadoc
locations??? Javadoc apparently can *only* be specified by an absolute,
and local filesystem path (I tried putting it at UNC-specified network
location, but that doesn't work either). I hope this is changed with
the next release!
Previous Topic:I don't see ToolTips. Why?
Next Topic:Formatting text in a TableViewer
Goto Forum:
  


Current Time: Thu Jul 10 02:48:41 EDT 2025

Powered by FUDForum. Page generated in 0.12818 seconds
.:: Contact :: Home ::.

Powered by: FUDforum 3.0.2.
Copyright ©2001-2010 FUDforum Bulletin Board Software

Back to the top