Added code comments.

iluwatar · iluwatar · commit b01e841dffbb · 2015-05-02T23:49:33.000+03:00
diff --git a/model-view-controller/src/main/java/com/iluwatar/App.java b/model-view-controller/src/main/java/com/iluwatar/App.java
@@ -1,5 +1,20 @@
 package com.iluwatar;
 
+/**
+ * 
+ * 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.
+ * 
+ * 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
+ * delegates redrawing the giant to the view.
+ *
+ */
 public class App {
 	
     public static void main( String[] args ) {
diff --git a/model-view-controller/src/main/java/com/iluwatar/Fatigue.java b/model-view-controller/src/main/java/com/iluwatar/Fatigue.java
@@ -1,5 +1,10 @@
 package com.iluwatar;
 
+/**
+ * 
+ * Fatigue enumeration
+ *
+ */
 public enum Fatigue {
 
 	ALERT("alert"), TIRED("tired"), SLEEPING("sleeping");
diff --git a/model-view-controller/src/main/java/com/iluwatar/GiantController.java b/model-view-controller/src/main/java/com/iluwatar/GiantController.java
@@ -1,5 +1,10 @@
 package com.iluwatar;
 
+/**
+ * 
+ * GiantController can update the giant data and redraw it using the view.
+ *
+ */
 public class GiantController {
 
 	private GiantModel giant;
diff --git a/model-view-controller/src/main/java/com/iluwatar/GiantModel.java b/model-view-controller/src/main/java/com/iluwatar/GiantModel.java
@@ -1,5 +1,10 @@
 package com.iluwatar;
 
+/**
+ * 
+ * GiantModel contains the giant data
+ *
+ */
 public class GiantModel {
 	
 	private Health health;
diff --git a/model-view-controller/src/main/java/com/iluwatar/GiantView.java b/model-view-controller/src/main/java/com/iluwatar/GiantView.java
@@ -1,5 +1,10 @@
 package com.iluwatar;
 
+/**
+ * 
+ * GiantView displays the giant
+ *
+ */
 public class GiantView {
 
 	public void displayGiant(GiantModel giant) {
diff --git a/model-view-controller/src/main/java/com/iluwatar/Health.java b/model-view-controller/src/main/java/com/iluwatar/Health.java
@@ -1,5 +1,10 @@
 package com.iluwatar;
 
+/**
+ * 
+ * Health enumeration
+ *
+ */
 public enum Health {
 	
 	HEALTHY("healthy"), WOUNDED("wounded"), DEAD("dead");
diff --git a/model-view-controller/src/main/java/com/iluwatar/Nourishment.java b/model-view-controller/src/main/java/com/iluwatar/Nourishment.java
@@ -1,5 +1,10 @@
 package com.iluwatar;
 
+/**
+ * 
+ * Nourishment enumeration
+ *
+ */
 public enum Nourishment {
 
 	SATURATED("saturated"), HUNGRY("hungry"), STARVING("starving");
