Bug 25471 - [Viewers] JavaDoc for class StructuredSelection inconsistent
Summary: [Viewers] JavaDoc for class StructuredSelection inconsistent
Status: RESOLVED FIXED
Alias: None
Product: Platform
Classification: Eclipse Project
Component: UI (show other bugs)
Version: 2.0.1   Edit
Hardware: PC Windows 2000
: P3 normal (vote)
Target Milestone: 2.1 RC1   Edit
Assignee: Nick Edgar CLA
QA Contact:
URL:
Whiteboard:
Keywords: api
Depends on:
Blocks:
 
Reported: 2002-10-28 16:38 EST by David J. Orme CLA
Modified: 2003-02-11 10:03 EST (History)
0 users

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description David J. Orme CLA 2002-10-28 16:38:29 EST
/**
 * A concrete implementation of the <code>IStructuredSelection</code> interface,
 * suitable for instantiating or subclassing.
 * <p>
 * This class is not intended to be subclassed.
 * </p>
 */
public class StructuredSelection implements IStructuredSelection {

-----

According to the JavaDoc quoted above, the class is both intended to be
subclassed and not intended to be subclassed.

Which is it?  :-)

In any case, this JavaDoc comment is broken and needs fixing.  :-)
Comment 1 Nick Edgar CLA 2003-02-10 10:21:19 EST
Do you have a need to subclass it?
Comment 2 David J. Orme CLA 2003-02-10 10:44:25 EST
I don't need to subclass it although I reimplement IStructuredSelection in 
various places.

Actually, I can't imagine anyone really needing to subclass it that badly, 
since one can just reimplement IStructuredSelection with any other features 
that might be needed.

Comment 3 Nick Edgar CLA 2003-02-11 10:03:53 EST
Took out the "suitable for subclassing" comment.  Left the "This class is not 
intended to be subclassed." comment.
Thanks for pointing this out.