Bug 173693

Summary: Add comment to javadoc in advanced graphics methods of SWTGraphics
Product: [Tools] GEF Reporter: Cherie Revells <crevells>
Component: GEF-Legacy GEF (MVC)Assignee: Anthony Hunter <ahunter.eclipse>
Status: RESOLVED FIXED QA Contact:
Severity: normal    
Priority: P3 Keywords: contributed
Version: 3.2.1   
Target Milestone: 3.3.0 (Europa) M6   
Hardware: PC   
OS: Windows XP   
Whiteboard:
Attachments:
Description Flags
Adds to existing javadoc.
none
Removed added whitespace from patch ahunter.eclipse: iplog+

Description Cherie Revells CLA 2007-02-09 15:48:55 EST 
If clients use some of the methods in SWTGraphics that require the advanced graphics library and the user does not have an advanced graphics library in their environment the results could be ugly (diagram may not open or be unusable and log fills up with errors).  Clients should check if advanced graphics is supported, by calling GC.getAdvanced(), before calling a method on SWTGraphics that requires advanced graphics.

I suggest we at least add a comment to the javadoc in advanced graphics methods of SWTGraphics to make clients aware of this.

I am attaching a patch.
Comment 1 Cherie Revells CLA 2007-02-09 15:50:06 EST 
Created attachment 58698 [details]
Adds to existing javadoc.
Comment 2 Anthony Hunter CLA 2007-02-15 13:50:03 EST 
Cherie, can you redo the patch so that it does not change the method indentation. Open the patch and you will see what I mean.
Comment 3 Cherie Revells CLA 2007-02-15 14:05:50 EST 
Created attachment 59082 [details]
Removed added whitespace from patch
Comment 4 Anthony Hunter CLA 2007-03-22 08:54:46 EDT 
Committed to HEAD
Comment 5 Anthony Hunter CLA 2007-03-29 15:04:56 EDT 
I cannot change the Assigned To: field without reopening the bug.
Comment 6 Anthony Hunter CLA 2007-03-29 15:05:44 EDT 
Patch committed to GEF 3.3 M6