diff --git a/intercepting-filter/src/main/java/com/iluwatar/intercepting/filter/App.java b/intercepting-filter/src/main/java/com/iluwatar/intercepting/filter/App.java index b597396f5..7cdb17fb8 100644 --- a/intercepting-filter/src/main/java/com/iluwatar/intercepting/filter/App.java +++ b/intercepting-filter/src/main/java/com/iluwatar/intercepting/filter/App.java @@ -2,13 +2,17 @@ package com.iluwatar.intercepting.filter; /** * - * This is an app that checks whether the order request is valid through pre-processing done via Filters - * Each field has its own corresponding Filter + * This is an app that checks whether the order request is valid through pre-processing done via {@link Filter}. + * Each field has its own corresponding {@link Filter} * @author joshzambales * */ public class App{ + /** + * Program entry point + * @param args command line args + */ public static void main(String[] args) { FilterManager filterManager = new FilterManager(new Target()); filterManager.addFilter(new NameFilter()); diff --git a/intercepting-filter/src/main/java/com/iluwatar/intercepting/filter/Client.java b/intercepting-filter/src/main/java/com/iluwatar/intercepting/filter/Client.java index 6c94af5c5..0125d1b9d 100644 --- a/intercepting-filter/src/main/java/com/iluwatar/intercepting/filter/Client.java +++ b/intercepting-filter/src/main/java/com/iluwatar/intercepting/filter/Client.java @@ -15,9 +15,9 @@ import javax.swing.JTextField; import javax.swing.SwingUtilities; /** - * The Client class is responsible for handling the input and running them through filters inside the filterManager + * The Client class is responsible for handling the input and running them through filters inside the {@link FilterManager}. * - * This is where Filters come to play as the client pre-processes the request before being displayed in the Target + * This is where {@link Filter}s come to play as the client pre-processes the request before being displayed in the {@link Target}. * * @author joshzambales * diff --git a/intercepting-filter/src/main/java/com/iluwatar/intercepting/filter/Filter.java b/intercepting-filter/src/main/java/com/iluwatar/intercepting/filter/Filter.java index 0782fddab..a71be5154 100644 --- a/intercepting-filter/src/main/java/com/iluwatar/intercepting/filter/Filter.java +++ b/intercepting-filter/src/main/java/com/iluwatar/intercepting/filter/Filter.java @@ -1,7 +1,7 @@ package com.iluwatar.intercepting.filter; /** - * Filter interface Filters perform certain tasks prior or after execution of + * Filters perform certain tasks prior or after execution of * request by request handler. In this case, before the request is handled by * the target, the request undergoes through each Filter * diff --git a/intercepting-filter/src/main/java/com/iluwatar/intercepting/filter/FilterManager.java b/intercepting-filter/src/main/java/com/iluwatar/intercepting/filter/FilterManager.java index 65c822c8a..d15df424a 100644 --- a/intercepting-filter/src/main/java/com/iluwatar/intercepting/filter/FilterManager.java +++ b/intercepting-filter/src/main/java/com/iluwatar/intercepting/filter/FilterManager.java @@ -1,7 +1,7 @@ package com.iluwatar.intercepting.filter; /** - * Filter Manager manages the filters and Filter Chain. + * Filter Manager manages the filters and {@link FilterChain}. * * @author joshzambales * diff --git a/intercepting-filter/src/main/java/com/iluwatar/intercepting/filter/NameFilter.java b/intercepting-filter/src/main/java/com/iluwatar/intercepting/filter/NameFilter.java index c9da2600a..201c68bca 100644 --- a/intercepting-filter/src/main/java/com/iluwatar/intercepting/filter/NameFilter.java +++ b/intercepting-filter/src/main/java/com/iluwatar/intercepting/filter/NameFilter.java @@ -1,7 +1,7 @@ package com.iluwatar.intercepting.filter; /** - * Concrete implementation of filter This filter checks if the input in the Name + * Concrete implementation of filter. This filter checks if the input in the Name * field is valid. (alphanumeric) * * @author joshzambales diff --git a/intercepting-filter/src/main/java/com/iluwatar/intercepting/filter/OrderFilter.java b/intercepting-filter/src/main/java/com/iluwatar/intercepting/filter/OrderFilter.java index bc86289b4..cdeaec6e0 100644 --- a/intercepting-filter/src/main/java/com/iluwatar/intercepting/filter/OrderFilter.java +++ b/intercepting-filter/src/main/java/com/iluwatar/intercepting/filter/OrderFilter.java @@ -1,7 +1,7 @@ package com.iluwatar.intercepting.filter; /** - * Concrete implementation of filter This checks for the order field + * Concrete implementation of filter. This checks for the order field. * * @author joshzambales * diff --git a/intercepting-filter/src/test/java/com/iluwatar/intercepting/filter/AppTest.java b/intercepting-filter/src/test/java/com/iluwatar/intercepting/filter/AppTest.java index b12bc8db9..9d31127a2 100644 --- a/intercepting-filter/src/test/java/com/iluwatar/intercepting/filter/AppTest.java +++ b/intercepting-filter/src/test/java/com/iluwatar/intercepting/filter/AppTest.java @@ -4,6 +4,11 @@ import org.junit.Test; import com.iluwatar.intercepting.filter.App; +/** + * + * Application test. + * + */ public class AppTest { @Test