From 3b12aa5cad4d64a91d72323012501dbf74bd35a5 Mon Sep 17 00:00:00 2001 From: Hannes Wellmann Date: Thu, 1 May 2025 21:29:27 +0200 Subject: [PATCH 1/2] [Build] Activate javadoc generation and 'bree-libs' profile --- .github/workflows/maven.yml | 2 +- Jenkinsfile | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/maven.yml b/.github/workflows/maven.yml index 034d6f2f673..87a935406a5 100644 --- a/.github/workflows/maven.yml +++ b/.github/workflows/maven.yml @@ -72,7 +72,7 @@ jobs: --threads 1C -DforkCount=1 '-Dnative=${{ matrix.config.native }}' - -Papi-check + -Papi-check -Pjavadoc '-Dtycho.baseline.replace=none' --fail-at-end -DskipNativeTests=false diff --git a/Jenkinsfile b/Jenkinsfile index e11010ad978..df61a78b02a 100644 --- a/Jenkinsfile +++ b/Jenkinsfile @@ -351,7 +351,7 @@ pipeline { sh ''' mvn clean verify \ --batch-mode --threads 1C -V -U -e -DforkCount=0 \ - -Papi-check \ + -Pbree-libs -Papi-check -Pjavadoc \ -Dcompare-version-with-baselines.skip=false \ -Dorg.eclipse.swt.tests.junit.disable.test_isLocal=true \ -Dmaven.test.failure.ignore=true -Dmaven.test.error.ignore=true From 6f025a614100fdc6faa838c8d1b5d2db5fcea8a3 Mon Sep 17 00:00:00 2001 From: Hannes Wellmann Date: Thu, 1 May 2025 21:56:34 +0200 Subject: [PATCH 2/2] Fix javadoc errors --- binaries/pom.xml | 18 +++++++++ .../eclipse/swt/accessibility/Accessible.java | 10 ++--- .../gtk/org/eclipse/swt/internal/gtk/GTK.java | 2 +- .../gtk/org/eclipse/swt/internal/gtk/OS.java | 1 - .../org/eclipse/swt/internal/Converter.java | 6 +-- .../gtk/org/eclipse/swt/internal/GDBus.java | 2 +- .../examples/controls/CustomControlView.java | 7 ++-- .../swt/examples/accessibility/CTable.java | 16 ++++---- .../examples/accessibility/CTableColumn.java | 8 ++-- .../examples/accessibility/CTableItem.java | 39 +++++++++---------- .../examples/addressbook/DataEntryDialog.java | 5 +-- .../swt/examples/graphics/ColorListener.java | 4 +- .../swt/examples/hoverhelp/HoverHelp.java | 3 +- .../paint/ContinuousPaintSession.java | 7 ++-- .../swt/examples/paint/DragPaintSession.java | 2 +- .../swt/examples/paint/EllipseFigure.java | 9 +++-- .../swt/examples/paint/LineFigure.java | 9 +++-- .../swt/examples/paint/PaintSurface.java | 6 +-- .../swt/examples/paint/PencilTool.java | 2 +- .../swt/examples/paint/RectangleFigure.java | 9 +++-- .../paint/RoundedRectangleFigure.java | 9 +++-- .../examples/paint/SolidPolygonFigure.java | 6 ++- .../Bug516480_KeydownRussianlayout.java | 25 ++++++------ .../tests/gtk/snippets/Bug518961_RTTest.java | 2 +- ...ug546961_Scrollbar_Slider_Popup_Shell.java | 2 +- .../Bug573697_MenuBar_CrashShellReparent.java | 2 +- .../Bug573697_MenuBar_MenuDispose.java | 2 +- .../snippets/Bug573697_MenuBar_MenuLeak.java | 2 +- ...83_TestToolbarOverflow_itemEnablement.java | 4 +- ..._JvmCrashRemovingMenuItemAccelerators.java | 5 +-- .../swt/tests/manualJUnit/MJ_Template.java | 2 +- .../swt/tests/manualJUnit/MJ_Tree.java | 2 +- .../eclipse/swt/tests/junit/SwtTestUtil.java | 1 - .../Test_org_eclipse_swt_browser_Browser.java | 6 +-- ...est_org_eclipse_swt_custom_CTabFolder.java | 4 +- .../Test_org_eclipse_swt_widgets_List.java | 8 ++-- ...st_org_eclipse_swt_widgets_MessageBox.java | 3 -- .../junit/memoryleak/Test_Memory_Leak.java | 4 +- 38 files changed, 137 insertions(+), 117 deletions(-) diff --git a/binaries/pom.xml b/binaries/pom.xml index 743ed32629c..54c2920b8f0 100644 --- a/binaries/pom.xml +++ b/binaries/pom.xml @@ -83,6 +83,24 @@ + + org.apache.maven.plugins + maven-javadoc-plugin + + + + field + f + Native field + + + method + m + Native method + + + + diff --git a/bundles/org.eclipse.swt/Eclipse SWT Accessibility/cocoa/org/eclipse/swt/accessibility/Accessible.java b/bundles/org.eclipse.swt/Eclipse SWT Accessibility/cocoa/org/eclipse/swt/accessibility/Accessible.java index ed12c5fe9d2..076654fdcf6 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT Accessibility/cocoa/org/eclipse/swt/accessibility/Accessible.java +++ b/bundles/org.eclipse.swt/Eclipse SWT Accessibility/cocoa/org/eclipse/swt/accessibility/Accessible.java @@ -1351,7 +1351,7 @@ public id internal_accessibilityFocusedUIElement(int childID) { * You can assume the point has already been determined to lie within the receiver. * Override this method to do deeper hit testing within a UIElement - e.g. a NSMatrix * would test its cells. The point is bottom-left relative screen coordinates. - * + *

* IMPORTANT: This field is not part of the SWT * public API. It is marked public only so that it can be shared * within the packages provided by SWT. It is not available on all @@ -1393,7 +1393,7 @@ public id internal_accessibilityHitTest(NSPoint point, int childID) { * Return YES if the UIElement doesn't show up to the outside world - * i.e. its parent should return the UIElement's children as its own - * cutting the UIElement out. E.g. NSControls are ignored when they are single-celled. - * + *

* IMPORTANT: This field is not part of the SWT * public API. It is marked public only so that it can be shared * within the packages provided by SWT. It is not available on all @@ -1422,7 +1422,7 @@ public boolean internal_accessibilityIsIgnored(int childID) { /** * Return the array of supported attributes that take parameters. - * + *

* IMPORTANT: This field is not part of the SWT * public API. It is marked public only so that it can be shared * within the packages provided by SWT. It is not available on all @@ -1484,7 +1484,7 @@ public NSArray internal_accessibilityParameterizedAttributeNames(int childID) { /** * Performs the specified action. - * + *

* IMPORTANT: This field is not part of the SWT * public API. It is marked public only so that it can be shared * within the packages provided by SWT. It is not available on all @@ -1530,7 +1530,7 @@ public boolean internal_accessibilityPerformAction(NSString action, int childID) /** * Set the value of the specified attribute to the given value. * Unsupported attributes are ignored. - * + *

* IMPORTANT: This field is not part of the SWT * public API. It is marked public only so that it can be shared * within the packages provided by SWT. It is not available on all diff --git a/bundles/org.eclipse.swt/Eclipse SWT PI/gtk/org/eclipse/swt/internal/gtk/GTK.java b/bundles/org.eclipse.swt/Eclipse SWT PI/gtk/org/eclipse/swt/internal/gtk/GTK.java index 29f15836b1d..a7793a09f6a 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT PI/gtk/org/eclipse/swt/internal/gtk/GTK.java +++ b/bundles/org.eclipse.swt/Eclipse SWT PI/gtk/org/eclipse/swt/internal/gtk/GTK.java @@ -185,7 +185,7 @@ public class GTK extends OS { public static final byte[] gtk_application_prefer_dark_theme = OS.ascii("gtk-application-prefer-dark-theme"); /** Named icons. - * See https://docs.google.com/spreadsheet/pub?key=0AsPAM3pPwxagdGF4THNMMUpjUW5xMXZfdUNzMXhEa2c&output=html + * See https://docs.google.com/spreadsheet/pub?key=0AsPAM3pPwxagdGF4THNMMUpjUW5xMXZfdUNzMXhEa2c&output=html * See http://standards.freedesktop.org/icon-naming-spec/icon-naming-spec-latest.html#names * Icon preview tool: gtk3-icon-browser * Snippets often demonstrate usage of these. E.x 309, 258. diff --git a/bundles/org.eclipse.swt/Eclipse SWT PI/gtk/org/eclipse/swt/internal/gtk/OS.java b/bundles/org.eclipse.swt/Eclipse SWT PI/gtk/org/eclipse/swt/internal/gtk/OS.java index 97cc31ee5d8..37601e1f413 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT PI/gtk/org/eclipse/swt/internal/gtk/OS.java +++ b/bundles/org.eclipse.swt/Eclipse SWT PI/gtk/org/eclipse/swt/internal/gtk/OS.java @@ -741,7 +741,6 @@ public static boolean isX11 () { public static final native long G_OBJECT_CLASS_CONSTRUCTOR(long object_class); /** * @param object_class cast=(GObjectClass *) - * @paramOFF constructor cast=(GObject* (*) (GType, guint, GObjectConstructParam *)) */ public static final native void G_OBJECT_CLASS_SET_CONSTRUCTOR(long object_class, long constructor); /** @param xevent cast=(XEvent *) */ diff --git a/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/internal/Converter.java b/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/internal/Converter.java index f6903657204..dc819bff0c5 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/internal/Converter.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/internal/Converter.java @@ -31,7 +31,7 @@ * * This class is tested via: org.eclipse.swt.tests.gtk.Test_GtkTextEncoding * - * About JNI & string conversion: + * About JNI & string conversion: * ############################# * - Regular JNI String conversion usually uses a modified UTF-8, see: https://en.wikipedia.org/wiki/UTF-8#Modified_UTF-8 * - And in JNI, normally (env*)->GetStringUTFChars(..) is used to convert a javaString into a C string. @@ -50,12 +50,12 @@ * Java uses UTF-16 Wide characters internally to represent a string. * C uses UTF-8 Multibyte characters (null terminated) to represent a string. * - * About encoding on Linux/Gtk & it's relevance to SWT: + * About encoding on Linux/Gtk & it's relevance to SWT: * #################################################### * * UTF-* = variable length encoding. * - * UTF-8 = minimum is 8 bits, max is 6 bytes, but rarely goes beyond 4 bytes. Gtk & most of web uses this. + * UTF-8 = minimum is 8 bits, max is 6 bytes, but rarely goes beyond 4 bytes. Gtk & most of web uses this. * UTF-16 = minimum is 16 bits. Java's string are stored this way. * UTF-16 can be * Big Endian : 65 = 00000000 01000001 # Human friendly, reads left to right. diff --git a/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/internal/GDBus.java b/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/internal/GDBus.java index 648c9ac8dcd..7cc17b2d6e1 100644 --- a/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/internal/GDBus.java +++ b/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/internal/GDBus.java @@ -58,7 +58,7 @@ public static class GDBusMethod { * @param inputArgs 2D array pair of Strings in the format of: (DBUS_TYPE_*, argument_name). * Where argument_name is only so that it's seen by command line by user. * @param outputArgs Same as inputArgs, but for returning values. - * @param userFunction A Function, that you would like to run when the user calls the method over gdbus. + * @param userFunction A Function<Object[],Object[]>, that you would like to run when the user calls the method over gdbus. * Note, input argument(s) are provided as an Object[] array. You need to cast items manually. * Output must always be an Object[] array or null. (E.g Object[] with only 1 element in it). * diff --git a/examples/org.eclipse.swt.examples.views/src/org/eclipse/swt/examples/controls/CustomControlView.java b/examples/org.eclipse.swt.examples.views/src/org/eclipse/swt/examples/controls/CustomControlView.java index a2cbd7cff2b..6f9d0d595de 100644 --- a/examples/org.eclipse.swt.examples.views/src/org/eclipse/swt/examples/controls/CustomControlView.java +++ b/examples/org.eclipse.swt.examples.views/src/org/eclipse/swt/examples/controls/CustomControlView.java @@ -14,8 +14,9 @@ package org.eclipse.swt.examples.controls; -import org.eclipse.swt.examples.controlexample.*; -import org.eclipse.swt.widgets.*; +import org.eclipse.swt.examples.controlexample.CustomControlExample; +import org.eclipse.swt.widgets.Composite; +import org.eclipse.ui.part.ViewPart; /** * CustomControls is a simple demonstration @@ -30,7 +31,7 @@ public class CustomControlView extends ControlView { /** * Create the example * - * @see ViewPart#createPartControl + * @see ViewPart#createPartControl(Composite) */ @Override public void createPartControl(Composite frame) { diff --git a/examples/org.eclipse.swt.examples/src/org/eclipse/swt/examples/accessibility/CTable.java b/examples/org.eclipse.swt.examples/src/org/eclipse/swt/examples/accessibility/CTable.java index a3c12619033..91a038532c8 100644 --- a/examples/org.eclipse.swt.examples/src/org/eclipse/swt/examples/accessibility/CTable.java +++ b/examples/org.eclipse.swt.examples/src/org/eclipse/swt/examples/accessibility/CTable.java @@ -60,9 +60,9 @@ * instead of up-front. This can provide significant performance improvements for * tables that are very large or for which TableItem population is * expensive (for example, retrieving values from an external source). - *

+ *

* Here is an example of using a Table with style VIRTUAL: - * 
+ * 
  *  final Table table = new Table (parent, SWT.VIRTUAL | SWT.BORDER);
  *  table.setItemCount (1000000);
  *  table.addListener (SWT.SetData, new Listener () {
@@ -73,20 +73,20 @@
  *          System.out.println (item.getText ());
  *      }
  *  });
- * 

- * 

+ *
+ *

* Note that although this class is a subclass of Composite, * it does not normally make sense to add Control children to * it, or set a layout on it, unless implementing something like a cell * editor. - *

+ *

*
*
Styles:
*
SINGLE, MULTI, CHECK, FULL_SELECTION, HIDE_SELECTION, VIRTUAL, NO_SCROLL
*
Events:
*
Selection, DefaultSelection, SetData, MeasureItem, EraseItem, PaintItem
*
- *

+ *

* Note: Only one of the styles SINGLE, and MULTI may be specified. *

* IMPORTANT: This class is not intended to be subclassed. @@ -3844,7 +3844,7 @@ void setHeaderImageHeight (int value) { * it visible may not actually cause it to be displayed. *

* - * @param show the new visibility state + * @param value the new visibility state * * @exception SWTException