Bug 201735 - Documentation misleading for scanlinePad argument to ImageData constructor
Summary: Documentation misleading for scanlinePad argument to ImageData constructor
Status: NEW
Alias: None
Product: Platform
Classification: Eclipse Project
Component: SWT (show other bugs)
Version: 3.3   Edit
Hardware: All All
: P3 minor with 1 vote (vote)
Target Milestone: ---   Edit
Assignee: Silenio Quarti CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2007-08-30 09:18 EDT by Erland Lewin CLA
Modified: 2019-09-06 16:13 EDT (History)
0 users

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Erland Lewin CLA 2007-08-30 09:18:07 EDT
This is for version 3.3.4 of SWT, and regards the org.eclipse.swt.graphics.ImageData class.

One of the ImageData constructors takes an argument called "scanlinePad", documented as "the padding of each line, in bytes".

My understanding of the term "padding"  is that it means extra bytes added to the end of some data, often to make the length of the data item evenly divisible by some power of 2.

However, in this case, I believe the parameter means the length of each scan line (including padding) in bytes.

I propose that the parameter be renamed to "scanlineLength", "scanlineLengthBytes", or "fullScanlineLength", and the documentation (JavaDoc) clarified. 

As it stands the documentation is misleading.

I read the JavaDoc at:

http://help.eclipse.org/help33/index.jsp?topic=/org.eclipse.platform.doc.isv/reference/api/index
Comment 1 Grant Gayed CLA 2007-08-30 10:14:01 EDT
SSQ can you verify what this wording should be?
Comment 2 Eclipse Webmaster CLA 2019-09-06 16:13:39 EDT
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.