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

Bug 357135

Summary: GenTopic should generate UIEvents with comments and javadoc warning supression
Product: [Eclipse Project] Platform Reporter: Dean Roberts <dean.t.roberts>
Component: UIAssignee: Dean Roberts <dean.t.roberts>
Status: VERIFIED FIXED QA Contact: Remy Suen <remy.suen>
Severity: normal    
Priority: P3 CC: emoffatt, pwebster, remy.suen
Version: 4.2   
Target Milestone: 4.2 M3   
Hardware: All   
OS: All   
Whiteboard:
Bug Depends on:    
Bug Blocks: 357136    
Attachments:
Description Flags
Patch to add comments and fix copyright none

Description Dean Roberts CLA 2011-09-08 14:30:44 EDT
I've been told that UIEvents is a generated class.  The generator should probably add a comment that the class is generated.

Super deluxe would include comments with instructions on how to run the generator.

It should also generate such that it does not contain warnings.  A @SuppressWarnings("javadoc") is likely sufficient as it is not clear if the variables need any description more than just the name.
Comment 1 Paul Webster CLA 2011-09-08 14:35:15 EDT
The app that generates that class is org.eclipse.e4.ui.internal.workbench.swt.GenTopic

PW
Comment 2 Dean Roberts CLA 2011-09-13 14:10:34 EDT
Created attachment 203274 [details]
Patch to add comments and fix copyright
Comment 3 Remy Suen CLA 2011-09-19 12:45:31 EDT
(In reply to comment #2)
> Created attachment 203274 [details]
> Patch to add comments and fix copyright

Can you apply this patch, Dean? It doesn't seem to work for me.
Comment 5 Dean Roberts CLA 2011-10-26 13:43:54 EDT
Verified on I20111014-1625