diff --git a/build.gradle b/build.gradle index a1827fea..f09e9439 100644 --- a/build.gradle +++ b/build.gradle @@ -70,13 +70,6 @@ subprojects { testRuntimeOnly(libs.junit.launcher) } } - - // Suppress javadoc warnings for missing documentation, minor formatting issues. - javadoc { - options { - addStringOption('Xdoclint:none', '-quiet') - } - } } jreleaser { diff --git a/core/build.gradle b/core/build.gradle index cb26ed8a..9448e09b 100644 --- a/core/build.gradle +++ b/core/build.gradle @@ -7,6 +7,15 @@ description = 'A docking system for JavaFX' apply from: '../gradle/publishing.gradle' +javadoc { + options { + // Only the public API exposed in module-info.java; configure Javadoc + // to match it. + showFromPublic() + addBooleanOption('Xdoclint:all,-missing', true) + } +} + javafx { version = libs.javafx.base.get().version modules = ['javafx.controls'] diff --git a/core/src/main/java/software/coley/bentofx/building/ControlsBuilding.java b/core/src/main/java/software/coley/bentofx/building/ControlsBuilding.java index cb6043fd..0b035f81 100644 --- a/core/src/main/java/software/coley/bentofx/building/ControlsBuilding.java +++ b/core/src/main/java/software/coley/bentofx/building/ControlsBuilding.java @@ -36,6 +36,8 @@ public HeaderPaneFactory getHeaderPaneFactory() { } /** + * Sets the factory used to create {@link HeaderPane} instances. + * * @param headerPaneFactory * Factory for creating {@link HeaderPane}. * {@code null} to use the default factory. @@ -54,6 +56,8 @@ public HeadersFactory getHeadersFactory() { } /** + * Sets the factory used to create {@link Headers} instances. + * * @param headersFactory * Factory for creating {@link Headers}. * {@code null} to use the default factory. @@ -72,6 +76,8 @@ public HeaderFactory getHeaderFactory() { } /** + * Sets the factory used to create {@link Header} instances. + * * @param headerFactory * Factory for creating {@link Header}. * {@code null} to use the default factory. @@ -90,6 +96,8 @@ public ContentWrapperFactory getContentWrapperFactory() { } /** + * Sets the factory used to create {@link ContentWrapper} instances. + * * @param contentWrapperFactory * Factory for creating {@link ContentWrapper}. * {@code null} to use the default factory. @@ -108,6 +116,8 @@ public CanvasFactory getCanvasFactory() { } /** + * Sets the factory used to create {@link PixelCanvas} instances. + * * @param canvasFactory * Factory for creating {@link PixelCanvas}. * {@code null} to use the default factory. diff --git a/core/src/main/java/software/coley/bentofx/building/DockBuilding.java b/core/src/main/java/software/coley/bentofx/building/DockBuilding.java index b36ed67c..0947f9b6 100644 --- a/core/src/main/java/software/coley/bentofx/building/DockBuilding.java +++ b/core/src/main/java/software/coley/bentofx/building/DockBuilding.java @@ -19,6 +19,8 @@ public class DockBuilding { private final Bento bento; /** + * Creates a builder for the given bento instance. + * * @param bento * Parent bento instance. */ diff --git a/core/src/main/java/software/coley/bentofx/building/PlaceholderBuilding.java b/core/src/main/java/software/coley/bentofx/building/PlaceholderBuilding.java index cd1d4579..d34db5e3 100644 --- a/core/src/main/java/software/coley/bentofx/building/PlaceholderBuilding.java +++ b/core/src/main/java/software/coley/bentofx/building/PlaceholderBuilding.java @@ -28,6 +28,8 @@ public DockablePlaceholderFactory getDockablePlaceholderFactory() { } /** + * Sets the placeholder factory for dockables with no content to show. + * * @param dockablePlaceholderFactory * Placeholder factory for dockables with no content to show. */ @@ -43,6 +45,8 @@ public DockContainerLeafPlaceholderFactory getContainerPlaceholderFactory() { } /** + * Sets the placeholder factory for containers with no content to show. + * * @param containerPlaceholderFactory * Placeholder factory for containers with no content to show. */ diff --git a/core/src/main/java/software/coley/bentofx/building/StageBuilding.java b/core/src/main/java/software/coley/bentofx/building/StageBuilding.java index 26b68523..4488099f 100644 --- a/core/src/main/java/software/coley/bentofx/building/StageBuilding.java +++ b/core/src/main/java/software/coley/bentofx/building/StageBuilding.java @@ -236,6 +236,8 @@ protected void initializeFromSource(Scene sourceScene, } /** + * Sets the factory used to create new stages. + * * @param factory * New factory for creating stages. */ @@ -246,6 +248,8 @@ public void setStageFactory(@Nullable StageFactory factory) { } /** + * Sets the factory used to create new scenes. + * * @param factory * New factory for creating scenes. */ @@ -256,6 +260,8 @@ public void setSceneFactory(@Nullable SceneFactory factory) { } /** + * Sets whether newly created stages have their owner set to the source stage. + * * @param applySourceAsOwner * {@code true} to make newly created stages have their owner set to the source stage the dockable is being dragged out of. * {@code false} to not set an owner, allowing the new stage to be handled independently of the source stage. diff --git a/core/src/main/java/software/coley/bentofx/control/ButtonHBar.java b/core/src/main/java/software/coley/bentofx/control/ButtonHBar.java index 0d4fef7a..c047694b 100644 --- a/core/src/main/java/software/coley/bentofx/control/ButtonHBar.java +++ b/core/src/main/java/software/coley/bentofx/control/ButtonHBar.java @@ -15,6 +15,8 @@ */ public class ButtonHBar extends HBox { /** + * Creates a horizontal button bar whose children track the given parent's height. + * * @param parent * Parent region to bind child height to. * @param children diff --git a/core/src/main/java/software/coley/bentofx/control/ButtonVBar.java b/core/src/main/java/software/coley/bentofx/control/ButtonVBar.java index e06a0460..0b0a7486 100644 --- a/core/src/main/java/software/coley/bentofx/control/ButtonVBar.java +++ b/core/src/main/java/software/coley/bentofx/control/ButtonVBar.java @@ -15,6 +15,8 @@ */ public class ButtonVBar extends VBox { /** + * Creates a vertical button bar whose children track the given parent's width. + * * @param parent * Parent region to bind child width to. * @param children diff --git a/core/src/main/java/software/coley/bentofx/control/ContentWrapper.java b/core/src/main/java/software/coley/bentofx/control/ContentWrapper.java index f7117e58..7bf1c4fc 100644 --- a/core/src/main/java/software/coley/bentofx/control/ContentWrapper.java +++ b/core/src/main/java/software/coley/bentofx/control/ContentWrapper.java @@ -23,6 +23,8 @@ */ public class ContentWrapper extends BorderPane { /** + * Creates a content wrapper with drag-drop handling for the given container. + * * @param container * Parent container. */ diff --git a/core/src/main/java/software/coley/bentofx/control/DragDropStage.java b/core/src/main/java/software/coley/bentofx/control/DragDropStage.java index b36292b9..975d526c 100644 --- a/core/src/main/java/software/coley/bentofx/control/DragDropStage.java +++ b/core/src/main/java/software/coley/bentofx/control/DragDropStage.java @@ -25,6 +25,8 @@ public class DragDropStage extends Stage { private WeakReference content; /** + * Creates a drag-drop stage, wiring up close/hide/show handling for its content. + * * @param autoCloseWhenEmpty * Flag to determine if this stage should auto-close if its sole content is removed. * See {@link #isAutoCloseWhenEmpty()} for more details. @@ -71,11 +73,11 @@ public DragDropStage(boolean autoCloseWhenEmpty) { /** * Context:These stages are created when a user drags a {@link Header} into empty space. - *

