fix #866 update javadocs

.github/workflows/deploy.yaml

@@ -1,5 +1,5 @@
 #
-# Copyright © ${year} Dominokit
+# Copyright © 2019 Dominokit
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

domino-ui-shared/src/main/java/org/dominokit/domino/ui/IsElement.java

@@ -17,12 +17,18 @@
 
 import elemental2.dom.Element;
 
-/** IsElement interface. */
+/**
+ * The {@code IsElement} interface represents an element that can be associated with an underlying
+ * DOM element.
+ *
+ * @param <E> The type of the underlying DOM element.
+ */
 public interface IsElement<E extends Element> {
+
   /**
-   * element.
+   * Gets the underlying DOM element associated with this element.
    *
-   * @return a E object.
+   * @return The underlying DOM element.
    */
   E element();
 }

domino-ui-shared/src/main/java/org/dominokit/domino/ui/MdiIconsFactory.java

@@ -17,7 +17,6 @@
 
 import java.lang.annotation.*;
 
-/** MdiIconsFactory class. */
 @Retention(RetentionPolicy.SOURCE)
 @Target(ElementType.PACKAGE)
 @Documented

domino-ui-shared/src/main/java/org/dominokit/domino/ui/mediaquery/HasMediaQueries.java

@@ -13,128 +13,139 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
 package org.dominokit.domino.ui.mediaquery;
 
