From 426ac39befd9481b572cb3907a0ebb453bc6e776 Mon Sep 17 00:00:00 2001
From: Jerry Lee <oldratlee@gmail.com>
Date: Fri, 13 Dec 2019 21:24:31 +0800
Subject: [PATCH] improve javadoc

---
 .../com/alibaba/ttl/threadpool/TtlExecutors.java     | 12 +++++++++---
 .../ttl/threadpool/TtlForkJoinPoolHelper.java        |  4 +++-
 .../com/alibaba/ttl/threadpool/package-info.java     |  2 +-
 3 files changed, 13 insertions(+), 5 deletions(-)

diff --git a/src/main/java/com/alibaba/ttl/threadpool/TtlExecutors.java b/src/main/java/com/alibaba/ttl/threadpool/TtlExecutors.java
index 8baf195c..74e45553 100644
--- a/src/main/java/com/alibaba/ttl/threadpool/TtlExecutors.java
+++ b/src/main/java/com/alibaba/ttl/threadpool/TtlExecutors.java
@@ -8,13 +8,19 @@ import edu.umd.cs.findbugs.annotations.Nullable;
 import java.util.concurrent.*;
 
 /**
- * Factory Utils for getting TTL wrapper of jdk executors.
+ * Util methods for TTL wrapper of jdk executors.
+ *
+ * <ol>
+ *     <li>Factory methods to get TTL wrapper from jdk executors.</li>
+ *     <li>unwrap/check methods for TTL wrapper of jdk executors.</li>
+ *     <li>wrap/unwrap/check methods to disable Inheritable for {@link ThreadFactory}.</li>
+ * </ol>
  * <p>
  * <b><i>Note:</i></b>
  * <ul>
  * <li>all method is {@code null}-safe, when input {@code executor} parameter is {@code null}, return {@code null}.</li>
- * <li>skip decorating thread pool/{@code executor}(aka. just return input {@code executor})
- * when ttl agent is loaded, Or when input {@code executor} is already decorated.</li>
+ * <li>skip wrap/decoration thread pool/{@code executor}(aka. just return input {@code executor})
+ * when ttl agent is loaded, Or when input {@code executor} is already wrapped/decorated.</li>
  * </ul>
  *
  * @author Jerry Lee (oldratlee at gmail dot com)
diff --git a/src/main/java/com/alibaba/ttl/threadpool/TtlForkJoinPoolHelper.java b/src/main/java/com/alibaba/ttl/threadpool/TtlForkJoinPoolHelper.java
index 0dfded38..586bb69a 100644
--- a/src/main/java/com/alibaba/ttl/threadpool/TtlForkJoinPoolHelper.java
+++ b/src/main/java/com/alibaba/ttl/threadpool/TtlForkJoinPoolHelper.java
@@ -6,7 +6,9 @@ import java.util.concurrent.ForkJoinPool;
 import java.util.concurrent.ForkJoinPool.ForkJoinWorkerThreadFactory;
 
 /**
- * Factory Utils for getting TTL wrapper of {@link ForkJoinWorkerThreadFactory}.
+ * Util methods to wrap/unwrap/check methods to disable Inheritable for {@link ForkJoinWorkerThreadFactory}.
+ * <p>
+ * <b><i>Note:</i></b>
  * <p>
  * all method is {@code null}-safe, when input parameter(eg: {@link ForkJoinWorkerThreadFactory}) is {@code null}, return {@code null}.
  *
diff --git a/src/main/java/com/alibaba/ttl/threadpool/package-info.java b/src/main/java/com/alibaba/ttl/threadpool/package-info.java
index 1754f9a9..f878ab98 100644
--- a/src/main/java/com/alibaba/ttl/threadpool/package-info.java
+++ b/src/main/java/com/alibaba/ttl/threadpool/package-info.java
@@ -1,5 +1,5 @@
 /**
- * Thread pool decoration utils.
+ * Thread pool wrap/decoration utils.
  *
  * @author Jerry Lee (oldratlee at gmail dot com)
  */
-- 
GitLab