Skip to content

Commit 56b1110

Browse files
javier-godoypaodb
authored andcommitted
docs: fix javadoc warnings
Close #182
1 parent e96f6e3 commit 56b1110

File tree

3 files changed

+12
-11
lines changed

3 files changed

+12
-11
lines changed

src/main/java/com/flowingcode/vaadin/addons/twincolgrid/LegacyTwinColGrid.java

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -89,8 +89,8 @@ public LegacyTwinColGrid(String caption) {
8989
*
9090
* @param dataProvider the data provider, not {@code null}
9191
* @param caption the component caption
92-
* @deprecated Use {@link #TwinColGrid()} and {@link #setDataProvider(ListDataProvider)}, {@link
93-
* #setCaption(String)}
92+
* @deprecated Use {@link TwinColGrid#TwinColGrid()} and
93+
* {@link #setDataProvider(ListDataProvider)}, {@link #setCaption(String)}
9494
*/
9595
@Deprecated
9696
@SuppressWarnings("unchecked")
@@ -147,7 +147,8 @@ public LegacyTwinColGrid(
147147
*
148148
* @param caption the caption to set, can be {@code null}
149149
* @param options the options, cannot be {@code null}
150-
* @deprecated Use {@link #TwinColGrid(Collection)} and {{@link #setCaption(String)}
150+
* @deprecated Use {@link TwinColGrid#TwinColGrid(Collection)} and
151+
* {{@link TwinColGrid#setCaption(String)}
151152
*/
152153
@Deprecated
153154
@SuppressWarnings("unchecked")
@@ -338,7 +339,7 @@ public LegacyTwinColGrid<T> addSortableColumn(
338339
* @param itemLabelGenerator the value provider
339340
* @param comparator the in-memory comparator
340341
* @param header the column header
341-
* @param header the column key
342+
* @param key the column key
342343
* @return this instance
343344
*/
344345
@Deprecated

src/main/java/com/flowingcode/vaadin/addons/twincolgrid/TwinColGrid.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -251,7 +251,7 @@ private void initMoveItemsByDoubleClick() {
251251
/**
252252
* Sets the component caption.
253253
*
254-
* @param captinText the component caption.
254+
* @param captionText the component caption.
255255
*/
256256
public void setCaption(String captionText) {
257257
if (captionText != null) {
@@ -282,7 +282,7 @@ public String getCaption() {
282282
* Sets orientation for TwinColGridComponent
283283
*
284284
* @param orientation
285-
* @return
285+
* @return this instance for method chaining.
286286
*/
287287
public TwinColGrid<T> withOrientation(Orientation orientation) {
288288
if (this.orientation != orientation) {
@@ -336,7 +336,7 @@ private Component createContainerLayout() {
336336

337337
private String getLayoutId() {
338338
return Optional.ofNullable(layoutId).orElseGet(()->{
339-
return this.layoutId = "twincol-" + UUID.randomUUID();
339+
return layoutId = "twincol-" + UUID.randomUUID();
340340
});
341341
}
342342

src/main/java/com/flowingcode/vaadin/addons/twincolgrid/TwinColumn.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -199,9 +199,9 @@ public TwinColumn<T> setFooter(String labelText) {
199199
* header of each column
200200
* @return this instance, for method chaining
201201
*/
202-
public TwinColumn<T> setHeader(Supplier<Component> footerComponentSupplier) {
203-
availableColumn.setHeader(footerComponentSupplier.get());
204-
selectionColumn.setHeader(footerComponentSupplier.get());
202+
public TwinColumn<T> setHeader(Supplier<Component> headerComponentSupplier) {
203+
availableColumn.setHeader(headerComponentSupplier.get());
204+
selectionColumn.setHeader(headerComponentSupplier.get());
205205
return this;
206206
}
207207

@@ -210,7 +210,7 @@ public TwinColumn<T> setHeader(Supplier<Component> footerComponentSupplier) {
210210
*
211211
* @see Column#setFooter(String)
212212
*
213-
* @param footerComponentSuppleir a supplier that instantiates the component to be used in the
213+
* @param footerComponentSupplier a supplier that instantiates the component to be used in the
214214
* footer of each column
215215
* @return this instance, for method chaining
216216
*/

0 commit comments

Comments
 (0)