docs: fix javadoc warnings

Close #182
FlowingCode · Nov 6, 2024 · f6ebfaa · f6ebfaa
1 parent e96f6e3
commit f6ebfaa
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 11 deletions.
diff --git a/src/main/java/com/flowingcode/vaadin/addons/twincolgrid/LegacyTwinColGrid.java b/src/main/java/com/flowingcode/vaadin/addons/twincolgrid/LegacyTwinColGrid.java
@@ -89,8 +89,8 @@ public LegacyTwinColGrid(String caption) {
    *
    * @param dataProvider the data provider, not {@code null}
    * @param caption the component caption
-   * @deprecated Use {@link #TwinColGrid()} and {@link #setDataProvider(ListDataProvider)}, {@link
-   *     #setCaption(String)}
+   * @deprecated Use {@link TwinColGrid#TwinColGrid()} and
+   *             {@link #setDataProvider(ListDataProvider)}, {@link #setCaption(String)}
    */
   @Deprecated
   @SuppressWarnings("unchecked")
@@ -147,7 +147,8 @@ public LegacyTwinColGrid(
    *
    * @param caption the caption to set, can be {@code null}
    * @param options the options, cannot be {@code null}
-   * @deprecated Use {@link #TwinColGrid(Collection)} and {{@link #setCaption(String)}
+   * @deprecated Use {@link TwinColGrid#TwinColGrid(Collection)} and
+   *             {{@link TwinColGrid#setCaption(String)}
    */
   @Deprecated
   @SuppressWarnings("unchecked")
@@ -338,7 +339,7 @@ public LegacyTwinColGrid<T> addSortableColumn(
    * @param itemLabelGenerator the value provider
    * @param comparator the in-memory comparator
    * @param header the column header
-   * @param header the column key
+   * @param key the column key
    * @return this instance
    */
   @Deprecated

diff --git a/src/main/java/com/flowingcode/vaadin/addons/twincolgrid/TwinColGrid.java b/src/main/java/com/flowingcode/vaadin/addons/twincolgrid/TwinColGrid.java
@@ -251,7 +251,7 @@ private void initMoveItemsByDoubleClick() {
   /**
    * Sets the component caption.
    *
-   * @param captinText the component caption.
+   * @param captionText the component caption.
    */
   public void setCaption(String captionText) {
     if (captionText != null) {
@@ -282,7 +282,7 @@ public String getCaption() {
    * Sets orientation for TwinColGridComponent
    *
    * @param orientation
-   * @return
+   * @return this instance for method chaining.
    */
   public TwinColGrid<T> withOrientation(Orientation orientation) {
     if (this.orientation != orientation) {
@@ -336,7 +336,7 @@ private Component createContainerLayout() {
 
   private String getLayoutId() {
     return Optional.ofNullable(layoutId).orElseGet(()->{
-      return this.layoutId = "twincol-" + UUID.randomUUID();
+      return layoutId = "twincol-" + UUID.randomUUID();
     });
   }
 

diff --git a/src/main/java/com/flowingcode/vaadin/addons/twincolgrid/TwinColumn.java b/src/main/java/com/flowingcode/vaadin/addons/twincolgrid/TwinColumn.java
@@ -199,9 +199,9 @@ public TwinColumn<T> setFooter(String labelText) {
    *        header of each column
    * @return this instance, for method chaining
    */
-  public TwinColumn<T> setHeader(Supplier<Component> footerComponentSupplier) {
-    availableColumn.setHeader(footerComponentSupplier.get());
-    selectionColumn.setHeader(footerComponentSupplier.get());
+  public TwinColumn<T> setHeader(Supplier<Component> headerComponentSupplier) {
+    availableColumn.setHeader(headerComponentSupplier.get());
+    selectionColumn.setHeader(headerComponentSupplier.get());
     return this;
   }
 
@@ -210,7 +210,7 @@ public TwinColumn<T> setHeader(Supplier<Component> footerComponentSupplier) {
    *
    * @see Column#setFooter(String)
    *
-   * @param footerComponentSuppleir a supplier that instantiates the component to be used in the
+   * @param footerComponentSupplier a supplier that instantiates the component to be used in the
    *        footer of each column
    * @return this instance, for method chaining
    */