summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGrant Gayed <ggayed>2008-06-02 19:56:11 +0000
committerGrant Gayed <ggayed>2008-06-02 19:56:11 +0000
commite763cdd07dff278e5e14204ef6d2f7fe0549abf7 (patch)
tree1cb1cbcd3f3ee47632b15c32a508a32e7308bbce
parenta648f6fdec8dc889f31b8ddbf5a2e9cb2d17dae7 (diff)
downloadeclipse.platform.swt-e763cdd07dff278e5e14204ef6d2f7fe0549abf7.tar.gz
eclipse.platform.swt-e763cdd07dff278e5e14204ef6d2f7fe0549abf7.tar.xz
eclipse.platform.swt-e763cdd07dff278e5e14204ef6d2f7fe0549abf7.zip
doc
-rwxr-xr-xbundles/org.eclipse.swt/Eclipse SWT Custom Widgets/common/org/eclipse/swt/custom/CTabFolder.java4
-rwxr-xr-xbundles/org.eclipse.swt/Eclipse SWT Custom Widgets/common/org/eclipse/swt/custom/DefaultContent.java3
-rwxr-xr-xbundles/org.eclipse.swt/Eclipse SWT Custom Widgets/common/org/eclipse/swt/custom/StyledText.java28
-rwxr-xr-xbundles/org.eclipse.swt/Eclipse SWT Custom Widgets/common/org/eclipse/swt/custom/StyledTextContent.java3
-rwxr-xr-xbundles/org.eclipse.swt/Eclipse SWT Drag and Drop/win32/org/eclipse/swt/dnd/DragSource.java2
-rwxr-xr-xbundles/org.eclipse.swt/Eclipse SWT Drag and Drop/win32/org/eclipse/swt/dnd/DropTarget.java2
-rwxr-xr-xbundles/org.eclipse.swt/Eclipse SWT OLE Win32/win32/org/eclipse/swt/ole/win32/OleControlSite.java12
-rwxr-xr-xbundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Display.java2
-rwxr-xr-xbundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Widget.java6
9 files changed, 36 insertions, 26 deletions
diff --git a/bundles/org.eclipse.swt/Eclipse SWT Custom Widgets/common/org/eclipse/swt/custom/CTabFolder.java b/bundles/org.eclipse.swt/Eclipse SWT Custom Widgets/common/org/eclipse/swt/custom/CTabFolder.java
index b238723eea..7e85cfd313 100755
--- a/bundles/org.eclipse.swt/Eclipse SWT Custom Widgets/common/org/eclipse/swt/custom/CTabFolder.java
+++ b/bundles/org.eclipse.swt/Eclipse SWT Custom Widgets/common/org/eclipse/swt/custom/CTabFolder.java
@@ -2334,7 +2334,7 @@ void redrawTabs() {
/**
* Removes the listener.
*
- * @param listener the listener
+ * @param listener the listener which should no longer be notified
*
* @exception IllegalArgumentException <ul>
* <li>ERROR_NULL_ARGUMENT - if the listener is null</li>
@@ -2373,7 +2373,7 @@ public void removeCTabFolder2Listener(CTabFolder2Listener listener) {
/**
* Removes the listener.
*
- * @param listener the listener
+ * @param listener the listener which should no longer be notified
*
* @exception IllegalArgumentException <ul>
* <li>ERROR_NULL_ARGUMENT - if the listener is null</li>
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 de146e54ce..b3b92606b7 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
@@ -720,7 +720,8 @@ public String getTextRange(int start, int length) {
* Removes the specified <code>TextChangeListener</code>.
* <p>
*
- * @param listener the listener
+ * @param listener the listener which should no longer be notified
+ *
* @exception IllegalArgumentException <ul>
* <li>ERROR_NULL_ARGUMENT when listener is null</li>
* </ul>
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 8fb4843158..fe5686a212 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
@@ -6141,7 +6141,8 @@ public void redrawRange(int start, int length, boolean clearBackground) {
/**
* Removes the specified bidirectional segment listener.
*
- * @param listener the listener
+ * @param listener the listener which should no longer be notified
+ *
* @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>
@@ -6149,6 +6150,7 @@ public void redrawRange(int start, int length, boolean clearBackground) {
* @exception IllegalArgumentException <ul>
* <li>ERROR_NULL_ARGUMENT when listener is null</li>
* </ul>
+ *
* @since 2.0
*/
public void removeBidiSegmentListener(BidiSegmentListener listener) {
@@ -6159,7 +6161,8 @@ public void removeBidiSegmentListener(BidiSegmentListener listener) {
/**
* Removes the specified extended modify listener.
*
- * @param extendedModifyListener the listener
+ * @param extendedModifyListener the listener which should no longer be notified
+ *
* @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>
@@ -6176,7 +6179,8 @@ public void removeExtendedModifyListener(ExtendedModifyListener extendedModifyLi
/**
* Removes the specified line background listener.
*
- * @param listener the listener
+ * @param listener the listener which should no longer be notified
+ *
* @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>
@@ -6193,7 +6197,8 @@ public void removeLineBackgroundListener(LineBackgroundListener listener) {
/**
* Removes the specified line style listener.
*
- * @param listener the listener
+ * @param listener the listener which should no longer be notified
+ *
* @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>
@@ -6210,7 +6215,8 @@ public void removeLineStyleListener(LineStyleListener listener) {
/**
* Removes the specified modify listener.
*
- * @param modifyListener the listener
+ * @param modifyListener the listener which should no longer be notified
+ *
* @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>
@@ -6227,7 +6233,8 @@ public void removeModifyListener(ModifyListener modifyListener) {
/**
* Removes the specified listener.
*
- * @param listener the listener
+ * @param listener the listener which should no longer be notified
+ *
* @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>
@@ -6267,7 +6274,8 @@ public void removeSelectionListener(SelectionListener listener) {
/**
* Removes the specified verify listener.
*
- * @param verifyListener the listener
+ * @param verifyListener the listener which should no longer be notified
+ *
* @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>
@@ -6284,7 +6292,8 @@ public void removeVerifyListener(VerifyListener verifyListener) {
/**
* Removes the specified key verify listener.
*
- * @param listener the listener
+ * @param listener the listener which should no longer be notified
+ *
* @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>
@@ -6300,7 +6309,8 @@ public void removeVerifyKeyListener(VerifyKeyListener listener) {
/**
* Removes the specified word movement listener.
*
- * @param listener the listener
+ * @param listener the listener which should no longer be notified
+ *
* @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>
diff --git a/bundles/org.eclipse.swt/Eclipse SWT Custom Widgets/common/org/eclipse/swt/custom/StyledTextContent.java b/bundles/org.eclipse.swt/Eclipse SWT Custom Widgets/common/org/eclipse/swt/custom/StyledTextContent.java
index a067b0fcfd..fcd43baa20 100755
--- a/bundles/org.eclipse.swt/Eclipse SWT Custom Widgets/common/org/eclipse/swt/custom/StyledTextContent.java
+++ b/bundles/org.eclipse.swt/Eclipse SWT Custom Widgets/common/org/eclipse/swt/custom/StyledTextContent.java
@@ -138,7 +138,8 @@ public String getTextRange(int start, int length);
* Remove the specified text changed listener.
* <p>
*
- * @param listener the listener
+ * @param listener the listener which should no longer be notified
+ *
* @exception IllegalArgumentException <ul>
* <li>ERROR_NULL_ARGUMENT when listener is null</li>
* </ul>
diff --git a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/win32/org/eclipse/swt/dnd/DragSource.java b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/win32/org/eclipse/swt/dnd/DragSource.java
index 5330777111..a769d53ac2 100755
--- a/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/win32/org/eclipse/swt/dnd/DragSource.java
+++ b/bundles/org.eclipse.swt/Eclipse SWT Drag and Drop/win32/org/eclipse/swt/dnd/DragSource.java
@@ -657,7 +657,7 @@ private int Release() {
* Removes the listener from the collection of listeners who will
* be notified when a drag and drop operation is in progress.
*
- * @param listener the listener which should be removed
+ * @param listener the listener which should no longer be notified
*
* @exception IllegalArgumentException <ul>
* <li>ERROR_NULL_ARGUMENT - if the listener is null</li>
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 90cc41a401..297281f719 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
@@ -639,7 +639,7 @@ void refresh() {
* Removes the listener from the collection of listeners who will
* be notified when a drag and drop operation is in progress.
*
- * @param listener the listener which should be removed
+ * @param listener the listener which should no longer be notified
*
* @exception IllegalArgumentException <ul>
* <li>ERROR_NULL_ARGUMENT - if the listener is null</li>
diff --git a/bundles/org.eclipse.swt/Eclipse SWT OLE Win32/win32/org/eclipse/swt/ole/win32/OleControlSite.java b/bundles/org.eclipse.swt/Eclipse SWT OLE Win32/win32/org/eclipse/swt/ole/win32/OleControlSite.java
index b4a114bb62..0fb97c9fc8 100755
--- a/bundles/org.eclipse.swt/Eclipse SWT OLE Win32/win32/org/eclipse/swt/ole/win32/OleControlSite.java
+++ b/bundles/org.eclipse.swt/Eclipse SWT OLE Win32/win32/org/eclipse/swt/ole/win32/OleControlSite.java
@@ -681,7 +681,7 @@ protected void releaseObjectInterfaces() {
*
* @param eventID the event identifier
*
- * @param listener the listener
+ * @param listener the listener which should no longer be notified
*
* @exception IllegalArgumentException <ul>
* <li>ERROR_NULL_ARGUMENT when listener is null</li>
@@ -722,17 +722,15 @@ public void removeEventListener(OleAutomation automation, GUID guid, int eventID
/**
* Removes the listener.
*
- * @since 2.0
- *
* @param automation the automation object that provides the event notification
- *
* @param eventID the event identifier
- *
- * @param listener the listener
+ * @param listener the listener which should no longer be notified
*
* @exception IllegalArgumentException <ul>
* <li>ERROR_NULL_ARGUMENT when listener is null</li>
* </ul>
+ *
+ * @since 2.0
*/
public void removeEventListener(OleAutomation automation, int eventID, OleListener listener) {
checkWidget();
@@ -784,7 +782,7 @@ void removeEventListener(int /*long*/ iunknown, GUID guid, int eventID, OleListe
/**
* Removes the listener.
*
- * @param listener the listener
+ * @param listener the listener which should no longer be notified
*
* @exception IllegalArgumentException <ul>
* <li>ERROR_NULL_ARGUMENT when listener 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 b882b4fd91..cb95ad5a83 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
@@ -3726,7 +3726,7 @@ public void removeFilter (int eventType, Listener listener) {
* is one of the event constants defined in class <code>SWT</code>.
*
* @param eventType the type of event to listen for
- * @param listener the listener which should no longer be notified when the event occurs
+ * @param listener the listener which should no longer be notified
*
* @exception IllegalArgumentException <ul>
* <li>ERROR_NULL_ARGUMENT - if the listener is null</li>
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 9fa412b94e..edddc72d7e 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
@@ -896,7 +896,7 @@ void releaseWidget () {
* type is one of the event constants defined in class <code>SWT</code>.
*
* @param eventType the type of event to listen for
- * @param listener the listener which should no longer be notified when the event occurs
+ * @param listener the listener which should no longer be notified
*
* @exception IllegalArgumentException <ul>
* <li>ERROR_NULL_ARGUMENT - if the listener is null</li>
@@ -930,7 +930,7 @@ public void removeListener (int eventType, Listener listener) {
* </p>
*
* @param eventType the type of event to listen for
- * @param listener the listener which should no longer be notified when the event occurs
+ * @param listener the listener which should no longer be notified
*
* @exception IllegalArgumentException <ul>
* <li>ERROR_NULL_ARGUMENT - if the listener is null</li>
@@ -954,7 +954,7 @@ protected void removeListener (int eventType, SWTEventListener listener) {
* Removes the listener from the collection of listeners who will
* be notified when the widget is disposed.
*
- * @param listener the listener which should no longer be notified when the receiver is disposed
+ * @param listener the listener which should no longer be notified
*
* @exception IllegalArgumentException <ul>
* <li>ERROR_NULL_ARGUMENT - if the listener is null</li>