iluwatar#107 Improvements for Multiton JavaDoc

iluwatar · iluwatar · commit 952ebc638fa0 · 2015-08-20T22:35:57.000+03:00
diff --git a/multiton/src/main/java/com/iluwatar/multiton/App.java b/multiton/src/main/java/com/iluwatar/multiton/App.java
@@ -6,14 +6,18 @@
  * accessible object the Multiton pattern defines many globally
  * accessible objects. The client asks for the correct instance 
  * from the Multiton by passing an enumeration as parameter.
- * 
- * In this example Nazgul is the Multiton and we can ask single
- * Nazgul from it using NazgulName. The Nazguls are statically
+ * <p>
+ * In this example {@link Nazgul} is the Multiton and we can ask single
+ * {@link Nazgul} from it using {@link NazgulName}. The {@link Nazgul}s are statically
  * initialized and stored in concurrent hash map.
  *
  */
 public class App {
 	
+	/**
+	 * Program entry point
+	 * @param args command line args
+	 */
     public static void main( String[] args ) {
     	System.out.println("KHAMUL=" + Nazgul.getInstance(NazgulName.KHAMUL));
     	System.out.println("MURAZOR=" + Nazgul.getInstance(NazgulName.MURAZOR));
diff --git a/multiton/src/main/java/com/iluwatar/multiton/Nazgul.java b/multiton/src/main/java/com/iluwatar/multiton/Nazgul.java
@@ -6,7 +6,7 @@
 /**
  * 
  * Nazgul is a Multiton class. Nazgul instances can be queried
- * using getInstance() method.
+ * using {@link #getInstance} method.
  *
  */
 public class Nazgul {
diff --git a/multiton/src/main/java/com/iluwatar/multiton/NazgulName.java b/multiton/src/main/java/com/iluwatar/multiton/NazgulName.java
@@ -2,7 +2,7 @@
 
 /**
  * 
- * Each Nazgul has different NazgulName.
+ * Each Nazgul has different {@link NazgulName}.
  *
  */
 public enum NazgulName {
diff --git a/multiton/src/test/java/com/iluwatar/multiton/AppTest.java b/multiton/src/test/java/com/iluwatar/multiton/AppTest.java
@@ -4,6 +4,11 @@
 
 import com.iluwatar.multiton.App;
 
+/**
+ * 
+ * Application test
+ *
+ */
 public class AppTest {
 	
 	@Test

Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@`
`6`	`6`	`/**`
`7`	`7`	`*`
`8`	`8`	`* Nazgul is a Multiton class. Nazgul instances can be queried`
`9`		`- * using getInstance() method.`
	`9`	`+ * using {@link #getInstance} method.`
`10`	`10`	`*`
`11`	`11`	`*/`
`12`	`12`	`public class Nazgul {`
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@`
`2`	`2`
`3`	`3`	`/**`
`4`	`4`	`*`
`5`		`- * Each Nazgul has different NazgulName.`
	`5`	`+ * Each Nazgul has different {@link NazgulName}.`
`6`	`6`	`*`
`7`	`7`	`*/`
`8`	`8`	`public enum NazgulName {`