Cleanup: Add Javadoc to all public methods and members

[lttng-ust.git] / liblttng-ust-java-agent / java / lttng-ust-agent-common / org / lttng / ust / agent / LogFrameworkSkeleton.java

diff --git a/liblttng-ust-java-agent/java/lttng-ust-agent-common/org/lttng/ust/agent/LogFrameworkSkeleton.java b/liblttng-ust-java-agent/java/lttng-ust-agent-common/org/lttng/ust/agent/LogFrameworkSkeleton.java
index 6d1ea9f68c9e85889e19db7a185588c2bc52d0a7..4a58d2e22322ec2e64702047c1a6fd06b9b28b1e 100644 (file)
--- a/liblttng-ust-java-agent/java/lttng-ust-agent-common/org/lttng/ust/agent/LogFrameworkSkeleton.java
+++ b/liblttng-ust-java-agent/java/lttng-ust-agent-common/org/lttng/ust/agent/LogFrameworkSkeleton.java
@@ -18,15 +18,23 @@
 
 package org.lttng.ust.agent;
 
-import java.util.Map;
 import java.util.HashMap;
 import java.util.Iterator;
+import java.util.Map;
 
+/**
+ * Basic implementation of LogFramework.
+ *
+ * @author Christian Babeux
+ */
 public abstract class LogFrameworkSkeleton implements LogFramework {
 
        /* A map of event name and reference count */
        private final Map<String, Integer> enabledLoggers;
 
+       /**
+        * Constructor
+        */
        public LogFrameworkSkeleton() {
                this.enabledLoggers = new HashMap<String, Integer>();
        }
@@ -88,6 +96,11 @@ public abstract class LogFrameworkSkeleton implements LogFramework {
                enabledLoggers.clear();
        }
 
+       /**
+        * Get the number of enabled events.
+        *
+        * @return The number of enabled events
+        */
        protected Integer getEventCount() {
                return enabledLoggers.size();
        }