diff options
9 files changed, 90 insertions, 91 deletions
diff --git a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/win32/org/eclipse/swt/dnd/ByteArrayTransfer.java b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/win32/org/eclipse/swt/dnd/ByteArrayTransfer.java index 9cad59cc9d..a446dab7e1 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/win32/org/eclipse/swt/dnd/ByteArrayTransfer.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/win32/org/eclipse/swt/dnd/ByteArrayTransfer.java @@ -16,8 +16,7 @@ import org.eclipse.swt.internal.win32.*; /** * The class <code>ByteArrayTransfer</code> provides a platform specific * mechanism for converting a java <code>byte[]</code> to a platform - * specific representation of the byte array and vice versa. See - * <code>Transfer</code> for additional information. + * specific representation of the byte array and vice versa. * * <p><code>ByteArrayTransfer</code> is never used directly but is sub-classed * by transfer agents that convert between data in a java format such as a @@ -117,7 +116,7 @@ import org.eclipse.swt.internal.win32.*; * } * </code></pre> * - * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> + * @see Transfer */ public abstract class ByteArrayTransfer extends Transfer { @@ -151,14 +150,13 @@ public boolean isSupportedType(TransferData transferData){ /** * This implementation of <code>javaToNative</code> converts a java - * <code>byte[]</code> to a platform specific representation. For additional - * information see <code>Transfer#javaToNative</code>. - * - * @see Transfer#javaToNative + * <code>byte[]</code> to a platform specific representation. * * @param object a java <code>byte[]</code> containing the data to be converted - * @param transferData an empty <code>TransferData</code> object; this - * object will be filled in on return with the platform specific format of the data + * @param transferData an empty <code>TransferData</code> object that will + * be filled in on return with the platform specific format of the data + * + * @see Transfer#nativeToJava */ protected void javaToNative (Object object, TransferData transferData) { if (!checkByteArray(object) || !isSupportedType(transferData)) { @@ -180,14 +178,12 @@ protected void javaToNative (Object object, TransferData transferData) { /** * This implementation of <code>nativeToJava</code> converts a platform specific * representation of a byte array to a java <code>byte[]</code>. - * For additional information see <code>Transfer#nativeToJava</code>. * - * @see Transfer#nativeToJava + * @param transferData the platform specific representation of the data to be converted + * @return a java <code>byte[]</code> containing the converted data if the conversion was + * successful; otherwise null * - * @param transferData the platform specific representation of the data to be - * been converted - * @return a java <code>byte[]</code> containing the converted data if the - * conversion was successful; otherwise null + * @see Transfer#javaToNative */ protected Object nativeToJava(TransferData transferData) { if (!isSupportedType(transferData) || transferData.pIDataObject == 0) return null; diff --git a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/win32/org/eclipse/swt/dnd/FileTransfer.java b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/win32/org/eclipse/swt/dnd/FileTransfer.java index 6018e5c681..70dac53ecf 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/win32/org/eclipse/swt/dnd/FileTransfer.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/win32/org/eclipse/swt/dnd/FileTransfer.java @@ -19,7 +19,6 @@ import org.eclipse.swt.internal.win32.*; * platform specific representation of the data and vice versa. * Each <code>String</code> in the array contains the absolute path for a single * file or directory. - * See <code>Transfer</code> for additional information. * * <p>An example of a java <code>String[]</code> containing a list of files is shown * below:</p> @@ -32,7 +31,7 @@ import org.eclipse.swt.internal.win32.*; * fileData[1] = file2.getAbsolutePath(); * </code></pre> * - * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> + * @see Transfer */ public class FileTransfer extends ByteArrayTransfer { @@ -56,13 +55,13 @@ public static FileTransfer getInstance () { * This implementation of <code>javaToNative</code> converts a list of file names * represented by a java <code>String[]</code> to a platform specific representation. * Each <code>String</code> in the array contains the absolute path for a single - * file or directory. For additional information see - * <code>Transfer#javaToNative</code>. + * file or directory. + * + * @param object a java <code>String[]</code> containing the file names to be converted + * @param transferData an empty <code>TransferData</code> object that will + * be filled in on return with the platform specific format of the data * - * @param object a java <code>String[]</code> containing the file names to be - * converted - * @param transferData an empty <code>TransferData</code> object; this - * object will be filled in on return with the platform specific format of the data + * @see Transfer#nativeToJava */ public void javaToNative(Object object, TransferData transferData) { if (!checkFile(object) || !isSupportedType(transferData)) { @@ -97,12 +96,12 @@ public void javaToNative(Object object, TransferData transferData) { * This implementation of <code>nativeToJava</code> converts a platform specific * representation of a list of file names to a java <code>String[]</code>. * Each String in the array contains the absolute path for a single file or directory. - * For additional information see <code>Transfer#nativeToJava</code>. * - * @param transferData the platform specific representation of the data to be - * been converted - * @return a java <code>String[]</code> containing a list of file names if the - * conversion was successful; otherwise null + * @param transferData the platform specific representation of the data to be converted + * @return a java <code>String[]</code> containing a list of file names if the conversion + * was successful; otherwise null + * + * @see Transfer#javaToNative */ public Object nativeToJava(TransferData transferData) { if (!isSupportedType(transferData) || transferData.pIDataObject == 0) return null; diff --git a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/win32/org/eclipse/swt/dnd/HTMLTransfer.java b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/win32/org/eclipse/swt/dnd/HTMLTransfer.java index 18df6e56f8..5563e193b1 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/win32/org/eclipse/swt/dnd/HTMLTransfer.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/win32/org/eclipse/swt/dnd/HTMLTransfer.java @@ -16,8 +16,7 @@ import org.eclipse.swt.internal.win32.*; /** * The class <code>HTMLTransfer</code> provides a platform specific mechanism * for converting text in HTML format represented as a java <code>String</code> - * to a platform specific representation of the data and vice versa. See - * <code>Transfer</code> for additional information. + * to a platform specific representation of the data and vice versa. * * <p>An example of a java <code>String</code> containing HTML text is shown * below:</p> @@ -26,7 +25,7 @@ import org.eclipse.swt.internal.win32.*; * String htmlData = "<p>This is a paragraph of text.</p>"; * </code></pre> * - * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> + * @see Transfer */ public class HTMLTransfer extends ByteArrayTransfer { @@ -54,11 +53,12 @@ public static HTMLTransfer getInstance () { /** * This implementation of <code>javaToNative</code> converts HTML-formatted text * represented by a java <code>String</code> to a platform specific representation. - * For additional information see <code>Transfer#javaToNative</code>. * * @param object a java <code>String</code> containing HTML text - * @param transferData an empty <code>TransferData</code> object; this - * object will be filled in on return with the platform specific format of the data + * @param transferData an empty <code>TransferData</code> object that will + * be filled in on return with the platform specific format of the data + * + * @see Transfer#nativeToJava */ public void javaToNative (Object object, TransferData transferData){ if (!checkHTML(object) || !isSupportedType(transferData)) { @@ -120,12 +120,12 @@ public void javaToNative (Object object, TransferData transferData){ /** * This implementation of <code>nativeToJava</code> converts a platform specific * representation of HTML text to a java <code>String</code>. - * For additional information see <code>Transfer#nativeToJava</code>. * - * @param transferData the platform specific representation of the data to be - * been converted - * @return a java <code>String</code> containing HTML text if the - * conversion was successful; otherwise null + * @param transferData the platform specific representation of the data to be converted + * @return a java <code>String</code> containing HTML text if the conversion was successful; + * otherwise null + * + * @see Transfer#javaToNative */ public Object nativeToJava(TransferData transferData){ if (!isSupportedType(transferData) || transferData.pIDataObject == 0) return null; diff --git a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/win32/org/eclipse/swt/dnd/ImageTransfer.java b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/win32/org/eclipse/swt/dnd/ImageTransfer.java index f482360f5a..bb9665d279 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/win32/org/eclipse/swt/dnd/ImageTransfer.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/win32/org/eclipse/swt/dnd/ImageTransfer.java @@ -17,19 +17,17 @@ import org.eclipse.swt.graphics.*; /** * The class <code>ImageTransfer</code> provides a platform specific mechanism - * for converting a Image represented as a java <code>ImageData</code> to a + * for converting an Image represented as a java <code>ImageData</code> to a * platform specific representation of the data and vice versa. - * See <code>Transfer</code> for additional information. * - * <p>An example of a java <code>ImageData</code> is shown - * below:</p> + * <p>An example of a java <code>ImageData</code> is shown below:</p> * * <code><pre> - * Image image = new Image("C:\temp\img1.gif"); + * Image image = new Image(display, "C:\temp\img1.gif"); * ImageData imgData = image.getImageData(); * </code></pre> * - * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> + * @see Transfer * * @since 3.4 */ @@ -53,12 +51,12 @@ public static ImageTransfer getInstance () { /** * This implementation of <code>javaToNative</code> converts an ImageData object represented * by java <code>ImageData</code> to a platform specific representation. - * For additional information see <code>Transfer#javaToNative</code>. * - * @param object a java <code>ImageData</code> containing the ImageData to be - * converted - * @param transferData an empty <code>TransferData</code> object; this - * object will be filled in on return with the platform specific format of the data + * @param object a java <code>ImageData</code> containing the ImageData to be converted + * @param transferData an empty <code>TransferData</code> object that will + * be filled in on return with the platform specific format of the data + * + * @see Transfer#nativeToJava */ public void javaToNative(Object object, TransferData transferData) { if (!checkImage(object) || !isSupportedType(transferData)) { @@ -126,12 +124,12 @@ public void javaToNative(Object object, TransferData transferData) { /** * This implementation of <code>nativeToJava</code> converts a platform specific * representation of an image to java <code>ImageData</code>. - * For additional information see <code>Transfer#nativeToJava</code>. * - * @param transferData the platform specific representation of the data to be - * been converted - * @return a java <code>ImageData</code> of the image if - * conversion was successful; otherwise null + * @param transferData the platform specific representation of the data to be converted + * @return a java <code>ImageData</code> of the image if the conversion was successful; + * otherwise null + * + * @see Transfer#javaToNative */ public Object nativeToJava(TransferData transferData) { if (!isSupportedType(transferData) || transferData.pIDataObject == 0) return null; diff --git a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/win32/org/eclipse/swt/dnd/RTFTransfer.java b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/win32/org/eclipse/swt/dnd/RTFTransfer.java index 223368aef4..4ba244f012 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/win32/org/eclipse/swt/dnd/RTFTransfer.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/win32/org/eclipse/swt/dnd/RTFTransfer.java @@ -16,8 +16,7 @@ import org.eclipse.swt.internal.win32.*; /** * The class <code>RTFTransfer</code> provides a platform specific mechanism * for converting text in RTF format represented as a java <code>String</code> - * to a platform specific representation of the data and vice versa. See - * <code>Transfer</code> for additional information. + * to a platform specific representation of the data and vice versa. * * <p>An example of a java <code>String</code> containing RTF text is shown * below:</p> @@ -26,7 +25,7 @@ import org.eclipse.swt.internal.win32.*; * String rtfData = "{\\rtf1{\\colortbl;\\red255\\green0\\blue0;}\\uc1\\b\\i Hello World}"; * </code></pre> * - * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> + * @see Transfer */ public class RTFTransfer extends ByteArrayTransfer { @@ -48,11 +47,12 @@ public static RTFTransfer getInstance () { /** * This implementation of <code>javaToNative</code> converts RTF-formatted text * represented by a java <code>String</code> to a platform specific representation. - * For additional information see <code>Transfer#javaToNative</code>. * * @param object a java <code>String</code> containing RTF text - * @param transferData an empty <code>TransferData</code> object; this - * object will be filled in on return with the platform specific format of the data + * @param transferData an empty <code>TransferData</code> object that will + * be filled in on return with the platform specific format of the data + * + * @see Transfer#nativeToJava */ public void javaToNative (Object object, TransferData transferData){ if (!checkRTF(object) || !isSupportedType(transferData)) { @@ -83,12 +83,12 @@ public void javaToNative (Object object, TransferData transferData){ /** * This implementation of <code>nativeToJava</code> converts a platform specific * representation of RTF text to a java <code>String</code>. - * For additional information see <code>Transfer#nativeToJava</code>. * - * @param transferData the platform specific representation of the data to be - * been converted - * @return a java <code>String</code> containing RTF text if the - * conversion was successful; otherwise null + * @param transferData the platform specific representation of the data to be converted + * @return a java <code>String</code> containing RTF text if the conversion was successful; + * otherwise null + * + * @see Transfer#javaToNative */ public Object nativeToJava(TransferData transferData){ if (!isSupportedType(transferData) || transferData.pIDataObject == 0) return null; diff --git a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/win32/org/eclipse/swt/dnd/TextTransfer.java b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/win32/org/eclipse/swt/dnd/TextTransfer.java index 4522985628..cc2c55b616 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/win32/org/eclipse/swt/dnd/TextTransfer.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/win32/org/eclipse/swt/dnd/TextTransfer.java @@ -26,7 +26,6 @@ import org.eclipse.swt.internal.win32.*; * </code></pre> * * @see Transfer - * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> */ public class TextTransfer extends ByteArrayTransfer { @@ -52,10 +51,10 @@ public static TextTransfer getInstance () { * represented by a java <code>String</code> to a platform specific representation. * * @param object a java <code>String</code> containing text - * @param transferData an empty <code>TransferData</code> object; this object - * will be filled in on return with the platform specific format of the data + * @param transferData an empty <code>TransferData</code> object that will + * be filled in on return with the platform specific format of the data * - * @see Transfer#javaToNative + * @see Transfer#nativeToJava */ public void javaToNative (Object object, TransferData transferData){ if (!checkText(object) || !isSupportedType(transferData)) { @@ -109,7 +108,7 @@ public void javaToNative (Object object, TransferData transferData){ * @param transferData the platform specific representation of the data to be converted * @return a java <code>String</code> containing text if the conversion was successful; otherwise null * - * @see Transfer#nativeToJava + * @see Transfer#javaToNative */ public Object nativeToJava(TransferData transferData){ if (!isSupportedType(transferData) || transferData.pIDataObject == 0) return null; diff --git a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/win32/org/eclipse/swt/dnd/URLTransfer.java b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/win32/org/eclipse/swt/dnd/URLTransfer.java index 9bf964be31..d023efc328 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/win32/org/eclipse/swt/dnd/URLTransfer.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/win32/org/eclipse/swt/dnd/URLTransfer.java @@ -16,18 +16,16 @@ import org.eclipse.swt.internal.win32.*; /** * The class <code>URLTransfer</code> provides a platform specific mechanism * for converting text in URL format represented as a java <code>String</code> - * to a platform specific representation of the data and vice versa. See - * <code>Transfer</code> for additional information. The string + * to a platform specific representation of the data and vice versa. The string * must contain a fully specified url. * - * <p>An example of a java <code>String</code> containing a URL is shown - * below:</p> + * <p>An example of a java <code>String</code> containing a URL is shown below:</p> * * <code><pre> * String url = "http://www.eclipse.org"; * </code></pre> * - * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a> + * @see Transfer */ public class URLTransfer extends ByteArrayTransfer { @@ -49,11 +47,12 @@ public static URLTransfer getInstance () { /** * This implementation of <code>javaToNative</code> converts a URL * represented by a java <code>String</code> to a platform specific representation. - * For additional information see <code>Transfer#javaToNative</code>. * * @param object a java <code>String</code> containing a URL - * @param transferData an empty <code>TransferData</code> object; this - * object will be filled in on return with the platform specific format of the data + * @param transferData an empty <code>TransferData</code> object that will + * be filled in on return with the platform specific format of the data + * + * @see Transfer#nativeToJava */ public void javaToNative (Object object, TransferData transferData){ if (!checkURL(object) || !isSupportedType(transferData)) { @@ -83,14 +82,14 @@ public void javaToNative (Object object, TransferData transferData){ } /** - * This implementation of <code>nativeToJava</code> converts a platform specific - * representation of a URL to a java <code>String</code>. - * For additional information see <code>Transfer#nativeToJava</code>. + * This implementation of <code>nativeToJava</code> converts a platform + * specific representation of a URL to a java <code>String</code>. + * + * @param transferData the platform specific representation of the data to be converted + * @return a java <code>String</code> containing a URL if the conversion was successful; + * otherwise null * - * @param transferData the platform specific representation of the data to be - * converted - * @return a java <code>String</code> containing a URL if the - * conversion was successful; otherwise null + * @see Transfer#javaToNative */ public Object nativeToJava(TransferData transferData){ if (!isSupportedType(transferData) || transferData.pIDataObject == 0) return null; diff --git a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/ProgressBar.java b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/ProgressBar.java index f96f2e7da1..b4261a7cb3 100755 --- a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/ProgressBar.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/ProgressBar.java @@ -191,8 +191,12 @@ public int getSelection () { } /** - * Returns the state of the receiver. The value will be one of - * <code>NORMAL</code>, <code>ERROR</code> or <code>PAUSED</code>. + * Returns the state of the receiver. The value will be one of: + * <ul> + * <li>{@link SWT#NORMAL}</li> + * <li>{@link SWT#ERROR}</li> + * <li>{@link SWT#PAUSED}</li> + * </ul> * * @return the state * @@ -328,8 +332,12 @@ public void setSelection (int value) { } /** - * Sets the state of the receiver. The state is be one of - * <code>NORMAL</code>, <code>ERROR</code> or <code>PAUSED</code>. + * Sets the state of the receiver. The state must be one of these values: + * <ul> + * <li>{@link SWT#NORMAL}</li> + * <li>{@link SWT#ERROR}</li> + * <li>{@link SWT#PAUSED}</li> + * </ul> * * @param state the new state * 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 2260a208bd..1e96f7d599 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 @@ -43,7 +43,7 @@ public class TreeItem extends Item { * within the packages provided by SWT. It is not available on all * platforms and should never be accessed from application code. * </p> - */ + */ public int /*long*/ handle; Tree parent; String [] strings; |