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

Bug 466467

Summary:	Polishing of GEF4 FX component (javadoc, doc)
Product:	[Tools] GEF	Reporter:	Alexander Nyßen <nyssen>
Component:	GEF FX	Assignee:	gef-inbox <gef-inbox>
Status:	RESOLVED FIXED	QA Contact:
Severity:	normal
Priority:	P3	CC:	matthias.wienand
Version:	unspecified
Target Milestone:	3.10.0 (Mars) RC3
Hardware:	All
OS:	All
Whiteboard:

Description Alexander Nyßen

2015-05-05 12:15:07 EDT

The GEF4 FX component needs some polishing w.r.t. its javadoc and developer documentation in the wiki.

Comment 1 Alexander Nyßen

2015-05-06 02:07:51 EDT

Implemented the following changes so far (which are pushed to origin/master):
- Changed jdt.core.prefs to report javadoc warnings where documentation is still missing (we should switch to error as soon as all warnings are resolved).
- Started to augment javadoc.
- Ensured GEF4 Common and GEF4 Geometry javadoc are properly linked offline by javadoc.
- Ensured Google Guava javadoc is properly linked (online).

Comment 2 Alexander Nyßen

2015-05-12 12:33:28 EDT

Created "standard" document structure at http://wiki.eclipse.org/GEF/GEF4/FX. However, most of the section still need to be filled with contents.

Comment 3 Alexander Nyßen

2015-05-13 03:23:12 EDT

Started to augment documentation in the wiki (added class diagrams).

Comment 4 Matthias Wienand

2015-05-26 11:56:49 EDT

I added some content to the developer documentation in the Wiki and added all missing javadoc comments within FX, however, FX.UI is still lacking some javadoc.

Comment 5 Matthias Wienand

2015-05-28 09:37:10 EDT

I added the remaining javadoc to FX.UI and enhanced the Wiki documentation for FX.UI. Therefore, I resolve this ticket as fixed for 3.10.0RC3.