Bug 38640 - [EditorMgmt] Error in comment for org.eclipse.ui.part.EditorPart.init(IEditorSite site, IEditorInput input)
Summary: [EditorMgmt] Error in comment for org.eclipse.ui.part.EditorPart.init(IEditor...
Status: RESOLVED FIXED
Alias: None
Product: Platform
Classification: Eclipse Project
Component: UI (show other bugs)
Version: 2.1   Edit
Hardware: PC Windows XP
: P3 enhancement (vote)
Target Milestone: 3.0 M2   Edit
Assignee: Simon Arsenault CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2003-06-09 06:42 EDT by Guy Dierx CLA
Modified: 2003-06-18 12:04 EDT (History)
1 user (show)

See Also:

Attachments
Patch for org.eclipse.ui.workbench (772 bytes, patch)
2003-06-12 09:29 EDT, Debbie Wilson CLA 		no flags Details | Diff
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 Guy Dierx CLA 2003-06-09 06:42:43 EDT 
The comment for org.eclipse.ui.part.EditorPart.init(IEditorSite site, 
IEditorInput input):
"/* (non-Javadoc)
 * Initializes the editor part with a site and input.
 * <p>
 * Subclasses of <code>EditorPart</code> must implement this method.  Within
 * the implementation subclasses should verify that the input type is 
acceptable
 * and then save the site and input.  Here is sample code:
 * </p>
 * <pre>
 *		if (!(input instanceof IFileEditorInput))
 *			throw new PartInitException("Invalid Input: Must be 
IFileEditorInput");
 *		setSite(site);
 *		setInput(editorInput);
 * </pre>
 */"

The line "setInput(editorInput)" should be "setInput(input)".
Comment 1 Dejan Glozic CLA 2003-06-09 08:30:10 EDT 
Wrong address :-).
Comment 2 Debbie Wilson CLA 2003-06-12 09:29:19 EDT 
Created attachment 5172 [details]
Patch for org.eclipse.ui.workbench

Patch created for project org.eclipse.ui.workbench.  Simon, could you review
and release if appropriate?
Comment 3 Simon Arsenault CLA 2003-06-18 12:04:43 EDT 
Applied the patch and released the changes.