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

Bug 140554

Summary:

GEF Javadoc is not indexed in Eclipse Help system

Product:

[Tools] GEF

Reporter:

Steven R. Shaw <steveshaw>

Component:

GEF-Legacy GEF (MVC)

Assignee:

Syed Atif <syedatif>

Status:

RESOLVED FIXED

QA Contact:

Severity:

major

Priority:

CC:

hudsonr, nyssen

Version:

3.2

Target Milestone:

3.2.0 (Callisto) RC3

Hardware:

OS:

Windows XP

Whiteboard:

Attachments:

Description	Flags
Patch + folders to extract	none
Patch 2...everything fixed	nyssen: iplog+

Description Steven R. Shaw

2006-05-08 09:14:28 EDT

This is because we don't have a subtopic entry in the TOC per package. The GMF Runtime doclet could help you here, it generates the TOC for you among other things. Eclipse probably use a similar tool that may be used instead
Page referenced by TOC entries should not show the "frame" version of the javadoc page anymore

Comment 1 Steven R. Shaw

2006-05-08 09:16:31 EDT

Additionally:
GEF's javadoc topics should be moved into "Reference > API Reference"
Remove the 2 "frame" versions in TOC
Fix the stylesheet of the generated javadoc

Comment 2 Syed Atif

2006-05-15 11:16:06 EDT

Created attachment 41456 [details]
Patch + folders to extract

This zipfile contains a patch that applies to a workspace containing org.eclipse.draw2d.doc.isv and org.eclipse.gef.doc.isv projecs as well as two files that need to be extracted to the workspace.

It is not the generated javadoc stylesheet that causes the font problem (in overview_summary.html), it is the generated overview_summary.html itself. It seems that this generated file does not contain the closing tag for the title (i.e. </h2>).

However, The patch does not contain a fix to this font problem because the generated javadoc was never included in the original folder from CVS. Therefore, I am supplying the files that I changed in the javadoc generated reference folders in the zip file. (Just extract these two folders into your workspace folder after generating the javadoc files using the buildDoc.xml antscript for each project.)

Note 1: if you generate javadoc again, this font problem will occur again because the bug is in the javadoc executable (unless you extract the two folders into the workspace again).

Note 2: Before executing the antscript buildDoc.xml for each project, make sure you have declared a property called JAVADOC14_HOME in the ant preferences, with the value pointing to your javadoc executable folder.

Comment 3 Steven R. Shaw

2006-05-15 16:55:20 EDT

+1

Syed is looking into fixing the JavaDoc generation build scripts to fix the font problem.

The patch addresses JavaDoc consistency issues with other projects and fixes the indexing problem.

Comment 4 Syed Atif

2006-05-15 17:39:50 EDT

Created attachment 41521 [details]
Patch 2...everything fixed

The 'stylesheet' problem was in overview.html files included in the src folders of org.eclipse.draw2D and org.eclipse.gef and has been fixed.

Obtain a fresh copy from CVS and apply the patch. You will need to regenerate all the javadoc for org.eclipse.draw2D and org.eclipse.gef using the original buildDoc.xml ant script from CVS.

Comment 5 Steven R. Shaw

2006-05-16 10:09:12 EDT

Committed changes contributed by Syed.