Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.

Bug 232984

Summary:	GEF & Draw2D doc plugins do not contain javadoc reference
Product:	[Tools] GEF	Reporter:	Brian Lillie <brianlil>
Component:	GEF-Legacy GEF (MVC)	Assignee:	Anthony Hunter <ahunter.eclipse>
Status:	RESOLVED FIXED	QA Contact:
Severity:	normal
Priority:	P3	CC:	ahunter.eclipse, hudsonr, raji
Version:	3.4
Target Milestone:	3.4.0 (Ganymede) RC4
Hardware:	PC
OS:	Windows XP
Whiteboard:

Description Brian Lillie

2008-05-20 10:42:13 EDT

Build ID: 3.4.0M7

Steps To Reproduce:
In constructing a platform, we will be including only the coc plugins and not the source plugins.  Without the source plugins, the javadoc for GEF & Draw2D classes will not be available.

The GEF & Draw2D doc.isv plugins should include a javadoc reference such as this for draw2d

<extension point="org.eclipse.pde.core.javadoc">
   <javadoc path="reference/api">
  <plugin id="org.eclipse.draw2d" /> 
  </javadoc>
</extension>


and this for gef

<extension point="org.eclipse.pde.core.javadoc">
   <javadoc path="reference/api">
  <plugin id="org.eclipse.gef" /> 
  </javadoc>
</extension>

(This is the same pattern currently in use in the org.eclipse.platfor.doc.isv plugin)


More information:

Comment 1 Anthony Hunter

2008-05-20 11:26:06 EDT

So you are saying you take the GEF-SDK download and remove the source?

Comment 2 Randy Hudson

2008-05-20 11:53:27 EDT

This sounds like a reasonable request, but I'm just wondering what is the reason for depriving developers of the source code should they need to debug or just verify the javadoc's claims? Is source being left out of this "platform" for legal/contamination reasons?

Comment 3 Randy Hudson

2008-05-20 11:53:53 EDT

... or, can you not answer that question for legal reasons ;-)

Comment 4 Brian Lillie

2008-05-20 13:54:44 EDT

Randy, you pretty much nailed it :)

What's the difference between ...  ... ah, never mind, I'll get in trouble for that.

The product delivery is not including any of the eclipse source, but we are able to include the doc plugins.    Since we are providing our own target platform, including the doc plugins into the target platform allows for the content assist/auto complete to show javadoc assistance.  With source, the javadoc would normally come from the source, but by using the ext allows it to be found from the doc plugins.

Comment 5 Anthony Hunter

2008-06-06 12:31:06 EDT

Documentation fix, so OK to commit to HEAD for 3.4 RC4.