From b01e841dffbbc04054dc8de0ee9d433dc8804b25 Mon Sep 17 00:00:00 2001
From: Ilkka Seppala <iluwatar@gmail.com>
Date: Sat, 2 May 2015 23:49:33 +0300
Subject: [PATCH] Added code comments.

---
 .../src/main/java/com/iluwatar/App.java           | 15 +++++++++++++++
 .../src/main/java/com/iluwatar/Fatigue.java       |  5 +++++
 .../main/java/com/iluwatar/GiantController.java   |  5 +++++
 .../src/main/java/com/iluwatar/GiantModel.java    |  5 +++++
 .../src/main/java/com/iluwatar/GiantView.java     |  5 +++++
 .../src/main/java/com/iluwatar/Health.java        |  5 +++++
 .../src/main/java/com/iluwatar/Nourishment.java   |  5 +++++
 7 files changed, 45 insertions(+)

diff --git a/model-view-controller/src/main/java/com/iluwatar/App.java b/model-view-controller/src/main/java/com/iluwatar/App.java
index 500197aed..df54067d2 100644
--- 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
index 758cf17ee..f4712fe5f 100644
--- 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
index 534f50167..82f6c0406 100644
--- 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
index dba3c9355..94a8ac55d 100644
--- 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
index d33aa3344..12905fcb4 100644
--- 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
index c0ad1c220..993b71c68 100644
--- 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
index 55c582a7f..55301ea65 100644
--- 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");