Cleanup: Add Javadoc to all public methods and members

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

diff --git a/doc/examples/java-log4j/Hello.java b/doc/examples/java-log4j/Hello.java
index 38725cb6a7e04b9c3032497cb99b030652b2c83d..c0393392e96bea7a9d402d088b441391fdd3bdb3 100644 (file)
--- a/doc/examples/java-log4j/Hello.java
+++ b/doc/examples/java-log4j/Hello.java
@@ -24,8 +24,13 @@ import org.apache.log4j.BasicConfigurator;
 import org.apache.log4j.Logger;
 import org.lttng.ust.agent.LTTngAgent;
 
-public class Hello
-{
+/**
+ * Example application using the LTTng-UST Java JUL agent.
+ *
+ * @author Christian Babeux
+ */
+public class Hello {
+
        /* Of course :) */
        private static final int answer = 42;
 
@@ -33,8 +38,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 {
                BasicConfigurator.configure();
                lttngAgent = LTTngAgent.getLTTngAgent();