iluwatar#107 Improve JavaDoc for Model-View-Controller example

iluwatar · iluwatar · commit ef887e6003a4 · 2015-08-19T22:15:49.000+03:00
diff --git a/model-view-controller/src/main/java/com/iluwatar/model/view/controller/App.java b/model-view-controller/src/main/java/com/iluwatar/model/view/controller/App.java
@@ -4,19 +4,23 @@
  * 
  * Model-View-Controller is a pattern for implementing user interfaces. It divides the application
  * into three interconnected parts namely the model, the view and the controller.
- * 
+ * <p>
  * The central component of MVC, the model, captures the behavior of the application in terms of its problem 
  * domain, independent of the user interface. The model directly manages the data, logic and rules of the 
  * application. A view can be any output representation of information, such as a chart or a diagram
  * The third part, the controller, accepts input and converts it to commands for the model or view.
- * 
- * In this example we have a giant (GiantModel) with statuses for health, fatigue and nourishment. GiantView
- * can display the giant with its current status. GiantController receives input affecting the model and
+ * <p>
+ * In this example we have a giant ({@link GiantModel}) with statuses for health, fatigue and nourishment. {@link GiantView}
+ * can display the giant with its current status. {@link GiantController} receives input affecting the model and
  * delegates redrawing the giant to the view.
  *
  */
 public class App {
 	
+	/**
+	 * Program entry point
+	 * @param args command line args
+	 */
     public static void main( String[] args ) {
     	// create model, view and controller
     	GiantModel giant = new GiantModel(Health.HEALTHY, Fatigue.ALERT, Nourishment.SATURATED);
diff --git a/model-view-controller/src/test/java/com/iluwatar/model/view/controller/AppTest.java b/model-view-controller/src/test/java/com/iluwatar/model/view/controller/AppTest.java
@@ -4,6 +4,11 @@
 
 import com.iluwatar.model.view.controller.App;
 
+/**
+ * 
+ * Application test
+ *
+ */
 public class AppTest {
 	
 	@Test
