iluwatar#107 JavaDoc for Service Layer

iluwatar · iluwatar · commit 488e5dd28161 · 2015-08-21T22:57:24.000+03:00
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
@@ -18,23 +18,27 @@
 /**
  * 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 
  * with the application to access and manipulate its data and invoke its business logic. The 
  * 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
@@ -9,7 +9,7 @@
 
 /**
  * 
- * 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
@@ -4,6 +4,11 @@
 
 import com.iluwatar.servicelayer.app.App;
 
+/**
+ * 
+ * Application test
+ *
+ */
 public class AppTest {
 	
 	@Test

Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@`
`9`	`9`
`10`	`10`	`/**`
`11`	`11`	`*`
`12`		`- * Produces the Hibernate SessionFactory.`
	`12`	`+ * Produces the Hibernate {@link SessionFactory}.`
`13`	`13`	`*`
`14`	`14`	`*/`
`15`	`15`	`public class HibernateUtil {`