Bugzilla – Full Text Bug Listing
| Summary: | IStackPresentationSite dragStart() Javadoc inconsistent with param name | ||
|---|---|---|---|
| Product: | [Eclipse Project] Platform | Reporter: | Alan Green <reg.eclipse.org> |
| Component: | UI | Assignee: | Platform UI Triaged <platform-ui-triaged> |
| Status: | ASSIGNED --- | QA Contact: | |
| Severity: | normal | ||
| Priority: | P3 | ||
| Version: | 3.2 | ||
| Target Milestone: | --- | ||
| Hardware: | PC | ||
| OS: | Windows XP | ||
| Whiteboard: | |||
This bug hasn't had any activity in quite some time. Maybe the problem got resolved, was a duplicate of something else, or became less pressing for some reason - or maybe it's still relevant but just hasn't been looked at yet. If you have further information on the current state of the bug, please add it. The information can be, for example, that the problem still occurs, that you still want the feature, that more information is needed, or that the bug is (for whatever reason) no longer relevant. This bug hasn't had any activity in quite some time. Maybe the problem got resolved, was a duplicate of something else, or became less pressing for some reason - or maybe it's still relevant but just hasn't been looked at yet. If you have further information on the current state of the bug, please add it. The information can be, for example, that the problem still occurs, that you still want the feature, that more information is needed, or that the bug is (for whatever reason) no longer relevant. |
There are two methods in org.eclipse.ui.presentations.IStackPresentationSite named "dragStart". Both have a boolean parameter named "keyboard". The Javadoc for this parameter reads: * @param keyboard true iff the drag was initiated via mouse dragging, * and false if the drag may be using the keyboard Obviously, the Javadoc is inconsistent with the parameter name. From my experience with the API, it appears that parameter name is correct and the Javadoc is right. The Javadoc should read: * @param keyboard true if the drag was initiated with the keyboard, * and false if it was initiated with the mouse.