Comments for memento example.

iluwatar · iluwatar · commit 8ddcdac33ec0 · 2014-08-31T11:13:50.000+03:00
diff --git a/memento/src/main/java/com/iluwatar/App.java b/memento/src/main/java/com/iluwatar/App.java
@@ -2,6 +2,15 @@
 
 import java.util.Stack;
 
+/**
+ * 
+ * Memento pattern is for storing and restoring object
+ * state. The object (Star) gives out a "memento" 
+ * (StarMemento) that contains the state of the object. 
+ * Later on the memento can be set back to the object 
+ * restoring the state.
+ *
+ */
 public class App 
 {
     public static void main( String[] args )
diff --git a/memento/src/main/java/com/iluwatar/Star.java b/memento/src/main/java/com/iluwatar/Star.java
@@ -1,5 +1,10 @@
 package com.iluwatar;
 
+/**
+ * 
+ * Star uses "mementos" to store and restore state.
+ *
+ */
 public class Star {
 	
 	private StarType type;
diff --git a/memento/src/main/java/com/iluwatar/StarMemento.java b/memento/src/main/java/com/iluwatar/StarMemento.java
@@ -1,5 +1,10 @@
 package com.iluwatar;
 
+/**
+ * 
+ * External interface to memento.
+ *
+ */
 public interface StarMemento {
 
 }
diff --git a/memento/src/main/java/com/iluwatar/StarMementoInternal.java b/memento/src/main/java/com/iluwatar/StarMementoInternal.java
@@ -1,5 +1,10 @@
 package com.iluwatar;
 
+/**
+ * 
+ * Internal interface to memento.
+ *
+ */
 public class StarMementoInternal implements StarMemento {
 
 	private StarType type;

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,10 @@`
`1`	`1`	`package com.iluwatar;`
`2`	`2`
	`3`	`+/**`
	`4`	`+ *`
	`5`	`+ * External interface to memento.`
	`6`	`+ *`
	`7`	`+ */`
`3`	`8`	`public interface StarMemento {`
`4`	`9`
`5`	`10`	`}`