You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@dubbo.apache.org by il...@apache.org on 2019/02/11 03:15:33 UTC

[incubator-dubbo] branch master updated: Enhance the java doc of dubbo-container module (#3437)

This is an automated email from the ASF dual-hosted git repository.

iluo pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-dubbo.git


The following commit(s) were added to refs/heads/master by this push:
     new e9e176b  Enhance the java doc of dubbo-container module (#3437)
e9e176b is described below

commit e9e176b1f11f106fbf96da6d8fc8d520871e63bb
Author: Ankit Kumar <an...@gmail.com>
AuthorDate: Mon Feb 11 08:45:27 2019 +0530

    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 ++
 .../main/java/org/apache/dubbo/container/log4j/Log4jContainer.java    | 2 ++
 .../java/org/apache/dubbo/container/logback/LogbackContainer.java     | 2 ++
 .../main/java/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 ec55295..bb3cc5c 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 eaf0c64..5ae08c2 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 ed65941..946e4c5 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 452e181..430e2e2 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 43c10fb..32f2475 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 {