From e9e176b1f11f106fbf96da6d8fc8d520871e63bb Mon Sep 17 00:00:00 2001
From: Ankit Kumar <ankitbansal.nitj@gmail.com>
Date: Mon, 11 Feb 2019 08:45:27 +0530
Subject: [PATCH] Enhance the java doc of dubbo-container module (#3437)

Fixes #2994
---
 .../src/main/java/org/apache/dubbo/container/Container.java   | 4 ++--
 .../src/main/java/org/apache/dubbo/container/Main.java        | 2 ++
 .../java/org/apache/dubbo/container/log4j/Log4jContainer.java | 2 ++
 .../org/apache/dubbo/container/logback/LogbackContainer.java  | 2 ++
 .../org/apache/dubbo/container/spring/SpringContainer.java    | 2 ++
 5 files changed, 10 insertions(+), 2 deletions(-)

diff --git a/dubbo-container/dubbo-container-api/src/main/java/org/apache/dubbo/container/Container.java b/dubbo-container/dubbo-container-api/src/main/java/org/apache/dubbo/container/Container.java
index ec552959fa..bb3cc5cc10 100644
--- a/dubbo-container/dubbo-container-api/src/main/java/org/apache/dubbo/container/Container.java
+++ b/dubbo-container/dubbo-container-api/src/main/java/org/apache/dubbo/container/Container.java
@@ -25,12 +25,12 @@ import org.apache.dubbo.common.extension.SPI;
 public interface Container {
 
     /**
-     * start.
+     * start method to load the container.
      */
     void start();
 
     /**
-     * stop.
+     * stop method to unload the container.
      */
     void stop();
 
diff --git a/dubbo-container/dubbo-container-api/src/main/java/org/apache/dubbo/container/Main.java b/dubbo-container/dubbo-container-api/src/main/java/org/apache/dubbo/container/Main.java
index eaf0c64a2a..5ae08c27af 100644
--- a/dubbo-container/dubbo-container-api/src/main/java/org/apache/dubbo/container/Main.java
+++ b/dubbo-container/dubbo-container-api/src/main/java/org/apache/dubbo/container/Main.java
@@ -33,6 +33,8 @@ import java.util.concurrent.locks.ReentrantLock;
 
 /**
  * Main. (API, Static, ThreadSafe)
+ *
+ * This class is entry point loading containers.
  */
 public class Main {
 
diff --git a/dubbo-container/dubbo-container-log4j/src/main/java/org/apache/dubbo/container/log4j/Log4jContainer.java b/dubbo-container/dubbo-container-log4j/src/main/java/org/apache/dubbo/container/log4j/Log4jContainer.java
index ed6594196f..946e4c59eb 100644
--- a/dubbo-container/dubbo-container-log4j/src/main/java/org/apache/dubbo/container/log4j/Log4jContainer.java
+++ b/dubbo-container/dubbo-container-log4j/src/main/java/org/apache/dubbo/container/log4j/Log4jContainer.java
@@ -30,6 +30,8 @@ import java.util.Properties;
 
 /**
  * Log4jContainer. (SPI, Singleton, ThreadSafe)
+ *
+ * The container class implementation for Log4j
  */
 public class Log4jContainer implements Container {
 
diff --git a/dubbo-container/dubbo-container-logback/src/main/java/org/apache/dubbo/container/logback/LogbackContainer.java b/dubbo-container/dubbo-container-logback/src/main/java/org/apache/dubbo/container/logback/LogbackContainer.java
index 452e181a53..430e2e2191 100644
--- a/dubbo-container/dubbo-container-logback/src/main/java/org/apache/dubbo/container/logback/LogbackContainer.java
+++ b/dubbo-container/dubbo-container-logback/src/main/java/org/apache/dubbo/container/logback/LogbackContainer.java
@@ -31,6 +31,8 @@ import org.slf4j.LoggerFactory;
 
 /**
  * LogbackContainer. (SPI, Singleton, ThreadSafe)
+ *
+ * The container class implementation for Logback
  */
 public class LogbackContainer implements Container {
 
diff --git a/dubbo-container/dubbo-container-spring/src/main/java/org/apache/dubbo/container/spring/SpringContainer.java b/dubbo-container/dubbo-container-spring/src/main/java/org/apache/dubbo/container/spring/SpringContainer.java
index 43c10fbb24..32f2475a07 100644
--- a/dubbo-container/dubbo-container-spring/src/main/java/org/apache/dubbo/container/spring/SpringContainer.java
+++ b/dubbo-container/dubbo-container-spring/src/main/java/org/apache/dubbo/container/spring/SpringContainer.java
@@ -26,6 +26,8 @@ import org.springframework.context.support.ClassPathXmlApplicationContext;
 
 /**
  * SpringContainer. (SPI, Singleton, ThreadSafe)
+ *
+ * The container class implementation for Spring
  */
 public class SpringContainer implements Container {