Cleanup: Add Javadoc to all public methods and members

[deliverable/lttng-ust.git] / doc / examples / java-jul / Hello.java

diff --git a/doc/examples/java-jul/Hello.java b/doc/examples/java-jul/Hello.java
index 588ec815daf302f950ed7db355093139a6c636a3..28360c721a809bc2eae8d2c4ae8d382b3e102787 100644 (file)
--- a/doc/examples/java-jul/Hello.java
+++ b/doc/examples/java-jul/Hello.java
@@ -27,8 +27,13 @@ import java.util.logging.Logger;
  */
 import org.lttng.ust.agent.LTTngAgent;
 
-public class Hello
-{
+/**
+ * Example application using the LTTng-UST Java JUL agent.
+ *
+ * @author David Goulet
+ */
+public class Hello {
+
        /* Of course :) */
        private static final int answer = 42;
 
@@ -38,8 +43,14 @@ public class Hello
         */
        private static LTTngAgent lttngAgent;
 
-       public static void main(String args[]) throws Exception
-       {
+       /**
+        * Application start
+        *
+        * @param args
+        *            Command-line arguments
+        * @throws Exception
+        */
+       public static void main(String args[]) throws Exception {
                /*
                 * For this example, a custom "hello" logger is created. Note that JUL
                 * has a default "global" that can also be used.