+ *

* Most of the time, if a user drags the {@link Header} from this stage into some other place in another stage, * leaving this stage with nothing in {@link DockContainer} it would be ideal to automatically * close this window. - *

+ *

* When this is {@code true} we do just that. * * @return {@code true} when this stage should auto-close if its {@link DockContainer} is cleared/removed. diff --git a/core/src/main/java/software/coley/bentofx/control/Header.java b/core/src/main/java/software/coley/bentofx/control/Header.java index 2258fafe..0398174b 100644 --- a/core/src/main/java/software/coley/bentofx/control/Header.java +++ b/core/src/main/java/software/coley/bentofx/control/Header.java @@ -72,6 +72,8 @@ public class Header extends Region { private double insertionMidpoint = Double.NaN; /** + * Creates a header wrapping the given dockable. + * * @param dockable * Dockable to wrap. * @param parentPane diff --git a/core/src/main/java/software/coley/bentofx/control/HeaderPane.java b/core/src/main/java/software/coley/bentofx/control/HeaderPane.java index 9e1a44aa..b17ac5d2 100644 --- a/core/src/main/java/software/coley/bentofx/control/HeaderPane.java +++ b/core/src/main/java/software/coley/bentofx/control/HeaderPane.java @@ -40,6 +40,8 @@ public class HeaderPane extends BorderPane { private @Nullable Headers headers; /** + * Creates a header pane for the given container. + * * @param container * Parent container. */ diff --git a/core/src/main/java/software/coley/bentofx/control/Headers.java b/core/src/main/java/software/coley/bentofx/control/Headers.java index 0a3af456..00b24708 100644 --- a/core/src/main/java/software/coley/bentofx/control/Headers.java +++ b/core/src/main/java/software/coley/bentofx/control/Headers.java @@ -23,6 +23,8 @@ */ public class Headers extends LinearItemPane { /** + * Creates a headers pane laying out the given container's headers. + * * @param container * Parent container. * @param orientation diff --git a/core/src/main/java/software/coley/bentofx/control/LinearItemPane.java b/core/src/main/java/software/coley/bentofx/control/LinearItemPane.java index 2a53e0da..0f048eb8 100644 --- a/core/src/main/java/software/coley/bentofx/control/LinearItemPane.java +++ b/core/src/main/java/software/coley/bentofx/control/LinearItemPane.java @@ -30,6 +30,8 @@ public class LinearItemPane extends Pane { private final ObjectProperty keepInView = new SimpleObjectProperty<>(); /** + * Creates a linear item pane laid out along the given axis. + * * @param orientation * Which axis to layout children on. */ diff --git a/core/src/main/java/software/coley/bentofx/control/canvas/ArgbBufferedImageSource.java b/core/src/main/java/software/coley/bentofx/control/canvas/ArgbBufferedImageSource.java index 1db54b10..533e7426 100644 --- a/core/src/main/java/software/coley/bentofx/control/canvas/ArgbBufferedImageSource.java +++ b/core/src/main/java/software/coley/bentofx/control/canvas/ArgbBufferedImageSource.java @@ -16,6 +16,8 @@ public class ArgbBufferedImageSource implements ArgbSource { private int hash; /** + * Wraps the given image as an ARGB source. + * * @param image * Wrapped image. */ diff --git a/core/src/main/java/software/coley/bentofx/control/canvas/ArgbImageSource.java b/core/src/main/java/software/coley/bentofx/control/canvas/ArgbImageSource.java index 20caad31..34a2102b 100644 --- a/core/src/main/java/software/coley/bentofx/control/canvas/ArgbImageSource.java +++ b/core/src/main/java/software/coley/bentofx/control/canvas/ArgbImageSource.java @@ -18,6 +18,8 @@ public class ArgbImageSource implements ArgbSource { private int hash; /** + * Wraps the given image as an ARGB source. + * * @param image * Wrapped image. */ diff --git a/core/src/main/java/software/coley/bentofx/dockable/Dockable.java b/core/src/main/java/software/coley/bentofx/dockable/Dockable.java index 34a6d3c9..7b497c9a 100644 --- a/core/src/main/java/software/coley/bentofx/dockable/Dockable.java +++ b/core/src/main/java/software/coley/bentofx/dockable/Dockable.java @@ -45,6 +45,8 @@ public class Dockable implements BentoBacked, Identifiable { private @Nullable List closeListeners; /** + * Creates a dockable. + * * @param bento * Parent bento instance. * @param identifier @@ -72,6 +74,8 @@ public void fireCloseListeners() { } /** + * Runs the given action with this dockable's parent container, if one exists. + * * @param consumer * Action to run in the parent container, if one exists. */ @@ -82,6 +86,8 @@ public void inContainer(Consumer consumer) { } /** + * Runs the given action with this dockable and its parent container, if one exists. + * * @param consumer * Action to run in the parent container, if one exists. */ @@ -137,6 +143,8 @@ public StringProperty titleProperty() { } /** + * Sets the title. + * * @param title * New title. */ @@ -164,6 +172,8 @@ public ObjectProperty tooltipProperty() { } /** + * Sets the tooltip. + * * @param tooltip * New tooltip. */ @@ -190,6 +200,8 @@ public ObjectProperty iconFactoryProperty() { } /** + * Sets the icon factory. + * * @param iconFactory * New icon factory. */ @@ -217,6 +229,8 @@ public ObjectProperty contextMenuFactoryProperty() { } /** + * Sets the context menu factory. + * * @param contextMenuFactory * New context menu factory. */ @@ -244,6 +258,8 @@ public ObjectProperty nodeProperty() { } /** + * Sets the node to display when this dockable is selected. + * * @param node * New node to display when this dockable is selected. */ @@ -271,6 +287,8 @@ public ObjectProperty containerProperty() { } /** + * Sets the parent container. + * * @param container * New parent container. */ @@ -299,6 +317,8 @@ public IntegerProperty dragGroupMaskProperty() { } /** + * Sets the drag group mask. + * * @param dragGroupMask * New drag group mask. */ @@ -325,6 +345,8 @@ public BooleanProperty closableProperty() { } /** + * Sets whether this dockable is closable. + * * @param closable * {@code true} to make this dockable closable. {@code false} to disable closure. */ @@ -351,6 +373,8 @@ public BooleanProperty canBeDraggedProperty() { } /** + * Sets whether this dockable can be dragged. + * * @param canBeDragged * {@code true} to make this dockable draggable. {@code false} to make it not draggable. */ @@ -377,6 +401,8 @@ public BooleanProperty canBeDroppedToNewWindowProperty() { } /** + * Sets whether this dockable can be drag-dropped to a new window. + * * @param canBeDroppedToNewWindow * {@code true} to allow this dockable to be drag-dropped to a new window. {@code false} to limit to cross-container dragging. */ diff --git a/core/src/main/java/software/coley/bentofx/dockable/DockableCloseListener.java b/core/src/main/java/software/coley/bentofx/dockable/DockableCloseListener.java index f2f727b2..fe68b095 100644 --- a/core/src/main/java/software/coley/bentofx/dockable/DockableCloseListener.java +++ b/core/src/main/java/software/coley/bentofx/dockable/DockableCloseListener.java @@ -10,6 +10,8 @@ */ public interface DockableCloseListener { /** + * Called when the dockable is closed. + * * @param path * Path to dockable prior to closure. * @param dockable diff --git a/core/src/main/java/software/coley/bentofx/dockable/DockableDragDropBehavior.java b/core/src/main/java/software/coley/bentofx/dockable/DockableDragDropBehavior.java index cf6f2e20..ac7d6e0f 100644 --- a/core/src/main/java/software/coley/bentofx/dockable/DockableDragDropBehavior.java +++ b/core/src/main/java/software/coley/bentofx/dockable/DockableDragDropBehavior.java @@ -14,14 +14,14 @@ public interface DockableDragDropBehavior { * Determines if a given dockable can be placed into a container. * Generally this is used to control how the {@link Dockable#getDragGroupMask()} behaves. * You can override this method to support alternative grouping models. - *

+ *

* For example, the default implementation is a simple equality check. * Any dockable can be put into a container that has other dockables of the same mask. * 

{@code
 	 * return targetContainer.getDockables().stream()
 	 * 		.anyMatch(d -> d.getDragMask() == dockable.getDragMask());
 	 * }
- *

+ *

* As an alternative, you can make the mask... more like a mask! * In this example, drag groups are specified as bit-masks, allowing more fine-control over * what can go where. diff --git a/core/src/main/java/software/coley/bentofx/dockable/DockableMoveListener.java b/core/src/main/java/software/coley/bentofx/dockable/DockableMoveListener.java index e59fdb47..d3ad5dee 100644 --- a/core/src/main/java/software/coley/bentofx/dockable/DockableMoveListener.java +++ b/core/src/main/java/software/coley/bentofx/dockable/DockableMoveListener.java @@ -10,6 +10,8 @@ */ public interface DockableMoveListener { /** + * Called when the dockable is moved to a new location. + * * @param oldPath * Path to old dockable location. * @param newPath diff --git a/core/src/main/java/software/coley/bentofx/dockable/DockableOpenListener.java b/core/src/main/java/software/coley/bentofx/dockable/DockableOpenListener.java index 6ab661ab..2225110a 100644 --- a/core/src/main/java/software/coley/bentofx/dockable/DockableOpenListener.java +++ b/core/src/main/java/software/coley/bentofx/dockable/DockableOpenListener.java @@ -10,6 +10,8 @@ */ public interface DockableOpenListener { /** + * Called when the dockable is opened. + * * @param path * Path to opened dockable. * @param dockable diff --git a/core/src/main/java/software/coley/bentofx/dockable/DockableSelectListener.java b/core/src/main/java/software/coley/bentofx/dockable/DockableSelectListener.java index 10f279f8..08542637 100644 --- a/core/src/main/java/software/coley/bentofx/dockable/DockableSelectListener.java +++ b/core/src/main/java/software/coley/bentofx/dockable/DockableSelectListener.java @@ -9,6 +9,8 @@ */ public interface DockableSelectListener { /** + * Called when the dockable is selected. + * * @param path * Path to selected dockable. * @param dockable diff --git a/core/src/main/java/software/coley/bentofx/event/DockEvent.java b/core/src/main/java/software/coley/bentofx/event/DockEvent.java index 3689f3b3..26206f36 100644 --- a/core/src/main/java/software/coley/bentofx/event/DockEvent.java +++ b/core/src/main/java/software/coley/bentofx/event/DockEvent.java @@ -85,6 +85,8 @@ final class DockableClosing implements DockEvent { private boolean cancelled; /** + * Creates the event for a dockable about to be closed. + * * @param dockable * Dockable being closed. * @param container diff --git a/core/src/main/java/software/coley/bentofx/event/DockEventListener.java b/core/src/main/java/software/coley/bentofx/event/DockEventListener.java index 8b24ffa1..51aca7eb 100644 --- a/core/src/main/java/software/coley/bentofx/event/DockEventListener.java +++ b/core/src/main/java/software/coley/bentofx/event/DockEventListener.java @@ -7,6 +7,8 @@ */ public interface DockEventListener { /** + * Called when a {@link DockEvent} is fired. + * * @param event * Event fired. */ diff --git a/core/src/main/java/software/coley/bentofx/event/EventBus.java b/core/src/main/java/software/coley/bentofx/event/EventBus.java index e281b64c..e6f8d701 100644 --- a/core/src/main/java/software/coley/bentofx/event/EventBus.java +++ b/core/src/main/java/software/coley/bentofx/event/EventBus.java @@ -26,6 +26,8 @@ public class EventBus { private final List selectListeners = new CopyOnWriteArrayList<>(); /** + * Fires the given event to generic and event-specific listeners. + * * @param event * Event to fire. */ @@ -86,6 +88,8 @@ public List getEventListeners() { } /** + * Adds a generic event listener. + * * @param listener * Generic event listener to add. */ @@ -94,6 +98,8 @@ public void addEventListener(DockEventListener listener) { } /** + * {@return {@code true} if the listener was removed} + * * @param listener * Generic event listener to remove. */ @@ -109,6 +115,8 @@ public List getDockableOpenListener() { } /** + * Adds a dockable opening listener. + * * @param listener * Dockable opening listener to add. */ @@ -117,6 +125,8 @@ public void addDockableOpenListener(DockableOpenListener listener) { } /** + * {@return {@code true} if the listener was removed} + * * @param listener * Dockable opening listener to remove. */ @@ -132,6 +142,8 @@ public List getDockableMoveListener() { } /** + * Adds a dockable moving listener. + * * @param listener * Dockable moving listener to add. */ @@ -140,6 +152,8 @@ public void addDockableMoveListener(DockableMoveListener listener) { } /** + * {@return {@code true} if the listener was removed} + * * @param listener * Dockable moving listener to remove. */ @@ -155,6 +169,8 @@ public List getDockableCloseListener() { } /** + * Adds a dockable closing listener. + * * @param listener * Dockable closing listener to add. */ @@ -163,6 +179,8 @@ public void addDockableCloseListener(DockableCloseListener listener) { } /** + * {@return {@code true} if the listener was removed} + * * @param listener * Dockable closing listener to remove. */ @@ -178,6 +196,8 @@ public List getDockableSelectListener() { } /** + * Adds a dockable selecting listener. + * * @param listener * Dockable selecting listener to add. */ @@ -186,6 +206,8 @@ public void addDockableSelectListener(DockableSelectListener listener) { } /** + * {@return {@code true} if the listener was removed} + * * @param listener * Dockable selecting listener to remove. */ diff --git a/core/src/main/java/software/coley/bentofx/layout/DockContainer.java b/core/src/main/java/software/coley/bentofx/layout/DockContainer.java index b46133f6..4b45b9a7 100644 --- a/core/src/main/java/software/coley/bentofx/layout/DockContainer.java +++ b/core/src/main/java/software/coley/bentofx/layout/DockContainer.java @@ -133,6 +133,8 @@ default boolean removeFromParent() { boolean doPruneWhenEmpty(); /** + * Sets whether this container should be pruned when it has no remaining dockables. + * * @param pruneWhenEmpty * {@code true} to {@link #removeFromParent() prune} when this container has no remaining dockables. */ diff --git a/core/src/main/java/software/coley/bentofx/layout/container/DockContainerBranch.java b/core/src/main/java/software/coley/bentofx/layout/container/DockContainerBranch.java index 1763509d..a5801e98 100644 --- a/core/src/main/java/software/coley/bentofx/layout/container/DockContainerBranch.java +++ b/core/src/main/java/software/coley/bentofx/layout/container/DockContainerBranch.java @@ -35,6 +35,8 @@ public non-sealed class DockContainerBranch extends SplitPane implements DockCon private boolean pruneWhenEmpty = true; /** + * Creates a branch container. + * * @param bento * Parent bento instance. * @param identifier diff --git a/core/src/main/java/software/coley/bentofx/layout/container/DockContainerLeaf.java b/core/src/main/java/software/coley/bentofx/layout/container/DockContainerLeaf.java index dc1abc5f..60baeeb4 100644 --- a/core/src/main/java/software/coley/bentofx/layout/container/DockContainerLeaf.java +++ b/core/src/main/java/software/coley/bentofx/layout/container/DockContainerLeaf.java @@ -55,6 +55,8 @@ public non-sealed class DockContainerLeaf extends StackPane implements DockConta private boolean pruneWhenEmpty = true; /** + * Creates a leaf container. + * * @param bento * Parent bento instance. * @param identifier @@ -255,6 +257,8 @@ public void setPruneWhenEmpty(boolean pruneWhenEmpty) { } /** + * Draws a full-region overlay hint on this container's canvas. + * * @param target * Region to draw as an overlay on this container's canvas. */ @@ -263,6 +267,8 @@ public void drawCanvasHint(Region target) { } /** + * Draws an overlay hint on this container's canvas. + * * @param target * Region to draw as an overlay on this container's canvas. * @param side @@ -350,6 +356,8 @@ public boolean toggleCollapse(@Nullable Dockable selectedDockable) { } /** + * Updates the tracked size to apply once this container is uncollapsed. + * * @param size * Uncollapsed size. */ @@ -362,6 +370,8 @@ protected void updateCollapsedSize(double size) { } /** + * Sets the collapsed pseudo-state, without adjusting layout. + * * @param collapse * New collapsed state. */ @@ -428,6 +438,8 @@ public Side getSide() { } /** + * Sets the side to place {@link Header} displays on. + * * @param side * Side of this container to place {@link Header} displays on. * {@code null} to not display any headers. @@ -497,6 +509,8 @@ public ObjectProperty menuFactoryProperty() { } /** + * Sets the context menu factory for this container. + * * @param menuFactory * Menu factory for this container. */ @@ -522,6 +536,8 @@ public BooleanProperty canSplitProperty() { } /** + * Sets whether this leaf can be split via drag-n-drop operations. + * * @param canSplit * {@code true} if this leaf can be split via drag-n-drop operations. */ diff --git a/core/src/main/java/software/coley/bentofx/layout/container/DockContainerRootBranch.java b/core/src/main/java/software/coley/bentofx/layout/container/DockContainerRootBranch.java index 08ff1d25..8a00af43 100644 --- a/core/src/main/java/software/coley/bentofx/layout/container/DockContainerRootBranch.java +++ b/core/src/main/java/software/coley/bentofx/layout/container/DockContainerRootBranch.java @@ -20,6 +20,8 @@ public class DockContainerRootBranch extends DockContainerBranch { private final DockContainerPath path = new DockContainerPath(Collections.singletonList(this)); /** + * Creates a root branch container. + * * @param bento * Parent bento instance. * @param identifier diff --git a/core/src/main/java/software/coley/bentofx/search/DockableVisitor.java b/core/src/main/java/software/coley/bentofx/search/DockableVisitor.java index 385e4b4d..9bf2c825 100644 --- a/core/src/main/java/software/coley/bentofx/search/DockableVisitor.java +++ b/core/src/main/java/software/coley/bentofx/search/DockableVisitor.java @@ -15,6 +15,8 @@ public class DockableVisitor implements SearchVisitor { private @Nullable Dockable result; /** + * Creates a visitor that yields the first dockable matching the given predicate. + * * @param matcher * Dockable predicate. */ diff --git a/core/src/main/java/software/coley/bentofx/search/SearchHandler.java b/core/src/main/java/software/coley/bentofx/search/SearchHandler.java index 0335d1b1..c0a10be6 100644 --- a/core/src/main/java/software/coley/bentofx/search/SearchHandler.java +++ b/core/src/main/java/software/coley/bentofx/search/SearchHandler.java @@ -26,6 +26,8 @@ public class SearchHandler { private final Bento bento; /** + * Creates a search handler for the given bento instance. + * * @param bento * Parent bento instance. */ diff --git a/core/src/main/java/software/coley/bentofx/util/BentoUtils.java b/core/src/main/java/software/coley/bentofx/util/BentoUtils.java index 80f335d4..c3823abb 100644 --- a/core/src/main/java/software/coley/bentofx/util/BentoUtils.java +++ b/core/src/main/java/software/coley/bentofx/util/BentoUtils.java @@ -79,7 +79,7 @@ public static Side computeClosestSide(Region target, double x, double y) { /** * Find all children with the given type in the given parent. - *

+ *

* The search does not continue for children that match the type. For instance if you had five * {@link BorderPane} embedded in a row all, only the top-most {@link BorderPane} would be yielded here. * @@ -97,7 +97,7 @@ public static List getCastChildren(Parent parent, Class nodeType) { /** * Find all children with the given type in the given parent. - *

+ *

* The search does not continue for children that match the type. For instance if you had five * {@link BorderPane} embedded in a row all, only the top-most {@link BorderPane} would be yielded here. * @@ -116,7 +116,7 @@ public static List getChildren(Parent parent, Class nodeType) { /** * Find all children with the given CSS selector in the given parent. - *

+ *

* The search does not continue for children that match the selector. For instance if you had five * panes embedded in a row all with the same selector, only the top-most pane would be yielded here. * diff --git a/demos/basic/build.gradle b/demos/basic/build.gradle index f7ceda27..6df0788c 100644 --- a/demos/basic/build.gradle +++ b/demos/basic/build.gradle @@ -22,3 +22,10 @@ dependencies { compileOnly libs.jspecify } + +// Demo code isn't public API. +javadoc { + options { + addStringOption('Xdoclint:none', '-quiet') + } +}