From 1b2a1fd19fb49d117ad90897a997ab64bb7c3236 Mon Sep 17 00:00:00 2001 From: Ilkka Seppala Date: Fri, 21 Aug 2015 22:54:18 +0300 Subject: [PATCH] #107 JavaDoc for Servant --- .../main/java/com/iluwatar/servant/App.java | 5 +++ .../main/java/com/iluwatar/servant/King.java | 6 ++++ .../main/java/com/iluwatar/servant/Queen.java | 6 ++++ .../java/com/iluwatar/servant/Royalty.java | 5 +++ .../java/com/iluwatar/servant/Servant.java | 6 ++++ .../java/com/iluwatar/servant/AppTest.java | 33 +++++++++++-------- 6 files changed, 47 insertions(+), 14 deletions(-) diff --git a/servant/src/main/java/com/iluwatar/servant/App.java b/servant/src/main/java/com/iluwatar/servant/App.java index 4951c7270..6a0ba6ca4 100644 --- a/servant/src/main/java/com/iluwatar/servant/App.java +++ b/servant/src/main/java/com/iluwatar/servant/App.java @@ -10,9 +10,14 @@ import java.util.ArrayList; * */ public class App { + static Servant jenkins = new Servant("Jenkins"); static Servant travis = new Servant("Travis"); + /** + * Program entry point + * @param args + */ public static void main(String[] args) { scenario(jenkins, 1); scenario(travis, 0); diff --git a/servant/src/main/java/com/iluwatar/servant/King.java b/servant/src/main/java/com/iluwatar/servant/King.java index 24aa1b870..29ec88192 100644 --- a/servant/src/main/java/com/iluwatar/servant/King.java +++ b/servant/src/main/java/com/iluwatar/servant/King.java @@ -1,6 +1,12 @@ package com.iluwatar.servant; +/** + * + * King + * + */ public class King implements Royalty { + private boolean isDrunk; private boolean isHungry = true; private boolean isHappy; diff --git a/servant/src/main/java/com/iluwatar/servant/Queen.java b/servant/src/main/java/com/iluwatar/servant/Queen.java index c581132de..815106725 100644 --- a/servant/src/main/java/com/iluwatar/servant/Queen.java +++ b/servant/src/main/java/com/iluwatar/servant/Queen.java @@ -1,6 +1,12 @@ package com.iluwatar.servant; +/** + * + * Queen + * + */ public class Queen implements Royalty { + private boolean isDrunk = true; private boolean isHungry; private boolean isHappy; diff --git a/servant/src/main/java/com/iluwatar/servant/Royalty.java b/servant/src/main/java/com/iluwatar/servant/Royalty.java index 02ebe3cce..543ffd8d5 100644 --- a/servant/src/main/java/com/iluwatar/servant/Royalty.java +++ b/servant/src/main/java/com/iluwatar/servant/Royalty.java @@ -1,5 +1,10 @@ package com.iluwatar.servant; +/** + * + * Royalty + * + */ interface Royalty { void getFed(); diff --git a/servant/src/main/java/com/iluwatar/servant/Servant.java b/servant/src/main/java/com/iluwatar/servant/Servant.java index b29e7fe20..8e61333d8 100644 --- a/servant/src/main/java/com/iluwatar/servant/Servant.java +++ b/servant/src/main/java/com/iluwatar/servant/Servant.java @@ -2,7 +2,13 @@ package com.iluwatar.servant; import java.util.ArrayList; +/** + * + * Servant + * + */ public class Servant { + public String name; public Servant(String name){ diff --git a/servant/src/test/java/com/iluwatar/servant/AppTest.java b/servant/src/test/java/com/iluwatar/servant/AppTest.java index bf6655f2a..94a12b207 100644 --- a/servant/src/test/java/com/iluwatar/servant/AppTest.java +++ b/servant/src/test/java/com/iluwatar/servant/AppTest.java @@ -1,14 +1,19 @@ -package com.iluwatar.servant; - -import org.junit.Test; - -import com.iluwatar.servant.App; - -public class AppTest { - - @Test - public void test() { - String[] args = {}; - App.main(args); - } -} +package com.iluwatar.servant; + +import org.junit.Test; + +import com.iluwatar.servant.App; + +/** + * + * Application test + * + */ +public class AppTest { + + @Test + public void test() { + String[] args = {}; + App.main(args); + } +}