Improved code comments for template method example.

iluwatar · iluwatar · commit b12243b94cb1 · 2015-01-16T08:52:30.000+02:00
diff --git a/template-method/src/main/java/com/iluwatar/App.java b/template-method/src/main/java/com/iluwatar/App.java
@@ -2,8 +2,11 @@
 
 /**
  * 
- * Template Method (StealingMethod) defines skeleton for the algorithm and
- * subclasses (HitAndRunMethod, SubtleMethod) fill in the blanks.
+ * Template Method defines a skeleton for an algorithm. The algorithm subclasses 
+ * provide implementation for the blank parts.
+ * 
+ * In this example HalflingThief contains StealingMethod that can be changed. 
+ * First the thief hits with HitAndRunMethod and then with SubtleMethod.
  * 
  */
 public class App {
diff --git a/template-method/src/main/java/com/iluwatar/HitAndRunMethod.java b/template-method/src/main/java/com/iluwatar/HitAndRunMethod.java
@@ -1,5 +1,10 @@
 package com.iluwatar;
 
+/**
+ * 
+ * HitAndRunMethod implementation of StealingMethod.
+ *
+ */
 public class HitAndRunMethod extends StealingMethod {
 
 	@Override
diff --git a/template-method/src/main/java/com/iluwatar/StealingMethod.java b/template-method/src/main/java/com/iluwatar/StealingMethod.java
@@ -2,7 +2,7 @@
 
 /**
  * 
- * Template Method base class.
+ * StealingMethod defines skeleton for the algorithm.
  * 
  */
 public abstract class StealingMethod {
diff --git a/template-method/src/main/java/com/iluwatar/SubtleMethod.java b/template-method/src/main/java/com/iluwatar/SubtleMethod.java
@@ -1,5 +1,10 @@
 package com.iluwatar;
 
+/**
+ * 
+ * SubtleMethod implementation of StealingMethod.
+ *
+ */
 public class SubtleMethod extends StealingMethod {
 
 	@Override

Original file line number	Diff line number	Diff line change
`@@ -2,8 +2,11 @@`
`2`	`2`
`3`	`3`	`/**`
`4`	`4`	`*`
`5`		`- * Template Method (StealingMethod) defines skeleton for the algorithm and`
`6`		`- * subclasses (HitAndRunMethod, SubtleMethod) fill in the blanks.`
	`5`	`+ * Template Method defines a skeleton for an algorithm. The algorithm subclasses`
	`6`	`+ * provide implementation for the blank parts.`
	`7`	`+ *`
	`8`	`+ * In this example HalflingThief contains StealingMethod that can be changed.`
	`9`	`+ * First the thief hits with HitAndRunMethod and then with SubtleMethod.`
`7`	`10`	`*`
`8`	`11`	`*/`
`9`	`12`	`public class App {`
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@`
`2`	`2`
`3`	`3`	`/**`
`4`	`4`	`*`
`5`		`- * Template Method base class.`
	`5`	`+ * StealingMethod defines skeleton for the algorithm.`
`6`	`6`	`*`
`7`	`7`	`*/`
`8`	`8`	`public abstract class StealingMethod {`