Bug 314066 - Add missing flags (<code>, @see, @return) in javadoc

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) {
  *    <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
  * </ul>
  *
- * @see #dispose
+ * @see #dispose()
  * 
  * @since 3.6
  */
@@ -989,11 +989,11 @@ public boolean setText (String html) {
  * Renders a string containing HTML.  The rendering of the content occurs asynchronously.
  * The rendered page can be given either trusted or untrusted permissions. 
  * <p>
- * The html parameter is Unicode-encoded since it is a java <code>String</code>.
+ * The <code>html</code> parameter is Unicode-encoded since it is a java <code>String</code>.
  * As a result, the HTML meta tag charset should not be set. The charset is implied
  * by the <code>String</code> itself.
  * <p>
- * The trusted parameter affects the permissions that will be granted to the rendered
+ * The <code>trusted</code> parameter affects the permissions that will be granted to the rendered
  * page.  Specifying <code>true</code> for trusted gives the page permissions equivalent
  * to a page on the local file system, while specifying <code>false</code> 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 <code>false</code> if the rendered page should be granted restricted
  * permissions and <code>true</code> otherwise
  *
- * @return true if the operation was successful and false otherwise.
+ * @return <code>true</code> if the operation was successful and <code>false</code> otherwise.
  *
  * @exception IllegalArgumentException <ul>
  *    <li>ERROR_NULL_ARGUMENT - if the html is null</li>
@@ -1066,7 +1066,7 @@ public boolean setUrl (String url) {
  * @param postData post data to be sent with the request, or <code>null</code>
  * @param headers header lines to be sent with the request, or <code>null</code> 
  *
- * @return true if the operation was successful and false otherwise.
+ * @return <code>true</code> if the operation was successful and <code>false</code> otherwise.
  *
  * @exception IllegalArgumentException <ul>
  *    <li>ERROR_NULL_ARGUMENT - if the url is null</li>
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 4f1fb850bb..b9672d28fa 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
@@ -756,12 +756,17 @@ public boolean getMRUVisible() {
 }
 /**
  * Returns the receiver's renderer.
+ * 
+ * @return the receiver's renderer
  *
  * @exception SWTException <ul>
  *		<li>ERROR_THREAD_INVALID_ACCESS when called from the wrong thread</li>
  *		<li>ERROR_WIDGET_DISPOSED when the widget has been disposed</li>
  *	</ul>
  *
+ * @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:
  * <pre>
@@ -1933,8 +1938,8 @@ public void setBackground (Color color) {
  *               background gradient. The value <code>null</code> 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 <code>percents</code>
+ *                 array must be one less than the size of the <code>colors</code> array.
  * 
  * @exception SWTException <ul>
  *		<li>ERROR_THREAD_INVALID_ACCESS when called from the wrong thread</li>
@@ -1947,7 +1952,7 @@ public void setBackground(Color[] colors, int[] percents) {
 	setBackground(colors, percents, false);
 }
 /**
- * Specify a gradient of colours to be drawn in the background of the unselected tab.
+ * Specify a gradient of colors to be drawn in the background of the unselected tab.
  * For example to draw a vertical gradient that varies from dark blue to blue and then to
  * white, use the following call to setBackground:
  * <pre>
@@ -1963,10 +1968,10 @@ public void setBackground(Color[] colors, int[] percents) {
  *               background gradient. The value <code>null</code> 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 <code>percents</code>
+ *                 array must be one less than the size of the <code>colors</code> array.
  * 
- * @param vertical indicate the direction of the gradient.  True is vertical and false is horizontal. 
+ * @param vertical indicate the direction of the gradient. <code>True</code> is vertical and <code>false</code> is horizontal. 
  * 
  * @exception SWTException <ul>
  *		<li>ERROR_THREAD_INVALID_ACCESS when called from the wrong thread</li>
@@ -2643,6 +2648,8 @@ public void setMRUVisible(boolean show) {
  *		<li>ERROR_WIDGET_DISPOSED when the widget has been disposed</li>
  *	</ul>
  *
+ * @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 {
 	 * </ul>
 	 * </p>
 	 * <p>
-	 * The state parameter may be one of the following: 
+	 * The <code>state</code> parameter may be one of the following: 
 	 * <ul>
 	 * <li>SWT.NONE</li>
 	 * <li>SWT.SELECTED - whether the part is selected</li>
@@ -479,8 +479,8 @@ public class CTabFolderRenderer {
 	}
 	
 	/**
-	 * Draw a specified part of the CTabFolder using the provided bounds and GC. 
-	 * <p>The valid CTabFolder part constants are:
+	 * Draw a specified <code>part</code> of the CTabFolder using the provided <code>bounds</code> and <code>GC</code>. 
+	 * <p>The valid CTabFolder <code>part</code> constants are:
 	 * <ul>
 	 * <li>PART_BODY - the entire body of the CTabFolder</li>
 	 * <li>PART_HEADER - the upper tab area of the CTabFolder</li>
@@ -494,7 +494,7 @@ public class CTabFolderRenderer {
 	 * </ul>
 	 * </p>
 	 * <p>
-	 * The state parameter may be a combination of: 
+	 * The <code>state</code> parameter may be a combination of: 
 	 * <ul>
 	 * <li>SWT.BACKGROUND - whether the background should be drawn</li>
 	 * <li>SWT.FOREGROUND - whether the foreground should be drawn</li>
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 0070c1d0b2..31b2d44c07 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
@@ -4230,7 +4230,7 @@ public int getLineIndex(int y) {
 	return line;
 }
 /**
- * Returns the tab stops of the line at the given index.
+ * Returns the tab stops of the line at the given <code>index</code>.
  * 
  * @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 <code>index</code>.
  * 
  * @param index the index of the line
  * 
@@ -9042,7 +9042,7 @@ public void setLineSpacing(int lineSpacing) {
 /**
  * Sets the tab stops of the specified lines.
  * <p>
- * Should not be called if a LineStyleListener has been set since the listener 
+ * Should not be called if a <code>LineStyleListener</code> has been set since the listener 
  * maintains the line attributes.
  * </p><p>
  * 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.
  * <p>
- * Should not be called if a LineStyleListener has been set since the listener 
+ * Should not be called if a <code>LineStyleListener</code> has been set since the listener 
  * maintains the line attributes.
  * </p><p>
  * 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 <code>progID</code>.
  *
  * @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).  
 	 * <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>