Skip to content

Commit 427735f

Browse files
committed
javadocs clean
1 parent 1dfe898 commit 427735f

31 files changed

Lines changed: 117 additions & 135 deletions

File tree

pom.xml

Lines changed: 28 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -424,35 +424,36 @@
424424
<autoReleaseAfterClose>true</autoReleaseAfterClose>
425425
</configuration>
426426
</plugin>
427-
<!--<plugin>-->
428-
<!--<groupId>org.apache.maven.plugins</groupId>-->
429-
<!--<artifactId>maven-javadoc-plugin</artifactId>-->
430-
<!--<version>${maven.javadoc.plugin}</version>-->
431-
<!--<executions>-->
432-
<!--<execution>-->
433-
<!--<id>attach-javadocs</id>-->
434-
<!--<goals>-->
435-
<!--<goal>jar</goal>-->
436-
<!--</goals>-->
437-
<!--</execution>-->
438-
<!--</executions>-->
439-
<!--</plugin>-->
427+
428+
<plugin>
429+
<groupId>org.apache.maven.plugins</groupId>
430+
<artifactId>maven-javadoc-plugin</artifactId>
431+
<version>${maven.javadoc.plugin}</version>
432+
<executions>
433+
<execution>
434+
<id>attach-javadocs</id>
435+
<goals>
436+
<goal>jar</goal>
437+
</goals>
438+
</execution>
439+
</executions>
440+
</plugin>
440441

441442
<!--手动打包时,将下面的plugin注释掉-->
442-
<!--<plugin>-->
443-
<!--<groupId>org.apache.maven.plugins</groupId>-->
444-
<!--<artifactId>maven-gpg-plugin</artifactId>-->
445-
<!--<version>${maven.gpg.plugin}</version>-->
446-
<!--<executions>-->
447-
<!--<execution>-->
448-
<!--<id>sign-artifacts</id>-->
449-
<!--<phase>verify</phase>-->
450-
<!--<goals>-->
451-
<!--<goal>sign</goal>-->
452-
<!--</goals>-->
453-
<!--</execution>-->
454-
<!--</executions>-->
455-
<!--</plugin>-->
443+
<plugin>
444+
<groupId>org.apache.maven.plugins</groupId>
445+
<artifactId>maven-gpg-plugin</artifactId>
446+
<version>${maven.gpg.plugin}</version>
447+
<executions>
448+
<execution>
449+
<id>sign-artifacts</id>
450+
<phase>verify</phase>
451+
<goals>
452+
<goal>sign</goal>
453+
</goals>
454+
</execution>
455+
</executions>
456+
</plugin>
456457

457458
</plugins>
458459
</build>

tx-client/src/main/java/com/codingapi/txlcn/client/core/lcn/resource/LCNConnectionProxy.java

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,6 @@
2525

