Skip to content

Commit 07ecce7

Browse files
HannesWellHannesWell
committed
Fix javadoc errors
1 parent 08d3737 commit 07ecce7

File tree

6 files changed

+28
-11
lines changed

6 files changed

+28
-11
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
*

0 commit comments

Comments
 (0)