Bug 6259

Summary:	DCR: IClasspathEntry with JavaDoc location
Product:	[Eclipse Project] JDT	Reporter:	Martin Aeschlimann <martinae>
Component:	Core	Assignee:	Philipe Mulet <philippe_mulet>
Status:	RESOLVED WONTFIX	QA Contact:
Severity:	normal
Priority:	P3	CC:	erich_gamma
Version:	2.0
Target Milestone:	2.0 F3
Hardware:	PC
OS:	Windows 2000
Whiteboard:

Description Martin Aeschlimann

2001-11-23 11:06:19 EST

A library classpath entry also contains a location of it's JavaDoc.

Features based on this:
- show the JavaDoc of a Java Element in a web browser.
  (jdt.ui)
- use the JavaDoc as secondary source, if no source attchment is available.
  (jdt.core, SourceBuffer)
- Use the JavaDoc location as links for the creation of JavaDoc from sources.

- JavaDoc generation: Use the location attached to the sourcefolder as 
destination. 

Issues:
Location as IPath / URL?
The idea to represent it as URL is very tempting, but is not very consistent 
with the rest of eclipse.
Clathpath variables are defines a IPath, so JRE witching would not be possible 
if URL would be taken.

What about putting an URL in a Path? Probably fails due to port numbers in URLs.

-> IPath is not optimal, but theres no alternative.

Comment 1 Erich Gamma

2001-11-23 13:12:59 EST

Philippe this Javadoc feature request we have discussed last Friday.

From the features described below the first one is the most important. We would 
like to support that the user can select and element in the UI and 
execute "Show External Javadoc". 

The idea to use a URL is good, but as Martin says there is no good alternative. 
So for now it is sufficient when the IPath can refer to either a directory or a 
zip file with archived javadoc.

Java Core could also provide a method for IMembers to find the URL to the 
external JavaDoc. The UI would then show this in a browser.

Comment 2 Martin Aeschlimann

2001-11-26 03:49:55 EST

Doc in a zip file is not common (web browsers can't browse in a zip file)

For point 2 (JavaDoc as secondary source), the cheapest solution for JCore 
would be to allow the plugin of a SourceMapper.

Other API woshes related to JavaDoc would be a 'getJavaDocSourceRange()'
(like getSourceRange, but only the JavaDoc comment)
getCommenRange would be sufficent and more general, too.

Comment 3 Erich Gamma

2001-11-26 07:03:13 EST

>Doc in a zip file is not common 
the Eclipse JavaDoc ships in a zip so it is important that we can present 
JavaDoc out of a zip. The Help View can handle links in zips so we can look 
their how they did it.

Comment 4 Erich Gamma

2002-02-13 01:41:08 EST

Before starting to implement a particular solution we should discuss the 
options again. One issue is that we would really like to be able to use a URL 
to define the location of JavaDoc. Martin pls Philippe your current write-up on 
the options.

Comment 5 Philipe Mulet

2002-06-04 10:15:54 EDT

Closing, this DCR got turned down.