1 files changed, 37 insertions, 3 deletions

diff --git a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/motif/org/eclipse/swt/dnd/FileTransfer.java b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/motif/org/eclipse/swt/dnd/FileTransfer.java
index 8b70854312..0bda4b53f6 100755
--- a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/motif/org/eclipse/swt/dnd/FileTransfer.java
+++ b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/motif/org/eclipse/swt/dnd/FileTransfer.java
@@ -1,10 +1,13 @@
 package org.eclipse.swt.dnd;

 

 /*

- * Licensed Materials - Property of IBM,

- * (c) Copyright IBM Corp. 1998, 2000  All Rights Reserved

+ * (c) Copyright IBM Corp. 2000, 2001.

+ * All Rights Reserved

  */

- 

+

+/**
+ * The <code>FileTransfer</code> class is used to transfer files in a drag and drop operation.
+ */
 public class FileTransfer extends ByteArrayTransfer {

 	

 	private static FileTransfer _instance = new FileTransfer();

@@ -12,9 +15,33 @@ public class FileTransfer extends ByteArrayTransfer {
 	private static final int TYPEID = registerType(TYPENAME);

 

 private FileTransfer() {}

+/**
+ * Returns the singleton instance of the FileTransfer class.
+ *
+ * @return the singleton instance of the FileTransfer class
+ */
 public static FileTransfer getInstance () {

 	return _instance;

 }

+/**
+ * Converts a list of filenames to a platform specific representation. 
+ * <p>
+ * On a successful conversion, the transferData.result field will be set as follows:
+ * <ul>
+ * <li>Windows: OLE.S_OK
+ * <li>Motif: 0
+ * </ul>
+ * If this transfer agent is unable to perform the conversion,
+ * the transferData.result field will be set to a failure value as follows:
+ * <ul>
+ * <li>Windows: OLE.DV_E_TYMED
+ * <li>Motif: 1
+ * </ul></p>
+ *
+ * @param object a list of file names
+ * @param transferData an empty TransferData object; this object will be filled in on return
+ *        with the platform specific format of the data
+ */
 public void javaToNative(Object object, TransferData transferData) {

 

 	if (object == null || !(object instanceof String[])) return;

@@ -31,6 +58,13 @@ public void javaToNative(Object object, TransferData transferData) {
 	// pass byte array on to super to convert to native

 	super.javaToNative(nativeFormat.getBytes(), transferData);

 }

+/**
+ * Converts a platform specific representation of a list of file names to a Java array of String.
+ *
+ * @param transferData the platform specific representation of the data that has been transferred
+ * @return a Java array of String containing a list of file names if the conversion was successful;
+ *         otherwise null
+ */
 public Object nativeToJava(TransferData transferData) {

 

 	byte[] data = (byte[])super.nativeToJava(transferData);