optimize: optimize java doc warning (apache#4925)

all/pom.xml

@@ -715,6 +715,7 @@
                             <dependencySourceIncludes>
                                 <dependencySourceInclude>io.seata:seata-*</dependencySourceInclude>
                             </dependencySourceIncludes>
+                            <additionalparam>-Xdoclint:none</additionalparam>
                         </configuration>
                         <executions>
                             <execution>

common/src/main/java/io/seata/common/exception/EurekaRegistryException.java

@@ -18,7 +18,7 @@
 /**
  * eureka registry exception
  *
- * @author: [email protected]
+ * @author [email protected]
  */
 public class EurekaRegistryException extends RuntimeException {
 

common/src/main/java/io/seata/common/loader/LoadLevel.java

@@ -46,7 +46,6 @@
 
     /**
      * Scope enum.
-     * @return
      */
     Scope scope() default Scope.SINGLETON;
 }

common/src/main/java/io/seata/common/util/PageUtil.java

@@ -25,7 +25,7 @@
 /**
  * db page util
  *
- * @author: lvekee [email protected]
+ * @author lvekee [email protected]
  */
 public class PageUtil {
     /**
@@ -78,8 +78,8 @@ public class PageUtil {
     /**
      * check page parm
      *
-     * @param pageNum
-     * @param pageSize
+     * @param pageNum the page num
+     * @param pageSize the page size
      */
     public static void checkParam(int pageNum, int pageSize) {
         if (!(pageNum >= MIN_PAGE_NUM && pageNum <= MAX_PAGE_NUM)) {
@@ -93,11 +93,11 @@ public static void checkParam(int pageNum, int pageSize) {
     /**
      * get pagesql
      *
-     * @param sourceSql
-     * @param dbType
-     * @param pageNum
-     * @param pageSize
-     * @return
+     * @param sourceSql the source sql
+     * @param dbType the db type
+     * @param pageNum the page num
+     * @param pageSize the page size
+     * @return the page sql
      */
     public static String pageSql(String sourceSql, String dbType, int pageNum, int pageSize) {
         switch (dbType) {
@@ -120,9 +120,9 @@ public static String pageSql(String sourceSql, String dbType, int pageNum, int p
     /**
      * get countsql
      *
-     * @param sourceSql
-     * @param dbType
-     * @return
+     * @param sourceSql the source sql
+     * @param dbType the db type
+     * @return the count sql
      */
     public static String countSql(String sourceSql, String dbType) {
         switch (dbType) {
@@ -144,9 +144,9 @@ public static String countSql(String sourceSql, String dbType) {
 
     /**
      * set sqlParamList in preparedStatement
-     * @param ps
-     * @param sqlParamList
-     * @throws SQLException
+     * @param ps the prepared statement
+     * @param sqlParamList the sql param list
+     * @throws SQLException the sql exception
      */
     public static void setObject(PreparedStatement ps, List<Object> sqlParamList) throws SQLException {
         for (int i = 0; i < sqlParamList.size(); i++) {

config/seata-config-apollo/src/main/java/io/seata/config/apollo/ApolloConfiguration.java

@@ -46,7 +46,7 @@
 /**
  * The type Apollo configuration.
  *
- * @author: kl @kailing.pub
+ * @author kl @kailing.pub
  */
 public class ApolloConfiguration extends AbstractConfiguration {
 

config/seata-config-core/src/main/java/io/seata/config/file/FileConfig.java

@@ -22,6 +22,7 @@
 public interface FileConfig {
     /**
      * @param path path expression
+     * @return the config
      */
     String getString(String path);
 

console/src/main/java/io/seata/console/param/BaseParam.java

@@ -18,8 +18,8 @@
 import java.io.Serializable;
 
 /**
- * @description: The base param
- * @author: zhongxiang.wang
+ * The base param
+ * @author zhongxiang.wang
  */
 public class BaseParam implements Serializable {
 

console/src/main/java/io/seata/console/result/PageResult.java

@@ -22,7 +22,7 @@
 /**
  * The page result
  *
- * @author: zhongxiang.wang
+ * @author zhongxiang.wang
  * @author miaoxueyu
  * @author doubleDimple
  */

console/src/main/java/io/seata/console/result/Result.java

@@ -18,8 +18,8 @@
 import java.io.Serializable;
 
 /**
- * @description: The basic result
- * @author: zhongxiang.wang
+ * The basic result
+ * @author zhongxiang.wang
  */
 public class Result<T>  implements Serializable {
     private static final long serialVersionUID = 7761261124298767L;

console/src/main/java/io/seata/console/result/SingleResult.java

@@ -21,7 +21,7 @@
 
 /**
  * The single result
- * @author: zhongxiang.wang
+ * @author zhongxiang.wang
  */
 public class SingleResult<T> extends Result<T>  implements Serializable {
     private static final long serialVersionUID = 77612626624298767L;

core/src/main/java/io/seata/core/rpc/RemotingClient.java

@@ -41,7 +41,7 @@ public interface RemotingClient {
      * {@link TmNettyRemotingClient#isEnableClientBatchSendRequest()}
      * is enabled, the message will be sent in batches.
      *
-     * @param msg transaction message {@link io.seata.core.protocol}
+     * @param msg transaction message {@code io.seata.core.protocol}
      * @return server result message
      * @throws TimeoutException TimeoutException
      */
@@ -51,7 +51,7 @@ public interface RemotingClient {
      * client send sync request.
      *
      * @param channel client channel
-     * @param msg     transaction message {@link io.seata.core.protocol}
+     * @param msg     transaction message {@code io.seata.core.protocol}
      * @return server result message
      * @throws TimeoutException TimeoutException
      */
@@ -61,7 +61,7 @@ public interface RemotingClient {
      * client send async request.
      *
      * @param channel client channel
-     * @param msg     transaction message {@link io.seata.core.protocol}
+     * @param msg     transaction message {@code io.seata.core.protocol}
      */
     void sendAsyncRequest(Channel channel, Object msg);
 
@@ -70,7 +70,7 @@ public interface RemotingClient {
      *
      * @param serverAddress server address
      * @param rpcMessage    rpc message from server request
-     * @param msg           transaction message {@link io.seata.core.protocol}
+     * @param msg           transaction message {@code io.seata.core.protocol}
      */
     void sendAsyncResponse(String serverAddress, RpcMessage rpcMessage, Object msg);
 

core/src/main/java/io/seata/core/rpc/RemotingServer.java

@@ -36,7 +36,7 @@ public interface RemotingServer {
      *
      * @param resourceId rm client resourceId
      * @param clientId   rm client id
-     * @param msg        transaction message {@link io.seata.core.protocol}
+     * @param msg        transaction message {@code io.seata.core.protocol}
      * @return client result message
      * @throws TimeoutException TimeoutException
      */
@@ -46,7 +46,7 @@ public interface RemotingServer {
      * server send sync request.
      *
      * @param channel client channel
-     * @param msg     transaction message {@link io.seata.core.protocol}
+     * @param msg     transaction message {@code io.seata.core.protocol}
      * @return client result message
      * @throws TimeoutException TimeoutException
      */
@@ -56,7 +56,7 @@ public interface RemotingServer {
      * server send async request.
      *
      * @param channel client channel
-     * @param msg     transaction message {@link io.seata.core.protocol}
+     * @param msg     transaction message {@code io.seata.core.protocol}
      */
     void sendAsyncRequest(Channel channel, Object msg);
 
@@ -65,7 +65,7 @@ public interface RemotingServer {
      *
      * @param rpcMessage rpc message from client request
      * @param channel    client channel
-     * @param msg        transaction message {@link io.seata.core.protocol}
+     * @param msg        transaction message {@code io.seata.core.protocol}
      */
     void sendAsyncResponse(RpcMessage rpcMessage, Channel channel, Object msg);
 

core/src/main/java/io/seata/core/rpc/netty/AbstractNettyRemotingClient.java

@@ -95,8 +95,8 @@ public abstract class AbstractNettyRemotingClient extends AbstractNettyRemoting
 
     /**
      * When batch sending is enabled, the message will be stored to basketMap
-     * Send via asynchronous thread {@link MergedSendRunnable}
-     * {@link this#isEnableClientBatchSendRequest()}
+     * Send via asynchronous thread {@link io.seata.core.rpc.netty.AbstractNettyRemotingClient.MergedSendRunnable}
+     * {@link AbstractNettyRemotingClient#isEnableClientBatchSendRequest()}
      */
     protected final ConcurrentHashMap<String/*serverAddress*/, BlockingQueue<RpcMessage>> basketMap = new ConcurrentHashMap<>();
 

core/src/main/java/io/seata/core/rpc/netty/ChannelManager.java

@@ -441,7 +441,7 @@ private static Channel tryOtherApp(ConcurrentMap<String, ConcurrentMap<String, C
     /**
      * get rm channels
      *
-     * @return
+     * @return the rm channels,key:resourceId,value:channel
      */
     public static Map<String,Channel> getRmChannels() {
         if (RM_CHANNELS.isEmpty()) {

core/src/main/java/io/seata/core/serializer/SerializerClassRegistry.java

@@ -61,7 +61,7 @@
 
 /**
  * Provide a unified serialization registry, this class used for {@code seata-serializer-fst}
- * and {@code seata-serializer-kryo}, it will register some classes at startup time (for example {@link KryoSerializerFactory#create})
+ * and {@code seata-serializer-kryo}, it will register some classes at startup time (for example {@code KryoSerializerFactory#create})
  * @author funkye
  */
 public class SerializerClassRegistry {

core/src/main/java/io/seata/core/store/DefaultDistributedLocker.java

@@ -16,7 +16,7 @@
 package io.seata.core.store;
 
 /**
- * @description Default distributed locker
+ * Default distributed locker
  * @author zhongxiang.wang
  */
 public class DefaultDistributedLocker implements DistributedLocker {

core/src/main/java/io/seata/core/store/DistributedLockDO.java

@@ -16,7 +16,7 @@
 package io.seata.core.store;
 
 /**
- * @description Distributed lock DO
+ * Distributed lock DO
  * @author zhongxiang.wang 
  * @author chd
  */

core/src/main/java/io/seata/core/store/DistributedLocker.java

@@ -16,23 +16,23 @@
 package io.seata.core.store;
 
 /**
- * @description Distributed locker
+ * Distributed locker
  * @author zhongxiang.wang 
  * @author chd
  */
 public interface DistributedLocker {
     /**
      * Acquire the distributed lock
      *
-     * @param distributedLockDO
+     * @param distributedLockDO the distributed lock info
      * @return the boolean
      */
     boolean acquireLock(DistributedLockDO distributedLockDO);
 
     /**
      * Release the distributed lock
      *
-     * @param distributedLockDO
+     * @param distributedLockDO the distributed lock info
      * @return the boolean
      */
     boolean releaseLock(DistributedLockDO distributedLockDO);

discovery/seata-discovery-core/src/main/java/io/seata/discovery/registry/RegistryHeartBeats.java

@@ -99,8 +99,8 @@ public interface ReRegister {
         /**
          * do re-register
          *
-         * @param serverAddress
-         * @throws Exception
+         * @param serverAddress the server address
+         * @throws Exception the exception
          */
         void register(InetSocketAddress serverAddress) throws Exception;
     }

discovery/seata-discovery-core/src/main/java/io/seata/discovery/registry/RegistryService.java

@@ -97,7 +97,7 @@ public interface RegistryService<T> {
 
     /**
      * Close.
-     * @throws Exception
+     * @throws Exception the exception
      */
     void close() throws Exception;
 

discovery/seata-discovery-eureka/src/main/java/io/seata/discovery/registry/eureka/CustomEurekaInstanceConfig.java

@@ -20,7 +20,7 @@
 import com.netflix.appinfo.MyDataCenterInstanceConfig;
 
 /**
- * @author: [email protected]
+ * @author [email protected]
  * override MyDataCenterInstanceConfig for set value,
  * eg: instanceId \ipAddress \ applicationName...
  */

discovery/seata-discovery-eureka/src/main/java/io/seata/discovery/registry/eureka/EurekaRegistryServiceImpl.java

@@ -45,7 +45,7 @@
 /**
  * The type Eureka registry service.
  *
- * @author: [email protected]
+ * @author [email protected]
  */
 public class EurekaRegistryServiceImpl implements RegistryService<EurekaEventListener> {
     private static final Logger LOGGER = LoggerFactory.getLogger(EurekaRegistryServiceImpl.class);

discovery/seata-discovery-zk/src/main/java/io/seata/discovery/registry/zk/ZookeeperRegisterServiceImpl.java

@@ -171,8 +171,8 @@ public void unsubscribe(String cluster, IZkChildListener listener) throws Except
 
     /**
      * @param key the key
-     * @return
-     * @throws Exception
+     * @return the socket address list
+     * @throws Exception the exception
      */
     @Override
     public List<InetSocketAddress> lookup(String key) throws Exception {

rm-datasource/src/main/java/io/seata/rm/GlobalLockExecutor.java

@@ -32,7 +32,7 @@ public interface GlobalLockExecutor {
 
     /**
      * global lock config info
-     * @return
+     * @return the global lock config
      */
     GlobalLockConfig getGlobalLockConfig();
 }

rm-datasource/src/main/java/io/seata/rm/datasource/exec/BaseInsertExecutor.java

@@ -132,7 +132,7 @@ protected Map<String, Integer> getPkIndex() {
 
     /**
      * parse primary key value from statement.
-     * @return
+     * @return the primary key and values<key:primary key,value:primary key values></key:primary>
      */
     protected Map<String, List<Object>> parsePkValuesFromStatement() {
         // insert values including PK
@@ -221,8 +221,8 @@ protected Map<String, List<Object>> parsePkValuesFromStatement() {
 
     /**
      * default get generated keys.
-     * @return
-     * @throws SQLException
+     * @return the generate keys
+     * @throws SQLException the sql exception
      */
     @Deprecated
     public List<Object> getGeneratedKeys() throws SQLException {
@@ -247,7 +247,7 @@ public List<Object> getGeneratedKeys() throws SQLException {
     /**
      * default get generated keys.
      * @param pkKey the pk key
-     * @return
+     * @return the generated key list
      * @throws SQLException
      */
     public List<Object> getGeneratedKeys(String pkKey) throws SQLException {

rm-datasource/src/main/java/io/seata/rm/datasource/exec/postgresql/PostgresqlInsertExecutor.java

@@ -87,8 +87,8 @@ public Map<String, List<Object>> getPkValuesByColumn() throws SQLException {
 
     /**
      * get primary key values by default
-     * @return
-     * @throws SQLException
+     * @return the pk values
+     * @throws SQLException the sql exception
      */
     @Override
     @Deprecated
@@ -110,8 +110,8 @@ public List<Object> getPkValuesByDefault() throws SQLException {
      * get primary key values by default
      *
      * @param pkKey the pk key
-     * @return
-     * @throws SQLException
+     * @return the primary values
+     * @throws SQLException the sql exception
      */
     @Override
     public List<Object> getPkValuesByDefault(String pkKey) throws SQLException {