2626
/**
2727
* @author lorne
28-
* @date 2018/12/2
29-
* @description
3028
*/
3129
@Slf4j
3230
public class LCNConnectionProxy implements Connection {
@@ -40,8 +38,8 @@ public LCNConnectionProxy(Connection connection) {
4038
/**
4139
* 通知事务
4240
*
43-
* @param state
44-
* @return
41+
* @param state state
42+
* @return RpcResponseState RpcResponseState
4543
*/
4644
public RpcResponseState notify(int state) {
4745
try {

tx-client/src/main/java/com/codingapi/txlcn/client/core/lcn/resource/LCNTransactionResourceExecutor.java

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,6 @@
2727

2828
/**
2929
* @author lorne
30-
* @date 2018/12/2
31-
* @description
3230
*/
3331
@Service(value = "transaction_lcn")
3432
@Slf4j

tx-client/src/main/java/com/codingapi/txlcn/client/support/resouce/TransactionResourceExecutor.java

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,17 +20,15 @@
2020

2121
/**
2222
* @author lorne
23-
* @date 2018/12/2
24-
* @description
2523
*/
2624
public interface TransactionResourceExecutor {
2725

2826
/**
2927
* 获取资源连接
3028
*
3129
* @param connectionSupplier Connection提供者
32-
* @return
33-
* @throws Throwable
30+
* @return Connection Connection
31+
* @throws Throwable Throwable
3432
*/
3533
Connection proxyConnection(Supplier<Connection> connectionSupplier) throws Throwable;
3634

tx-commons/src/main/java/com/codingapi/txlcn/commons/annotation/ITxTransaction.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ public interface ITxTransaction {
2323
/**
2424
* 指定事务类型
2525
*
26-
* @return
26+
* @return 事务类型
2727
*/
2828
String transactionType();
2929
}

tx-commons/src/main/java/com/codingapi/txlcn/commons/annotation/TccTransaction.java

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,8 @@
1818
import java.lang.annotation.*;
1919

2020
/**
21-
* @author 侯存路
22-
* @date 2018/12/3
23-
* @company codingApi
24-
* @description type [tcc] of DTX
21+
* @author 侯存路 2018/12/3
22+
*
2523
*/
2624
@Target(ElementType.METHOD)
2725
@Retention(RetentionPolicy.RUNTIME)
@@ -32,7 +30,7 @@
3230
/**
3331
* tcc事务回调执行类 该类需交由spring管理
3432
*
35-
* @return
33+
* @return 作用类对象
3634
*/
3735
Class<?> executeClass() default Void.class;
3836

@@ -41,7 +39,7 @@
4139
* 确认事务执行方法
4240
* 该方法参数需要和事务单元的参数保持一致
4341
*
44-
* @return
42+
* @return 确认方法
4543
*/
4644
String confirmMethod() default "";
4745

@@ -50,7 +48,7 @@
5048
* 取消事务执行方法
5149
* 该方法参数需要和事务单元的参数保持一致
5250
*
53-
* @return
51+
* @return 取消方法
5452
*/
5553
String cancelMethod() default "";
5654

tx-commons/src/main/java/com/codingapi/txlcn/commons/exception/SerializerException.java

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,8 @@
1616
package com.codingapi.txlcn.commons.exception;
1717

1818
/**
19-
* @author lorne
20-
* @date 2018/12/2
21-
* @description
19+
* @author lorne 2018/12/2
20+
*
2221
*/
2322
public class SerializerException extends Exception {
2423

tx-commons/src/main/java/com/codingapi/txlcn/commons/util/RandomUtils.java

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,7 @@
1919
import java.util.UUID;
2020

2121
/**
22-
* @author lorne
23-
* @date 2018/12/2
24-
* @description
22+
* @author lorne 2018/12/2
2523
*/
2624
public class RandomUtils {
2725

tx-commons/src/main/java/com/codingapi/txlcn/commons/util/Transactions.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,8 @@ public class Transactions {
4646
/**
4747
* 方法签名生成事务单元ID
4848
*
49-
* @param methodSignature
50-
* @return
49+
* @param methodSignature 方法签名key
50+
* @return md5hex val
5151
*/
5252
public static String unitId(String methodSignature) {
5353
return DigestUtils.md5DigestAsHex(methodSignature.getBytes());
@@ -56,8 +56,8 @@ public static String unitId(String methodSignature) {
5656
/**
5757
* 方法签名生成补偿ID
5858
*
59-
* @param startMethodSignature
60-
* @return
59+
* @param startMethodSignature 方法签名key
60+
* @return md5hex val
6161
*/
6262
public static String compensationId(String startMethodSignature) {
6363
return DigestUtils.md5DigestAsHex(startMethodSignature.getBytes());

tx-commons/src/main/java/com/codingapi/txlcn/commons/util/serializer/SerializerContext.java

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,8 @@
1818
import com.codingapi.txlcn.commons.exception.SerializerException;
1919

2020
/**
21-
* @author lorne
22-
* @date 2018/12/31
23-
* @description
21+
* @author lorne 2018/12/31
22+
*
2423
*/
2524
public class SerializerContext implements ISerializer {
2625

0 commit comments

Comments
 (0)