增加注释

mpusher · Aug 23, 2017 · 2657313 · 2657313
1 parent 295c402
commit 2657313
Show file tree

Hide file tree

Showing 4 changed files with 34 additions and 27 deletions.
diff --git a/mpush-api/src/main/java/com/mpush/api/common/ServerEventListener.java b/mpush-api/src/main/java/com/mpush/api/common/ServerEventListener.java
@@ -32,7 +32,7 @@ public interface ServerEventListener extends Plugin {
     /**
      * 该事件通过guava EventBus发出，实现接口的方法必须增加
      *
-     * @Subscribe 和 @AllowConcurrentEvents注解，
+     * <code>@Subscribe 和 @AllowConcurrentEvents</code>注解，
      * 并在构造函数调用EventBus.register(this);
      */
     default void on(ServerStartupEvent event) {
@@ -41,7 +41,7 @@ default void on(ServerStartupEvent event) {
     /**
      * 该事件通过guava EventBus发出，实现接口的方法必须增加
      *
-     * @Subscribe 和 @AllowConcurrentEvents注解，
+     * <code>@Subscribe 和 @AllowConcurrentEvents</code>注解，
      * 并在构造函数调用EventBus.register(this);
      */
     default void on(ServerShutdownEvent server) {
@@ -50,7 +50,7 @@ default void on(ServerShutdownEvent server) {
     /**
      * 该事件通过guava EventBus发出，实现接口的方法必须增加
      *
-     * @Subscribe 和 @AllowConcurrentEvents注解，
+     * <code>@Subscribe 和 @AllowConcurrentEvents</code>注解，
      * 并在构造函数调用EventBus.register(this);
      */
     default void on(RouterChangeEvent event) {
@@ -59,7 +59,7 @@ default void on(RouterChangeEvent event) {
     /**
      * 该事件通过guava EventBus发出，实现接口的方法必须增加
      *
-     * @Subscribe 和 @AllowConcurrentEvents注解，
+     * <code>@Subscribe 和 @AllowConcurrentEvents</code>注解，
      * 并在构造函数调用EventBus.register(this);
      */
     default void on(KickUserEvent event) {
@@ -68,7 +68,7 @@ default void on(KickUserEvent event) {
     /**
      * 该事件通过guava EventBus发出，实现接口的方法必须增加
      *
-     * @Subscribe 和 @AllowConcurrentEvents注解，
+     * <code>@Subscribe 和 @AllowConcurrentEvents</code>注解，
      * 并在构造函数调用EventBus.register(this);
      */
     default void on(UserOnlineEvent event) {
@@ -77,7 +77,7 @@ default void on(UserOnlineEvent event) {
     /**
      * 该事件通过guava EventBus发出，实现接口的方法必须增加
      *
-     * @Subscribe 和 @AllowConcurrentEvents注解，
+     * <code>@Subscribe 和 @AllowConcurrentEvents</code>注解，
      * 并在构造函数调用EventBus.register(this);
      */
     default void on(UserOfflineEvent event) {

diff --git a/mpush-api/src/main/java/com/mpush/api/router/RouterManager.java b/mpush-api/src/main/java/com/mpush/api/router/RouterManager.java
@@ -31,35 +31,35 @@ public interface RouterManager<R extends Router> {
     /**
      * 注册路由
      *
-     * @param userId
-     * @param router
-     * @return
+     * @param userId 用户ID
+     * @param router 新路由
+     * @return 如果有旧的的路由信息则返回之，否则返回空。
      */
     R register(String userId, R router);
 
     /**
      * 删除路由
      *
-     * @param userId
-     * @param clientType
-     * @return
+     * @param userId     用户ID
+     * @param clientType 客户端类型
+     * @return true:成功，false:失败
      */
     boolean unRegister(String userId, int clientType);
 
     /**
      * 查询路由
      *
-     * @param userId
-     * @return
+     * @param userId 用户ID
+     * @return userId对应的所有的路由信息
      */
     Set<R> lookupAll(String userId);
 
     /**
-     * 查询路由
+     * 查询指定设备类型的用户路由信息
      *
-     * @param userId
-     * @param clientType
-     * @return
+     * @param userId     用户ID
+     * @param clientType 客户端类型
+     * @return 指定类型的路由信息
      */
     R lookup(String userId, int clientType);
 }
diff --git a/mpush-api/src/main/java/com/mpush/api/service/BaseService.java b/mpush-api/src/main/java/com/mpush/api/service/BaseService.java
@@ -155,8 +155,8 @@ protected interface FunctionEx {
     /**
      * 防止Listener被重复执行
      *
-     * @param l
-     * @return
+     * @param l listener
+     * @return FutureListener
      */
     public FutureListener wrap(Listener l) {
         if (l == null) return new FutureListener(started);

diff --git a/mpush-api/src/main/java/com/mpush/api/spi/push/PushListener.java b/mpush-api/src/main/java/com/mpush/api/spi/push/PushListener.java
@@ -8,49 +8,56 @@ public interface PushListener<T extends IPushMessage> extends Plugin {
      * 消息下发成功后回调
      * 如果消息需要ACK则该方法不会被调用
      *
-     * @param message 要下发的消息
+     * @param message    要下发的消息
+     * @param timePoints 消息流转时间节点
      */
     void onSuccess(T message, Object[] timePoints);
 
     /**
      * 收到客户端ACK后回调
      *
-     * @param message 要下发的消息
+     * @param message    要下发的消息
+     * @param timePoints 消息流转时间节点
      */
     void onAckSuccess(T message, Object[] timePoints);
 
     /**
      * 广播消息推送全部结束后回调
      *
-     * @param message 要下发的消息
+     * @param message    要下发的消息
+     * @param timePoints 消息流转时间节点
      */
     void onBroadcastComplete(T message, Object[] timePoints);
 
     /**
      * 消息下发失败后回调
      *
-     * @param message 要下发的消息
+     * @param message    要下发的消息
+     * @param timePoints 消息流转时间节点
      */
     void onFailure(T message, Object[] timePoints);
 
     /**
      * 推送消息发现用户不在线时回调
      *
-     * @param message 要下发的消息
+     * @param message    要下发的消息
+     * @param timePoints 消息流转时间节点
      */
     void onOffline(T message, Object[] timePoints);
 
     /**
      * 推送消息发现用户不在当前机器时回调
      *
-     * @param message 要下发的消息
+     * @param message    要下发的消息
+     * @param timePoints 消息流转时间节点
      */
     void onRedirect(T message, Object[] timePoints);
 
     /**
      * 发送消息超时或等待客户端ACK超时时回调
      *
-     * @param message 要下发的消息
+     * @param message    要下发的消息
+     * @param timePoints 消息流转时间节点
      */
     void onTimeout(T message, Object[] timePoints);
 }