From 06b49e6b617fb3a7c950ffef3f6da71106d90fcf Mon Sep 17 00:00:00 2001
From: Carolyn MacLeod <carolyn>
Date: Wed, 22 Jun 2005 08:27:55 +0000
Subject: doc: bug 84911

---
 .../org/eclipse/swt/custom/SashFormData.java       |  6 ++++++
 .../common/org/eclipse/swt/custom/StackLayout.java |  6 ++++++
 .../common/org/eclipse/swt/custom/StyleRange.java  |  8 +++----
 .../win32/org/eclipse/swt/ole/win32/Variant.java   |  7 ++++++
 .../org/eclipse/swt/internal/win32/TCHAR.java      |  2 +-
 .../win32/org/eclipse/swt/program/Program.java     |  6 ++++++
 .../org/eclipse/swt/internal/image/PngChunk.java   |  9 +++++---
 .../common/org/eclipse/swt/layout/FillLayout.java  |  6 ++++++
 .../org/eclipse/swt/layout/FormAttachment.java     |  6 ++++++
 .../common/org/eclipse/swt/layout/FormData.java    |  6 ++++++
 .../common/org/eclipse/swt/layout/FormLayout.java  |  6 ++++++
 .../common/org/eclipse/swt/layout/GridData.java    |  6 ++++++
 .../common/org/eclipse/swt/layout/GridLayout.java  |  6 ++++++
 .../common/org/eclipse/swt/layout/RowData.java     |  6 ++++++
 .../common/org/eclipse/swt/layout/RowLayout.java   |  6 ++++++
 .../common/org/eclipse/swt/widgets/Event.java      | 25 +++++++++++-----------
 16 files changed, 97 insertions(+), 20 deletions(-)

diff --git a/bundles/org.eclipse.swt/Eclipse SWT Custom Widgets/common/org/eclipse/swt/custom/SashFormData.java b/bundles/org.eclipse.swt/Eclipse SWT Custom Widgets/common/org/eclipse/swt/custom/SashFormData.java
index cb34fd59b9..5ec15c3a46 100644
--- a/bundles/org.eclipse.swt/Eclipse SWT Custom Widgets/common/org/eclipse/swt/custom/SashFormData.java	
+++ b/bundles/org.eclipse.swt/Eclipse SWT Custom Widgets/common/org/eclipse/swt/custom/SashFormData.java	
@@ -21,6 +21,12 @@ String getName () {
 	return string.substring (index + 1, string.length ());
 }
 
+/**
+ * Returns a string containing a concise, human-readable
+ * description of the receiver.
+ *
+ * @return a string representation of the event
+ */
 public String toString () {
 	return getName()+" {weight="+weight+"}"; //$NON-NLS-2$
 }
diff --git a/bundles/org.eclipse.swt/Eclipse SWT Custom Widgets/common/org/eclipse/swt/custom/StackLayout.java b/bundles/org.eclipse.swt/Eclipse SWT Custom Widgets/common/org/eclipse/swt/custom/StackLayout.java
index f12813f80e..7980df7cd6 100755
--- a/bundles/org.eclipse.swt/Eclipse SWT Custom Widgets/common/org/eclipse/swt/custom/StackLayout.java	
+++ b/bundles/org.eclipse.swt/Eclipse SWT Custom Widgets/common/org/eclipse/swt/custom/StackLayout.java	
@@ -126,6 +126,12 @@ String getName () {
 	return string.substring (index + 1, string.length ());
 }
 
