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

Bug 224832

Summary:	[javadoc] org.eclipse.jface.text.quickassist.IQuickFixableAnnotation needs doc
Product:	[Eclipse Project] Platform	Reporter:	Nitin Dahyabhai <thatnitind>
Component:	Text	Assignee:	Dani Megert <daniel_megert>
Status:	RESOLVED FIXED	QA Contact:
Severity:	normal
Priority:	P2	CC:	daniel_megert, david_williams, for.work.things
Version:	3.2
Target Milestone:	3.4 M7
Hardware:	All
OS:	All
Whiteboard:

Description Nitin Dahyabhai

2008-03-31 02:54:05 EDT

The interface is part of the API and is implementable by clients, but curiously lacks any JavaDoc.  This is still the case with 3.4 I20080327-2251.

Comment 1 David Williams

2008-03-31 22:22:11 EDT

In particular, it's unclear why 
isQuickFixable() does not return false if
isQuickFixableStateSet() is not set
instead of throwing as Assert exception (as it does in M6). 

It would be a friendlier API if it just returned false ... unless there's some other reason. 

This caused us a bit of grief in bug 224804.

Comment 2 Dani Megert

2008-04-07 10:26:22 EDT

>it would be a friendlier API if it just returned false ... 
If we'd just return 'false' then the state might always be wrong. For example I am not sure your fix for bug 224804 is correct as it should probably compute the state and set it (see org.eclipse.ui.texteditor.DefaultMarkerAnnotationAccess.hasQuickFix(Annotation)). 
But of course you couldn't know that without seeing any Javadoc.

Fixed in HEAD.
Available in builds > N20080406-2000.