Bug 566346 - Do the Javadoc bash for 4.17
Change-Id: Ifd7213cfe5b60e73f7b92b1aac8d5ace3688c016
Signed-off-by: Niraj Modi <niraj.modi@in.ibm.com>
diff --git a/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/graphics/Color.java b/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/graphics/Color.java
index ed05e81..9e1f589 100644
--- a/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/graphics/Color.java
+++ b/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/graphics/Color.java
@@ -22,7 +22,8 @@
* 0 to 255 or provide an instance of an <code>RGB</code> or <code>RGBA</code>.
* <p>
* Colors do not need to be disposed, however to maintain compatibility
- * with older code, disposing a Color is not an error.
+ * with older code, disposing a Color is not an error. As Colors do not require
+ * disposal, the constructors which do not require a Device are recommended.
* </p>
*
* @see RGB
@@ -69,6 +70,8 @@
* <li>ERROR_NULL_ARGUMENT - if device is null and there is no current device</li>
* <li>ERROR_INVALID_ARGUMENT - if the red, green or blue argument is not between 0 and 255</li>
* </ul>
+ *
+ * @see #Color(int, int, int) The equivalent constructor not requiring a Device
*/
public Color(Device device, int red, int green, int blue) {
super(device);
@@ -111,6 +114,8 @@
* <li>ERROR_INVALID_ARGUMENT - if the red, green, blue or alpha argument is not between 0 and 255</li>
* </ul>
*
+ * @see #Color(int, int, int, int) The equivalent constructor not requiring a Device
+ *
* @since 3.104
*/
public Color(Device device, int red, int green, int blue, int alpha) {
@@ -152,6 +157,8 @@
* <li>ERROR_NULL_ARGUMENT - if the rgb argument is null</li>
* <li>ERROR_INVALID_ARGUMENT - if the red, green or blue components of the argument are not between 0 and 255</li>
* </ul>
+ *
+ * @see #Color(RGB) The equivalent constructor not requiring a Device
*/
public Color(Device device, RGB rgb) {
super(device);
@@ -191,6 +198,8 @@
* <li>ERROR_INVALID_ARGUMENT - if the red, green, blue or alpha components of the argument are not between 0 and 255</li>
* </ul>
*
+ * @see #Color(RGBA) The equivalent constructor not requiring a Device
+ *
* @since 3.104
*/
public Color(Device device, RGBA rgba) {
@@ -234,6 +243,8 @@
* <li>ERROR_INVALID_ARGUMENT - if the red, green, blue or alpha components of the argument are not between 0 and 255</li>
* </ul>
*
+ * @see #Color(RGB, int) The equivalent constructor not requiring a Device
+ *
* @since 3.104
*/
public Color(Device device, RGB rgb, int alpha) {
@@ -288,6 +299,11 @@
* created. In cases where no <code>Device</code> was used
* at creation, returns the current or default Device.
*
+ * <p>
+ * As Color does not require a Device it is recommended to not
+ * use {@link Color#getDevice()}.
+ * </p>
+ *
* @return <code>Device</code> the device of the receiver
* @since 3.2
*/
diff --git a/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/graphics/Device.java b/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/graphics/Device.java
index 92b6ed8..a0e1f42 100644
--- a/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/graphics/Device.java
+++ b/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/graphics/Device.java
@@ -133,23 +133,23 @@
}
/**
-*
-* @exception SWTException <ul>
-* <li>ERROR_DEVICE_DISPOSED - if the receiver has been disposed</li>
-* </ul>
-* @since 3.115
-*/
+ *
+ * @exception SWTException <ul>
+ * <li>ERROR_DEVICE_DISPOSED - if the receiver has been disposed</li>
+ * </ul>
+ * @since 3.115
+ */
public boolean isTracking() {
checkDevice();
return tracking;
}
/**
-* @exception SWTException <ul>
-* <li>ERROR_DEVICE_DISPOSED - if the receiver has been disposed</li>
-* </ul>
-* @since 3.115
-*/
+ * @exception SWTException <ul>
+ * <li>ERROR_DEVICE_DISPOSED - if the receiver has been disposed</li>
+ * </ul>
+ * @since 3.115
+ */
public void setTracking(boolean tracking) {
checkDevice();
if (tracking == this.tracking) {
diff --git a/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/graphics/Color.java b/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/graphics/Color.java
index 6f5c220..cfa3b17 100644
--- a/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/graphics/Color.java
+++ b/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/graphics/Color.java
@@ -23,7 +23,8 @@
* 0 to 255 or provide an instance of an <code>RGB</code> or <code>RGBA</code>.
* <p>
* Colors do not need to be disposed, however to maintain compatibility
- * with older code, disposing a Color is not an error.
+ * with older code, disposing a Color is not an error. As Colors do not require
+ * disposal, the constructors which do not require a Device are recommended.
* </p>
*
* @see RGB
@@ -71,6 +72,8 @@
* <li>ERROR_NULL_ARGUMENT - if device is null and there is no current device</li>
* <li>ERROR_INVALID_ARGUMENT - if the red, green or blue argument is not between 0 and 255</li>
* </ul>
+ *
+ * @see #Color(int, int, int) The equivalent constructor not requiring a Device
*/
public Color(Device device, int red, int green, int blue) {
super(device);
@@ -113,6 +116,8 @@
* <li>ERROR_INVALID_ARGUMENT - if the red, green, blue or alpha argument is not between 0 and 255</li>
* </ul>
*
+ * @see #Color(int, int, int, int) The equivalent constructor not requiring a Device
+ *
* @since 3.104
*/
public Color(Device device, int red, int green, int blue, int alpha) {
@@ -154,6 +159,8 @@
* <li>ERROR_NULL_ARGUMENT - if the rgb argument is null</li>
* <li>ERROR_INVALID_ARGUMENT - if the red, green or blue components of the argument are not between 0 and 255</li>
* </ul>
+ *
+ * @see #Color(RGB) The equivalent constructor not requiring a Device
*/
public Color(Device device, RGB rgb) {
super(device);
@@ -193,6 +200,8 @@
* <li>ERROR_INVALID_ARGUMENT - if the red, green, blue or alpha components of the argument are not between 0 and 255</li>
* </ul>
*
+ * @see #Color(RGBA) The equivalent constructor not requiring a Device
+ *
* @since 3.104
*/
public Color(Device device, RGBA rgba) {
@@ -236,6 +245,8 @@
* <li>ERROR_INVALID_ARGUMENT - if the red, green, blue or alpha components of the argument are not between 0 and 255</li>
* </ul>
*
+ * @see #Color(RGB, int) The equivalent constructor not requiring a Device
+ *
* @since 3.104
*/
public Color(Device device, RGB rgb, int alpha) {
@@ -290,6 +301,11 @@
* created. In cases where no <code>Device</code> was used
* at creation, returns the current or default Device.
*
+ * <p>
+ * As Color does not require a Device it is recommended to not
+ * use {@link Color#getDevice()}.
+ * </p>
+ *
* @return <code>Device</code> the device of the receiver
* @since 3.2
*/
diff --git a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/graphics/Device.java b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/graphics/Device.java
index 067d23e..dc09701 100644
--- a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/graphics/Device.java
+++ b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/graphics/Device.java
@@ -129,23 +129,23 @@
}
/**
-*
-* @exception SWTException <ul>
-* <li>ERROR_DEVICE_DISPOSED - if the receiver has been disposed</li>
-* </ul>
-* @since 3.115
-*/
+ *
+ * @exception SWTException <ul>
+ * <li>ERROR_DEVICE_DISPOSED - if the receiver has been disposed</li>
+ * </ul>
+ * @since 3.115
+ */
public boolean isTracking() {
checkDevice();
return tracking;
}
/**
-* @exception SWTException <ul>
-* <li>ERROR_DEVICE_DISPOSED - if the receiver has been disposed</li>
-* </ul>
-* @since 3.115
-*/
+ * @exception SWTException <ul>
+ * <li>ERROR_DEVICE_DISPOSED - if the receiver has been disposed</li>
+ * </ul>
+ * @since 3.115
+ */
public void setTracking(boolean tracking) {
checkDevice();
if (tracking == this.tracking) {
