From 488e5dd2816107f75a7d47e4641175213f0239fa Mon Sep 17 00:00:00 2001
From: Ilkka Seppala <iluwatar@gmail.com>
Date: Fri, 21 Aug 2015 22:57:24 +0300
Subject: [PATCH] #107 JavaDoc for Service Layer

---
 .../main/java/com/iluwatar/servicelayer/app/App.java | 12 ++++++++----
 .../servicelayer/hibernate/HibernateUtil.java        |  2 +-
 .../java/com/iluwatar/servicelayer/app/AppTest.java  |  5 +++++
 3 files changed, 14 insertions(+), 5 deletions(-)

diff --git a/service-layer/src/main/java/com/iluwatar/servicelayer/app/App.java b/service-layer/src/main/java/com/iluwatar/servicelayer/app/App.java
index ea0419606..2d91b43d9 100644
--- a/service-layer/src/main/java/com/iluwatar/servicelayer/app/App.java
+++ b/service-layer/src/main/java/com/iluwatar/servicelayer/app/App.java
@@ -18,7 +18,7 @@ import com.iluwatar.servicelayer.wizard.WizardDaoImpl;
 /**
  * Service layer defines an application's boundary with a layer of services that establishes 
  * a set of available operations and coordinates the application's response in each operation.
- * 
+ * <p>
  * Enterprise applications typically require different kinds of interfaces to the data 
  * they store and the logic they implement: data loaders, user interfaces, integration gateways, 
  * and others. Despite their different purposes, these interfaces often need common interactions 
@@ -26,15 +26,19 @@ import com.iluwatar.servicelayer.wizard.WizardDaoImpl;
  * interactions may be complex, involving transactions across multiple resources and the 
  * coordination of several responses to an action. Encoding the logic of the interactions 
  * separately in each interface causes a lot of duplication.
- * 
- * The example application demonstrates interactions between a client (App) and a service 
- * (MagicService). The service is implemented with 3-layer architecture (entity, dao, service).
+ * <p>
+ * The example application demonstrates interactions between a client ({@link App}) and a service 
+ * ({@link MagicService}). The service is implemented with 3-layer architecture (entity, dao, service).
  * For persistence the example uses in-memory H2 database which is populated on each application
  * startup.
  *
  */
 public class App {
 	
+	/**
+	 * Program entry point
+	 * @param args command line args
+	 */
     public static void main( String[] args ) {   
     	// populate the in-memory database
     	initData();
diff --git a/service-layer/src/main/java/com/iluwatar/servicelayer/hibernate/HibernateUtil.java b/service-layer/src/main/java/com/iluwatar/servicelayer/hibernate/HibernateUtil.java
index 922fe9f21..70d586c08 100644
--- a/service-layer/src/main/java/com/iluwatar/servicelayer/hibernate/HibernateUtil.java
+++ b/service-layer/src/main/java/com/iluwatar/servicelayer/hibernate/HibernateUtil.java
@@ -9,7 +9,7 @@ import com.iluwatar.servicelayer.wizard.Wizard;
 
 /**
  * 
- * Produces the Hibernate SessionFactory.
+ * Produces the Hibernate {@link SessionFactory}.
  *
  */
 public class HibernateUtil {
diff --git a/service-layer/src/test/java/com/iluwatar/servicelayer/app/AppTest.java b/service-layer/src/test/java/com/iluwatar/servicelayer/app/AppTest.java
index aabeb1a6c..bbf476c0b 100644
--- a/service-layer/src/test/java/com/iluwatar/servicelayer/app/AppTest.java
+++ b/service-layer/src/test/java/com/iluwatar/servicelayer/app/AppTest.java
@@ -4,6 +4,11 @@ import org.junit.Test;
 
 import com.iluwatar.servicelayer.app.App;
 
+/**
+ * 
+ * Application test
+ *
+ */
 public class AppTest {
 	
 	@Test