iluwatar#107 Dependency Injection example JavaDoc

iluwatar · iluwatar · commit e71f2279f074 · 2015-08-18T22:17:16.000+03:00
diff --git a/dependency-injection/src/main/java/com/iluwatar/dependency/injection/App.java b/dependency-injection/src/main/java/com/iluwatar/dependency/injection/App.java
@@ -9,23 +9,27 @@
  * implements so called inversion of control principle. Inversion of control has two specific rules:
  *  - High-level modules should not depend on low-level modules. Both should depend on abstractions.
  *  - Abstractions should not depend on details. Details should depend on abstractions.
- *  
- *  In this example we show you three different wizards. The first one (SimpleWizard) is a naive 
+ *  <p>
+ *  In this example we show you three different wizards. The first one ({@link SimpleWizard}) is a naive 
  *  implementation violating the inversion of control principle. It depends directly on a concrete
  *  implementation which cannot be changed.
- *  
- *  The second wizard (AdvancedWizard) is more flexible. It does not depend on any concrete implementation 
- *  but abstraction. It utilizes Dependency Injection pattern allowing its Tobacco dependency to be
+ *  <p>
+ *  The second wizard ({@link AdvancedWizard}) is more flexible. It does not depend on any concrete implementation 
+ *  but abstraction. It utilizes Dependency Injection pattern allowing its {@link Tobacco} dependency to be
  *  injected through its constructor. This way, handling the dependency is no longer the wizard's
  *  responsibility. It is resolved outside the wizard class.
- *  
+ *  <p>
  *  The third example takes the pattern a step further. It uses Guice framework for Dependency Injection.
- *  TobaccoModule binds a concrete implementation to abstraction. Injector is then used to create
- *  GuiceWizard object with correct dependencies.
+ *  {@link TobaccoModule} binds a concrete implementation to abstraction. Injector is then used to create
+ *  {@link GuiceWizard} object with correct dependencies.
  *
  */
 public class App {
 	
+	/**
+	 * Program entry point
+	 * @param args command line args
+	 */
     public static void main( String[] args ) {
     	SimpleWizard simpleWizard = new SimpleWizard();
     	simpleWizard.smoke();
diff --git a/dependency-injection/src/main/java/com/iluwatar/dependency/injection/OldTobyTobacco.java b/dependency-injection/src/main/java/com/iluwatar/dependency/injection/OldTobyTobacco.java
@@ -2,7 +2,7 @@
 
 /**
  * 
- * OldTobyTobacco concrete Tobacco implementation
+ * OldTobyTobacco concrete {@link Tobacco} implementation
  *
  */
 public class OldTobyTobacco extends Tobacco {
diff --git a/dependency-injection/src/main/java/com/iluwatar/dependency/injection/RivendellTobacco.java b/dependency-injection/src/main/java/com/iluwatar/dependency/injection/RivendellTobacco.java
@@ -2,7 +2,7 @@
 
 /**
  * 
- * RivendellTobacco concrete Tobacco implementation
+ * RivendellTobacco concrete {@link Tobacco} implementation
  *
  */
 public class RivendellTobacco extends Tobacco {
diff --git a/dependency-injection/src/main/java/com/iluwatar/dependency/injection/SecondBreakfastTobacco.java b/dependency-injection/src/main/java/com/iluwatar/dependency/injection/SecondBreakfastTobacco.java
@@ -2,7 +2,7 @@
 
 /**
  * 
- * SecondBreakfastTobacco concrete Tobacco implementation
+ * SecondBreakfastTobacco concrete {@link Tobacco} implementation
  *
  */
 public class SecondBreakfastTobacco extends Tobacco {
diff --git a/dependency-injection/src/main/java/com/iluwatar/dependency/injection/TobaccoModule.java b/dependency-injection/src/main/java/com/iluwatar/dependency/injection/TobaccoModule.java
@@ -4,7 +4,7 @@
 
 /**
  * 
- * Guice module for binding certain concrete Tobacco implementation.
+ * Guice module for binding certain concrete {@link Tobacco} implementation.
  *
  */
 public class TobaccoModule extends AbstractModule {
diff --git a/dependency-injection/src/test/java/com/iluwatar/dependency/injection/AppTest.java b/dependency-injection/src/test/java/com/iluwatar/dependency/injection/AppTest.java
@@ -4,6 +4,11 @@
 
 import com.iluwatar.dependency.injection.App;
 
+/**
+ * 
+ * Application test
+ *
+ */
 public class AppTest {
 
 	@Test

Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@`
`2`	`2`
`3`	`3`	`/**`
`4`	`4`	`*`
`5`		`- * OldTobyTobacco concrete Tobacco implementation`
	`5`	`+ * OldTobyTobacco concrete {@link Tobacco} implementation`
`6`	`6`	`*`
`7`	`7`	`*/`
`8`	`8`	`public class OldTobyTobacco extends Tobacco {`
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@`
`2`	`2`
`3`	`3`	`/**`
`4`	`4`	`*`
`5`		`- * RivendellTobacco concrete Tobacco implementation`
	`5`	`+ * RivendellTobacco concrete {@link Tobacco} implementation`
`6`	`6`	`*`
`7`	`7`	`*/`
`8`	`8`	`public class RivendellTobacco extends Tobacco {`
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@`
`2`	`2`
`3`	`3`	`/**`
`4`	`4`	`*`
`5`		`- * SecondBreakfastTobacco concrete Tobacco implementation`
	`5`	`+ * SecondBreakfastTobacco concrete {@link Tobacco} implementation`
`6`	`6`	`*`
`7`	`7`	`*/`
`8`	`8`	`public class SecondBreakfastTobacco extends Tobacco {`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@`
`4`	`4`
`5`	`5`	`/**`
`6`	`6`	`*`
`7`		`- * Guice module for binding certain concrete Tobacco implementation.`
	`7`	`+ * Guice module for binding certain concrete {@link Tobacco} implementation.`
`8`	`8`	`*`
`9`	`9`	`*/`
`10`	`10`	`public class TobaccoModule extends AbstractModule {`