Add class documentation

2 files changed, 13 insertions, 0 deletions

diff --git a/node-admin/src/main/java/com/yahoo/vespa/hosted/node/admin/provider/DebugHandlerHelper.java b/node-admin/src/main/java/com/yahoo/vespa/hosted/node/admin/provider/DebugHandlerHelper.java
index a1e6ab7c8be..f957ca1d3d8 100644
--- a/node-admin/src/main/java/com/yahoo/vespa/hosted/node/admin/provider/DebugHandlerHelper.java
+++ b/node-admin/src/main/java/com/yahoo/vespa/hosted/node/admin/provider/DebugHandlerHelper.java
@@ -9,6 +9,14 @@ import java.util.concurrent.ConcurrentMap;
 import java.util.function.Supplier;
 import java.util.stream.Collectors;
 
+/**
+ * Class to make it easier to implement a NodeAdminDebugHandler:
+ *  - Forward to sub-NodeAdminDebugHandlers with addHandler,
+ *  - Specify constants with addConstant
+ *  - Forwarding to methods that dynamically build debug objects with addThreadSafeSupplier.
+ *
+ * @author hakon
+ */
 @ThreadSafe
 public class DebugHandlerHelper implements NodeAdminDebugHandler {
     private Object monitor = new Object();
diff --git a/node-admin/src/main/java/com/yahoo/vespa/hosted/node/admin/provider/NodeAdminDebugHandler.java b/node-admin/src/main/java/com/yahoo/vespa/hosted/node/admin/provider/NodeAdminDebugHandler.java
index 7cd5386ecbd..4affb62650a 100644
--- a/node-admin/src/main/java/com/yahoo/vespa/hosted/node/admin/provider/NodeAdminDebugHandler.java
+++ b/node-admin/src/main/java/com/yahoo/vespa/hosted/node/admin/provider/NodeAdminDebugHandler.java
@@ -5,6 +5,11 @@ package com.yahoo.vespa.hosted.node.admin.provider;
 import javax.annotation.concurrent.ThreadSafe;
 import java.util.Map;
 
+/**
+ * Interface for supporting debug info to introspect e.g. internal state.
+ *
+ * @author hakon
+ */
 @ThreadSafe
 public interface NodeAdminDebugHandler {
     /**