diff options
author | Carolyn MacLeod <carolyn> | 2005-06-22 22:17:47 +0000 |
---|---|---|
committer | Carolyn MacLeod <carolyn> | 2005-06-22 22:17:47 +0000 |
commit | 9d15374a15440713922dbd7d2e04fcc36ec25dcc (patch) | |
tree | eeb213e7d75b7a03f3fd813c3f60e14b2174bc40 | |
parent | 7f8f02497e4b7e8e36d28129ec6fe63374a1da99 (diff) | |
download | eclipse.platform.swt-9d15374a15440713922dbd7d2e04fcc36ec25dcc.tar.gz eclipse.platform.swt-9d15374a15440713922dbd7d2e04fcc36ec25dcc.tar.xz eclipse.platform.swt-9d15374a15440713922dbd7d2e04fcc36ec25dcc.zip |
Ran javadoc checkerBEFORE_JAVADOC_BASH_FOR_31RC4
28 files changed, 144 insertions, 91 deletions
diff --git a/bundles/org.eclipse.swt/Eclipse SWT Browser/win32/org/eclipse/swt/browser/Browser.java b/bundles/org.eclipse.swt/Eclipse SWT Browser/win32/org/eclipse/swt/browser/Browser.java index 9c5ef74966..180d31c1a8 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT Browser/win32/org/eclipse/swt/browser/Browser.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Browser/win32/org/eclipse/swt/browser/Browser.java @@ -140,7 +140,7 @@ public class Browser extends Composite { * <li>ERROR_NO_HANDLES if a handle could not be obtained for browser creation</li> * </ul> * - * @see #getStyle + * @see Widget#getStyle * * @since 3.0 */ diff --git a/bundles/org.eclipse.swt/Eclipse SWT Custom Widgets/common/org/eclipse/swt/custom/CLabel.java b/bundles/org.eclipse.swt/Eclipse SWT Custom Widgets/common/org/eclipse/swt/custom/CLabel.java index 5a00678f56..cd3b2b5635 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT Custom Widgets/common/org/eclipse/swt/custom/CLabel.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Custom Widgets/common/org/eclipse/swt/custom/CLabel.java @@ -752,6 +752,11 @@ public void setToolTipText (String string) { * the given width. The default implementation replaces characters in the * center of the original string with an ellipsis ("..."). * Override if you need a different strategy. + * + * @param gc the gc to use for text measurement + * @param t the text to shorten + * @param width the width to shorten the text to, in pixels + * @return the shortened text */ protected String shortenText(GC gc, String t, int width) { if (t == null) return null; diff --git a/bundles/org.eclipse.swt/Eclipse SWT Custom Widgets/common/org/eclipse/swt/custom/CTabFolderListener.java b/bundles/org.eclipse.swt/Eclipse SWT Custom Widgets/common/org/eclipse/swt/custom/CTabFolderListener.java index 329027726f..ec4d7e8f10 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT Custom Widgets/common/org/eclipse/swt/custom/CTabFolderListener.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Custom Widgets/common/org/eclipse/swt/custom/CTabFolderListener.java @@ -12,15 +12,30 @@ package org.eclipse.swt.custom; import org.eclipse.swt.internal.*; +/** + * Classes which implement this interface provide a method + * that deals with events generated in the CTabFolder. + * <p> + * After creating an instance of a class that implements + * this interface it can be added to a CTabFolder using the + * <code>addCTabFolderListener</code> method and removed using + * the <code>removeCTabFolderListener</code> method. When a + * tab item is closed, the itemClosed method will be invoked. + * </p> + * + * @see CTabFolderEvent + */ public interface CTabFolderListener extends SWTEventListener { /** * Sent when the user clicks on the close button of an item in the CTabFolder. The item being closed is specified - * in the event.item field. Setting the event.doit field to false will stop the CTabItem from closing. - * When the CTabItem is closed, it is disposed. The contents of the CTabItem (see CTabItem#setControl) will be + * in the event.item field. Setting the event.doit field to false will stop the CTabItem from closing. + * When the CTabItem is closed, it is disposed. The contents of the CTabItem (see CTabItem.setControl) will be * made not visible when the CTabItem is closed. * * @param event an event indicating the item being closed + * + * @see CTabItem#setControl */ public void itemClosed(CTabFolderEvent event); } diff --git a/bundles/org.eclipse.swt/Eclipse SWT Custom Widgets/common/org/eclipse/swt/custom/DefaultContent.java b/bundles/org.eclipse.swt/Eclipse SWT Custom Widgets/common/org/eclipse/swt/custom/DefaultContent.java index 6e63b3c77a..a683e209e6 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT Custom Widgets/common/org/eclipse/swt/custom/DefaultContent.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Custom Widgets/common/org/eclipse/swt/custom/DefaultContent.java @@ -174,6 +174,7 @@ boolean isDelimiter(char ch) { * @param start start offset of text to replace * @param replaceLength start offset of text to replace * @param newText start offset of text to replace + * @return a boolean specifying whether or not the replace operation is valid */ protected boolean isValidReplace(int start, int replaceLength, String newText){ if (replaceLength == 0) { @@ -258,7 +259,7 @@ int[][] indexLines(int offset, int length, int numLines){ * <p> * * @param position the position at which to insert the text - * @param length the text to insert + * @param text the text to insert */ void insert(int position, String text) { if (text.length() == 0) return; @@ -326,8 +327,8 @@ void insert(int position, String text) { * <p> * * @param position the position at which a change is occurring - * @param sizeHint the size of the change - * @param line the line where the gap should be put + * @param size the size of the change + * @param newGapLine the line where the gap should be put */ void moveAndResizeGap(int position, int size, int newGapLine) { char[] content = null; diff --git a/bundles/org.eclipse.swt/Eclipse SWT Custom Widgets/common/org/eclipse/swt/custom/DefaultLineStyler.java b/bundles/org.eclipse.swt/Eclipse SWT Custom Widgets/common/org/eclipse/swt/custom/DefaultLineStyler.java index d5e8fce7ba..c4c0e9048a 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT Custom Widgets/common/org/eclipse/swt/custom/DefaultLineStyler.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Custom Widgets/common/org/eclipse/swt/custom/DefaultLineStyler.java @@ -253,9 +253,8 @@ StyleRange [] getStyleRanges() { * Handles the get line background color callback. * <p> * - * @param event.lineOffset line number (input) - * @param event.lineText line text (input) - * @param event.background line background color (output) + * @param event the lineOffset line number (input), lineText line text (input), + * and background line background color (output) */ public void lineGetBackground(LineBackgroundEvent event) { int lineIndex = content.getLineAtOffset(event.lineOffset); @@ -265,9 +264,8 @@ public void lineGetBackground(LineBackgroundEvent event) { * Handles the get line style information callback. * <p> * - * @param event.lineOffset line number (input) - * @param event.lineText line text (input) - * @param event.styles array of StyleRanges, need to be in order (output) + * @param event the lineOffset line number (input), lineText line text (input), + * and styles array of StyleRanges, need to be in order (output) */ public void lineGetStyle(LineStyleEvent event) { int lineStart = event.lineOffset; @@ -324,7 +322,7 @@ int searchForStyle(int start, int end) { * <p> * * @param startLine index of the first line to color - * @param lineCount number of lines to color starting at startLine + * @param count number of lines to color starting at startLine * @param background the background color for the lines */ void setLineBackground(int startLine, int count, Color background) { @@ -436,9 +434,10 @@ void setStyleRange(StyleRange newStyle) { } /** * Replace the styles for the given range. - * <p> * - * @param styles the new styles, must be in order and non-overlapping + * @param start the initial style range to replace + * @param length the number of ranges to replace + * @param ranges the new styles, must be in order and non-overlapping */ void replaceStyleRanges(int start, int length, StyleRange[] ranges) { clearStyle(new StyleRange(start, length, null, null)); diff --git a/bundles/org.eclipse.swt/Eclipse SWT Custom Widgets/common/org/eclipse/swt/custom/DisplayRenderer.java b/bundles/org.eclipse.swt/Eclipse SWT Custom Widgets/common/org/eclipse/swt/custom/DisplayRenderer.java index eaa1de498d..6ab5147e66 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT Custom Widgets/common/org/eclipse/swt/custom/DisplayRenderer.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Custom Widgets/common/org/eclipse/swt/custom/DisplayRenderer.java @@ -27,8 +27,6 @@ class DisplayRenderer extends StyledTextRenderer { * </p> * @param device Device to render on * @param regularFont Font to use for regular text - * @param isBidi true=bidi platform, false=no bidi platform - * @param leftMargin margin to the left of the text * @param parent <class>StyledText</class> widget to render * @param tabLength length in characters of a tab character */ @@ -64,7 +62,7 @@ protected void disposeGC(GC gc) { * @param line the line to draw * @param lineOffset offset of the first character in the line. * Relative to the start of the document. - * @param styles line styles + * @param paintX x location to draw at * @param paintY y location to draw at * @param gc GC to draw on */ @@ -112,7 +110,7 @@ protected void drawLineBreakSelection(String line, int lineOffset, int paintX, i * * @param lineOffset offset of the first character in the line. * 0 based from the beginning of the document. - * @param line text of the line to specify bidi segments for + * @param lineText text of the line to specify bidi segments for * @return text segments that should be treated as if they had a * different direction than the surrounding text. Only the start * index of a segment is specified, relative to the start of the @@ -151,7 +149,7 @@ protected StyledTextContent getContent() { * calling disposeGC. * </p> * @return the GC to use for rendering and measuring. - * @see disposeGC + * @see #disposeGC */ protected GC getGC() { return new GC(parent); diff --git a/bundles/org.eclipse.swt/Eclipse SWT Custom Widgets/common/org/eclipse/swt/custom/StyledText.java b/bundles/org.eclipse.swt/Eclipse SWT Custom Widgets/common/org/eclipse/swt/custom/StyledText.java index b42fdff87e..79a9f48153 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT Custom Widgets/common/org/eclipse/swt/custom/StyledText.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Custom Widgets/common/org/eclipse/swt/custom/StyledText.java @@ -883,7 +883,7 @@ public class StyledText extends Canvas { * widget document. Any text occurring before the start offset or after the * end offset specified during object creation is ignored. * @param styles styles to use for formatting. Must not be null. - * @param linebackground line background color to use for formatting. + * @param lineBackground line background color to use for formatting. * May be null. */ void writeStyledLine(String line, int lineOffset, StyleRange[] styles, Color lineBackground) { @@ -1022,6 +1022,7 @@ public class StyledText extends Canvas { } /** * Returns the number of characters to write. + * @return the integer number of characters to write */ public int getCharCount() { return endOffset - startOffset; @@ -1029,12 +1030,14 @@ public class StyledText extends Canvas { /** * Returns the offset where writing starts. 0 based from the start of * the widget text. Used to write partial lines. + * @return the integer offset where writing starts */ public int getStart() { return startOffset; } /** * Returns whether the writer is closed. + * @return a boolean specifying whether or not the writer is closed */ public boolean isClosed() { return isClosed; @@ -1042,7 +1045,6 @@ public class StyledText extends Canvas { /** * Returns the string. <code>close()</code> must be called before <code>toString()</code> * is guaranteed to return a valid string. - * <p> * * @return the string */ @@ -1214,7 +1216,8 @@ public class StyledText extends Canvas { * * @param parent the StyledText widget used to create a GC for * line measuring - * @param lineCount initial number of lines to allocate space for + * @param content a StyledTextContent containing the initial number + * of lines to allocate space for */ public ContentWidthCache(StyledText parent, StyledTextContent content) { this.parent = parent; @@ -1275,9 +1278,6 @@ public class StyledText extends Canvas { * @param line the line to measure * @param lineOffset start offset of the line to measure, relative * to the start of the document - * @param gc the GC to use for measuring the line - * @param currentFont the font currently set in gc. Cached for better - * performance. Null when running in a bidi locale. * @return the width of the given line */ int contentWidth(String line, int lineOffset) { @@ -1316,7 +1316,7 @@ public class StyledText extends Canvas { * Updates the line width array to reflect inserted or deleted lines. * <p> * - * @param start the starting line of the change that took place + * @param startLine the starting line of the change that took place * @param delta the number of lines in the change, > 0 indicates lines inserted, * < 0 indicates lines deleted */ @@ -2090,14 +2090,6 @@ void clearSelection(boolean sendEvent) { } } } -/** - * Computes the preferred size. - * - * @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> - * </ul> - */ public Point computeSize (int wHint, int hHint, boolean changed) { checkWidget(); int count, width, height; @@ -3358,9 +3350,6 @@ void draw(int x, int y, int width, int height, boolean clearBackground) { void endAutoScroll() { autoScrollDirection = SWT.NULL; } -/** - * @see org.eclipse.swt.widgets.Control#getBackground - */ public Color getBackground() { checkWidget(); if (background == null) { @@ -3557,9 +3546,6 @@ public boolean getEditable() { checkWidget(); return editable; } -/** - * @see org.eclipse.swt.widgets.Control#getForeground - */ public Color getForeground() { checkWidget(); if (foreground == null) { @@ -3670,9 +3656,10 @@ public int getCharCount() { * color has been specified for the line. Should not be called if a * LineBackgroundListener has been set since the listener maintains the * line background colors. - * <p> - * + * + * @param index the index of the line * @return the background color of the line at the given index. + * * @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> @@ -4224,7 +4211,7 @@ int [] getBidiSegments(int lineOffset, String line) { return segments; } /** - * @see getBidiSegments + * @see #getBidiSegments * Supports deprecated setBidiColoring API. Remove when API is removed. */ int [] getBidiSegmentsCompatibility(String line, int lineOffset) { @@ -4340,7 +4327,9 @@ public StyleRange [] getStyleRanges() { * Returns an empty array if a LineStyleListener has been set. * Should not be called if a LineStyleListener has been set since the * listener maintains the styles. - * <p> + * + * @param start the start offset of the style ranges to return + * @param length the number of style ranges to return * * @return the styles or an empty array if a LineStyleListener has * been set. The returned styles will reflect the given range. The first @@ -4535,9 +4524,9 @@ public String getTextRange(int start, int length) { return content.getTextRange(start, length); } /** - * Gets the text limit. The text limit specifies the amount of text that the user - * can type into the widget. - * <p> + * Returns the maximum number of characters that the receiver is capable of holding. + * + * @return the text limit * * @exception SWTException <ul> * <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> @@ -7618,7 +7607,7 @@ public void setText(String text) { } } /** - * Sets the text limit. + * Sets the text limit to the specified number of characters. * <p> * The text limit specifies the amount of text that * the user can type into the widget. diff --git a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/win32/org/eclipse/swt/dnd/DropTarget.java b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/win32/org/eclipse/swt/dnd/DropTarget.java index c92e05e1ef..a7bd90128f 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/win32/org/eclipse/swt/dnd/DropTarget.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/win32/org/eclipse/swt/dnd/DropTarget.java @@ -116,7 +116,7 @@ public class DropTarget extends Widget { * <p>NOTE: ERROR_CANNOT_INIT_DROP should be an SWTException, since it is a * recoverable error, but can not be changed due to backward compatability.</p> * - * @see DropTarget#dispose + * @see Widget#dispose * @see DropTarget#checkSubclass * @see DND#DROP_NONE * @see DND#DROP_COPY diff --git a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/win32/org/eclipse/swt/dnd/Transfer.java b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/win32/org/eclipse/swt/dnd/Transfer.java index cee1ec800c..528d19049a 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/win32/org/eclipse/swt/dnd/Transfer.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/win32/org/eclipse/swt/dnd/Transfer.java @@ -96,7 +96,7 @@ abstract protected String[] getTypeNames(); * @param transferData an empty TransferData object; this object will be * filled in on return with the platform specific representation of the data * - * @exception SWTException <ul> + * @exception org.eclipse.swt.SWTException <ul> * <li>ERROR_INVALID_DATA - if object does not contain data in a valid format or is <code>null</code></li> * </ul> */ diff --git a/bundles/org.eclipse.swt/Eclipse SWT OLE Win32/win32/org/eclipse/swt/ole/win32/Variant.java b/bundles/org.eclipse.swt/Eclipse SWT OLE Win32/win32/org/eclipse/swt/ole/win32/Variant.java index e812590025..f22d2fb13c 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT OLE Win32/win32/org/eclipse/swt/ole/win32/Variant.java +++ b/bundles/org.eclipse.swt/Eclipse SWT OLE Win32/win32/org/eclipse/swt/ole/win32/Variant.java @@ -23,11 +23,13 @@ import org.eclipse.swt.internal.win32.*; */ public final class Variant { - // A variant always takes up 16 bytes, no matter what you - // store in it. Objects, strings, and arrays are not physically - // stored in the Variant; in these cases, four bytes of the - // Variant are used to hold either an object reference, or a - // pointer to the string or array. The actual data are stored elsewhere. + /** + * A variant always takes up 16 bytes, no matter what you + * store in it. Objects, strings, and arrays are not physically + * stored in the Variant; in these cases, four bytes of the + * Variant are used to hold either an object reference, or a + * pointer to the string or array. The actual data are stored elsewhere. + */ public static final int sizeof = 16; private short type; // OLE.VT_* type 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 5e5854d9fe..7226826ab9 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 @@ -200,6 +200,7 @@ public Printer(PrinterData data) { * Creates the printer handle. * This method is called internally by the instance creation * mechanism of the <code>Device</code> class. + * @param deviceData the device data */ protected void create(DeviceData deviceData) { data = (PrinterData)deviceData; diff --git a/bundles/org.eclipse.swt/Eclipse SWT Program/win32/org/eclipse/swt/program/Program.java b/bundles/org.eclipse.swt/Eclipse SWT Program/win32/org/eclipse/swt/program/Program.java index 6ffd34c3ff..d01fdba2c9 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT Program/win32/org/eclipse/swt/program/Program.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Program/win32/org/eclipse/swt/program/Program.java @@ -314,7 +314,7 @@ public String getName () { * if they represent the <em>same</em> object using a class * specific comparison. * - * @param object the object to compare with this object + * @param other the object to compare with this object * @return <code>true</code> if the object is the same as this object and <code>false</code> otherwise * * @see #hashCode() diff --git a/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/SWTError.java b/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/SWTError.java index 04abc96bcb..27b57e0c66 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/SWTError.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/SWTError.java @@ -105,6 +105,7 @@ public SWTError (int code, String message) { * added to JDK1.4. It is necessary to override this method * in order for inherited printStackTrace() methods to work. * </p> + * @return the underlying throwable * * @since 3.1 */ diff --git a/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/SWTException.java b/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/SWTException.java index f6e4948c02..04e796066d 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/SWTException.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/SWTException.java @@ -96,6 +96,7 @@ public SWTException (int code, String message) { * added to JDK1.4. It is necessary to override this method * in order for inherited printStackTrace() methods to work. * </p> + * @return the underlying throwable * * @since 3.1 */ diff --git a/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/layout/FormData.java b/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/layout/FormData.java index 2aee5790a8..985165795e 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/layout/FormData.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/layout/FormData.java @@ -50,7 +50,7 @@ public final class FormData { * * The default value is SWT.DEFAULT. * - * @see Control#computeSize + * @see Control#computeSize(int, int, boolean) */ public int width = SWT.DEFAULT; /** @@ -60,7 +60,7 @@ public final class FormData { * * The default value is SWT.DEFAULT. * - * @see Control#computeSize + * @see Control#computeSize(int, int, boolean) */ public int height = SWT.DEFAULT; /** @@ -89,9 +89,21 @@ public final class FormData { FormAttachment cacheLeft, cacheRight, cacheTop, cacheBottom; boolean isVisited, needed; +/** + * Constructs a new instance of FormData using + * default values. + */ public FormData () { } +/** + * Constructs a new instance of FormData according to the parameters. + * A value of SWT.DEFAULT indicates that no minimum width or + * no minumum height is specified. + * + * @param width a minimum width for the control + * @param height a minimum height for the control + */ public FormData (int width, int height) { this.width = width; this.height = height; diff --git a/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/layout/GridData.java b/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/layout/GridData.java index 908132c85f..c88435c607 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/layout/GridData.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/layout/GridData.java @@ -82,7 +82,7 @@ public final class GridData { * * The default value is SWT.DEFAULT. * - * @see Control#computeSize + * @see Control#computeSize(int, int, boolean) */ public int widthHint = SWT.DEFAULT; @@ -93,7 +93,7 @@ public final class GridData { * * The default value is SWT.DEFAULT. * - * @see Control#computeSize + * @see Control#computeSize(int, int, boolean) */ public int heightHint = SWT.DEFAULT; @@ -203,7 +203,7 @@ public final class GridData { * The default value is 0. * * @since 3.1 - * @see Control#computeSize + * @see Control#computeSize(int, int, boolean) * @see GridData#widthHint */ public int minimumWidth = 0; @@ -218,7 +218,7 @@ public final class GridData { * The default value is 0. * * @since 3.1 - * @see Control#computeSize + * @see Control#computeSize(int, int, boolean) * @see GridData#heightHint */ public int minimumHeight = 0; diff --git a/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/layout/RowData.java b/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/layout/RowData.java index a0fc6de688..77072a9b8c 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/layout/RowData.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/layout/RowData.java @@ -67,14 +67,34 @@ public final class RowData { */ public boolean exclude = false; +/** + * Constructs a new instance of RowData using + * default values. + */ public RowData () { } +/** + * Constructs a new instance of RowData according to the parameters. + * A value of SWT.DEFAULT indicates that no minimum width or + * no minumum height is specified. + * + * @param width a minimum width for the control + * @param height a minimum height for the control + */ public RowData (int width, int height) { this.width = width; this.height = height; } +/** + * Constructs a new instance of RowData according to the parameter. + * A value of SWT.DEFAULT indicates that no minimum width or + * no minumum height is specified. + * + * @param point a point whose x coordinate specifies a minimum width for the control + * and y coordinate specifies a minimum height for the control + */ public RowData (Point point) { this (point.x, point.y); } diff --git a/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/widgets/Dialog.java b/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/widgets/Dialog.java index 72c431cc61..932f07bb91 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/widgets/Dialog.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/widgets/Dialog.java @@ -108,6 +108,7 @@ public Dialog (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> @@ -164,7 +165,7 @@ void checkParent (Shell parent) { * * @param code the descriptive error code * - * @see SWTError#error + * @see SWT#error(int) */ void error (int code) { SWT.error(code); diff --git a/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/widgets/Item.java b/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/widgets/Item.java index 9f11364aff..eed4a41085 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/widgets/Item.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/widgets/Item.java @@ -55,7 +55,7 @@ public abstract class Item extends Widget { * </ul> * * @see SWT - * @see #getStyle + * @see Widget#getStyle */ public Item (Widget parent, int style) { super (parent, style); @@ -89,7 +89,7 @@ public Item (Widget parent, int style) { * </ul> * * @see SWT - * @see #getStyle + * @see Widget#getStyle */ public Item (Widget parent, int style, int index) { this (parent, style); diff --git a/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/widgets/Layout.java b/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/widgets/Layout.java index 18b41b5f9e..b476c9bf5e 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/widgets/Layout.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/widgets/Layout.java @@ -52,7 +52,7 @@ public abstract class Layout { * @see Control#getBorderWidth * @see Control#getBounds * @see Control#getSize - * @see Control#pack + * @see Control#pack(boolean) * @see "computeTrim, getClientArea for controls that implement them" */ protected abstract Point computeSize (Composite composite, int wHint, int hHint, boolean flushCache); diff --git a/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/widgets/TypedListener.java b/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/widgets/TypedListener.java index 52e5de2058..186cbe9d33 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/widgets/TypedListener.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/widgets/TypedListener.java @@ -73,6 +73,7 @@ public SWTEventListener getEventListener () { * within the packages provided by SWT. It should never be * referenced from application code. * </p> + * @param e the event to handle */ public void handleEvent (Event e) { switch (e.type) { 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 6b03de318b..d1a76b5b89 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 @@ -587,7 +587,7 @@ public void drawArc (int x, int y, int width, int height, int startAngle, int ar * <li>ERROR_GRAPHIC_DISPOSED - if the receiver has been disposed</li> * </ul> * - * @see #drawRectangle + * @see #drawRectangle(int, int, int, int) */ public void drawFocus (int x, int y, int width, int height) { if (handle == 0) SWT.error(SWT.ERROR_GRAPHIC_DISPOSED); @@ -2139,7 +2139,7 @@ public void fillArc (int x, int y, int width, int height, int startAngle, int ar * <li>ERROR_GRAPHIC_DISPOSED - if the receiver has been disposed</li> * </ul> * - * @see #drawRectangle + * @see #drawRectangle(int, int, int, int) */ public void fillGradientRectangle(int x, int y, int width, int height, boolean vertical) { if (handle == 0) SWT.error(SWT.ERROR_GRAPHIC_DISPOSED); @@ -2357,7 +2357,7 @@ public void fillPolygon(int[] pointArray) { * <li>ERROR_GRAPHIC_DISPOSED - if the receiver has been disposed</li> * </ul> * - * @see #drawRectangle + * @see #drawRectangle(int, int, int, int) */ public void fillRectangle (int x, int y, int width, int height) { if (handle == 0) SWT.error(SWT.ERROR_GRAPHIC_DISPOSED); @@ -2390,7 +2390,7 @@ public void fillRectangle (int x, int y, int width, int height) { * <li>ERROR_GRAPHIC_DISPOSED - if the receiver has been disposed</li> * </ul> * - * @see #drawRectangle + * @see #drawRectangle(int, int, int, int) */ public void fillRectangle (Rectangle rect) { if (rect == null) SWT.error(SWT.ERROR_NULL_ARGUMENT); @@ -3355,7 +3355,7 @@ float measureSpace(int font, int format) { * @see #setAlpha * @see #setAntialias * @see #setBackgroundPattern - * @see #setClipping + * @see #setClipping(Path) * @see #setForegroundPattern * @see #setInterpolation * @see #setTextAntialias 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 61cd590f51..5e5ae6f17d 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 @@ -373,7 +373,7 @@ public void intersect (Region region) { * <li>ERROR_GRAPHIC_DISPOSED - if the receiver has been disposed</li> * </ul> * - * @see Rectangle#intersects + * @see Rectangle#intersects(Rectangle) */ public boolean intersects (int x, int y, int width, int height) { if (isDisposed()) SWT.error(SWT.ERROR_GRAPHIC_DISPOSED); @@ -397,7 +397,7 @@ public boolean intersects (int x, int y, int width, int height) { * <li>ERROR_GRAPHIC_DISPOSED - if the receiver has been disposed</li> * </ul> * - * @see Rectangle#intersects + * @see Rectangle#intersects(Rectangle) */ public boolean intersects (Rectangle rect) { if (isDisposed()) SWT.error(SWT.ERROR_GRAPHIC_DISPOSED); diff --git a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/graphics/Transform.java b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/graphics/Transform.java index de699c005e..84d3359799 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/graphics/Transform.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/graphics/Transform.java @@ -133,7 +133,7 @@ public void dispose() { * that the receiver represents, in the order {m11, m12, m21, m22, dx, dy}. * * @param elements array to hold the matrix values - * @return the transformation matrix represented by the receiver + * @return (in elements array) the transformation matrix represented by the receiver * * @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/widgets/Control.java b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Control.java index e4650627da..41e85a8b0f 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 @@ -385,7 +385,7 @@ void checkMirrored () { * @see #getBorderWidth * @see #getBounds * @see #getSize - * @see #pack + * @see #pack(boolean) * @see "computeTrim, getClientArea for controls that implement them" */ public Point computeSize (int wHint, int hHint) { @@ -423,7 +423,7 @@ public Point computeSize (int wHint, int hHint) { * @see #getBorderWidth * @see #getBounds * @see #getSize - * @see #pack + * @see #pack(boolean) * @see "computeTrim, getClientArea for controls that implement them" */ public Point computeSize (int wHint, int hHint, boolean changed) { @@ -1451,7 +1451,7 @@ GC new_GC (GCData data) { * <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> * </ul> * - * @see #computeSize + * @see #computeSize(int, int, boolean) */ public void pack () { checkWidget (); @@ -1477,7 +1477,7 @@ public void pack () { * <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> * </ul> * - * @see #computeSize + * @see #computeSize(int, int, boolean) */ public void pack (boolean changed) { checkWidget (); @@ -2316,7 +2316,7 @@ boolean setRadioSelection (boolean value) { * <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> * </ul> * - * @see #redraw + * @see #redraw(int, int, int, int, boolean) * @see #update */ public void setRedraw (boolean redraw) { @@ -2901,7 +2901,7 @@ void unsubclass () { * <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> * </ul> * - * @see #redraw + * @see #redraw(int, int, int, int, boolean) * @see PaintListener * @see SWT#Paint */ 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 f2dcd5f1b5..94ccfd193c 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 @@ -175,9 +175,9 @@ protected void checkSubclass () { * @see Layout * @see #getBounds * @see #getSize - * @see CoolBar#getBorderWidth - * @see CoolBar#computeTrim - * @see CoolBar#getClientArea + * @see Control#getBorderWidth + * @see Scrollable#computeTrim + * @see Scrollable#getClientArea */ public Point computeSize (int wHint, int hHint) { checkWidget (); 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 79c70291d9..d37ba02cae 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 @@ -379,6 +379,11 @@ public Display () { this (null); } +/** + * Constructs a new instance of this class using the parameter. + * + * @param data the device data + */ public Display (DeviceData data) { super (data); } @@ -824,7 +829,7 @@ static synchronized void deregister (Display display) { * <p> * This method is called after <code>release</code>. * </p> - * @see #dispose + * @see Device#dispose * @see #release */ protected void destroy () { @@ -902,7 +907,7 @@ int embeddedProc (int hwnd, int msg, int wParam, int lParam) { * * @param code the descriptive error code * - * @see SWTError#error + * @see SWT#error(int) */ void error (int code) { SWT.error (code); @@ -2745,7 +2750,7 @@ static synchronized void register (Display display) { * </p> * This method is called before <code>destroy</code>. * - * @see #dispose + * @see Device#dispose * @see #destroy */ protected void release () { diff --git a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Widget.java b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Widget.java index 129d3299bb..509c43e653 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Widget.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Widget.java @@ -389,7 +389,7 @@ public void dispose () { * * @param code the descriptive error code * - * @see SWTError#error + * @see SWT#error(int) */ void error (int code) { SWT.error(code); @@ -442,7 +442,7 @@ char [] fixMnemonic (String string) { * <li>ERROR_THREAD_INVALID_ACCESS - when called from the wrong thread</li> * </ul> * - * @see #setData + * @see #setData(Object) */ public Object getData () { checkWidget(); @@ -471,7 +471,7 @@ public Object getData () { * <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> * </ul> * - * @see #setData + * @see #setData(String, Object) */ public Object getData (String key) { checkWidget(); @@ -924,6 +924,8 @@ boolean sendMouseEvent (int type, int button, int count, int detail, boolean sen * <li>ERROR_WIDGET_DISPOSED - when the receiver has been disposed</li> * <li>ERROR_THREAD_INVALID_ACCESS - when called from the wrong thread</li> * </ul> + * + * @see #getData() */ public void setData (Object data) { checkWidget(); @@ -956,7 +958,7 @@ public void setData (Object data) { * <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> * </ul> * - * @see #getData + * @see #getData(String) */ public void setData (String key, Object value) { checkWidget(); |