Bug 182110 - Clean up new JFace Viewers APIs
Summary: Clean up new JFace Viewers APIs
Status: VERIFIED FIXED
Alias: None
Product: Platform
Classification: Eclipse Project
Component: UI (show other bugs)
Version: 3.3   Edit
Hardware: PC Windows XP
: P3 normal (vote)
Target Milestone: 3.3 M7   Edit
Assignee: Thomas Schindl CLA
QA Contact:
URL:
Whiteboard:
Keywords: api, polish
Depends on:
Blocks:
 
Reported: 2007-04-12 06:32 EDT by Markus Keller CLA
Modified: 2007-05-03 18:17 EDT (History)
3 users (show)

See Also:

Attachments
Fixed spelling errors (43.17 KB, patch)
2007-04-17 17:06 EDT, Thomas Schindl CLA 		no flags Details | Diff
Started with JavaDoc errors (55.74 KB, patch)
2007-04-17 17:25 EDT, Thomas Schindl CLA 		no flags Details | Diff
Show Obsolete (1) View All Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description Markus Keller CLA 2007-04-12 06:32:07 EDT 
I20070410-1043

Many of the new JFace Viewers APIs introduced for 3.3 need some clean-up to become Eclipse-quality. There are spelling errors, missing type comments (e.g. CellNavigationStrategy), incomplete comments (e.g. OwnerDrawLabelProvider does not tell that is is intended to be subclassed; ), undocumented methods (e.g. TreeViewerEditor), undocumented @param and @return tags, etc.

See http://wiki.eclipse.org/index.php/API_Central and the links in http://wiki.eclipse.org/index.php/Javadoc for how-tos.
Comment 1 Markus Keller CLA 2007-04-12 06:40:27 EDT 
APIs must also tell if null is allowed as argument or return value (e.g.
ColumnViewerEditor#getFocusCell()).
Comment 2 Thomas Schindl CLA 2007-04-17 17:06:35 EDT 
Created attachment 64101 [details]
Fixed spelling errors

I not only fixed those in the new API but because I was at it I went through all classes in the viewer package and fixed those errors.
Comment 3 Thomas Schindl CLA 2007-04-17 17:25:48 EDT 
Created attachment 64102 [details]
Started with JavaDoc errors
Comment 4 Thomas Schindl CLA 2007-04-23 15:11:11 EDT 
Released spelling corrections to CVS
Comment 5 Thomas Schindl CLA 2007-04-23 15:50:06 EDT 
I think I polished all new API to be Eclipse-quality but I hope I haven't missed one. Released with multiple commits > 20070423
Comment 6 Thomas Schindl CLA 2007-05-03 18:17:38 EDT 
Verified in I20070502-1800 by code inspection