summaryrefslogtreecommitdiffstats
path: root/bundles/org.eclipse.swt/Eclipse SWT
diff options
context:
space:
mode:
authorLakshmi Shanmugam <lshanmugam>2010-05-24 08:49:09 +0000
committerLakshmi Shanmugam <lshanmugam>2010-05-24 08:49:09 +0000
commite99cb861db693f625b5ae30fccdcc326dffe2d65 (patch)
treeab8059ddee6c882d19739346097966925a611559 /bundles/org.eclipse.swt/Eclipse SWT
parenta8f6b411f160de32df8aaa9f9b628d44dc67cbc8 (diff)
downloadeclipse.platform.swt-e99cb861db693f625b5ae30fccdcc326dffe2d65.tar.gz
eclipse.platform.swt-e99cb861db693f625b5ae30fccdcc326dffe2d65.tar.xz
eclipse.platform.swt-e99cb861db693f625b5ae30fccdcc326dffe2d65.zip
Bug 314066 - Add missing flags (<code>, @see, @return) in javadoc
Diffstat (limited to 'bundles/org.eclipse.swt/Eclipse SWT')
-rwxr-xr-xbundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/SWT.java2
-rw-r--r--bundles/org.eclipse.swt/Eclipse SWT/common_j2me/org/eclipse/swt/internal/Compatibility.java14
-rw-r--r--bundles/org.eclipse.swt/Eclipse SWT/common_j2se/org/eclipse/swt/internal/Compatibility.java12
-rw-r--r--bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/graphics/TextLayout.java4
-rwxr-xr-xbundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Composite.java4
-rwxr-xr-xbundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Control.java4
6 files changed, 23 insertions, 17 deletions
diff --git a/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/SWT.java b/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/SWT.java
index cdc862841f..0b9572a033 100755
--- a/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/SWT.java
+++ b/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/SWT.java
@@ -669,7 +669,7 @@ public class SWT {
/**
* The orientation change event type (value is 43).
* <p>
- * On some platforms of orientation of text widgets
+ * On some platforms the orientation of text widgets
* can be changed by keyboard shortcut.
* The application can use the <code>doit</code> field
* of the event to stop the change from happening.
diff --git a/bundles/org.eclipse.swt/Eclipse SWT/common_j2me/org/eclipse/swt/internal/Compatibility.java b/bundles/org.eclipse.swt/Eclipse SWT/common_j2me/org/eclipse/swt/internal/Compatibility.java
index d1049c4a94..d72cb9fdc1 100644
--- a/bundles/org.eclipse.swt/Eclipse SWT/common_j2me/org/eclipse/swt/internal/Compatibility.java
+++ b/bundles/org.eclipse.swt/Eclipse SWT/common_j2me/org/eclipse/swt/internal/Compatibility.java
@@ -286,7 +286,7 @@ public static boolean isWhitespace(char c) {
* The new process inherits the environment of the caller.
* </p>
*
- * @param program the name of the program to execute
+ * @param prog the name of the program to execute
*
* @exception IOException
* if the program cannot be executed
@@ -327,21 +327,21 @@ public static void exec(String[] progArray) throws java.io.IOException{
}
/**
- * Execute progArray[0] in a separate platform process with the specified
- * environment and working directory if the underlying platform support
+ * Execute prog[0] in a separate platform process with the specified
+ * environment and working directory if the underlying platform supports
* this.
* <p>
* If envp is null the new process inherits the environment of the caller.
* <p>
*
- * @param progArray
+ * @param prog
* array containing the program to execute and its arguments
* @param envp
* array of strings, each element of which has environment
- * variable settings in format name=value.
- * @param dir
+ * variable settings in the format name=value
+ * @param workingDir
* the working directory of the new process, or null if the new
- * process should inherit the working directory of the caller.
+ * process should inherit the working directory of the caller
*
* @exception IOException
* if the program cannot be executed
diff --git a/bundles/org.eclipse.swt/Eclipse SWT/common_j2se/org/eclipse/swt/internal/Compatibility.java b/bundles/org.eclipse.swt/Eclipse SWT/common_j2se/org/eclipse/swt/internal/Compatibility.java
index 7f7ca9d6ff..57f0b3b393 100644
--- a/bundles/org.eclipse.swt/Eclipse SWT/common_j2se/org/eclipse/swt/internal/Compatibility.java
+++ b/bundles/org.eclipse.swt/Eclipse SWT/common_j2se/org/eclipse/swt/internal/Compatibility.java
@@ -283,13 +283,19 @@ public static void exec(String[] progArray) throws java.io.IOException{
}
/**
- * Execute prog in a separate platform process if the
- * underlying platform support this.
+ * Execute prog[0] in a separate platform process if the
+ * underlying platform supports this.
* <p>
* The new process inherits the environment of the caller.
* <p>
*
- * @param prog containing the program to execute and its arguments
+ * @param prog array containing the program to execute and its arguments
+ * @param envp
+ * array of strings, each element of which has environment
+ * variable settings in the format name=value
+ * @param workingDir
+ * the working directory of the new process, or null if the new
+ * process should inherit the working directory of the caller
*
* @exception IOException
* if the program cannot be executed
diff --git a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/graphics/TextLayout.java b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/graphics/TextLayout.java
index 99b12e00cf..f5dde0c965 100644
--- a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/graphics/TextLayout.java
+++ b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/graphics/TextLayout.java
@@ -2827,7 +2827,7 @@ public void setOrientation (int orientation) {
/**
* Sets the offsets of the receiver's text segments. Text segments are used to
- * override the default behaviour of the bidirectional algorithm.
+ * override the default behavior of the bidirectional algorithm.
* Bidirectional reordering can happen within a text segment but not
* between two adjacent segments.
* <p>
@@ -2870,7 +2870,7 @@ public void setSegments(int[] segments) {
* are set by calling <code>setSegments(int[])</code>. The application can
* use this API to insert Unicode Control Characters in the text to control
* the display of the text and bidi reordering. The characters are not
- * accessible by any other API in </code>TextLayout<code>.
+ * accessible by any other API in <code>TextLayout</code>.
*
* @param segmentsChars the segments characters
*
diff --git a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Composite.java b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Composite.java
index 7b469740fd..da8112119e 100755
--- a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Composite.java
+++ b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Composite.java
@@ -319,7 +319,7 @@ void createHandle () {
* with the receiver's background.
*
* <p>The <code>offsetX</code> and <code>offsetY</code> are used to map from
- * the gc origin to the origin of the parent image background. This is useful
+ * the <code>gc</code> origin to the origin of the parent image background. This is useful
* to ensure proper alignment of the image background.</p>
*
* @param gc the gc where the rectangle is to be filled
@@ -733,7 +733,7 @@ public void layout (Control [] changed) {
* calling <code>Composite.setLayoutDeferred(true)</code> and scheduling a call
* to <code>Composite.setLayoutDeferred(false)</code>, which will happen when
* appropriate (usually before the next event is handled). When this flag is set,
- * the application should not call <code>Composite.setLayoutDeferred()</code>.
+ * the application should not call <code>Composite.setLayoutDeferred(boolean)</code>.
* </p>
* <p>
* Note: Layout is different from painting. If a child is
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 c59d93f2d8..41f3dbfdc9 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
@@ -3751,7 +3751,7 @@ public boolean traverse (int traversal) {
* this from <code>event</code>
* @param event the KeyDown event
*
- * @return true if the traversal succeeded
+ * @return <code>true</code> if the traversal succeeded
*
* @exception IllegalArgumentException <ul>
* <li>ERROR_NULL_ARGUMENT if the event is null</li>
@@ -3789,7 +3789,7 @@ public boolean traverse (int traversal, Event event) {
* this from <code>event</code>
* @param event the KeyDown event
*
- * @return true if the traversal succeeded
+ * @return <code>true</code> if the traversal succeeded
*
* @exception IllegalArgumentException <ul>
* <li>ERROR_NULL_ARGUMENT if the event is null</li>