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

Bug 466449

Summary:	Polishing of GEF4 Common component (javadoc, doc, warnings)
Product:	[Tools] GEF	Reporter:	Alexander Nyßen <nyssen>
Component:	GEF Common	Assignee:	Alexander Nyßen <nyssen>
Status:	RESOLVED FIXED	QA Contact:
Severity:	normal
Priority:	P3
Version:	unspecified
Target Milestone:	3.10.0 (Mars) RC1
Hardware:	All
OS:	All
Whiteboard:

Description Alexander Nyßen

2015-05-05 11:00:12 EDT

The GEF4 Common component needs some polishing, augmenting its javadoc and removing warnings related to unused imports, etc.

Comment 1 Alexander Nyßen

2015-05-05 12:08:22 EDT

Implemented the following changes (which are pushed to origin/master):
- Changed jdt.core.prefs to enforce that javadoc is provided up to package visibility level.
- Augmented respective javadoc where missing.
- Fixed potential NPE within AdaptableSupport#unsetAdapters()
- Fixed potential memory leak within AdaptablSupport by ensuring that dispose() properly unbinds adapters when removing them.
- Adjusted pom.xml to no longer introduce pom-dependency to Guice-Multibindings (is already loaded as api-context-lib via package import)
- Added missing packages within javadocOptions.txt
- Ensured javadocs of Google Guava and Google Guice are properly linked.
- Added missing package-info.html files.
- Ensure generic type parameters are all documented.

What remains is to augment the (developer) reference documentation for GEF4 Common in the wiki.

Comment 2 Alexander Nyßen

2015-05-08 07:49:16 EDT

I updated the class diagrams for documenting the API and uploaded the image exports to the wiki. Will still need to add documentation though.

Comment 3 Alexander Nyßen

2015-05-12 12:39:11 EDT

Migrated the wiki documentation into "standard" structure. As javadoc is complete and wiki doc covers all packages as well, resolving as fixed in 3.10.0RC1.