Skip to content

Commit

Permalink
JavaDoc fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
hohwille committed Feb 11, 2024
1 parent ec46077 commit 2e6ee12
Show file tree
Hide file tree
Showing 7 changed files with 38 additions and 10 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ public interface UiController<V extends UiRegularWidget>

/**
* The ID of a controller should only contain ASCII letters, Latin digits, hyphens or underscores. It may also contain
* slashes ('/') or the hash sign ('#'). It must not contain '?', '&', '=', ':', ';', '\\' or ' '.
* slashes ('/') or the hash sign ('#'). It must not contain '?', '{@literal &}', '=', ':', ';', '\\' or ' '.
*
* @see #ID_ROOT
* @see #ID_PAGE
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,6 @@ default void addColumn(UiColumn<R, ?> column) {
/**
* @param <V> type of the cell values of the {@link UiColumn}.
* @param property the {@link PropertyPath property} of the row data.
* @param index the index where to add the new column.
* @return the new {@link UiColumn}.
* @throws RuntimeException if the given {@code property} does not belong to the data model of this data widget.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@
package io.github.mmm.ui.api.widget.form;

import io.github.mmm.ui.api.factory.UiWidgetFactoryNative;
import io.github.mmm.ui.api.widget.AbstractUiCustomWidget;

/**
* {@link AbstractUiCustomWidget} that is a {@link UiFormPanel}.
* {@link UiCustomCompositeInput} that is a {@link UiHorizontalInput}.
*
* @param <V> type of the {@link #getValue() value}.
* @since 1.0.0
*/
public class UiCustomHorizontalInput<V> extends UiCustomCompositeInput<V, UiHorizontalInput<V>> implements UiHorizontalInput<V> {
public class UiCustomHorizontalInput<V> extends UiCustomCompositeInput<V, UiHorizontalInput<V>>
implements UiHorizontalInput<V> {

/**
* The constructor.
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
/* Copyright (c) The m-m-m Team, Licensed under the Apache License, Version 2.0
* http://www.apache.org/licenses/LICENSE-2.0 */
package io.github.mmm.ui.api.widget.form;

import io.github.mmm.ui.api.factory.UiWidgetFactoryNative;

/**
* {@link UiCustomCompositeInput} that is a {@link UiVerticalInput}.
*
* @param <V> type of the {@link #getValue() value}.
* @since 1.0.0
*/
public class UiCustomVerticalInput<V> extends UiCustomCompositeInput<V, UiVerticalInput<V>>
implements UiVerticalInput<V> {

/**
* The constructor.
*/
public UiCustomVerticalInput() {

super(UiWidgetFactoryNative.get().create(UiVerticalInput.class));
}

/**
* The constructor.
*
* @param delegate the {@link UiHorizontalInput}.
*/
public UiCustomVerticalInput(UiVerticalInput<V> delegate) {

super(delegate);
}

}
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
* http://www.apache.org/licenses/LICENSE-2.0 */
package io.github.mmm.ui.api.widget.form;

import io.github.mmm.ui.api.attribute.AttributeWriteValueForUser;
import io.github.mmm.ui.api.binding.UiValueBinding;
import io.github.mmm.ui.api.factory.UiWidgetFactoryNative;
import io.github.mmm.ui.api.widget.UiNativeWidget;
Expand Down Expand Up @@ -34,7 +33,6 @@ static UiFormPanel<Void> of() {

/**
* @param <V> type of the {@link #getValue() value}.
* @param binding the {@link AttributeWriteValueForUser} defining how to read and write the value.
* @param children the {@link UiAbstractInput}s to add as children.
* @return the new {@link UiFormPanel}.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,6 @@ default UiMenuItem addItem(String text, UiClickEventListener listener) {

/**
* @param action the {@link UiAction} to bind.
* @param index is the {@link #getChildIndex(UiAbstractMenuEntry) index} where to insert the new {@link UiMenuItem}.
* @return the created and added {@link UiMenuItem}.
*/
default UiMenuItem addItem(UiAction action) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,6 @@ public interface UiPopupNotifier extends UiNotifier {
* flexible but also the most inconvenient {@code showPopup} method variant.
*
* @param notification the {@link UiNotification} to show.
* @param actions are the {@link UiAction}s for the buttons to close (answer, confirm, or cancel) the popup. Has to be
* at least one {@link UiAction}.
* @return the {@link UiPopup}.
*/
default UiPopup createPopupOk(UiNotification notification) {
Expand Down

0 comments on commit 2e6ee12

Please sign in to comment.