+/**
+ * Returns a string containing a concise, human-readable
+ * description of the receiver.
+ *
+ * @return a string representation of the event
+ */
 public String toString () {
  	String string = getName ()+" {";
  	if (marginWidth != 0) string += "marginWidth="+marginWidth+" ";
diff --git a/bundles/org.eclipse.swt/Eclipse SWT Custom Widgets/common/org/eclipse/swt/custom/StyleRange.java b/bundles/org.eclipse.swt/Eclipse SWT Custom Widgets/common/org/eclipse/swt/custom/StyleRange.java
index ee170c3c48..a11f4ac21c 100755
--- a/bundles/org.eclipse.swt/Eclipse SWT Custom Widgets/common/org/eclipse/swt/custom/StyleRange.java	
+++ b/bundles/org.eclipse.swt/Eclipse SWT Custom Widgets/common/org/eclipse/swt/custom/StyleRange.java	
@@ -141,11 +141,11 @@ public Object clone() {
  	style.strikeout = this.strikeout;
 	return style;
 }
-/** 
- * Answers a string description of the receiver.
- * <p>
+/**
+ * Returns a string containing a concise, human-readable
+ * description of the receiver.
  *
- * @return a printable representation for the receiver.
+ * @return a string representation of the event
  */
 public String toString() {
 	StringBuffer buf = new StringBuffer();
diff --git a/bundles/org.eclipse.swt/Eclipse SWT OLE Win32/win32/org/eclipse/swt/ole/win32/Variant.java b/bundles/org.eclipse.swt/Eclipse SWT OLE Win32/win32/org/eclipse/swt/ole/win32/Variant.java
index 3fa0210fbc..e812590025 100755
--- a/bundles/org.eclipse.swt/Eclipse SWT OLE Win32/win32/org/eclipse/swt/ole/win32/Variant.java	
+++ b/bundles/org.eclipse.swt/Eclipse SWT OLE Win32/win32/org/eclipse/swt/ole/win32/Variant.java	
@@ -752,6 +752,13 @@ void setData(int pData){
 			break;
 	}
 }
+
+/**
+ * Returns a string containing a concise, human-readable
+ * description of the receiver.
+ *
+ * @return a string representation of the event
+ */
 public String toString () {
     switch (type) {
 	    case COM.VT_BOOL :
diff --git a/bundles/org.eclipse.swt/Eclipse SWT PI/win32/org/eclipse/swt/internal/win32/TCHAR.java b/bundles/org.eclipse.swt/Eclipse SWT PI/win32/org/eclipse/swt/internal/win32/TCHAR.java
index 1bf5bb7228..52b0f4f099 100644
--- a/bundles/org.eclipse.swt/Eclipse SWT PI/win32/org/eclipse/swt/internal/win32/TCHAR.java	
+++ b/bundles/org.eclipse.swt/Eclipse SWT PI/win32/org/eclipse/swt/internal/win32/TCHAR.java	
@@ -15,7 +15,7 @@ package org.eclipse.swt.internal.win32;
  * This class implements the conversions between unicode characters
  * and the <em>platform supported</em> representation for characters.
  * <p>
- * Note that, unicode characters which can not be found in the platform
+ * Note that unicode characters which can not be found in the platform
  * encoding will be converted to an arbitrary platform specific character.
  * </p>
  */
diff --git a/bundles/org.eclipse.swt/Eclipse SWT Program/win32/org/eclipse/swt/program/Program.java b/bundles/org.eclipse.swt/Eclipse SWT Program/win32/org/eclipse/swt/program/Program.java
index 687d944880..0a35312fc7 100755
--- a/bundles/org.eclipse.swt/Eclipse SWT Program/win32/org/eclipse/swt/program/Program.java	
+++ b/bundles/org.eclipse.swt/Eclipse SWT Program/win32/org/eclipse/swt/program/Program.java	
@@ -334,6 +334,12 @@ public int hashCode() {
 	return name.hashCode() ^ command.hashCode() ^ iconName.hashCode();
 }
 
+/**
+ * Returns a string containing a concise, human-readable
+ * description of the receiver.
+ *
+ * @return a string representation of the event
+ */
 public String toString () {
 	return "Program {" + name + "}"; //$NON-NLS-1$ //$NON-NLS-2$
 }
diff --git a/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/internal/image/PngChunk.java b/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/internal/image/PngChunk.java
index ed4ba2da08..f38895dc64 100755
--- a/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/internal/image/PngChunk.java	
+++ b/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/internal/image/PngChunk.java	
@@ -251,9 +251,6 @@ int getChunkType() {
 	return CHUNK_UNKNOWN;
 }
 
-
-
-
 /**
  * Read the next PNG chunk from the input stream given.
  * If unable to read a chunk, return null.
@@ -318,6 +315,12 @@ void validate(PngFileReadState readState, PngIhdrChunk headerChunk) {
  */
 void contributeToString(StringBuffer buffer) {}
 
+/**
+ * Returns a string containing a concise, human-readable
+ * description of the receiver.
+ *
+ * @return a string representation of the event
+ */
 public String toString() {
 	StringBuffer buffer = new StringBuffer();
 	buffer.append("{");
diff --git a/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/layout/FillLayout.java b/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/layout/FillLayout.java
index 2a7a32e7b5..82df1dbeea 100755
--- a/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/layout/FillLayout.java	
+++ b/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/layout/FillLayout.java	
@@ -216,6 +216,12 @@ protected void layout (Composite composite, boolean flushCache) {
 	}
 }
 
+/**
+ * Returns a string containing a concise, human-readable
+ * description of the receiver.
+ *
+ * @return a string representation of the event
+ */
 public String toString () {
  	String string = getName ()+" {";
  	string += "type="+((type == SWT.VERTICAL) ? "SWT.VERTICAL" : "SWT.HORIZONTAL")+" ";
diff --git a/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/layout/FormAttachment.java b/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/layout/FormAttachment.java
index 61ac2e09e9..619c0c288e 100644
--- a/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/layout/FormAttachment.java	
+++ b/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/layout/FormAttachment.java	
@@ -276,6 +276,12 @@ int solveY (int value) {
 	return (value - offset) * denominator / numerator;
 }
 	
+/**
+ * Returns a string containing a concise, human-readable
+ * description of the receiver.
+ *
+ * @return a string representation of the event
+ */
 public String toString () {
  	String string = control != null ? control.toString () : numerator + "/" + denominator;
 	return "{y = (" + string + (offset >= 0 ? ")x + " + offset: ")x - " + (-offset))+"}";
diff --git a/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/layout/FormData.java b/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/layout/FormData.java
index d97ade4b0b..c0a7260a7c 100644
--- a/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/layout/FormData.java	
+++ b/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/layout/FormData.java	
@@ -307,6 +307,12 @@ FormAttachment getTopAttachment (Control control, int spacing, boolean flushCach
 	return cacheTop;
 }
 
+/**
+ * Returns a string containing a concise, human-readable
+ * description of the receiver.
+ *
+ * @return a string representation of the event
+ */
 public String toString () {
  	String string = getName()+" {";
  	if (width != SWT.DEFAULT) string += "width="+width+" ";
diff --git a/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/layout/FormLayout.java b/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/layout/FormLayout.java
index b0b154a72c..62f3779f76 100644
--- a/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/layout/FormLayout.java	
+++ b/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/layout/FormLayout.java	
@@ -361,6 +361,12 @@ Point layout (Composite composite, boolean move, int x, int y, int width, int he
 	return new Point (w, h);
 }
 
+/**
+ * Returns a string containing a concise, human-readable
+ * description of the receiver.
+ *
+ * @return a string representation of the event
+ */
 public String toString () {
  	String string =  getName ()+" {";
  	if (marginWidth != 0) string += "marginWidth="+marginWidth+" ";
diff --git a/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/layout/GridData.java b/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/layout/GridData.java
index 00b3012b40..908132c85f 100755
--- a/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/layout/GridData.java	
+++ b/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/layout/GridData.java	
@@ -509,6 +509,12 @@ String getName () {
 	return string.substring (index + 1, string.length ());
 }
 
+/**
+ * Returns a string containing a concise, human-readable
+ * description of the receiver.
+ *
+ * @return a string representation of the event
+ */
 public String toString () {
 	String hAlign = "";
 	switch (horizontalAlignment) {
diff --git a/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/layout/GridLayout.java b/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/layout/GridLayout.java
index 1e5e169d45..fc369e3152 100755
--- a/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/layout/GridLayout.java	
+++ b/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/layout/GridLayout.java	
@@ -701,6 +701,12 @@ String getName () {
 	return string.substring (index + 1, string.length ());
 }
 
+/**
+ * Returns a string containing a concise, human-readable
+ * description of the receiver.
+ *
+ * @return a string representation of the event
+ */
 public String toString () {
  	String string = getName ()+" {";
  	if (numColumns != 1) string += "numColumns="+numColumns+" ";
diff --git a/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/layout/RowData.java b/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/layout/RowData.java
index 4442dd0f8f..891a6cc1ea 100755
--- a/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/layout/RowData.java	
+++ b/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/layout/RowData.java	
@@ -86,6 +86,12 @@ String getName () {
 	return string.substring (index + 1, string.length ());
 }
 
+/**
+ * Returns a string containing a concise, human-readable
+ * description of the receiver.
+ *
+ * @return a string representation of the event
+ */
 public String toString () {
 	String string = getName ()+" {";
 	if (width != SWT.DEFAULT) string += "width="+width+" ";
diff --git a/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/layout/RowLayout.java b/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/layout/RowLayout.java
index fb82262f5f..72adb38b4f 100755
--- a/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/layout/RowLayout.java	
+++ b/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/layout/RowLayout.java	
@@ -434,6 +434,12 @@ Point layoutVertical (Composite composite, boolean move, boolean wrap, int heigh
 	return new Point (x + maxWidth + marginRight + marginWidth, maxY);
 }
 
+/**
+ * Returns a string containing a concise, human-readable
+ * description of the receiver.
+ *
+ * @return a string representation of the event
+ */
 public String toString () {
  	String string = getName ()+" {";
  	string += "type="+((type != SWT.HORIZONTAL) ? "SWT.VERTICAL" : "SWT.HORIZONTAL")+" ";
diff --git a/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/widgets/Event.java b/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/widgets/Event.java
index cd379635dd..59f948fc28 100755
--- a/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/widgets/Event.java	
+++ b/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/widgets/Event.java	
@@ -180,19 +180,19 @@ public class Event {
 	public Object data;
 	
 /**
-* Gets the bounds.
-* <p>
-* @return a rectangle that is the bounds.
-*/
+ * Gets the bounds.
+ * 
+ * @return a rectangle that is the bounds.
+ */
 public Rectangle getBounds () {
 	return new Rectangle (x, y, width, height);
 }
 
 /**
-* Sets the bounds.
-* <p>
-* @param rect the new rectangle
-*/
+ * Sets the bounds.
+ * 
+ * @param rect the new rectangle
+ */
 public void setBounds (Rectangle rect) {
 	this.x = rect.x;
 	this.y = rect.y;
@@ -201,10 +201,11 @@ public void setBounds (Rectangle rect) {
 }
 
 /**
-* Returns a string representation of the object.
-*
-* @return a string representation of the object
-*/
+ * Returns a string containing a concise, human-readable
+ * description of the receiver.
+ *
+ * @return a string representation of the event
+ */
 public String toString () {
 	return "Event {type=" + type + ",widget=" + widget + ",x=" + x + ",y=" + y + ",width=" + width + ",height=" + height + "}";  //$NON-NLS-1$//$NON-NLS-2$ //$NON-NLS-3$ //$NON-NLS-4$ //$NON-NLS-5$ //$NON-NLS-6$ //$NON-NLS-7$
 }
-- 
cgit