iluwatar#107 RAII example JavaDoc

iluwatar · iluwatar · commit ace8b3e22fa5 · 2015-08-21T22:52:22.000+03:00
diff --git a/resource-acquisition-is-initialization/src/main/java/com/iluwatar/resource/acquisition/is/initialization/App.java b/resource-acquisition-is-initialization/src/main/java/com/iluwatar/resource/acquisition/is/initialization/App.java
@@ -5,27 +5,32 @@
  * Resource Acquisition Is Initialization pattern was developed
  * for exception safe resource management by C++ creator Bjarne
  * Stroustrup.
- * 
+ * <p>
  * In RAII resource is tied to object lifetime: resource allocation
  * is done during object creation while resource deallocation is
  * done during object destruction.
- * 
+ * <p>
  * In Java RAII is achieved with try-with-resources statement and
- * interfaces Closeable and AutoCloseable. The try-with-resources 
+ * interfaces {@link Closeable} and {@link AutoCloseable}. The try-with-resources 
  * statement ensures that each resource is closed at the end of the 
- * statement. Any object that implements java.lang.AutoCloseable, which 
- * includes all objects which implement java.io.Closeable, can be used 
+ * statement. Any object that implements {@link java.lang.AutoCloseable}, which 
+ * includes all objects which implement {@link java.io.Closeable}, can be used 
  * as a resource.
  *
- * In this example, SlidingDoor implements AutoCloseable and 
- * TreasureChest implements Closeable. Running the example, we can
+ * In this example, {@link SlidingDoor} implements {@link AutoCloseable} and 
+ * {@link TreasureChest} implements {@link Closeable}. Running the example, we can
  * observe that both resources are automatically closed.
- * 
+ * <p>
  * http://docs.oracle.com/javase/7/docs/technotes/guides/language/try-with-resources.html
  *
  */
 public class App {
 	
+	/**
+	 * Program entry point
+	 * @param args command line args
+	 * @throws Exception
+	 */
 	public static void main( String[] args ) throws Exception {
 		
     	try (SlidingDoor slidingDoor = new SlidingDoor()) {
diff --git a/resource-acquisition-is-initialization/src/test/java/com/iluwatar/resource/acquisition/is/initialization/AppTest.java b/resource-acquisition-is-initialization/src/test/java/com/iluwatar/resource/acquisition/is/initialization/AppTest.java
@@ -4,6 +4,11 @@
 
 import com.iluwatar.resource.acquisition.is.initialization.App;
 
+/**
+ * 
+ * Application test
+ *
+ */
 public class AppTest {
 
 	@Test
