diff options
author | Carolyn MacLeod <carolyn> | 2005-06-21 21:11:34 +0000 |
---|---|---|
committer | Carolyn MacLeod <carolyn> | 2005-06-21 21:11:34 +0000 |
commit | abee13b3bcd9260c2ca7824ce15632593cf59218 (patch) | |
tree | 0cd89ec866884b10ee3ac39b8f0af86c2f91abc6 | |
parent | fb124d2ba5ec40e564190dc83884d6e6c7990509 (diff) | |
download | eclipse.platform.swt-abee13b3bcd9260c2ca7824ce15632593cf59218.tar.gz eclipse.platform.swt-abee13b3bcd9260c2ca7824ce15632593cf59218.tar.xz eclipse.platform.swt-abee13b3bcd9260c2ca7824ce15632593cf59218.zip |
doc: bug 84906
12 files changed, 41 insertions, 40 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 cbe6c0d276..b27e8c0527 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 @@ -27,7 +27,7 @@ import org.eclipse.swt.internal.win32.*; * <code>byte[]</code>, you should sub-class <code>Transfer</code> directly * and do your own mapping to a platform data type.</p> * - * <p>The following snippet shows a sublcass of ByteArrayTransfer that transfers + * <p>The following snippet shows a subclass of ByteArrayTransfer that transfers * data defined by the class <code>MyType</code>.</p> * * <pre><code> @@ -38,7 +38,7 @@ import org.eclipse.swt.internal.win32.*; * } * </code></pre> * - * <code><pre> + * <pre><code> * public class MyTypeTransfer extends ByteArrayTransfer { * * private static final String MYTYPENAME = "my_type_name"; @@ -115,6 +115,7 @@ import org.eclipse.swt.internal.win32.*; * return new int[] {MYTYPEID}; * } * } + * </code></pre> */ public abstract class ByteArrayTransfer extends Transfer { 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 413faedeba..030fa1fc4f 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 @@ -16,8 +16,7 @@ import org.eclipse.swt.internal.win32.*; /** * The class <code>TextTransfer</code> provides a platform specific mechanism * for converting plain text 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 plain text is shown * below:</p> @@ -25,6 +24,8 @@ import org.eclipse.swt.internal.win32.*; * <code><pre> * String textData = "Hello World"; * </code></pre> + * + * @see Transfer */ public class TextTransfer extends ByteArrayTransfer { @@ -48,11 +49,12 @@ public static TextTransfer getInstance () { /** * This implementation of <code>javaToNative</code> converts plain 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 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; this object + * will be filled in on return with the platform specific format of the data + * + * @see Transfer#javaToNative */ public void javaToNative (Object object, TransferData transferData){ if (!checkText(object) || !isSupportedType(transferData)) { @@ -102,12 +104,11 @@ public void javaToNative (Object object, TransferData transferData){ /** * This implementation of <code>nativeToJava</code> converts a platform specific * representation of plain 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 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 text if the conversion was successful; otherwise null + * + * @see Transfer#nativeToJava */ public Object nativeToJava(TransferData transferData){ if (!isSupportedType(transferData) || transferData.pIDataObject == 0) return null; 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 537638108b..687d944880 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 @@ -303,7 +303,7 @@ public ImageData getImageData () { * the program has no descriptive name, this string may * be the executable name, path or empty. * - * @return an the name of the program + * @return the name of the program */ public String getName () { return name; 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 1d48ca883c..843019b7c3 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 @@ -432,7 +432,7 @@ public int getItemCount () { /** * Returns the height of the area which would be used to - * display <em>one</em> of the items in the tree. + * display <em>one</em> of the items in the list. * * @return the height of one item * @@ -1381,7 +1381,7 @@ public void setSelection (String [] items) { /** * Selects the item at the given zero-relative index in the receiver. * If the item at the index was already selected, it remains selected. - * The current selected is first cleared, then the new items are selected. + * The current selection is first cleared, then the new item is selected. * Indices that are out of range are ignored. * * @param index the index of the item to select 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 f8dbfb2e7c..4b294d3a3b 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 @@ -668,7 +668,7 @@ public MenuItem getDefaultItem () { /** * Returns <code>true</code> if the receiver is enabled, and - * <code>false</code> otherwise. A disabled control is typically + * <code>false</code> otherwise. A disabled menu is typically * not selectable from the user interface and draws with an * inactive or "grayed" look. * @@ -995,7 +995,7 @@ public int indexOf (MenuItem item) { /** * Returns <code>true</code> if the receiver is enabled and all * of the receiver's ancestors are enabled, and <code>false</code> - * otherwise. A disabled control is typically not selectable from the + * otherwise. A disabled menu is typically not selectable from the * user interface and draws with an inactive or "grayed" look. * * @return the receiver's enabled state @@ -1167,7 +1167,7 @@ public void setDefaultItem (MenuItem item) { /** * Enables the receiver if the argument is <code>true</code>, - * and disables it otherwise. A disabled control is typically + * and disables it otherwise. A disabled menu is typically * not selectable from the user interface and draws with an * inactive or "grayed" look. * 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 455be8cc7d..fdaa5e54e9 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 @@ -180,7 +180,7 @@ public void addHelpListener (HelpListener listener) { /** * Adds the listener to the collection of listeners who will - * be notified when the control is selected, by sending + * be notified when the menu item is selected, by sending * it one of the messages defined in the <code>SelectionListener</code> * interface. * <p> @@ -344,7 +344,7 @@ public int getAccelerator () { /** * Returns <code>true</code> if the receiver is enabled, and - * <code>false</code> otherwise. A disabled control is typically + * <code>false</code> otherwise. A disabled menu item is typically * not selectable from the user interface and draws with an * inactive or "grayed" look. * @@ -452,7 +452,7 @@ public boolean getSelection () { /** * Returns <code>true</code> if the receiver is enabled and all * of the receiver's ancestors are enabled, and <code>false</code> - * otherwise. A disabled control is typically not selectable from the + * otherwise. A disabled menu item is typically not selectable from the * user interface and draws with an inactive or "grayed" look. * * @return the receiver's enabled state @@ -599,7 +599,7 @@ public void setAccelerator (int accelerator) { /** * Enables the receiver if the argument is <code>true</code>, - * and disables it otherwise. A disabled control is typically + * and disables it otherwise. A disabled menu item is typically * not selectable from the user interface and draws with an * inactive or "grayed" look. * 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 d7f1a7ddb7..d9e9687934 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 @@ -172,7 +172,7 @@ public int getMinimum () { } /** - * Returns the single <em>selection</em> that is the receiver's position. + * Returns the single 'selection' that is the receiver's position. * * @return the selection * @@ -270,7 +270,7 @@ public void setMinimum (int value) { } /** - * Sets the single <em>selection</em> that is the receiver's + * Sets the single 'selection' that is the receiver's * position to the argument which must be greater than or equal * to zero. * 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 00a16a8287..ee1442ed54 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 @@ -237,7 +237,7 @@ public int getPageIncrement () { } /** - * Returns the <em>selection</em>, which is the receiver's position. + * Returns the 'selection', which is the receiver's position. * * @return the selection * @@ -380,9 +380,8 @@ public void setPageIncrement (int pageIncrement) { } /** - * Sets the <em>selection</em>, which is the receiver's - * value, to the argument which must be greater than or equal - * to zero. + * Sets the 'selection', which is the receiver's value, + * to the argument which must be greater than or equal to zero. * * @param value the new selection (must be zero or greater) * 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 493f49eaed..95127c39c3 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 @@ -21,7 +21,7 @@ import org.eclipse.swt.events.*; * objects that represent a range of positive, numeric values. * <p> * At any given moment, a given scroll bar will have a - * single <em>selection</em> that is considered to be its + * single 'selection' that is considered to be its * value, which is constrained to be within the range of * values the scroll bar represents (that is, between its * <em>minimum</em> and <em>maximum</em> values). @@ -314,7 +314,7 @@ public int getPageIncrement () { } /** - * Returns the receiver's parent, which must be scrollable. + * Returns the receiver's parent, which must be a Scrollable. * * @return the receiver's parent * @@ -329,7 +329,7 @@ public Scrollable getParent () { } /** - * Returns the single <em>selection</em> that is the receiver's value. + * Returns the single 'selection' that is the receiver's value. * * @return the selection * 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 d97882bf0a..5a56a74be6 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 @@ -1067,7 +1067,7 @@ public void setImeInputMode (int mode) { } /** - * Sets the receiver's minimum size to the point specified by the arguments. + * Sets the receiver's minimum size to the size specified by the arguments. * If the new minimum size is larger than the current size of the receiver, * the receiver is resized to the new minimum size. * @@ -1108,7 +1108,7 @@ public void setMinimumSize (int width, int height) { } /** - * Sets the receiver's minimum size to the point specified by the argument. + * Sets the receiver's minimum size to the size specified by the argument. * If the new minimum size is larger than the current size of the receiver, * the receiver is resized to the new minimum size. * 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 06985520db..42ac6884b3 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 @@ -21,7 +21,7 @@ import org.eclipse.swt.events.*; * objects that represent a range of positive, numeric values. * <p> * At any given moment, a given slider will have a - * single <em>selection</em> that is considered to be its + * single 'selection' that is considered to be its * value, which is constrained to be within the range of * values the slider represents (that is, between its * <em>minimum</em> and <em>maximum</em> values). @@ -302,7 +302,7 @@ public int getPageIncrement () { } /** - * Returns the <em>selection</em>, which is the receiver's value. + * Returns the 'selection', which is the receiver's value. * * @return the selection * @@ -499,7 +499,7 @@ boolean SetScrollInfo (int hwnd, int flags, SCROLLINFO info, boolean fRedraw) { } /** - * Sets the <em>selection</em>, which is the receiver's + * Sets the 'selection', which is the receiver's * value, to the argument which must be greater than or equal * to zero. * 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 81d4d41915..ed359bec4a 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 @@ -63,7 +63,7 @@ public class TreeItem extends Item { * Style bits are also inherited from superclasses. * </p> * - * @param parent a composite control which will be the parent of the new instance (cannot be null) + * @param parent a tree control which will be the parent of the new instance (cannot be null) * @param style the style of control to construct * * @exception IllegalArgumentException <ul> @@ -99,7 +99,7 @@ public TreeItem (Tree parent, int style) { * Style bits are also inherited from superclasses. * </p> * - * @param parent a composite control which will be the parent of the new instance (cannot be null) + * @param parent a tree control which will be the parent of the new instance (cannot be null) * @param style the style of control to construct * @param index the index to store the receiver in its parent * @@ -147,7 +147,7 @@ public TreeItem (Tree parent, int style, int index) { * Style bits are also inherited from superclasses. * </p> * - * @param parentItem a composite control which will be the parent of the new instance (cannot be null) + * @param parentItem a tree control which will be the parent of the new instance (cannot be null) * @param style the style of control to construct * * @exception IllegalArgumentException <ul> @@ -184,7 +184,7 @@ public TreeItem (TreeItem parentItem, int style) { * Style bits are also inherited from superclasses. * </p> * - * @param parentItem a composite control which will be the parent of the new instance (cannot be null) + * @param parentItem a tree control which will be the parent of the new instance (cannot be null) * @param style the style of control to construct * @param index the index to store the receiver in its parent * |