upload maven fix javadoc rules (#330)

Co-authored-by: 江村 <jiangcun.hlc@antfin.com>
sofastack · Jul 5, 2023 · 808b7dc · 808b7dc
1 parent eb984a8
commit 808b7dc
Show file tree

Hide file tree

Showing 151 changed files with 1,085 additions and 685 deletions.
diff --git a/pom.xml b/pom.xml
@@ -42,6 +42,11 @@
             <email>caojie.cj@antfin.com</email>
             <organization>Ant Financial</organization>
         </developer>
+        <developer>
+            <name>LongChao Huang</name>
+            <email>jiangcun.hlc@antfin.com</email>
+            <organization>Ant Financial</organization>
+        </developer>
     </developers>
 
     <scm>
@@ -725,5 +730,61 @@
                 </pluginRepository>
             </pluginRepositories>
         </profile>
+
+            <profile>
+                <id>release</id>
+                <build>
+                    <plugins>
+                        <plugin>
+                            <groupId>org.apache.maven.plugins</groupId>
+                            <artifactId>maven-javadoc-plugin</artifactId>
+                            <version>2.9.1</version>
+                            <executions>
+                                <execution>
+                                    <id>attach-javadocs</id>
+                                    <goals>
+                                        <goal>jar</goal>
+                                    </goals>
+                                </execution>
+                            </executions>
+                        </plugin>
+                        <plugin>
+                            <groupId>org.sonatype.plugins</groupId>
+                            <artifactId>nexus-staging-maven-plugin</artifactId>
+                            <version>1.6.7</version>
+                            <extensions>true</extensions>
+                            <configuration>
+                                <serverId>ossrh</serverId>
+                                <nexusUrl>https://oss.sonatype.org/</nexusUrl>
+                                <autoReleaseAfterClose>false</autoReleaseAfterClose>
+                            </configuration>
+                        </plugin>
+                        <plugin>
+                            <groupId>org.apache.maven.plugins</groupId>
+                            <artifactId>maven-gpg-plugin</artifactId>
+                            <version>1.6</version>
+                            <executions>
+                                <execution>
+                                    <id>sign-artifacts</id>
+                                    <phase>verify</phase>
+                                    <goals>
+                                        <goal>sign</goal>
+                                    </goals>
+                                </execution>
+                            </executions>
+                        </plugin>
+                    </plugins>
+                </build>
+                <distributionManagement>
+                    <snapshotRepository>
+                        <id>ossrh</id>
+                        <url>https://oss.sonatype.org/content/repositories/snapshots</url>
+                    </snapshotRepository>
+                    <repository>
+                        <id>ossrh</id>
+                        <url>https://oss.sonatype.org/service/local/staging/deploy/maven2/</url>
+                    </repository>
+                </distributionManagement>
+            </profile>
     </profiles>
 </project>
diff --git a/server/common/model/src/main/java/com/alipay/sofa/registry/common/model/CommonResponse.java b/server/common/model/src/main/java/com/alipay/sofa/registry/common/model/CommonResponse.java
@@ -38,8 +38,8 @@ public CommonResponse() {}
   /**
    * constructor
    *
-   * @param success
-   * @param message
+   * @param success success
+   * @param message message
    */
   public CommonResponse(boolean success, String message) {
     this.success = success;
@@ -49,7 +49,7 @@ public CommonResponse(boolean success, String message) {
   /**
    * build success resp
    *
-   * @return
+   * @return CommonResponse
    */
   public static CommonResponse buildSuccessResponse() {
     return new CommonResponse(true, "");
@@ -58,7 +58,8 @@ public static CommonResponse buildSuccessResponse() {
   /**
    * build success resp
    *
-   * @return
+   * @param msg msg
+   * @return CommonResponse
    */
   public static CommonResponse buildSuccessResponse(String msg) {
     return new CommonResponse(true, msg);
@@ -67,8 +68,8 @@ public static CommonResponse buildSuccessResponse(String msg) {
   /**
    * build fail resp
    *
-   * @param msg
-   * @return
+   * @param msg msg
+   * @return CommonResponse
    */
   public static CommonResponse buildFailedResponse(String msg) {
     return new CommonResponse(false, msg);

diff --git a/server/common/model/src/main/java/com/alipay/sofa/registry/common/model/DataUtils.java b/server/common/model/src/main/java/com/alipay/sofa/registry/common/model/DataUtils.java
@@ -30,7 +30,13 @@ public final class DataUtils {
 
   private DataUtils() {}
 
-  /** instanceId/group/app - > {info.count,dataInfoId.count} */
+  /**
+   * instanceId/group/app - {info.count,dataInfoId.count}
+   *
+   * @param infos infos
+   * @param <T> T
+   * @return Map
+   */
   public static <T extends BaseInfo>
       Map<String, Map<String, Map<String, Tuple<Integer, Integer>>>> countGroupByInstanceIdGroupApp(
           Collection<T> infos) {
@@ -72,7 +78,13 @@ Map<String, Map<String, Map<String, Tuple<Integer, Integer>>>> countGroupByInsta
     return ret;
   }
 
-  /** instanceId/group - > {info.count,dataInfoId.count} */
+  /**
+   * instanceId/group - {info.count,dataInfoId.count}
+   *
+   * @param infos infos
+   * @param <T> T
+   * @return Map
+   */
   public static <T extends BaseInfo>
       Map<String, Map<String, Tuple<Integer, Integer>>> countGroupByInstanceIdGroup(
           Collection<T> infos) {

diff --git a/server/common/model/src/main/java/com/alipay/sofa/registry/common/model/GenericResponse.java b/server/common/model/src/main/java/com/alipay/sofa/registry/common/model/GenericResponse.java
@@ -31,8 +31,8 @@ public class GenericResponse<T> extends CommonResponse {
   /**
    * get success response
    *
-   * @param data
-   * @return
+   * @param data data
+   * @return GenericResponse
    */
   public GenericResponse<T> fillSucceed(T data) {
     this.setSuccess(true);
@@ -43,8 +43,8 @@ public GenericResponse<T> fillSucceed(T data) {
   /**
    * get fail response
    *
-   * @param msg
-   * @return
+   * @param msg msg
+   * @return GenericResponse
    */
   public GenericResponse<T> fillFailed(String msg) {
     this.setSuccess(false);
@@ -55,8 +55,8 @@ public GenericResponse<T> fillFailed(String msg) {
   /**
    * get fail response
    *
-   * @param data
-   * @return
+   * @param data data
+   * @return GenericResponse
    */
   public GenericResponse<T> fillFailData(T data) {
     this.setSuccess(false);
@@ -77,6 +77,7 @@ public T getData() {
    * Setter method for property <tt>data</tt>.
    *
    * @param data value to be assigned to property data
+   * @return GenericResponse
    */
   public GenericResponse<T> setData(T data) {
     this.data = data;

diff --git a/server/common/model/src/main/java/com/alipay/sofa/registry/common/model/Node.java b/server/common/model/src/main/java/com/alipay/sofa/registry/common/model/Node.java
@@ -51,14 +51,14 @@ public static NodeType codeOf(String type) {
   /**
    * get node type
    *
-   * @return
+   * @return NodeType
    */
   NodeType getNodeType();
 
   /**
    * get node url
    *
-   * @return
+   * @return URL
    */
   URL getNodeUrl();
 }
diff --git a/server/common/model/src/main/java/com/alipay/sofa/registry/common/model/PublisherUtils.java b/server/common/model/src/main/java/com/alipay/sofa/registry/common/model/PublisherUtils.java
@@ -33,8 +33,8 @@ private PublisherUtils() {}
   /**
    * change publisher word cache
    *
-   * @param publisher
-   * @return
+   * @param publisher publisher
+   * @return publisher
    */
   public static Publisher internPublisher(Publisher publisher) {
     publisher.setRegisterId(publisher.getRegisterId());

diff --git a/server/common/model/src/main/java/com/alipay/sofa/registry/common/model/ServerDataBox.java b/server/common/model/src/main/java/com/alipay/sofa/registry/common/model/ServerDataBox.java
@@ -191,7 +191,7 @@ public byte[] getBytes() {
   /**
    * Set bytes byte [ ].
    *
-   * @return byte[] byte [ ]
+   * @param bytes bytes
    */
   public void setBytes(byte[] bytes) {
     this.bytes = bytes;

diff --git a/...r/common/model/src/main/java/com/alipay/sofa/registry/common/model/client/pb/AppList.java b/...r/common/model/src/main/java/com/alipay/sofa/registry/common/model/client/pb/AppList.java
@@ -468,14 +468,23 @@ public Builder mergeFrom(
     public long getVersion() {
       return version_;
     }
-    /** <code>int64 version = 1;</code> */
+    /**
+     * <code>int64 version = 1;</code>
+     *
+     * @param value value
+     * @return Builder
+     */
     public Builder setVersion(long value) {
 
       version_ = value;
       onChanged();
       return this;
     }
-    /** <code>int64 version = 1;</code> */
+    /**
+     * <code>int64 version = 1;</code>
+     *
+     * @return Builder
+     */
     public Builder clearVersion() {
 
       version_ = 0L;
@@ -508,7 +517,13 @@ public java.lang.String getApps(int index) {
     public com.google.protobuf.ByteString getAppsBytes(int index) {
       return apps_.getByteString(index);
     }
-    /** <code>repeated string apps = 2;</code> */
+    /**
+     * <code>repeated string apps = 2;</code>
+     *
+     * @param index index
+     * @param value value
+     * @return Builder
+     */
     public Builder setApps(int index, java.lang.String value) {
       if (value == null) {
         throw new NullPointerException();

diff --git a/...model/src/main/java/com/alipay/sofa/registry/common/model/client/pb/AppListOrBuilder.java b/...model/src/main/java/com/alipay/sofa/registry/common/model/client/pb/AppListOrBuilder.java
@@ -21,15 +21,37 @@ public interface AppListOrBuilder
     // @@protoc_insertion_point(interface_extends:AppList)
     com.google.protobuf.MessageOrBuilder {
 
-  /** <code>int64 version = 1;</code> */
+  /**
+   * <code>int64 version = 1;</code>
+   *
+   * @return long
+   */
   long getVersion();
 
-  /** <code>repeated string apps = 2;</code> */
+  /**
+   * <code>repeated string apps = 2;</code>
+   *
+   * @return List
+   */
   java.util.List<java.lang.String> getAppsList();
-  /** <code>repeated string apps = 2;</code> */
+  /**
+   * <code>repeated string apps = 2;</code>
+   *
+   * @return int
+   */
   int getAppsCount();
-  /** <code>repeated string apps = 2;</code> */
+  /**
+   * <code>repeated string apps = 2;</code>
+   *
+   * @param index index
+   * @return String
+   */
   java.lang.String getApps(int index);
-  /** <code>repeated string apps = 2;</code> */
+  /**
+   * <code>repeated string apps = 2;</code>
+   *
+   * @param index index
+   * @return ByteString
+   */
   com.google.protobuf.ByteString getAppsBytes(int index);
 }
diff --git a/...er/common/model/src/main/java/com/alipay/sofa/registry/common/model/dataserver/Datum.java b/...er/common/model/src/main/java/com/alipay/sofa/registry/common/model/dataserver/Datum.java
@@ -57,8 +57,8 @@ public Datum() {}
   /**
    * constructor
    *
-   * @param dataInfoId
-   * @param dataCenter
+   * @param dataInfoId dataInfoId
+   * @param dataCenter dataCenter
    */
   public Datum(String dataInfoId, String dataCenter) {
     this.dataInfoId = WordCache.getWordCache(dataInfoId);
@@ -70,8 +70,8 @@ public Datum(String dataInfoId, String dataCenter) {
   /**
    * constructor
    *
-   * @param publisher
-   * @param dataCenter
+   * @param publisher publisher
+   * @param dataCenter dataCenter
    */
   public Datum(Publisher publisher, String dataCenter) {
     this(publisher.getDataInfoId(), dataCenter);
@@ -84,9 +84,9 @@ public Datum(Publisher publisher, String dataCenter) {
   /**
    * constructor
    *
-   * @param publisher
-   * @param dataCenter
-   * @param version
+   * @param publisher publisher
+   * @param dataCenter dataCenter
+   * @param version version
    */
   public Datum(Publisher publisher, String dataCenter, long version) {
     this.dataInfoId = publisher.getDataInfoId();
@@ -256,7 +256,11 @@ public synchronized Map<String, Publisher> getPubMap() {
     return Collections.unmodifiableMap(Maps.newHashMap(pubMap));
   }
 
-  /** should not call that, just for json serde */
+  /**
+   * should not call that, just for json serde
+   *
+   * @param pubMap pubMap
+   */
   public synchronized void setPubMap(Map<String, Publisher> pubMap) {
     this.pubMap.clear();
     if (pubMap != null) {

diff --git a/...src/main/java/com/alipay/sofa/registry/common/model/dataserver/GetDataVersionRequest.java b/...src/main/java/com/alipay/sofa/registry/common/model/dataserver/GetDataVersionRequest.java
@@ -36,7 +36,6 @@ public class GetDataVersionRequest extends AbstractSlotRequest {
   // dataInfoId:max(push.version)
   private final Map<String, DatumVersion> interests;
 
-  /** constructor */
   public GetDataVersionRequest(
       String dataCenter,
       ProcessId sessionProcessId,

diff --git a/...model/src/main/java/com/alipay/sofa/registry/common/model/metaserver/DataCenterNodes.java b/...model/src/main/java/com/alipay/sofa/registry/common/model/metaserver/DataCenterNodes.java
@@ -38,9 +38,9 @@ public class DataCenterNodes<T extends Node> implements Serializable {
   /**
    * constructor
    *
-   * @param nodeType
-   * @param version
-   * @param dataCenterId
+   * @param nodeType nodeType
+   * @param version version
+   * @param dataCenterId dataCenterId
    */
   public DataCenterNodes(NodeType nodeType, long version, String dataCenterId) {
     this.nodeType = nodeType;

diff --git a/...c/main/java/com/alipay/sofa/registry/common/model/metaserver/FetchProvideDataRequest.java b/...c/main/java/com/alipay/sofa/registry/common/model/metaserver/FetchProvideDataRequest.java
@@ -29,7 +29,7 @@ public class FetchProvideDataRequest implements Serializable {
   /**
    * construtor
    *
-   * @param dataInfoId
+   * @param dataInfoId dataInfoId
    */
   public FetchProvideDataRequest(String dataInfoId) {
     this.dataInfoId = dataInfoId;