-/** HasMediaQueries interface. */
+/**
+ * An interface representing an object capable of responding to various media query breakpoints. It
+ * allows the attachment of specific handlers for each breakpoint, ensuring responsive behavior
+ * across different device sizes.
+ *
+ * @param <T> The type of the implementing class.
+ */
 public interface HasMediaQueries<T> {
 
   /**
-   * onXSmall.
+   * Attaches a handler for the "extra small" media query breakpoint.
    *
-   * @param handler a {@link org.dominokit.domino.ui.mediaquery.MediaQueryHandler} object.
-   * @return a T object.
+   * @param handler The handler to be invoked at this breakpoint.
+   * @return The instance of the object implementing this interface.
    */
   T onXSmall(MediaQueryHandler<T> handler);
 
   /**
-   * onXSmallAndDown.
+   * Attaches a handler for devices that fall within the "extra small and down" media query
+   * breakpoint.
    *
-   * @param handler a {@link org.dominokit.domino.ui.mediaquery.MediaQueryHandler} object.
-   * @return a T object.
+   * @param handler The handler to be invoked for this breakpoint.
+   * @return The instance of the object implementing this interface.
    */
   T onXSmallAndDown(MediaQueryHandler<T> handler);
 
   /**
-   * onXSmallAndUp.
+   * Attaches a handler for devices that fall within the "extra small and up" media query
+   * breakpoint.
    *
-   * @param handler a {@link org.dominokit.domino.ui.mediaquery.MediaQueryHandler} object.
-   * @return a T object.
+   * @param handler The handler to be invoked for this breakpoint.
+   * @return The instance of the object implementing this interface.
    */
   T onXSmallAndUp(MediaQueryHandler<T> handler);
 
   /**
-   * onSmall.
+   * Attaches a handler for the "small" media query breakpoint.
    *
-   * @param handler a {@link org.dominokit.domino.ui.mediaquery.MediaQueryHandler} object.
-   * @return a T object.
+   * @param handler The handler to be invoked at this breakpoint.
+   * @return The instance of the object implementing this interface.
    */
   T onSmall(MediaQueryHandler<T> handler);
 
   /**
-   * onSmallAndDown.
+   * Attaches a handler for devices that fall within the "small and down" media query breakpoint.
    *
-   * @param handler a {@link org.dominokit.domino.ui.mediaquery.MediaQueryHandler} object.
-   * @return a T object.
+   * @param handler The handler to be invoked for this breakpoint.
+   * @return The instance of the object implementing this interface.
    */
   T onSmallAndDown(MediaQueryHandler<T> handler);
 
   /**
-   * onSmallAndUp.
+   * Attaches a handler for devices that fall within the "small and up" media query breakpoint.
    *
-   * @param handler a {@link org.dominokit.domino.ui.mediaquery.MediaQueryHandler} object.
-   * @return a T object.
+   * @param handler The handler to be invoked for this breakpoint.
+   * @return The instance of the object implementing this interface.
    */
   T onSmallAndUp(MediaQueryHandler<T> handler);
 
   /**
-   * onMedium.
+   * Attaches a handler for the "medium" media query breakpoint.
    *
-   * @param handler a {@link org.dominokit.domino.ui.mediaquery.MediaQueryHandler} object.
-   * @return a T object.
+   * @param handler The handler to be invoked at this breakpoint.
+   * @return The instance of the object implementing this interface.
    */
   T onMedium(MediaQueryHandler<T> handler);
 
   /**
-   * onMediumAndDown.
+   * Attaches a handler for devices that fall within the "medium and down" media query breakpoint.
    *
-   * @param handler a {@link org.dominokit.domino.ui.mediaquery.MediaQueryHandler} object.
-   * @return a T object.
+   * @param handler The handler to be invoked for this breakpoint.
+   * @return The instance of the object implementing this interface.
    */
   T onMediumAndDown(MediaQueryHandler<T> handler);
 
   /**
-   * onMediumAndUp.
+   * Attaches a handler for devices that fall within the "medium and up" media query breakpoint.
    *
-   * @param handler a {@link org.dominokit.domino.ui.mediaquery.MediaQueryHandler} object.
-   * @return a T object.
+   * @param handler The handler to be invoked for this breakpoint.
+   * @return The instance of the object implementing this interface.
    */
   T onMediumAndUp(MediaQueryHandler<T> handler);
 
   /**
-   * onLarge.
+   * Attaches a handler for the "large" media query breakpoint.
    *
-   * @param handler a {@link org.dominokit.domino.ui.mediaquery.MediaQueryHandler} object.
-   * @return a T object.
+   * @param handler The handler to be invoked at this breakpoint.
+   * @return The instance of the object implementing this interface.
    */
   T onLarge(MediaQueryHandler<T> handler);
 
   /**
-   * onLargeAndDown.
+   * Attaches a handler for devices that fall within the "large and down" media query breakpoint.
    *
-   * @param handler a {@link org.dominokit.domino.ui.mediaquery.MediaQueryHandler} object.
-   * @return a T object.
+   * @param handler The handler to be invoked for this breakpoint.
+   * @return The instance of the object implementing this interface.
    */
   T onLargeAndDown(MediaQueryHandler<T> handler);
 
   /**
-   * onLargeAndUp.
+   * Attaches a handler for devices that fall within the "large and up" media query breakpoint.
    *
-   * @param handler a {@link org.dominokit.domino.ui.mediaquery.MediaQueryHandler} object.
-   * @return a T object.
+   * @param handler The handler to be invoked for this breakpoint.
+   * @return The instance of the object implementing this interface.
    */
   T onLargeAndUp(MediaQueryHandler<T> handler);
 
   /**
-   * onXLarge.
+   * Attaches a handler for the "extra large" media query breakpoint.
    *
-   * @param handler a {@link org.dominokit.domino.ui.mediaquery.MediaQueryHandler} object.
-   * @return a T object.
+   * @param handler The handler to be invoked at this breakpoint.
+   * @return The instance of the object implementing this interface.
    */
   T onXLarge(MediaQueryHandler<T> handler);
 
   /**
-   * onXLargeAndDown.
+   * Attaches a handler for devices that fall within the "extra large and down" media query
+   * breakpoint.
    *
-   * @param handler a {@link org.dominokit.domino.ui.mediaquery.MediaQueryHandler} object.
-   * @return a T object.
+   * @param handler The handler to be invoked for this breakpoint.
+   * @return The instance of the object implementing this interface.
    */
   T onXLargeAndDown(MediaQueryHandler<T> handler);
 
   /**
-   * onXLargeAndUp.
+   * Attaches a handler for devices that fall within the "extra large and up" media query
+   * breakpoint.
    *
-   * @param handler a {@link org.dominokit.domino.ui.mediaquery.MediaQueryHandler} object.
-   * @return a T object.
+   * @param handler The handler to be invoked for this breakpoint.
+   * @return The instance of the object implementing this interface.
    */
   T onXLargeAndUp(MediaQueryHandler<T> handler);
 }