Skip to content

Commit

Permalink
fixed javadoc errors
Browse files Browse the repository at this point in the history
  • Loading branch information
tomsontom committed Mar 13, 2019
1 parent c302baf commit cfdb23a
Show file tree
Hide file tree
Showing 10 changed files with 28 additions and 71 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -713,7 +713,7 @@ public static BooleanProperty createPseudoClassProperty(String pseudoClass, Node

/**
* Run the provided runnable when the event occurs
*
* @param <E> event type
* @param r
* the runnable
* @return the event handler
Expand All @@ -727,6 +727,7 @@ public static <E extends Event> EventHandler<E> onEvent(Runnable r) {
* Run the provided supplier when the event occurs and if true is returned
* consume the event
*
* @param <E> event type
* @param r
* the supplier
* @return the event handler
Expand Down

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,8 @@ public class JFXUIProperties {
* <li>{@link TreeView}</li>
* <li>{@link TreeTableView}</li>
* </ul>
*
* @param <S> type of the source object
* @param <T> type of the value of the property
* @return the property
*/
@NonNull
Expand All @@ -49,6 +50,7 @@ public class JFXUIProperties {
}

/**
* @param <T> type of the value of the property
* @return single selection property for {@link ListView}
* @since 3.0.0
*/
Expand All @@ -58,6 +60,7 @@ public static <T> IJFXControlValueProperty<ListView<T>,T> singleListViewSelectio
}

/**
* @param <T> type of the value of the property
* @return single selection property for {@link ComboBox}
* @since 3.0.0
*/
Expand All @@ -67,6 +70,7 @@ public static <T> IJFXControlValueProperty<ComboBox<T>,T> singleComboBoxSelectio
}

/**
* @param <T> type of the value of the property
* @return single selection property for {@link TreeView}
* @since 3.0.0
*/
Expand All @@ -76,6 +80,7 @@ public static <T> IJFXControlValueProperty<TreeTableView<T>,T> singleTreeTableVi
}

/**
* @param <T> type of the value of the property
* @return single selection property for {@link TreeView}
* @since 3.0.0
*/
Expand All @@ -86,7 +91,7 @@ public static <T> IJFXControlValueProperty<TreeView<T>,T> singleTreeViewSelectio

/**
* Create a property for the text-property of a javafx bean
*
* @param <S> the source type
* @return the text property
* @since 2.4.0
*/
Expand Down Expand Up @@ -142,7 +147,7 @@ public static IJFXControlValueProperty<Tab,String> tabText() {

/**
* Create a date property of the {@link DatePicker}
*
* @param <S> the source type
* @return the property
*/
@NonNull
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,6 @@
@SuppressWarnings("javadoc")
public class ControlObservableValueDecorator<T> extends DecoratingObservableValue<T> implements IJFXControlValueObservable<T> {

/**
* @param decorated
*/
public ControlObservableValueDecorator(IObservableValue<T> decorated) {
super(decorated, true);
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ public interface FXMLBuilder<N> {

/**
* Load the FXML and return the root node and the controller
*
* @param <C> the controller type
* @return a structure holding root node and controller
* @throws IOException
* if there is a problem loading the fxml
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
/**
* Annotation to mark an injection of an {@link FXMLLoaderFactory}
*
* @Deprecated Use @LocalInstance {@link javafx.fxml.FXMLLoader} instead
* Deprecated Use @LocalInstance {@link javafx.fxml.FXMLLoader} instead
*/
@Qualifier
@Documented
Expand All @@ -34,6 +34,7 @@
/**
* If set to true the {@link ExtendedFXMLLoader} will be used and
* {@link FXMLBuilder#builderFactory(javafx.util.BuilderFactory)} is ignored
* @return <code>true</code> to use an extended loader
*/
boolean useExtendedLoader() default false;
}
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ public interface FXMLLoaderFactory {
/**
* Load the fxml file relative to the bundle the loading class is in,
* similar to pure java {@link ClassLoader#getResource(String)}
*
* @param <N> the root type
* @param relativePath
* the relative path to the bundle classpath
* @return the builder
Expand All @@ -41,7 +41,7 @@ public interface FXMLLoaderFactory {
/**
* Load the fxml file relative to the class requesting the loading, similar
* to pure java {@link Class#getResource(String)}
*
* @param <N> the root type
* @param relativePath
* the relative path from the class
* @return the builder
Expand All @@ -51,7 +51,7 @@ public interface FXMLLoaderFactory {

/**
* Load the fxml file from the given input stream
*
* @param <N> the root type
* @param stream
* the stream
* @param path
Expand All @@ -64,7 +64,7 @@ public interface FXMLLoaderFactory {

/**
* Load the fxml file from the given url
*
* @param <N> the root type
* @param url
* the url
* @return the builder
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ public abstract class InjectingFXMLLoader<N> implements FXMLBuilder<N> {

/**
* Create a loader which operates relative to the requestor
*
* @param <N> the root type
* @param context
* the di context
* @param requester
Expand All @@ -63,7 +63,7 @@ public static <N> InjectingFXMLLoader<N> create(@NonNull final IEclipseContext c
/**
* Create a loader which operates relative to the requestor and uses the
* {@link ExtendedFXMLLoader} if requested to do so
*
* @param <N> the root type
* @param context
* the di context
* @param requester
Expand Down Expand Up @@ -113,7 +113,7 @@ public N getNode() {

/**
* Create a loader which operates relative to the bundle classpath
*
* @param <N> the root type
* @param context
* the di context
* @param bundle
Expand All @@ -129,7 +129,7 @@ public static <N> InjectingFXMLLoader<N> create(@NonNull final IEclipseContext c
/**
* Create a loader which operates relative to the bundle classpath and uses
* the {@link ExtendedFXMLLoader} if requested to do so
*
* @param <N> the root type
* @param context
* the di context
* @param bundle
Expand Down Expand Up @@ -208,7 +208,7 @@ public N getNode() {

/**
* Create a loader which uses the given classloader
*
* @param <N> the root type
* @param context
* the di context
* @param classloader
Expand Down Expand Up @@ -251,7 +251,7 @@ public N getNode() {

/**
* Create a loader which uses a give classloader and reads from the stream
*
* @param <N> the root type
* @param context
* the di context
* @param classloader
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
public abstract class Util<T> {
/**
* Wrap a give callback to always run on the javafx threa
*
* @param <T> the value type
* @param callback
* the callback
* @return a wrapped callback
Expand Down Expand Up @@ -51,7 +51,7 @@ public void run() {
};
}

static abstract class SyncCallback<T> implements Callback<T> {
abstract static class SyncCallback<T> implements Callback<T> {
// nothing to to do
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,12 @@
import javafx.stage.Stage;

/**
* @param <R>
* @param <R> the result type
*/
public class TaskProgressDialog<R> extends Dialog<R> {

/**
* @param <T>
* @param <T> the value type
*/
@FunctionalInterface
public interface CancelledHandler<T> {
Expand All @@ -47,7 +47,7 @@ public interface CancelledHandler<T> {
}

/**
* @param <T>
* @param <T> the value type
*/
@FunctionalInterface
public interface FailedHandler<T> {
Expand Down

0 comments on commit cfdb23a

Please sign in to comment.