From 22ca6fef60c65b9b6561026282fff756d7a2cf64 Mon Sep 17 00:00:00 2001 From: Ilkka Seppala Date: Sat, 27 Dec 2014 11:11:54 +0200 Subject: [PATCH] Improved Command pattern code comments. --- command/src/main/java/com/iluwatar/App.java | 5 +++-- command/src/main/java/com/iluwatar/Command.java | 2 +- command/src/main/java/com/iluwatar/Size.java | 6 +++++- command/src/main/java/com/iluwatar/Target.java | 5 +++++ command/src/main/java/com/iluwatar/Visibility.java | 5 +++++ 5 files changed, 19 insertions(+), 4 deletions(-) diff --git a/command/src/main/java/com/iluwatar/App.java b/command/src/main/java/com/iluwatar/App.java index 9a004ec8e..382ce32ce 100644 --- a/command/src/main/java/com/iluwatar/App.java +++ b/command/src/main/java/com/iluwatar/App.java @@ -2,8 +2,9 @@ package com.iluwatar; /** * - * In Command pattern actions are objects that can be executed and undone. The - * commands in this example are spells cast by the wizard on the goblin. + * In Command pattern actions are objects that can be executed and undone. + * + * In this example the commands are the spells cast by the wizard on the goblin. * */ public class App { diff --git a/command/src/main/java/com/iluwatar/Command.java b/command/src/main/java/com/iluwatar/Command.java index ab14ca77c..da56e2268 100644 --- a/command/src/main/java/com/iluwatar/Command.java +++ b/command/src/main/java/com/iluwatar/Command.java @@ -2,7 +2,7 @@ package com.iluwatar; /** * - * Interface for spells. + * Interface for Commands. * */ public abstract class Command { diff --git a/command/src/main/java/com/iluwatar/Size.java b/command/src/main/java/com/iluwatar/Size.java index e4b342185..bdf9c5dca 100644 --- a/command/src/main/java/com/iluwatar/Size.java +++ b/command/src/main/java/com/iluwatar/Size.java @@ -1,5 +1,10 @@ package com.iluwatar; +/** + * + * Enumeration for target size. + * + */ public enum Size { SMALL, NORMAL, LARGE; @@ -24,5 +29,4 @@ public enum Size { } return s; } - } diff --git a/command/src/main/java/com/iluwatar/Target.java b/command/src/main/java/com/iluwatar/Target.java index 2ade4c3bd..46011a9a9 100644 --- a/command/src/main/java/com/iluwatar/Target.java +++ b/command/src/main/java/com/iluwatar/Target.java @@ -1,5 +1,10 @@ package com.iluwatar; +/** + * + * Base class for spell targets. + * + */ public abstract class Target { private Size size; diff --git a/command/src/main/java/com/iluwatar/Visibility.java b/command/src/main/java/com/iluwatar/Visibility.java index ec016b5f4..27f380c09 100644 --- a/command/src/main/java/com/iluwatar/Visibility.java +++ b/command/src/main/java/com/iluwatar/Visibility.java @@ -1,5 +1,10 @@ package com.iluwatar; +/** + * + * Enumeration for target visibility. + * + */ public enum Visibility { VISIBLE, INVISIBLE;