From 6224baabfc4b217290f584056366efabc786651a Mon Sep 17 00:00:00 2001 From: Carolyn MacLeod Date: Sat, 8 Jun 2002 19:46:21 +0000 Subject: JavadocBasher --- .../gtk/org/eclipse/swt/widgets/MessageBox.java | 4 +- .../gtk/org/eclipse/swt/widgets/ProgressBar.java | 8 ++-- .../gtk/org/eclipse/swt/widgets/Sash.java | 9 ++-- .../gtk/org/eclipse/swt/widgets/Scale.java | 10 ++-- .../gtk/org/eclipse/swt/widgets/ScrollBar.java | 8 ++-- .../gtk/org/eclipse/swt/widgets/Scrollable.java | 7 +-- .../gtk/org/eclipse/swt/widgets/Shell.java | 56 +++++++++++++++++++--- .../gtk/org/eclipse/swt/widgets/Slider.java | 15 +++--- .../gtk/org/eclipse/swt/widgets/TabFolder.java | 54 ++++++++++----------- .../gtk/org/eclipse/swt/widgets/TabItem.java | 8 ++-- .../gtk/org/eclipse/swt/widgets/Table.java | 10 ++-- 11 files changed, 122 insertions(+), 67 deletions(-) diff --git a/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/widgets/MessageBox.java b/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/widgets/MessageBox.java index 4074134680..e81ee10951 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/widgets/MessageBox.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/widgets/MessageBox.java @@ -70,8 +70,8 @@ public MessageBox (Shell parent) { * class, or must be built by bitwise OR'ing together * (that is, using the int "|" operator) two or more * of those SWT style constants. The class description - * for all SWT dialog classes should include a comment which - * describes the style constants which are applicable to the class. + * lists the style constants that are applicable to the class. + * Style bits are also inherited from superclasses. *

* Note: Currently, null can be passed in for the parent. * This has the effect of creating the dialog on the currently active diff --git a/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/widgets/ProgressBar.java b/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/widgets/ProgressBar.java index 1af04cbd77..4849ba0bff 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/widgets/ProgressBar.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/widgets/ProgressBar.java @@ -40,8 +40,8 @@ public class ProgressBar extends Control { * class, or must be built by bitwise OR'ing together * (that is, using the int "|" operator) two or more * of those SWT style constants. The class description - * for all SWT widget classes should include a comment which - * describes the style constants which are applicable to the class. + * lists the style constants that are applicable to the class. + * Style bits are also inherited from superclasses. *

* * @param parent a composite control which will be the parent of the new instance (cannot be null) @@ -55,7 +55,9 @@ public class ProgressBar extends Control { *
  • ERROR_INVALID_SUBCLASS - if this class is not an allowed subclass
    • * * - * @see SWT + * @see SWT#SMOOTH + * @see SWT#HORIZONTAL + * @see SWT#VERTICAL * @see Widget#checkSubclass * @see Widget#getStyle */ diff --git a/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/widgets/Sash.java b/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/widgets/Sash.java index f597049413..ad0afeee3a 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/widgets/Sash.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/widgets/Sash.java @@ -17,7 +17,7 @@ import org.eclipse.swt.events.*; * the parent control. *
    *
    Styles:
    - *
    HORIZONTAL, VERTICAL
    + *
    HORIZONTAL, VERTICAL
    *
    Events:
    *
    Selection
    *
    @@ -42,8 +42,8 @@ public class Sash extends Control { * class, or must be built by bitwise OR'ing together * (that is, using the int "|" operator) two or more * of those SWT style constants. The class description - * for all SWT widget classes should include a comment which - * describes the style constants which are applicable to the class. + * lists the style constants that are applicable to the class. + * Style bits are also inherited from superclasses. *

    * * @param parent a composite control which will be the parent of the new instance (cannot be null) @@ -57,7 +57,8 @@ public class Sash extends Control { *
  • ERROR_INVALID_SUBCLASS - if this class is not an allowed subclass
    • * * - * @see SWT + * @see SWT#HORIZONTAL + * @see SWT#VERTICAL * @see Widget#checkSubclass * @see Widget#getStyle */ diff --git a/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/widgets/Scale.java b/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/widgets/Scale.java index 0c32441bce..bd45935737 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/widgets/Scale.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/widgets/Scale.java @@ -17,13 +17,14 @@ import org.eclipse.swt.events.*; * numeric values. *
    *
    Styles:
    - *
    HORIZONTAL, VERTICAL
    + *
    HORIZONTAL, VERTICAL
    *
    Events:
    *
    Selection
    *
    *

    * Note: Only one of the styles HORIZONTAL and VERTICAL may be specified. *

    + *

    * IMPORTANT: This class is intended to be subclassed only * within the SWT implementation. *

    @@ -40,8 +41,8 @@ public class Scale extends Control { * class, or must be built by bitwise OR'ing together * (that is, using the int "|" operator) two or more * of those SWT style constants. The class description - * for all SWT widget classes should include a comment which - * describes the style constants which are applicable to the class. + * lists the style constants that are applicable to the class. + * Style bits are also inherited from superclasses. *

    * * @param parent a composite control which will be the parent of the new instance (cannot be null) @@ -55,7 +56,8 @@ public class Scale extends Control { *
  • ERROR_INVALID_SUBCLASS - if this class is not an allowed subclass
    • * * - * @see SWT + * @see SWT#HORIZONTAL + * @see SWT#VERTICAL * @see Widget#checkSubclass * @see Widget#getStyle */ diff --git a/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/widgets/ScrollBar.java b/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/widgets/ScrollBar.java index 692aab8667..e56056d18e 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/widgets/ScrollBar.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/widgets/ScrollBar.java @@ -30,10 +30,10 @@ import org.eclipse.swt.events.*; *
  • an arrow button for incrementing the value
    • * * Based on their style, scroll bars are either HORIZONTAL - * (which have left and right facing buttons for incrementing and - * decrementing the value) or VERTICAL (which have - * up and down facing buttons for incrementing and decrementing - * the value). + * (which have a left facing button for decrementing the value and a + * right facing button for incrementing it) or VERTICAL + * (which have an upward facing button for decrementing the value + * and a downward facing buttons for incrementing it). *

    * On some platforms, the size of the scroll bar's thumb can be * varied relative to the magnitude of the range of values it diff --git a/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/widgets/Scrollable.java b/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/widgets/Scrollable.java index 830073d837..7a75207e27 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/widgets/Scrollable.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/widgets/Scrollable.java @@ -42,8 +42,8 @@ Scrollable () {} * class, or must be built by bitwise OR'ing together * (that is, using the int "|" operator) two or more * of those SWT style constants. The class description - * for all SWT widget classes should include a comment which - * describes the style constants which are applicable to the class. + * lists the style constants that are applicable to the class. + * Style bits are also inherited from superclasses. *

    * * @param parent a composite control which will be the parent of the new instance (cannot be null) @@ -57,7 +57,8 @@ Scrollable () {} *
  • ERROR_INVALID_SUBCLASS - if this class is not an allowed subclass
    • * * - * @see SWT + * @see SWT#H_SCROLL + * @see SWT#V_SCROLL * @see Widget#checkSubclass * @see Widget#getStyle */ diff --git a/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/widgets/Shell.java b/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/widgets/Shell.java index 74b0ce599a..d2dc2a28c8 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/widgets/Shell.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/widgets/Shell.java @@ -122,8 +122,8 @@ public Shell () { * class, or must be built by bitwise OR'ing together * (that is, using the int "|" operator) two or more * of those SWT style constants. The class description - * for all SWT widget classes should include a comment which - * describes the style constants which are applicable to the class. + * lists the style constants that are applicable to the class. + * Style bits are also inherited from superclasses. *

    * * @param style the style of control to construct @@ -132,6 +132,20 @@ public Shell () { *
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the parent
    • *
  • ERROR_INVALID_SUBCLASS - if this class is not an allowed subclass
    • * + * + * @see SWT#BORDER + * @see SWT#CLOSE + * @see SWT#MIN + * @see SWT#MAX + * @see SWT#RESIZE + * @see SWT#TITLE + * @see SWT#NO_TRIM + * @see SWT#SHELL_TRIM + * @see SWT#DIALOG_TRIM + * @see SWT#MODELESS + * @see SWT#PRIMARY_MODAL + * @see SWT#APPLICATION_MODAL + * @see SWT#SYSTEM_MODAL */ public Shell (int style) { this ((Display) null, style); @@ -169,8 +183,8 @@ public Shell (Display display) { * class, or must be built by bitwise OR'ing together * (that is, using the int "|" operator) two or more * of those SWT style constants. The class description - * for all SWT widget classes should include a comment which - * describes the style constants which are applicable to the class. + * lists the style constants that are applicable to the class. + * Style bits are also inherited from superclasses. *

    * Note: Currently, null can be passed in for the display argument. * This has the effect of creating the shell on the currently active @@ -187,6 +201,20 @@ public Shell (Display display) { *

  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the parent
    • *
  • ERROR_INVALID_SUBCLASS - if this class is not an allowed subclass
    • * + * + * @see SWT#BORDER + * @see SWT#CLOSE + * @see SWT#MIN + * @see SWT#MAX + * @see SWT#RESIZE + * @see SWT#TITLE + * @see SWT#NO_TRIM + * @see SWT#SHELL_TRIM + * @see SWT#DIALOG_TRIM + * @see SWT#MODELESS + * @see SWT#PRIMARY_MODAL + * @see SWT#APPLICATION_MODAL + * @see SWT#SYSTEM_MODAL */ public Shell (Display display, int style) { this (display, null, style); @@ -238,8 +266,8 @@ public Shell (Shell parent) { * class, or must be built by bitwise OR'ing together * (that is, using the int "|" operator) two or more * of those SWT style constants. The class description - * for all SWT widget classes should include a comment which - * describes the style constants which are applicable to the class. + * lists the style constants that are applicable to the class. + * Style bits are also inherited from superclasses. *

    * Note: Currently, null can be passed in for the parent. * This has the effect of creating the shell on the currently active @@ -256,6 +284,20 @@ public Shell (Shell parent) { *

  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the parent
    • *
  • ERROR_INVALID_SUBCLASS - if this class is not an allowed subclass
    • * + * + * @see SWT#BORDER + * @see SWT#CLOSE + * @see SWT#MIN + * @see SWT#MAX + * @see SWT#RESIZE + * @see SWT#TITLE + * @see SWT#NO_TRIM + * @see SWT#SHELL_TRIM + * @see SWT#DIALOG_TRIM + * @see SWT#MODELESS + * @see SWT#PRIMARY_MODAL + * @see SWT#APPLICATION_MODAL + * @see SWT#SYSTEM_MODAL */ public Shell (Shell parent, int style) { this (null, parent, style); @@ -353,6 +395,8 @@ void adjustTrim () { *
  • ERROR_WIDGET_DISPOSED - if the receiver has been disposed
    • *
  • ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver
    • * + * + * @see #dispose */ public void close () { checkWidget (); diff --git a/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/widgets/Slider.java b/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/widgets/Slider.java index 00c332a01f..bebe3a8f6c 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/widgets/Slider.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/widgets/Slider.java @@ -30,10 +30,10 @@ import org.eclipse.swt.events.*; *
  • an arrow button for incrementing the value
    • * * Based on their style, sliders are either HORIZONTAL - * (which have left and right facing buttons for incrementing and - * decrementing the value) or VERTICAL (which have - * up and down facing buttons for incrementing and decrementing - * the value). + * (which have a left facing button for decrementing the value and a + * right facing button for incrementing it) or VERTICAL + * (which have an upward facing button for decrementing the value + * and a downward facing buttons for incrementing it). *

    * On some platforms, the size of the slider's thumb can be * varied relative to the magnitude of the range of values it @@ -71,8 +71,8 @@ public class Slider extends Control { * class, or must be built by bitwise OR'ing together * (that is, using the int "|" operator) two or more * of those SWT style constants. The class description - * for all SWT widget classes should include a comment which - * describes the style constants which are applicable to the class. + * lists the style constants that are applicable to the class. + * Style bits are also inherited from superclasses. *

    * * @param parent a composite control which will be the parent of the new instance (cannot be null) @@ -86,7 +86,8 @@ public class Slider extends Control { *
  • ERROR_INVALID_SUBCLASS - if this class is not an allowed subclass
    • * * - * @see SWT + * @see SWT#HORIZONTAL + * @see SWT#VERTICAL * @see Widget#checkSubclass * @see Widget#getStyle */ diff --git a/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/widgets/TabFolder.java b/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/widgets/TabFolder.java index 8276ef76cc..9855898538 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/widgets/TabFolder.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/widgets/TabFolder.java @@ -36,33 +36,33 @@ import org.eclipse.swt.events.*; public class TabFolder extends Composite { TabItem [] items; -/** - * Constructs a new instance of this class given its parent - * and a style value describing its behavior and appearance. - *

    - * The style value is either one of the style constants defined in - * class SWT which is applicable to instances of this - * class, or must be built by bitwise OR'ing together - * (that is, using the int "|" operator) two or more - * of those SWT style constants. The class description - * for all SWT widget classes should include a comment which - * describes the style constants which are applicable to the class. - *

    - * - * @param parent a composite control which will be the parent of the new instance (cannot be null) - * @param style the style of control to construct - * - * @exception IllegalArgumentException - * @exception SWTException - * - * @see SWT - * @see Widget#checkSubclass - * @see Widget#getStyle +/** + * Constructs a new instance of this class given its parent + * and a style value describing its behavior and appearance. + *

    + * The style value is either one of the style constants defined in + * class SWT which is applicable to instances of this + * class, or must be built by bitwise OR'ing together + * (that is, using the int "|" operator) two or more + * of those SWT style constants. The class description + * lists the style constants that are applicable to the class. + * Style bits are also inherited from superclasses. + *

    + * + * @param parent a composite control which will be the parent of the new instance (cannot be null) + * @param style the style of control to construct + * + * @exception IllegalArgumentException + * @exception SWTException + * + * @see SWT + * @see Widget#checkSubclass + * @see Widget#getStyle */ public TabFolder (Composite parent, int style) { super (parent, checkStyle (style)); diff --git a/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/widgets/TabItem.java b/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/widgets/TabItem.java index a885873638..c054d406e3 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/widgets/TabItem.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/widgets/TabItem.java @@ -41,8 +41,8 @@ public class TabItem extends Item { * class, or must be built by bitwise OR'ing together * (that is, using the int "|" operator) two or more * of those SWT style constants. The class description - * for all SWT widget classes should include a comment which - * describes the style constants which are applicable to the class. + * lists the style constants that are applicable to the class. + * Style bits are also inherited from superclasses. *

    * * @param parent a composite control which will be the parent of the new instance (cannot be null) @@ -77,8 +77,8 @@ public TabItem (TabFolder parent, int style) { * class, or must be built by bitwise OR'ing together * (that is, using the int "|" operator) two or more * of those SWT style constants. The class description - * for all SWT widget classes should include a comment which - * describes the style constants which are applicable to the class. + * lists the style constants that are applicable to the class. + * Style bits are also inherited from superclasses. *

    * * @param parent a composite control which will be the parent of the new instance (cannot be null) diff --git a/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/widgets/Table.java b/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/widgets/Table.java index 8f09c2a5d8..ce87c9d337 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/widgets/Table.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/widgets/Table.java @@ -52,8 +52,8 @@ public class Table extends Composite { * class, or must be built by bitwise OR'ing together * (that is, using the int "|" operator) two or more * of those SWT style constants. The class description - * for all SWT widget classes should include a comment which - * describes the style constants which are applicable to the class. + * lists the style constants that are applicable to the class. + * Style bits are also inherited from superclasses. *

    * * @param parent a composite control which will be the parent of the new instance (cannot be null) @@ -67,7 +67,11 @@ public class Table extends Composite { *
  • ERROR_INVALID_SUBCLASS - if this class is not an allowed subclass
    • * * - * @see SWT + * @see SWT#SINGLE + * @see SWT#MULTI + * @see SWT#CHECK + * @see SWT#FULL_SELECTION + * @see SWT#HIDE_SELECTION * @see Widget#checkSubclass * @see Widget#getStyle */ -- cgit