Skip to content

Commit 808b7dc

Browse files
huanglongchao江村
huanglongchao
and
江村
authored
upload maven fix javadoc rules (#330)
Co-authored-by: 江村 <[email protected]>
1 parent eb984a8 commit 808b7dc

File tree

151 files changed

+1085
-685
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

151 files changed

+1085
-685
lines changed

‎pom.xml‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,11 @@
4242
<email>[email protected]</email>
4343
<organization>Ant Financial</organization>
4444
</developer>
45+
<developer>
46+
<name>LongChao Huang</name>
47+
<email>[email protected]</email>
48+
<organization>Ant Financial</organization>
49+
</developer>
4550
</developers>
4651

4752
<scm>
@@ -725,5 +730,61 @@
725730
</pluginRepository>
726731
</pluginRepositories>
727732
</profile>
733+
734+
<profile>
735+
<id>release</id>
736+
<build>
737+
<plugins>
738+
<plugin>
739+
<groupId>org.apache.maven.plugins</groupId>
740+
<artifactId>maven-javadoc-plugin</artifactId>
741+
<version>2.9.1</version>
742+
<executions>
743+
<execution>
744+
<id>attach-javadocs</id>
745+
<goals>
746+
<goal>jar</goal>
747+
</goals>
748+
</execution>
749+
</executions>
750+
</plugin>
751+
<plugin>
752+
<groupId>org.sonatype.plugins</groupId>
753+
<artifactId>nexus-staging-maven-plugin</artifactId>
754+
<version>1.6.7</version>
755+
<extensions>true</extensions>
756+
<configuration>
757+
<serverId>ossrh</serverId>
758+
<nexusUrl>https://oss.sonatype.org/</nexusUrl>
759+
<autoReleaseAfterClose>false</autoReleaseAfterClose>
760+
</configuration>
761+
</plugin>
762+
<plugin>
763+
<groupId>org.apache.maven.plugins</groupId>
764+
<artifactId>maven-gpg-plugin</artifactId>
765+
<version>1.6</version>
766+
<executions>
767+
<execution>
768+
<id>sign-artifacts</id>
769+
<phase>verify</phase>
770+
<goals>
771+
<goal>sign</goal>
772+
</goals>
773+
</execution>
774+
</executions>
775+
</plugin>
776+
</plugins>
777+
</build>
778+
<distributionManagement>
779+
<snapshotRepository>
780+
<id>ossrh</id>
781+
<url>https://oss.sonatype.org/content/repositories/snapshots</url>
782+
</snapshotRepository>
783+
<repository>
784+
<id>ossrh</id>
785+
<url>https://oss.sonatype.org/service/local/staging/deploy/maven2/</url>
786+
</repository>
787+
</distributionManagement>
788+
</profile>
728789
</profiles>
729790
</project>

‎server/common/model/src/main/java/com/alipay/sofa/registry/common/model/CommonResponse.java‎

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,8 @@ public CommonResponse() {}
3838
/**
3939
* constructor
4040
*
41-
* @param success
42-
* @param message
41+
* @param success success
42+
* @param message message
4343
*/
4444
public CommonResponse(boolean success, String message) {
4545
this.success = success;
@@ -49,7 +49,7 @@ public CommonResponse(boolean success, String message) {
4949
/**
5050
* build success resp
5151
*
52-
* @return
52+
* @return CommonResponse
5353
*/
5454
public static CommonResponse buildSuccessResponse() {
5555
return new CommonResponse(true, "");
@@ -58,7 +58,8 @@ public static CommonResponse buildSuccessResponse() {
5858
/**
5959
* build success resp
6060
*
61-
* @return
61+
* @param msg msg
62+
* @return CommonResponse
6263
*/
6364
public static CommonResponse buildSuccessResponse(String msg) {
6465
return new CommonResponse(true, msg);
@@ -67,8 +68,8 @@ public static CommonResponse buildSuccessResponse(String msg) {
6768
/**
6869
* build fail resp
6970
*
70-
* @param msg
71-
* @return
71+
* @param msg msg
72+
* @return CommonResponse
7273
*/
7374
public static CommonResponse buildFailedResponse(String msg) {
7475
return new CommonResponse(false, msg);

‎server/common/model/src/main/java/com/alipay/sofa/registry/common/model/DataUtils.java‎

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,13 @@ public final class DataUtils {
3030

3131
private DataUtils() {}
3232

33-
/** instanceId/group/app - > {info.count,dataInfoId.count} */
33+
/**
34+
* instanceId/group/app - {info.count,dataInfoId.count}
35+
*
36+
* @param infos infos
37+
* @param <T> T
38+
* @return Map
39+
*/
3440
public static <T extends BaseInfo>
3541
Map<String, Map<String, Map<String, Tuple<Integer, Integer>>>> countGroupByInstanceIdGroupApp(
3642
Collection<T> infos) {
@@ -72,7 +78,13 @@ Map<String, Map<String, Map<String, Tuple<Integer, Integer>>>> countGroupByInsta
7278
return ret;
7379
}
7480

75-
/** instanceId/group - > {info.count,dataInfoId.count} */
81+
/**
82+
* instanceId/group - {info.count,dataInfoId.count}
83+
*
84+
* @param infos infos
85+
* @param <T> T
86+
* @return Map
87+
*/
7688
public static <T extends BaseInfo>
7789
Map<String, Map<String, Tuple<Integer, Integer>>> countGroupByInstanceIdGroup(
7890
Collection<T> infos) {

‎server/common/model/src/main/java/com/alipay/sofa/registry/common/model/GenericResponse.java‎

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,8 @@ public class GenericResponse<T> extends CommonResponse {
3131
/**
3232
* get success response
3333
*
34-
* @param data
35-
* @return
34+
* @param data data
35+
* @return GenericResponse
3636
*/
3737
public GenericResponse<T> fillSucceed(T data) {
3838
this.setSuccess(true);
@@ -43,8 +43,8 @@ public GenericResponse<T> fillSucceed(T data) {
4343
/**
4444
* get fail response
4545
*
46-
* @param msg
47-
* @return
46+
* @param msg msg
47+
* @return GenericResponse
4848
*/
4949
public GenericResponse<T> fillFailed(String msg) {
5050
this.setSuccess(false);
@@ -55,8 +55,8 @@ public GenericResponse<T> fillFailed(String msg) {
5555
/**
5656
* get fail response
5757
*
58-
* @param data
59-
* @return
58+
* @param data data
59+
* @return GenericResponse
6060
*/
6161
public GenericResponse<T> fillFailData(T data) {
6262
this.setSuccess(false);
@@ -77,6 +77,7 @@ public T getData() {
7777
* Setter method for property <tt>data</tt>.
7878
*
7979
* @param data value to be assigned to property data
80+
* @return GenericResponse
8081
*/
8182
public GenericResponse<T> setData(T data) {
8283
this.data = data;

‎server/common/model/src/main/java/com/alipay/sofa/registry/common/model/Node.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,14 +51,14 @@ public static NodeType codeOf(String type) {
5151
/**
5252
* get node type
5353
*
54-
* @return
54+
* @return NodeType
5555
*/
5656
NodeType getNodeType();
5757

5858
/**
5959
* get node url
6060
*
61-
* @return
61+
* @return URL
6262
*/
6363
URL getNodeUrl();
6464
}

‎server/common/model/src/main/java/com/alipay/sofa/registry/common/model/PublisherUtils.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,8 @@ private PublisherUtils() {}
3333
/**
3434
* change publisher word cache
3535
*
36-
* @param publisher
37-
* @return
36+
* @param publisher publisher
37+
* @return publisher
3838
*/
3939
public static Publisher internPublisher(Publisher publisher) {
4040
publisher.setRegisterId(publisher.getRegisterId());

‎server/common/model/src/main/java/com/alipay/sofa/registry/common/model/ServerDataBox.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -191,7 +191,7 @@ public byte[] getBytes() {
191191
/**
192192
* Set bytes byte [ ].
193193
*
194-
* @return byte[] byte [ ]
194+
* @param bytes bytes
195195
*/
196196
public void setBytes(byte[] bytes) {
197197
this.bytes = bytes;

‎server/common/model/src/main/java/com/alipay/sofa/registry/common/model/client/pb/AppList.java‎

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -468,14 +468,23 @@ public Builder mergeFrom(
468468
public long getVersion() {
469469
return version_;
470470
}
471-
/** <code>int64 version = 1;</code> */
471+
/**
472+
* <code>int64 version = 1;</code>
473+
*
474+
* @param value value
475+
* @return Builder
476+
*/
472477
public Builder setVersion(long value) {
473478

474479
version_ = value;
475480
onChanged();
476481
return this;
477482
}
478-
/** <code>int64 version = 1;</code> */
483+
/**
484+
* <code>int64 version = 1;</code>
485+
*
486+
* @return Builder
487+
*/
479488
public Builder clearVersion() {
480489

481490
version_ = 0L;
@@ -508,7 +517,13 @@ public java.lang.String getApps(int index) {
508517
public com.google.protobuf.ByteString getAppsBytes(int index) {
509518
return apps_.getByteString(index);
510519
}
511-
/** <code>repeated string apps = 2;</code> */
520+
/**
521+
* <code>repeated string apps = 2;</code>
522+
*
523+
* @param index index
524+
* @param value value
525+
* @return Builder
526+
*/
512527
public Builder setApps(int index, java.lang.String value) {
513528
if (value == null) {
514529
throw new NullPointerException();

‎server/common/model/src/main/java/com/alipay/sofa/registry/common/model/client/pb/AppListOrBuilder.java‎

Lines changed: 27 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,15 +21,37 @@ public interface AppListOrBuilder
2121
// @@protoc_insertion_point(interface_extends:AppList)
2222
com.google.protobuf.MessageOrBuilder {
2323

24-
/** <code>int64 version = 1;</code> */
24+
/**
25+
* <code>int64 version = 1;</code>
26+
*
27+
* @return long
28+
*/
2529
long getVersion();
2630

27-
/** <code>repeated string apps = 2;</code> */
31+
/**
32+
* <code>repeated string apps = 2;</code>
33+
*
34+
* @return List
35+
*/
2836
java.util.List<java.lang.String> getAppsList();
29-
/** <code>repeated string apps = 2;</code> */
37+
/**
38+
* <code>repeated string apps = 2;</code>
39+
*
40+
* @return int
41+
*/
3042
int getAppsCount();
31-
/** <code>repeated string apps = 2;</code> */
43+
/**
44+
* <code>repeated string apps = 2;</code>
45+
*
46+
* @param index index
47+
* @return String
48+
*/
3249
java.lang.String getApps(int index);
33-
/** <code>repeated string apps = 2;</code> */
50+
/**
51+
* <code>repeated string apps = 2;</code>
52+
*
53+
* @param index index
54+
* @return ByteString
55+
*/
3456
com.google.protobuf.ByteString getAppsBytes(int index);
3557
}

‎server/common/model/src/main/java/com/alipay/sofa/registry/common/model/dataserver/Datum.java‎

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -57,8 +57,8 @@ public Datum() {}
5757
/**
5858
* constructor
5959
*
60-
* @param dataInfoId
61-
* @param dataCenter
60+
* @param dataInfoId dataInfoId
61+
* @param dataCenter dataCenter
6262
*/
6363
public Datum(String dataInfoId, String dataCenter) {
6464
this.dataInfoId = WordCache.getWordCache(dataInfoId);
@@ -70,8 +70,8 @@ public Datum(String dataInfoId, String dataCenter) {
7070
/**
7171
* constructor
7272
*
73-
* @param publisher
74-
* @param dataCenter
73+
* @param publisher publisher
74+
* @param dataCenter dataCenter
7575
*/
7676
public Datum(Publisher publisher, String dataCenter) {
7777
this(publisher.getDataInfoId(), dataCenter);
@@ -84,9 +84,9 @@ public Datum(Publisher publisher, String dataCenter) {
8484
/**
8585
* constructor
8686
*
87-
* @param publisher
88-
* @param dataCenter
89-
* @param version
87+
* @param publisher publisher
88+
* @param dataCenter dataCenter
89+
* @param version version
9090
*/
9191
public Datum(Publisher publisher, String dataCenter, long version) {
9292
this.dataInfoId = publisher.getDataInfoId();
@@ -256,7 +256,11 @@ public synchronized Map<String, Publisher> getPubMap() {
256256
return Collections.unmodifiableMap(Maps.newHashMap(pubMap));
257257
}
258258

259-
/** should not call that, just for json serde */
259+
/**
260+
* should not call that, just for json serde
261+
*
262+
* @param pubMap pubMap
263+
*/
260264
public synchronized void setPubMap(Map<String, Publisher> pubMap) {
261265
this.pubMap.clear();
262266
if (pubMap != null) {

0 commit comments

Comments
 (0)