From e99cb861db693f625b5ae30fccdcc326dffe2d65 Mon Sep 17 00:00:00 2001
From: Lakshmi Shanmugam
- * The html parameter is Unicode-encoded since it is a java
- * The trusted parameter affects the permissions that will be granted to the rendered
+ * The , @see, @return) in javadoc
---
.../common/org/eclipse/swt/browser/Browser.java | 10 +++++-----
.../common/org/eclipse/swt/custom/CTabFolder.java | 21 ++++++++++++++-------
.../org/eclipse/swt/custom/CTabFolderRenderer.java | 8 ++++----
.../common/org/eclipse/swt/custom/StyledText.java | 8 ++++----
.../org/eclipse/swt/ole/win32/OleAutomation.java | 2 +-
.../Eclipse SWT/common/org/eclipse/swt/SWT.java | 2 +-
.../org/eclipse/swt/internal/Compatibility.java | 14 +++++++-------
.../org/eclipse/swt/internal/Compatibility.java | 12 +++++++++---
.../win32/org/eclipse/swt/graphics/TextLayout.java | 4 ++--
.../win32/org/eclipse/swt/widgets/Composite.java | 4 ++--
.../win32/org/eclipse/swt/widgets/Control.java | 4 ++--
11 files changed, 51 insertions(+), 38 deletions(-)
diff --git a/bundles/org.eclipse.swt/Eclipse SWT Browser/common/org/eclipse/swt/browser/Browser.java b/bundles/org.eclipse.swt/Eclipse SWT Browser/common/org/eclipse/swt/browser/Browser.java
index b56a0c142e..7480da8b79 100755
--- a/bundles/org.eclipse.swt/Eclipse SWT Browser/common/org/eclipse/swt/browser/Browser.java
+++ b/bundles/org.eclipse.swt/Eclipse SWT Browser/common/org/eclipse/swt/browser/Browser.java
@@ -510,7 +510,7 @@ public boolean execute (String script) {
*
String
.
+ * The html
parameter is Unicode-encoded since it is a java String
.
* As a result, the HTML meta tag charset should not be set. The charset is implied
* by the String
itself.
* trusted
parameter affects the permissions that will be granted to the rendered
* page. Specifying true
for trusted gives the page permissions equivalent
* to a page on the local file system, while specifying false
for trusted
* gives the page permissions equivalent to a page from the internet. Page content should
@@ -1005,7 +1005,7 @@ public boolean setText (String html) {
* @param trusted false
if the rendered page should be granted restricted
* permissions and true
otherwise
*
- * @return true if the operation was successful and false otherwise.
+ * @return true
if the operation was successful and false
otherwise.
*
* @exception IllegalArgumentException
*
null
* @param headers header lines to be sent with the request, or null
*
- * @return true if the operation was successful and false otherwise.
+ * @return true
if the operation was successful and false
otherwise.
*
* @exception IllegalArgumentException
*
*
*
+ * @see #setRenderer(CTabFolderRenderer)
+ * @see CTabFolderRenderer
+ *
* @since 3.6
*/
public CTabFolderRenderer getRenderer() {
@@ -1917,7 +1922,7 @@ public void setBackground (Color color) {
redraw();
}
/**
- * Specify a gradient of colours to be drawn in the background of the unselected tabs.
+ * Specify a gradient of colors to be drawn in the background of the unselected tabs.
* For example to draw a gradient that varies from dark blue to blue and then to
* white, use the following call to setBackground:
*
@@ -1933,8 +1938,8 @@ public void setBackground (Color color) {
* background gradient. The value
null
can be used inside the array of
* Color to specify the background color.
* @param percents an array of integers between 0 and 100 specifying the percent of the width
- * of the widget at which the color should change. The size of the percents array must be one
- * less than the size of the colors array.
+ * of the widget at which the color should change. The size of the percents
+ * array must be one less than the size of the colors
array.
*
* @exception SWTException
*
@@ -1963,10 +1968,10 @@ public void setBackground(Color[] colors, int[] percents) {
* background gradient. The value
null
can be used inside the array of
* Color to specify the background color.
* @param percents an array of integers between 0 and 100 specifying the percent of the width
- * of the widget at which the color should change. The size of the percents array must be one
- * less than the size of the colors array.
+ * of the widget at which the color should change. The size of the percents
+ * array must be one less than the size of the colors
array.
*
- * @param vertical indicate the direction of the gradient. True is vertical and false is horizontal.
+ * @param vertical indicate the direction of the gradient. True
is vertical and false
is horizontal.
*
* @exception SWTException
*
*
+ * @see CTabFolderRenderer
+ *
* @since 3.6
*/
public void setRenderer(CTabFolderRenderer renderer) {
diff --git a/bundles/org.eclipse.swt/Eclipse SWT Custom Widgets/common/org/eclipse/swt/custom/CTabFolderRenderer.java b/bundles/org.eclipse.swt/Eclipse SWT Custom Widgets/common/org/eclipse/swt/custom/CTabFolderRenderer.java
index 13c7ee3bcb..1a05182d94 100644
--- a/bundles/org.eclipse.swt/Eclipse SWT Custom Widgets/common/org/eclipse/swt/custom/CTabFolderRenderer.java
+++ b/bundles/org.eclipse.swt/Eclipse SWT Custom Widgets/common/org/eclipse/swt/custom/CTabFolderRenderer.java
@@ -193,7 +193,7 @@ public class CTabFolderRenderer {
*
*
- * The state parameter may be one of the following:
+ * The state
parameter may be one of the following:
*
The valid CTabFolder part constants are:
+ * Draw a specified part
of the CTabFolder using the provided bounds
and GC
.
+ *
The valid CTabFolder part
constants are:
*
- * The state parameter may be a combination of:
+ * The state
parameter may be a combination of:
*
index
.
*
* @param index the index of the line
*
@@ -4262,7 +4262,7 @@ public int[] getLineTabStops(int index) {
return result;
}
/**
- * Returns the wrap indentation of the line at the given index.
+ * Returns the wrap indentation of the line at the given index
.
*
* @param index the index of the line
*
@@ -9042,7 +9042,7 @@ public void setLineSpacing(int lineSpacing) {
/**
* Sets the tab stops of the specified lines.
*
- * Should not be called if a LineStyleListener has been set since the listener
+ * Should not be called if a LineStyleListener
has been set since the listener
* maintains the line attributes.
*
* All line attributes are maintained relative to the line text, not the @@ -9099,7 +9099,7 @@ public void setLineTabStops(int startLine, int lineCount, int[] tabStops) { /** * Sets the wrap indent of the specified lines. *
- * Should not be called if a LineStyleListener has been set since the listener
+ * Should not be called if a LineStyleListener
has been set since the listener
* maintains the line attributes.
*
* All line attributes are maintained relative to the line text, not the
diff --git a/bundles/org.eclipse.swt/Eclipse SWT OLE Win32/win32/org/eclipse/swt/ole/win32/OleAutomation.java b/bundles/org.eclipse.swt/Eclipse SWT OLE Win32/win32/org/eclipse/swt/ole/win32/OleAutomation.java
index 34a43ad1e7..2df8262476 100755
--- a/bundles/org.eclipse.swt/Eclipse SWT OLE Win32/win32/org/eclipse/swt/ole/win32/OleAutomation.java
+++ b/bundles/org.eclipse.swt/Eclipse SWT OLE Win32/win32/org/eclipse/swt/ole/win32/OleAutomation.java
@@ -127,7 +127,7 @@ public OleAutomation(OleClientSite clientSite) {
}
}
/**
- * Creates an OleAutomation object for the specified progID.
+ * Creates an OleAutomation object for the specified progID
.
*
* @param progId the unique program identifier of an OLE Document application;
* the value of the ProgID key or the value of the VersionIndependentProgID key specified
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).
*
- * 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 doit
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.
*
* If envp is null the new process inherits the environment of the caller. *
* - * @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. *
* The new process inherits the environment of the caller. *
* - * @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. *
@@ -2870,7 +2870,7 @@ public void setSegments(int[] segments) {
* are set by calling The setSegments(int[])
. 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 TextLayout.
+ * accessible by any other API in
TextLayout
.
*
* @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.
*
* offsetX
and offsetY
are used to map from
- * the gc origin to the origin of the parent image background. This is useful
+ * the gc
origin to the origin of the parent image background. This is useful
* to ensure proper alignment of the image background.Composite.setLayoutDeferred(true)
and scheduling a call
* to Composite.setLayoutDeferred(false)
, which will happen when
* appropriate (usually before the next event is handled). When this flag is set,
- * the application should not call Composite.setLayoutDeferred()
.
+ * the application should not call Composite.setLayoutDeferred(boolean)
.
*
* 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 event
* @param event the KeyDown event
*
- * @return true if the traversal succeeded
+ * @return true
if the traversal succeeded
*
* @exception IllegalArgumentException
event
* @param event the KeyDown event
*
- * @return true if the traversal succeeded
+ * @return true
if the traversal succeeded
*
* @exception IllegalArgumentException