diff options
author | Carolyn MacLeod <carolyn> | 2004-05-10 21:28:19 +0000 |
---|---|---|
committer | Carolyn MacLeod <carolyn> | 2004-05-10 21:28:19 +0000 |
commit | 78d893bd9353449f7f1929c8d1986e012ec88df0 (patch) | |
tree | 7fbfa6d2be5fc7cb7da14d92969a97b9291ea18b | |
parent | 844ac41a45f316893450db56222e677b1c5e39de (diff) | |
download | eclipse.platform.swt-78d893bd9353449f7f1929c8d1986e012ec88df0.tar.gz eclipse.platform.swt-78d893bd9353449f7f1929c8d1986e012ec88df0.tar.xz eclipse.platform.swt-78d893bd9353449f7f1929c8d1986e012ec88df0.zip |
javadoc typos
34 files changed, 85 insertions, 52 deletions
diff --git a/bundles/org.eclipse.swt/Eclipse SWT Accessibility/win32/org/eclipse/swt/accessibility/Accessible.java b/bundles/org.eclipse.swt/Eclipse SWT Accessibility/win32/org/eclipse/swt/accessibility/Accessible.java index 05575d6914..2d58a70392 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT Accessibility/win32/org/eclipse/swt/accessibility/Accessible.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Accessibility/win32/org/eclipse/swt/accessibility/Accessible.java @@ -392,8 +392,8 @@ public class Accessible { * <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver's control</li> * </ul> * - * @see ACC#NOTIFY_TEXT_INSERT - * @see ACC#NOTIFY_TEXT_DELETE + * @see ACC#TEXT_INSERT + * @see ACC#TEXT_DELETE * * @since 3.0 */ diff --git a/bundles/org.eclipse.swt/Eclipse SWT Printing/win32/org/eclipse/swt/printing/PrintDialog.java b/bundles/org.eclipse.swt/Eclipse SWT Printing/win32/org/eclipse/swt/printing/PrintDialog.java index 40d1a663ad..208e428669 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT Printing/win32/org/eclipse/swt/printing/PrintDialog.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Printing/win32/org/eclipse/swt/printing/PrintDialog.java @@ -116,7 +116,7 @@ public int getScope() { * <dd>Print the current selection</dd> * </dl> * - * @param int the scope setting when the dialog is opened + * @param scope the scope setting when the dialog is opened */ public void setScope(int scope) { this.scope = scope; @@ -144,7 +144,7 @@ public int getStartPage() { * <code>PAGE_RANGE</code>. * </p> * - * @param int the startPage setting when the dialog is opened + * @param startPage the startPage setting when the dialog is opened */ public void setStartPage(int startPage) { this.startPage = startPage; @@ -172,7 +172,7 @@ public int getEndPage() { * <code>PAGE_RANGE</code>. * </p> * - * @param int the end page setting when the dialog is opened + * @param endPage the end page setting when the dialog is opened */ public void setEndPage(int endPage) { this.endPage = endPage; @@ -192,7 +192,7 @@ public boolean getPrintToFile() { * Sets the 'Print to file' setting that the user will see * when the dialog is opened. * - * @param boolean the 'Print to file' setting when the dialog is opened + * @param printToFile the 'Print to file' setting when the dialog is opened */ public void setPrintToFile(boolean printToFile) { this.printToFile = printToFile; diff --git a/bundles/org.eclipse.swt/Eclipse SWT Printing/win32/org/eclipse/swt/printing/Printer.java b/bundles/org.eclipse.swt/Eclipse SWT Printing/win32/org/eclipse/swt/printing/Printer.java index a590376090..8645711b64 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT Printing/win32/org/eclipse/swt/printing/Printer.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Printing/win32/org/eclipse/swt/printing/Printer.java @@ -163,7 +163,7 @@ static DeviceData checkNull (PrinterData data) { * <li>ERROR_NO_HANDLES - if there are no valid printers * </ul> * - * @see #dispose + * @see Device#dispose */ public Printer() { this(null); @@ -185,7 +185,7 @@ public Printer() { * <li>ERROR_NO_HANDLES - if there are no valid printers * </ul> * - * @see #dispose + * @see Device#dispose */ public Printer(PrinterData data) { super(checkNull(data)); @@ -253,7 +253,7 @@ public int internal_new_GC(GCData data) { * application code. * </p> * - * @param handle the platform specific GC handle + * @param hDC the platform specific GC handle * @param data the platform specific GC data */ public void internal_dispose_GC(int hDC, GCData data) { @@ -270,6 +270,7 @@ public void internal_dispose_GC(int hDC, GCData data) { * will result in undefined behavior. * </p> * + * @param jobName the name of the print job to start * @return true if the job started successfully and false otherwise. * * @exception SWTException <ul> @@ -455,6 +456,10 @@ public Rectangle getClientArea() { * is usually used by passing in the client area (the 'printable * area') of the printer. It can also be useful to pass in 0, 0, 0, 0. * + * @param x the desired x coordinate of the client area + * @param y the desired y coordinate of the client area + * @param width the desired width of the client area + * @param height the desired height of the client area * @return the required bounds to produce the given client area * * @exception SWTException <ul> diff --git a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/graphics/Color.java b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/graphics/Color.java index 2755b9bd27..34870fb8bf 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/graphics/Color.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/graphics/Color.java @@ -91,7 +91,7 @@ public Color (Device device, int red, int green, int blue) { * </p> * * @param device the device on which to allocate the color - * @param RGB the RGB values of the desired color + * @param rgb the RGB values of the desired color * * @exception IllegalArgumentException <ul> * <li>ERROR_NULL_ARGUMENT - if device is null and there is no current device</li> @@ -199,6 +199,8 @@ public int getRed () { /** * Returns an <code>RGB</code> representing the receiver. * + * @return the RGB for the color + * * @exception SWTException <ul> * <li>ERROR_GRAPHIC_DISPOSED - if the receiver has been disposed</li> * </ul> @@ -320,6 +322,7 @@ public String toString () { * * @param device the device on which to allocate the color * @param handle the handle for the color + * @return a new color object containing the specified device and handle */ public static Color win32_new(Device device, int handle) { if (device == null) device = Device.getDevice(); diff --git a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/graphics/Cursor.java b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/graphics/Cursor.java index 4f2d56b548..68f62cb750 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/graphics/Cursor.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/graphics/Cursor.java @@ -308,7 +308,7 @@ public Cursor(Device device, ImageData source, ImageData mask, int hotspotX, int * </p> * * @param device the device on which to allocate the cursor - * @param image the color data for the cursor + * @param source the image data for the cursor * @param hotspotX the x coordinate of the cursor's hotspot * @param hotspotY the y coordinate of the cursor's hotspot * @@ -459,6 +459,7 @@ public String toString () { * * @param device the device on which to allocate the color * @param handle the handle for the cursor + * @return a new cursor object containing the specified device and handle */ public static Cursor win32_new(Device device, int handle) { if (device == null) device = Device.getDevice(); diff --git a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/graphics/Device.java b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/graphics/Device.java index f620074eeb..81f74af8de 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/graphics/Device.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/graphics/Device.java @@ -659,7 +659,7 @@ public abstract int internal_new_GC (GCData data); * application code. * </p> * - * @param handle the platform specific GC handle + * @param hDC the platform specific GC handle * @param data the platform specific GC data */ public abstract void internal_dispose_GC (int hDC, GCData data); diff --git a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/graphics/Font.java b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/graphics/Font.java index b379720711..7f05f26556 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/graphics/Font.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/graphics/Font.java @@ -246,6 +246,7 @@ public String toString () { * * @param device the device on which to allocate the color * @param handle the handle for the font + * @return a new font object containing the specified device and handle */ public static Font win32_new(Device device, int handle) { if (device == null) device = Device.getDevice(); diff --git a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/graphics/FontData.java b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/graphics/FontData.java index f4062b5918..1b6ff6538a 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/graphics/FontData.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/graphics/FontData.java @@ -623,6 +623,8 @@ public String toString() { * </p> * * @param data the <code>LOGFONT</code> for the font data + * @param height the height of the font data + * @return a new font data object containing the specified <code>LOGFONT</code> and height */ public static FontData win32_new(LOGFONT data, int height) { return new FontData(data, height); diff --git a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/graphics/FontMetrics.java b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/graphics/FontMetrics.java index 8f1e1aa7df..fb372550a5 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/graphics/FontMetrics.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/graphics/FontMetrics.java @@ -164,7 +164,8 @@ public int hashCode() { * application code. * </p> * - * @param tm the <code>TEXTMETRIC</code> containing information about a font + * @param handle the <code>TEXTMETRIC</code> containing information about a font + * @return a new font metrics object containing the specified <code>TEXTMETRIC</code> */ public static FontMetrics win32_new(TEXTMETRIC handle) { FontMetrics fontMetrics = new FontMetrics(); diff --git a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/graphics/GC.java b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/graphics/GC.java index ae6e558ae3..7ceb5dc0a3 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/graphics/GC.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/graphics/GC.java @@ -135,6 +135,7 @@ static int checkStyle(int style) { * Copies a rectangular area of the receiver at the specified * position into the image, which must be of type <code>SWT.BITMAP</code>. * + * @param image the image to copy into * @param x the x coordinate in the receiver of the area to be copied * @param y the y coordinate in the receiver of the area to be copied * @@ -1740,7 +1741,7 @@ public void fillRectangle (int x, int y, int width, int height) { * Fills the interior of the specified rectangle, using the receiver's * background color. * - * @param rectangle the rectangle to be filled + * @param rect the rectangle to be filled * * @exception IllegalArgumentException <ul> * <li>ERROR_NULL_ARGUMENT - if the rectangle is null</li> @@ -2259,7 +2260,7 @@ public void setClipping (Rectangle rect) { * by drawing operations to the region specified * by the argument. * - * @param rect the clipping region. + * @param region the clipping region. * * @exception SWTException <ul> * <li>ERROR_GRAPHIC_DISPOSED - if the receiver has been disposed</li> diff --git a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/graphics/Image.java b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/graphics/Image.java index fd636e8100..8b1edb60ad 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/graphics/Image.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/graphics/Image.java @@ -1747,7 +1747,7 @@ public int internal_new_GC (GCData data) { * application code. * </p> * - * @param handle the platform specific GC handle + * @param hDC the platform specific GC handle * @param data the platform specific GC data */ public void internal_dispose_GC (int hDC, GCData data) { @@ -1860,7 +1860,7 @@ public String toString () { * @param device the device on which to allocate the color * @param type the type of the image (<code>SWT.BITMAP</code> or <code>SWT.ICON</code>) * @param handle the OS handle for the image - * @param hPalette the OS handle for the palette, or 0 + * @return a new image object containing the specified device, type and handle */ public static Image win32_new(Device device, int type, int handle) { if (device == null) device = Device.getDevice(); diff --git a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/graphics/Region.java b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/graphics/Region.java index af682e3756..935ea8c2f8 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/graphics/Region.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/graphics/Region.java @@ -395,7 +395,7 @@ public boolean isEmpty () { * Subtracts the given polygon from the collection of rectangles * the receiver maintains to describe its area. * - * param pointArray points that describe the polygon to merge with the receiver + * @param pointArray points that describe the polygon to merge with the receiver * * @exception IllegalArgumentException <ul> * <li>ERROR_NULL_ARGUMENT - if the argument is null</li> @@ -475,7 +475,9 @@ public void subtract (Region region) { * application code. * </p> * + * @param device the device on which to allocate the region * @param handle the handle for the region + * @return a new region object containing the specified device and handle */ public static Region win32_new(Device device, int handle) { return new Region(device, handle); diff --git a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Caret.java b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Caret.java index 017b207205..6f66e92f03 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Caret.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Caret.java @@ -411,7 +411,7 @@ public void setFont (Font font) { * to the image specified by the argument, or to the default * which is a filled rectangle if the argument is null * - * @param font the new font (or null) + * @param image the new image (or null) * * @exception IllegalArgumentException <ul> * <li>ERROR_INVALID_ARGUMENT - if the image has been disposed</li> @@ -503,7 +503,6 @@ public void setSize (int width, int height) { * Sets the receiver's size to the point specified by the argument. * * @param size the new extent for the receiver - * @param height the new height for the receiver * * @exception IllegalArgumentException <ul> * <li>ERROR_NULL_ARGUMENT - if the point is null</li> diff --git a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Combo.java b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Combo.java index 33d6206c86..d151990eb1 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Combo.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Combo.java @@ -757,6 +757,7 @@ public int indexOf (String string) { * returns -1. * * @param string the search item + * @param start the zero-relative index at which to begin the search * @return the index of the item * * @exception IllegalArgumentException <ul> @@ -1285,7 +1286,7 @@ public void setOrientation (int orientation) { * start of the selection and whose y coordinate is the end * of the selection. * - * @param a point representing the new selection start and end + * @param selection a point representing the new selection start and end * * @exception IllegalArgumentException <ul> * <li>ERROR_NULL_ARGUMENT - if the point is null</li> @@ -1313,7 +1314,7 @@ public void setSelection (Point selection) { * display incorrectly. * </p> * - * @param text the new text + * @param string the new text * * @exception IllegalArgumentException <ul> * <li>ERROR_NULL_ARGUMENT - if the string is null</li> diff --git a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Control.java b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Control.java index a3023289a7..fcf240f5ea 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Control.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Control.java @@ -1068,7 +1068,7 @@ public int internal_new_GC (GCData data) { * application code. * </p> * - * @param handle the platform specific GC handle + * @param hDC the platform specific GC handle * @param data the platform specific GC data */ public void internal_dispose_GC (int hDC, GCData data) { @@ -1265,7 +1265,7 @@ boolean mnemonicMatch (char key) { * the top of the drawing order will not be covered by other * controls even if they occupy intersecting areas. * - * @param the sibling control (or null) + * @param control the sibling control (or null) * * @exception IllegalArgumentException <ul> * <li>ERROR_INVALID_ARGUMENT - if the control has been disposed</li> @@ -1308,7 +1308,7 @@ public void moveAbove (Control control) { * the bottom of the drawing order will be covered by all other * controls which occupy intersecting areas. * - * @param the sibling control (or null) + * @param control the sibling control (or null) * * @exception IllegalArgumentException <ul> * <li>ERROR_INVALID_ARGUMENT - if the control has been disposed</li> @@ -1366,6 +1366,8 @@ public void pack () { * manager caches can be retained. * </p> * + * @param changed whether or not the receiver's contents have changed + * * @exception SWTException <ul> * <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> * <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> @@ -2293,7 +2295,6 @@ public void setSize (int width, int height) { * </p> * * @param size the new size for the receiver - * @param height the new height for the receiver * * @exception IllegalArgumentException <ul> * <li>ERROR_NULL_ARGUMENT - if the point is null</li> diff --git a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/CoolItem.java b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/CoolItem.java index 72c87a1d92..f8544d0dc3 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/CoolItem.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/CoolItem.java @@ -414,7 +414,6 @@ public void setPreferredSize (int width, int height) { * Sets the receiver's ideal size to the point specified by the argument. * * @param size the new ideal size for the receiver - * @param height the new ideal height for the receiver * * @exception IllegalArgumentException <ul> * <li>ERROR_NULL_ARGUMENT - if the point is null</li> @@ -525,7 +524,6 @@ public void setSize (int width, int height) { * </p> * * @param size the new size for the receiver - * @param height the new height for the receiver * * @exception IllegalArgumentException <ul> * <li>ERROR_NULL_ARGUMENT - if the point is null</li> diff --git a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Decorations.java b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Decorations.java index fb6df51011..5fcf96d999 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Decorations.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Decorations.java @@ -770,7 +770,7 @@ void setBounds (int x, int y, int width, int height, int flags) { * disposed, the receiver's default button will be set to * null. * - * @param the new default button + * @param button the new default button * * @exception IllegalArgumentException <ul> * <li>ERROR_INVALID_ARGUMENT - if the button has been disposed</li> @@ -961,7 +961,7 @@ public void setImages (Image [] images) { * always. This should be avoided if possible. * </p> * - * @param the new maximized state + * @param maximized the new maximized state * * @exception SWTException <ul> * <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> @@ -1096,7 +1096,7 @@ public void setMenuBar (Menu menu) { * always. This should be avoided if possible. * </p> * - * @param the new maximized state + * @param minimized the new maximized state * * @exception SWTException <ul> * <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> diff --git a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/DirectoryDialog.java b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/DirectoryDialog.java index fd172a87e8..50de0902db 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/DirectoryDialog.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/DirectoryDialog.java @@ -65,6 +65,7 @@ public DirectoryDialog (Shell parent) { * </p> * * @param parent a shell which will be the parent of the new instance + * @param style the style of dialog to construct * * @exception IllegalArgumentException <ul> * <li>ERROR_NULL_ARGUMENT - if the parent is null</li> diff --git a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Display.java b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Display.java index 1914002e62..1c2e43722d 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Display.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Display.java @@ -89,7 +89,7 @@ import org.eclipse.swt.graphics.*; * @see #wake * @see #readAndDispatch * @see #sleep - * @see #dispose + * @see Device#dispose */ public class Display extends Device { @@ -573,7 +573,7 @@ int controlKey (int key) { * <li>ERROR_DEVICE_DISPOSED - if the receiver has been disposed</li> * </ul> * - * @see #dispose + * @see Device#dispose * * @since 2.0 */ @@ -1823,7 +1823,7 @@ protected void init () { * application code. * </p> * - * @param handle the platform specific GC handle + * @param hDC the platform specific GC handle * @param data the platform specific GC data */ public void internal_dispose_GC (int hDC, GCData data) { @@ -1902,8 +1902,8 @@ public Point map (Control from, Control to, Point point) { * * @param from the source <code>Control</code> or <code>null</code> * @param to the destination <code>Control</code> or <code>null</code> - * @param int x coordinates to be mapped - * @param int y coordinates to be mapped + * @param x coordinates to be mapped + * @param y coordinates to be mapped * @return point with mapped coordinates * * @exception IllegalArgumentException <ul> @@ -1993,10 +1993,10 @@ public Rectangle map (Control from, Control to, Rectangle rectangle) { * * @param from the source <code>Control</code> or <code>null</code> * @param to the destination <code>Control</code> or <code>null</code> - * @param int x coordinates to be mapped - * @param int y coordinates to be mapped - * @param int width coordinates to be mapped - * @param int heigth coordinates to be mapped + * @param x coordinates to be mapped + * @param y coordinates to be mapped + * @param width coordinates to be mapped + * @param height coordinates to be mapped * @return rectangle with mapped coordinates * * @exception IllegalArgumentException <ul> diff --git a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/FileDialog.java b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/FileDialog.java index 803fef3fee..de42b9f4b7 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/FileDialog.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/FileDialog.java @@ -67,6 +67,7 @@ public FileDialog (Shell parent) { * </p> * * @param parent a shell which will be the parent of the new instance + * @param style the style of dialog to construct * * @exception IllegalArgumentException <ul> * <li>ERROR_NULL_ARGUMENT - if the parent is null</li> diff --git a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/FontDialog.java b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/FontDialog.java index 8af80fd7f3..e3ff818060 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/FontDialog.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/FontDialog.java @@ -65,6 +65,7 @@ public FontDialog (Shell parent) { * </p> * * @param parent a shell which will be the parent of the new instance + * @param style the style of dialog to construct * * @exception IllegalArgumentException <ul> * <li>ERROR_NULL_ARGUMENT - if the parent is null</li> diff --git a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/List.java b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/List.java index c8c662460e..49cc69c4da 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/List.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/List.java @@ -659,6 +659,7 @@ public int indexOf (String string) { * returns -1. * * @param string the search item + * @param start the zero-relative index at which to start the search * @return the index of the item * * @exception IllegalArgumentException <ul> diff --git a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Menu.java b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Menu.java index 0a4d6a2bb6..e436b86e77 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Menu.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Menu.java @@ -122,7 +122,7 @@ public Menu (Decorations parent, int style) { * for the instance so that the instance will be a drop-down * menu on the given parent's parent. * - * @param parent a menu which will be the parent of the new instance (cannot be null) + * @param parentMenu a menu which will be the parent of the new instance (cannot be null) * * @exception IllegalArgumentException <ul> * <li>ERROR_NULL_ARGUMENT - if the parent is null</li> @@ -146,7 +146,7 @@ public Menu (Menu parentMenu) { * for the instance so that the instance will be a drop-down * menu on the given parent's parent menu. * - * @param parent a menu item which will be the parent of the new instance (cannot be null) + * @param parentItem a menu item which will be the parent of the new instance (cannot be null) * * @exception IllegalArgumentException <ul> * <li>ERROR_NULL_ARGUMENT - if the parent is null</li> diff --git a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/MenuItem.java b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/MenuItem.java index 3b457acf48..5c512ccabc 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/MenuItem.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/MenuItem.java @@ -615,7 +615,7 @@ public void setEnabled (boolean enabled) { * Note: This feature is not available on all window systems (for example, Window NT), * in which case, calling this method will silently do nothing. * - * @param menu the image to display + * @param image the image to display * * @exception SWTException <ul> * <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> diff --git a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/MessageBox.java b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/MessageBox.java index bdd07fd290..dd23667542 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/MessageBox.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/MessageBox.java @@ -67,6 +67,7 @@ public MessageBox (Shell parent) { * Style bits are also inherited from superclasses. * * @param parent a shell which will be the parent of the new instance + * @param style the style of dialog to construct * * @exception IllegalArgumentException <ul> * <li>ERROR_NULL_ARGUMENT - if the parent is null</li> diff --git a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Scale.java b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Scale.java index 9434072f70..0cd5711e47 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Scale.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Scale.java @@ -297,7 +297,7 @@ void setBackgroundPixel (int pixel) { * are pressed to the argument, which must be at least * one. * - * @param value the new increment (must be greater than zero) + * @param increment the new increment (must be greater than zero) * * @exception SWTException <ul> * <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> @@ -361,7 +361,7 @@ public void setMinimum (int value) { * are selected to the argument, which must be at least * one. * - * @return the page increment (must be greater than zero) + * @param pageIncrement the page increment (must be greater than zero) * * @exception SWTException <ul> * <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> diff --git a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/ScrollBar.java b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/ScrollBar.java index 555f87a6d7..c9000ae081 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/ScrollBar.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/ScrollBar.java @@ -700,7 +700,7 @@ public void setMinimum (int value) { * are selected to the argument, which must be at least * one. * - * @return the page increment (must be greater than zero) + * @param value the page increment (must be greater than zero) * * @exception SWTException <ul> * <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> @@ -718,7 +718,7 @@ public void setPageIncrement (int value) { * value to the argument which must be greater than or equal * to zero. * - * @param value the new selection (must be zero or greater) + * @param selection the new selection (must be zero or greater) * * @exception SWTException <ul> * <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> diff --git a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Scrollable.java b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Scrollable.java index 513f0515ad..b613e9c8cd 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Scrollable.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Scrollable.java @@ -91,6 +91,10 @@ int callWindowProc (int msg, int wParam, int lParam) { * receiver's parent). * </p> * + * @param x the desired x coordinate of the client area + * @param y the desired y coordinate of the client area + * @param width the desired width of the client area + * @param height the desired height of the client area * @return the required bounds to produce the given client area * * @exception SWTException <ul> diff --git a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Shell.java b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Shell.java index 941cb22137..2c9868f562 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Shell.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Shell.java @@ -335,6 +335,7 @@ public Shell (Shell parent, int style) { * * @param display the display for the shell * @param handle the handle for the shell + * @return a new shell object containing the specified display and handle */ public static Shell win32_new (Display display, int handle) { return new Shell (display, null, SWT.NO_TRIM, handle); diff --git a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Slider.java b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Slider.java index 1ff7bc6bf2..40148602b6 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Slider.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Slider.java @@ -505,7 +505,7 @@ public void setMinimum (int value) { * are selected to the argument, which must be at least * one. * - * @return the page increment (must be greater than zero) + * @param value the page increment (must be greater than zero) * * @exception SWTException <ul> * <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> diff --git a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Table.java b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Table.java index eee6dd6ff3..4c19c204d2 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Table.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Table.java @@ -1098,6 +1098,8 @@ int getForegroundPixel () { /** * Returns the width in pixels of a grid line. * + * @return the width of a grid line in pixels + * * @exception SWTException <ul> * <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> * <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> @@ -2184,7 +2186,7 @@ public void setHeaderVisible (boolean show) { /** * Sets the number of items contained in the receiver. * - * @param show the new visibility state + * @param count the number of items * * @exception SWTException <ul> * <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> diff --git a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Text.java b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Text.java index 47920d82be..170bb2ec8e 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Text.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Text.java @@ -616,6 +616,8 @@ String getClipboardText () { * default action of the text widget when the user * double clicks. * </p> + * + * @return whether or not double click is enabled * * @exception SWTException <ul> * <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> @@ -634,6 +636,8 @@ public boolean getDoubleClickEnabled () { * displayed when the user enters text or the * text is changed by the programmer. * </p> + * + * @return the echo character * * @exception SWTException <ul> * <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> @@ -650,6 +654,8 @@ public char getEchoChar () { /** * Gets the editable state. * + * @return whether or not the reciever is editable + * * @exception SWTException <ul> * <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> * <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> @@ -1545,7 +1551,7 @@ void setTabStops (int tabs) { * SINGLE and the argument contains multiple lines of text, the result of this * operation is undefined and may vary from platform to platform. * - * @param text the new text + * @param string the new text * * @exception IllegalArgumentException <ul> * <li>ERROR_NULL_ARGUMENT - if the string is null</li> diff --git a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/TrayItem.java b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/TrayItem.java index caaeb0612f..b5d7f97b48 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/TrayItem.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/TrayItem.java @@ -266,7 +266,7 @@ public void setImage (Image image) { * Sets the receiver's tool tip text to the argument, which * may be null indicating that no tool tip text should be shown. * - * @param string the new tool tip text (or null) + * @param value the new tool tip text (or null) * * @exception SWTException <ul> * <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> diff --git a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/TreeItem.java b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/TreeItem.java index 821018faf4..dbe16568bc 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/TreeItem.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/TreeItem.java @@ -679,7 +679,7 @@ public void setForeground (Color color) { * Sets the grayed state of the receiver. * <p> * - * @param checked the new grayed state + * @param grayed the new grayed state * * @exception SWTException <ul> * <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> |