optimize comment of package-info.java. (#1273) (#1276)

Signed-off-by: Jiangnan Jia <[email protected]> Signed-off-by: Jiangnan Jia <[email protected]>
sofastack · Nov 8, 2022 · 1d0dbe2 · 1d0dbe2
1 parent 8565e76
commit 1d0dbe2
Show file tree

Hide file tree

Showing 6 changed files with 20 additions and 22 deletions.
diff --git a/core/api/src/main/java/com/alipay/sofa/rpc/bootstrap/package-info.java b/core/api/src/main/java/com/alipay/sofa/rpc/bootstrap/package-info.java
@@ -14,8 +14,8 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package com.alipay.sofa.rpc.bootstrap;
-
 /**
  * 启动相关的类，包括发布引用服务的启动类，扩展接口等
  */
+package com.alipay.sofa.rpc.bootstrap;
+
diff --git a/core/api/src/main/java/com/alipay/sofa/rpc/client/package-info.java b/core/api/src/main/java/com/alipay/sofa/rpc/client/package-info.java
@@ -14,8 +14,8 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package com.alipay.sofa.rpc.client;
-
 /**
  * 客户端相关的类，例如客户端模式，长连接管理，路由，负载均衡等
  */
+package com.alipay.sofa.rpc.client;
+
diff --git a/core/api/src/main/java/com/alipay/sofa/rpc/codec/package-info.java b/core/api/src/main/java/com/alipay/sofa/rpc/codec/package-info.java
@@ -14,8 +14,8 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package com.alipay.sofa.rpc.codec;
-
 /**
  * 主要包含了序列化和压缩算法。注意：不是数据协议
  */
+package com.alipay.sofa.rpc.codec;
+
diff --git a/core/common/src/main/java/com/alipay/sofa/rpc/common/json/package-info.java b/core/common/src/main/java/com/alipay/sofa/rpc/common/json/package-info.java
@@ -14,12 +14,12 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package com.alipay.sofa.rpc.common.json;
-
-/*
+/**
  * 本包为简单的JSON解析类，性能一般，支持格式也有限，主要用于配置文件解析。
  * 建议只在配置加载等场景中使用。
  * 但是有一个特别的地方就是支持注释的json文档。
  * <p>
  * 自定义对象通过先转为Map再转为对象：JSON<-> Map <-> Object
- */
+ */
+package com.alipay.sofa.rpc.common.json;
+
diff --git a/fault/fault-tolerance/src/main/java/com/alipay/sofa/rpc/client/aft/package-info.java b/fault/fault-tolerance/src/main/java/com/alipay/sofa/rpc/client/aft/package-info.java
@@ -14,13 +14,12 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package com.alipay.sofa.rpc.client.aft;
-
-/*
+/**
  * Adaptive Fault Tolerance
- * 
- * Collection Data 
+ *
+ * Collection Data
  *     --> Build Measure Model
- *     --> Do Measure (Get Result) 
- *     --> Regulate measure result to do degrade or recover 
- */
+ *     --> Do Measure (Get Result)
+ *     --> Regulate measure result to do degrade or recover
+ */
+package com.alipay.sofa.rpc.client.aft;
diff --git a/test/test-integration/src/test/java/com/alipay/sofa/rpc/test/exception/package-info.java b/test/test-integration/src/test/java/com/alipay/sofa/rpc/test/exception/package-info.java
@@ -14,8 +14,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package com.alipay.sofa.rpc.test.exception;
-
-/*
+/**
  * 测试业务的异常捕获
- */
+ */
+package com.alipay.sofa.rpc.test.exception;