Skip to content

[Build] Activate javadoc generation and 'bree-libs' profile #2079

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 2, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/maven.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion Jenkinsfile
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
18 changes: 18 additions & 0 deletions binaries/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,24 @@
</archive>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<configuration>
<tags combine.children="append">
<tag>
<name>field</name>
<placement>f</placement>
<head>Native field</head>
</tag>
<tag>
<name>method</name>
<placement>m</placement>
<head>Native method</head>
</tag>
</tags>
</configuration>
</plugin>
</plugins>
</build>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
*
* <p>
* <b>IMPORTANT:</b> This field is <em>not</em> 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
Expand Down Expand Up @@ -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.
*
* <p>
* <b>IMPORTANT:</b> This field is <em>not</em> 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
Expand Down Expand Up @@ -1422,7 +1422,7 @@ public boolean internal_accessibilityIsIgnored(int childID) {

/**
* Return the array of supported attributes that take parameters.
*
* <p>
* <b>IMPORTANT:</b> This field is <em>not</em> 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
Expand Down Expand Up @@ -1484,7 +1484,7 @@ public NSArray internal_accessibilityParameterizedAttributeNames(int childID) {

/**
* Performs the specified action.
*
* <p>
* <b>IMPORTANT:</b> This field is <em>not</em> 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
Expand Down Expand Up @@ -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.
*
* <p>
* <b>IMPORTANT:</b> This field is <em>not</em> 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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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&amp;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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 *) */
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
*
* This class is tested via: org.eclipse.swt.tests.gtk.Test_GtkTextEncoding
*
* About JNI & string conversion:
* About JNI &amp; 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.
Expand All @@ -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 &amp; 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 &amp; 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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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<Object[],Object[]>, that you would like to run when the user calls the method over gdbus.
* @param userFunction A Function&lt;Object[],Object[]&gt;, 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).
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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;

/**
* <code>CustomControls</code> is a simple demonstration
Expand All @@ -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) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -60,9 +60,9 @@
* instead of up-front. This can provide significant performance improvements for
* tables that are very large or for which <code>TableItem</code> population is
* expensive (for example, retrieving values from an external source).
* </p><p>
* </p>
* Here is an example of using a <code>Table</code> with style <code>VIRTUAL</code>:
* <code><pre>
* <pre>
* final Table table = new Table (parent, SWT.VIRTUAL | SWT.BORDER);
* table.setItemCount (1000000);
* table.addListener (SWT.SetData, new Listener () {
Expand All @@ -73,20 +73,20 @@
* System.out.println (item.getText ());
* }
* });
* </pre></code>
* </p><p>
* </pre>
* <p>
* Note that although this class is a subclass of <code>Composite</code>,
* it does not normally make sense to add <code>Control</code> children to
* it, or set a layout on it, unless implementing something like a cell
* editor.
* </p><p>
* </p>
* <dl>
* <dt><b>Styles:</b></dt>
* <dd>SINGLE, MULTI, CHECK, FULL_SELECTION, HIDE_SELECTION, VIRTUAL, NO_SCROLL</dd>
* <dt><b>Events:</b></dt>
* <dd>Selection, DefaultSelection, SetData, MeasureItem, EraseItem, PaintItem</dd>
* </dl>
* </p><p>
* <p>
* Note: Only one of the styles SINGLE, and MULTI may be specified.
* </p><p>
* IMPORTANT: This class is <em>not</em> intended to be subclassed.
Expand Down Expand Up @@ -3844,7 +3844,7 @@ void setHeaderImageHeight (int value) {
* it visible may not actually cause it to be displayed.
* </p>
*
* @param show the new visibility state
* @param value the new visibility state
*
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
Expand Down Expand Up @@ -3970,7 +3970,7 @@ boolean setItemHeight (int value) {
* it visible may not actually cause it to be displayed.
* </p>
*
* @param show the new visibility state
* @param value the new visibility state
*
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,13 +35,13 @@

/**
* Instances of this class represent a column in a table widget.
* <p><dl>
* <dl>
* <dt><b>Styles:</b></dt>
* <dd>LEFT, RIGHT, CENTER</dd>
* <dt><b>Events:</b></dt>
* <dd> Move, Resize, Selection</dd>
* </dl>
* </p><p>
* <p>
* Note: Only one of the styles LEFT, RIGHT and CENTER may be specified.
* </p><p>
* IMPORTANT: This class is <em>not</em> intended to be subclassed.
Expand Down Expand Up @@ -679,7 +679,7 @@ public void setMoveable (boolean moveable) {
* cannot be dragged by the user but may be resized
* by the programmer.
*
* @param resizable the resize attribute
* @param value the resize attribute
*
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
Expand Down Expand Up @@ -756,7 +756,7 @@ public void setToolTipText (String string) {
/**
* Sets the width of the receiver.
*
* @param width the new width
* @param value the new width
*
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li>
Expand Down
Loading
Loading