Improved comments for the facade example.

iluwatar · iluwatar · commit 2be1ced00a19 · 2014-12-06T14:43:40.000+02:00
diff --git a/facade/src/main/java/com/iluwatar/App.java b/facade/src/main/java/com/iluwatar/App.java
@@ -3,6 +3,7 @@
 /**
  * 
  * Facade (DwarvenGoldmineFacade) provides simpler interface to subsystem.
+ * http://en.wikipedia.org/wiki/Facade_pattern
  * 
  */
 public class App {
diff --git a/facade/src/main/java/com/iluwatar/DwarvenCartOperator.java b/facade/src/main/java/com/iluwatar/DwarvenCartOperator.java
@@ -1,5 +1,10 @@
 package com.iluwatar;
 
+/**
+ * 
+ * DwarvenCartOperator is one of the goldmine subsystems.
+ *
+ */
 public class DwarvenCartOperator extends DwarvenMineWorker {
 
 	@Override
diff --git a/facade/src/main/java/com/iluwatar/DwarvenGoldDigger.java b/facade/src/main/java/com/iluwatar/DwarvenGoldDigger.java
@@ -1,5 +1,10 @@
 package com.iluwatar;
 
+/**
+ * 
+ * DwarvenGoldDigger is one of the goldmine subsystems.
+ *
+ */
 public class DwarvenGoldDigger extends DwarvenMineWorker {
 
 	@Override
diff --git a/facade/src/main/java/com/iluwatar/DwarvenGoldmineFacade.java b/facade/src/main/java/com/iluwatar/DwarvenGoldmineFacade.java
@@ -3,6 +3,16 @@
 import java.util.ArrayList;
 import java.util.List;
 
+/**
+ * 
+ * DwarvenGoldmineFacade provides a single interface
+ * through which users can operate the subsystems.
+ * 
+ * This makes the goldmine easier to operate and
+ * cuts the dependencies from the goldmine user to
+ * the subsystems.
+ *
+ */
 public class DwarvenGoldmineFacade {
 
 	List<DwarvenMineWorker> workers;
diff --git a/facade/src/main/java/com/iluwatar/DwarvenMineWorker.java b/facade/src/main/java/com/iluwatar/DwarvenMineWorker.java
@@ -1,5 +1,10 @@
 package com.iluwatar;
 
+/**
+ * 
+ * DwarvenMineWorker is one of the goldmine subsystems.
+ *
+ */
 public abstract class DwarvenMineWorker {
 
 	public void goToSleep() {
diff --git a/facade/src/main/java/com/iluwatar/DwarvenTunnelDigger.java b/facade/src/main/java/com/iluwatar/DwarvenTunnelDigger.java
@@ -1,5 +1,10 @@
 package com.iluwatar;
 
+/**
+ * 
+ * DwarvenTunnelDigger is one of the goldmine subsystems.
+ *
+ */
 public class DwarvenTunnelDigger extends DwarvenMineWorker {
 
 	@Override

Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,7 @@`
`3`	`3`	`/**`
`4`	`4`	`*`
`5`	`5`	`* Facade (DwarvenGoldmineFacade) provides simpler interface to subsystem.`
	`6`	`+ * http://en.wikipedia.org/wiki/Facade_pattern`
`6`	`7`	`*`
`7`	`8`	`*/`
`8`	`9`	`public class App {`