Skip to content

Commit 6f025a6

Browse files
HannesWellHannesWell
committed
Fix javadoc errors
1 parent 3b12aa5 commit 6f025a6

File tree

38 files changed

+137
-117
lines changed

38 files changed

+137
-117
lines changed

‎binaries/pom.xml‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,24 @@
8383
</archive>
8484
</configuration>
8585
</plugin>
86+
<plugin>
87+
<groupId>org.apache.maven.plugins</groupId>
88+
<artifactId>maven-javadoc-plugin</artifactId>
89+
<configuration>
90+
<tags combine.children="append">
91+
<tag>
92+
<name>field</name>
93+
<placement>f</placement>
94+
<head>Native field</head>
95+
</tag>
96+
<tag>
97+
<name>method</name>
98+
<placement>m</placement>
99+
<head>Native method</head>
100+
</tag>
101+
</tags>
102+
</configuration>
103+
</plugin>
86104
</plugins>
87105
</build>
88106

‎bundles/org.eclipse.swt/Eclipse SWT Accessibility/cocoa/org/eclipse/swt/accessibility/Accessible.java‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1351,7 +1351,7 @@ public id internal_accessibilityFocusedUIElement(int childID) {
13511351
* You can assume the point has already been determined to lie within the receiver.
13521352
* Override this method to do deeper hit testing within a UIElement - e.g. a NSMatrix
13531353
* would test its cells. The point is bottom-left relative screen coordinates.
1354-
*
1354+
* <p>
13551355
* <b>IMPORTANT:</b> This field is <em>not</em> part of the SWT
13561356
* public API. It is marked public only so that it can be shared
13571357
* within the packages provided by SWT. It is not available on all
@@ -1393,7 +1393,7 @@ public id internal_accessibilityHitTest(NSPoint point, int childID) {
13931393
* Return YES if the UIElement doesn't show up to the outside world -
13941394
* i.e. its parent should return the UIElement's children as its own -
13951395
* cutting the UIElement out. E.g. NSControls are ignored when they are single-celled.
1396-
*
1396+
* <p>
13971397
* <b>IMPORTANT:</b> This field is <em>not</em> part of the SWT
13981398
* public API. It is marked public only so that it can be shared
13991399
* within the packages provided by SWT. It is not available on all
@@ -1422,7 +1422,7 @@ public boolean internal_accessibilityIsIgnored(int childID) {
14221422

14231423
/**
14241424
* Return the array of supported attributes that take parameters.
1425-
*
1425+
* <p>
14261426
* <b>IMPORTANT:</b> This field is <em>not</em> part of the SWT
14271427
* public API. It is marked public only so that it can be shared
14281428
* within the packages provided by SWT. It is not available on all
@@ -1484,7 +1484,7 @@ public NSArray internal_accessibilityParameterizedAttributeNames(int childID) {
14841484

14851485
/**
14861486
* Performs the specified action.
1487-
*
1487+
* <p>
14881488
* <b>IMPORTANT:</b> This field is <em>not</em> part of the SWT
14891489
* public API. It is marked public only so that it can be shared
14901490
* within the packages provided by SWT. It is not available on all
@@ -1530,7 +1530,7 @@ public boolean internal_accessibilityPerformAction(NSString action, int childID)
15301530
/**
15311531
* Set the value of the specified attribute to the given value.
15321532
* Unsupported attributes are ignored.
1533-
*
1533+
* <p>
15341534
* <b>IMPORTANT:</b> This field is <em>not</em> part of the SWT
15351535
* public API. It is marked public only so that it can be shared
15361536
* within the packages provided by SWT. It is not available on all

‎bundles/org.eclipse.swt/Eclipse SWT PI/gtk/org/eclipse/swt/internal/gtk/GTK.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,7 @@ public class GTK extends OS {
185185
public static final byte[] gtk_application_prefer_dark_theme = OS.ascii("gtk-application-prefer-dark-theme");
186186

187187
/** Named icons.
188-
* See https://docs.google.com/spreadsheet/pub?key=0AsPAM3pPwxagdGF4THNMMUpjUW5xMXZfdUNzMXhEa2c&output=html
188+
* See https://docs.google.com/spreadsheet/pub?key=0AsPAM3pPwxagdGF4THNMMUpjUW5xMXZfdUNzMXhEa2c&amp;output=html
189189
* See http://standards.freedesktop.org/icon-naming-spec/icon-naming-spec-latest.html#names
190190
* Icon preview tool: gtk3-icon-browser
191191
* Snippets often demonstrate usage of these. E.x 309, 258.

‎bundles/org.eclipse.swt/Eclipse SWT PI/gtk/org/eclipse/swt/internal/gtk/OS.java‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -741,7 +741,6 @@ public static boolean isX11 () {
741741
public static final native long G_OBJECT_CLASS_CONSTRUCTOR(long object_class);
742742
/**
743743
* @param object_class cast=(GObjectClass *)
744-
* @paramOFF constructor cast=(GObject* (*) (GType, guint, GObjectConstructParam *))
745744
*/
746745
public static final native void G_OBJECT_CLASS_SET_CONSTRUCTOR(long object_class, long constructor);
747746
/** @param xevent cast=(XEvent *) */

‎bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/internal/Converter.java‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
*
3232
* This class is tested via: org.eclipse.swt.tests.gtk.Test_GtkTextEncoding
3333
*
34-
* About JNI & string conversion:
34+
* About JNI &amp; string conversion:
3535
* #############################
3636
* - Regular JNI String conversion usually uses a modified UTF-8, see: https://en.wikipedia.org/wiki/UTF-8#Modified_UTF-8
3737
* - And in JNI, normally (env*)->GetStringUTFChars(..) is used to convert a javaString into a C string.
@@ -50,12 +50,12 @@
5050
* Java uses UTF-16 Wide characters internally to represent a string.
5151
* C uses UTF-8 Multibyte characters (null terminated) to represent a string.
5252
*
53-
* About encoding on Linux/Gtk & it's relevance to SWT:
53+
* About encoding on Linux/Gtk &amp; it's relevance to SWT:
5454
* ####################################################
5555
*
5656
* UTF-* = variable length encoding.
5757
*
58-
* UTF-8 = minimum is 8 bits, max is 6 bytes, but rarely goes beyond 4 bytes. Gtk & most of web uses this.
58+
* UTF-8 = minimum is 8 bits, max is 6 bytes, but rarely goes beyond 4 bytes. Gtk &amp; most of web uses this.
5959
* UTF-16 = minimum is 16 bits. Java's string are stored this way.
6060
* UTF-16 can be
6161
* Big Endian : 65 = 00000000 01000001 # Human friendly, reads left to right.

‎bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/internal/GDBus.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ public static class GDBusMethod {
5858
* @param inputArgs 2D array pair of Strings in the format of: (DBUS_TYPE_*, argument_name).
5959
* Where argument_name is only so that it's seen by command line by user.
6060
* @param outputArgs Same as inputArgs, but for returning values.
61-
* @param userFunction A Function<Object[],Object[]>, that you would like to run when the user calls the method over gdbus.
61+
* @param userFunction A Function&lt;Object[],Object[]&gt;, that you would like to run when the user calls the method over gdbus.
6262
* Note, input argument(s) are provided as an Object[] array. You need to cast items manually.
6363
* Output must always be an Object[] array or null. (E.g Object[] with only 1 element in it).
6464
*

‎examples/org.eclipse.swt.examples.views/src/org/eclipse/swt/examples/controls/CustomControlView.java‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,9 @@
1414
package org.eclipse.swt.examples.controls;
1515

1616

17-
import org.eclipse.swt.examples.controlexample.*;
18-
import org.eclipse.swt.widgets.*;
17+
import org.eclipse.swt.examples.controlexample.CustomControlExample;
18+
import org.eclipse.swt.widgets.Composite;
19+
import org.eclipse.ui.part.ViewPart;
1920

2021
/**
2122
* <code>CustomControls</code> is a simple demonstration
@@ -30,7 +31,7 @@ public class CustomControlView extends ControlView {
3031
/**
3132
* Create the example
3233
*
33-
* @see ViewPart#createPartControl
34+
* @see ViewPart#createPartControl(Composite)
3435
*/
3536
@Override
3637
public void createPartControl(Composite frame) {

‎examples/org.eclipse.swt.examples/src/org/eclipse/swt/examples/accessibility/CTable.java‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -60,9 +60,9 @@
6060
* instead of up-front. This can provide significant performance improvements for
6161
* tables that are very large or for which <code>TableItem</code> population is
6262
* expensive (for example, retrieving values from an external source).
63-
* </p><p>
63+
* </p>
6464
* Here is an example of using a <code>Table</code> with style <code>VIRTUAL</code>:
65-
* <code><pre>
65+
* <pre>
6666
* final Table table = new Table (parent, SWT.VIRTUAL | SWT.BORDER);
6767
* table.setItemCount (1000000);
6868
* table.addListener (SWT.SetData, new Listener () {
@@ -73,20 +73,20 @@
7373
* System.out.println (item.getText ());
7474
* }
7575
* });
76-
* </pre></code>
77-
* </p><p>
76+
* </pre>
77+
* <p>
7878
* Note that although this class is a subclass of <code>Composite</code>,
7979
* it does not normally make sense to add <code>Control</code> children to
8080
* it, or set a layout on it, unless implementing something like a cell
8181
* editor.
82-
* </p><p>
82+
* </p>
8383
* <dl>
8484
* <dt><b>Styles:</b></dt>
8585
* <dd>SINGLE, MULTI, CHECK, FULL_SELECTION, HIDE_SELECTION, VIRTUAL, NO_SCROLL</dd>
8686
* <dt><b>Events:</b></dt>
8787
* <dd>Selection, DefaultSelection, SetData, MeasureItem, EraseItem, PaintItem</dd>
8888
* </dl>
89-
* </p><p>
89+
* <p>
9090
* Note: Only one of the styles SINGLE, and MULTI may be specified.
9191
* </p><p>
9292
* IMPORTANT: This class is <em>not</em> intended to be subclassed.
@@ -3844,7 +3844,7 @@ void setHeaderImageHeight (int value) {
38443844
* it visible may not actually cause it to be displayed.
38453845
* </p>
38463846
*
3847-
* @param show the new visibility state
3847+
* @param value the new visibility state
38483848
*
38493849
* @exception SWTException <ul>
38503850
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
@@ -3970,7 +3970,7 @@ boolean setItemHeight (int value) {
39703970
* it visible may not actually cause it to be displayed.
39713971
* </p>
39723972
*
3973-
* @param show the new visibility state
3973+
* @param value the new visibility state
39743974
*
39753975
* @exception SWTException <ul>
39763976
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>

‎examples/org.eclipse.swt.examples/src/org/eclipse/swt/examples/accessibility/CTableColumn.java‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,13 +35,13 @@
3535

3636
/**
3737
* Instances of this class represent a column in a table widget.
38-
* <p><dl>
38+
* <dl>
3939
* <dt><b>Styles:</b></dt>
4040
* <dd>LEFT, RIGHT, CENTER</dd>
4141
* <dt><b>Events:</b></dt>
4242
* <dd> Move, Resize, Selection</dd>
4343
* </dl>
44-
* </p><p>
44+
* <p>
4545
* Note: Only one of the styles LEFT, RIGHT and CENTER may be specified.
4646
* </p><p>
4747
* IMPORTANT: This class is <em>not</em> intended to be subclassed.
@@ -679,7 +679,7 @@ public void setMoveable (boolean moveable) {
679679
* cannot be dragged by the user but may be resized
680680
* by the programmer.
681681
*
682-
* @param resizable the resize attribute
682+
* @param value the resize attribute
683683
*
684684
* @exception SWTException <ul>
685685
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
@@ -756,7 +756,7 @@ public void setToolTipText (String string) {
756756
/**
757757
* Sets the width of the receiver.
758758
*
759-
* @param width the new width
759+
* @param value the new width
760760
*
761761
* @exception SWTException <ul>
762762
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>

‎examples/org.eclipse.swt.examples/src/org/eclipse/swt/examples/accessibility/CTableItem.java‎

Lines changed: 19 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -553,7 +553,7 @@ public Color getBackground () {
553553
/**
554554
* Returns the background color at the given column index in the receiver.
555555
*
556-
* @param index the column index
556+
* @param columnIndex the column index
557557
* @return the background color
558558
*
559559
* @exception SWTException <ul>
@@ -605,7 +605,7 @@ Rectangle getBounds (boolean checkData) {
605605
* Returns a rectangle describing the receiver's size and location
606606
* relative to its parent at a column in the table.
607607
*
608-
* @param index the index that specifies the column
608+
* @param columnIndex the index that specifies the column
609609
* @return the receiver's bounding column rectangle
610610
*
611611
* @exception SWTException <ul>
@@ -818,7 +818,7 @@ Font getFont (boolean checkData) {
818818
* Returns the font that the receiver will use to paint textual information
819819
* for the specified cell in this item.
820820
*
821-
* @param index the column index
821+
* @param columnIndex the column index
822822
* @return the receiver's font
823823
*
824824
* @exception SWTException <ul>
@@ -869,7 +869,7 @@ public Color getForeground () {
869869
*
870870
* Returns the foreground color at the given column index in the receiver.
871871
*
872-
* @param index the column index
872+
* @param columnIndex the column index
873873
* @return the foreground color
874874
*
875875
* @exception SWTException <ul>
@@ -950,7 +950,7 @@ public Image getImage () {
950950
* Returns the image stored at the given column index in the receiver,
951951
* or null if the image has not been set or if the column does not exist.
952952
*
953-
* @param index the column index
953+
* @param columnIndex the column index
954954
* @return the image stored at the given column index in the receiver
955955
*
956956
* @exception SWTException <ul>
@@ -975,7 +975,7 @@ Image getImage (int columnIndex, boolean checkData) {
975975
* table. An empty rectangle is returned if index exceeds
976976
* the index of the table's last column.
977977
*
978-
* @param index the index that specifies the column
978+
* @param columnIndex the index that specifies the column
979979
* @return the receiver's bounding image rectangle
980980
*
981981
* @exception SWTException <ul>
@@ -1096,7 +1096,7 @@ public String getText () {
10961096
* Returns the text stored at the given column index in the receiver,
10971097
* or empty string if the text has not been set.
10981098
*
1099-
* @param index the column index
1099+
* @param columnIndex the column index
11001100
* @return the text stored at the given column index in the receiver
11011101
*
11021102
* @exception SWTException <ul>
@@ -1122,7 +1122,7 @@ String getText (int columnIndex, boolean checkData) {
11221122
* table. An empty rectangle is returned if index exceeds
11231123
* the index of the table's last column.
11241124
*
1125-
* @param index the index that specifies the column
1125+
* @param columnIndex the index that specifies the column
11261126
* @return the receiver's bounding text rectangle
11271127
*
11281128
* @exception SWTException <ul>
@@ -1653,7 +1653,7 @@ public void setBackground (Color color) {
16531653
* to the color specified by the argument, or to the default system color for the item
16541654
* if the argument is null.
16551655
*
1656-
* @param index the column index
1656+
* @param columnIndex the column index
16571657
* @param color the new color (or null)
16581658
*
16591659
* @exception IllegalArgumentException <ul>
@@ -1692,7 +1692,7 @@ public void setBackground (int columnIndex, Color color) {
16921692
* Sets the checked state of the checkbox for this item. This state change
16931693
* only applies if the Table was created with the SWT.CHECK style.
16941694
*
1695-
* @param checked the new checked state of the checkbox
1695+
* @param value the new checked state of the checkbox
16961696
*
16971697
* @exception SWTException <ul>
16981698
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
@@ -1768,7 +1768,7 @@ public void setFont (Font font) {
17681768
* argument, or to the default font for that kind of control if the
17691769
* argument is null.
17701770
*
1771-
* @param index the column index
1771+
* @param columnIndex the column index
17721772
* @param font the new font (or null)
17731773
*
17741774
* @exception IllegalArgumentException <ul>
@@ -1846,7 +1846,7 @@ public void setForeground (Color color) {
18461846
* to the color specified by the argument, or to the default system color for the item
18471847
* if the argument is null.
18481848
*
1849-
* @param index the column index
1849+
* @param columnIndex the column index
18501850
* @param color the new color (or null)
18511851
*
18521852
* @exception IllegalArgumentException <ul>
@@ -1889,7 +1889,7 @@ public void setForeground (int columnIndex, Color color) {
18891889
* Sets the grayed state of the checkbox for this item. This state change
18901890
* only applies if the Table was created with the SWT.CHECK style.
18911891
*
1892-
* @param grayed the new grayed state of the checkbox;
1892+
* @param value the new grayed state of the checkbox;
18931893
*
18941894
* @exception SWTException <ul>
18951895
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
@@ -1916,7 +1916,7 @@ public void setImage (Image value) {
19161916
/**
19171917
* Sets the image for multiple columns in the table.
19181918
*
1919-
* @param images the array of new images
1919+
* @param value the array of new images
19201920
*
19211921
* @exception IllegalArgumentException <ul>
19221922
* <li>ERROR_NULL_ARGUMENT - if the array of images is null</li>
@@ -1939,8 +1939,8 @@ public void setImage (Image[] value) {
19391939
/**
19401940
* Sets the receiver's image at a column.
19411941
*
1942-
* @param index the column index
1943-
* @param image the new image
1942+
* @param columnIndex the column index
1943+
* @param value the new image
19441944
*
19451945
* @exception IllegalArgumentException <ul>
19461946
* <li>ERROR_INVALID_ARGUMENT - if the image has been disposed</li>
@@ -2046,7 +2046,6 @@ public void setImage (int columnIndex, Image value) {
20462046
*
20472047
* @param indent the new indent
20482048
*
2049-
* </ul>
20502049
* @exception SWTException <ul>
20512050
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
20522051
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li>
@@ -2065,8 +2064,8 @@ public void setImageIndent (int indent) {
20652064
/**
20662065
* Sets the receiver's text at a column
20672066
*
2068-
* @param index the column index
2069-
* @param string the new text
2067+
* @param columnIndex the column index
2068+
* @param value the new text
20702069
*
20712070
* @exception IllegalArgumentException <ul>
20722071
* <li>ERROR_NULL_ARGUMENT - if the text is null</li>
@@ -2125,7 +2124,7 @@ public void setText (String value) {
21252124
/**
21262125
* Sets the text for multiple columns in the table.
21272126
*
2128-
* @param strings the array of new strings
2127+
* @param value the array of new strings
21292128
*
21302129
* @exception IllegalArgumentException <ul>
21312130
* <li>ERROR_NULL_ARGUMENT - if the text is null</li>

0 commit comments

Comments
 (0)