java doc

yhyzgn · Sep 29, 2020 · 19955f6 · 19955f6
1 parent d82e19b
commit 19955f6
Show file tree

Hide file tree

Showing 16 changed files with 119 additions and 119 deletions.
diff --git a/src/main/java/com/yhy/http/pigeon/annotation/Form.java b/src/main/java/com/yhy/http/pigeon/annotation/Form.java
@@ -3,18 +3,18 @@
 import java.lang.annotation.*;
 
 /**
- * author : 颜洪毅 <br/>
- * e-mail : yhyzgn@gmail.com <br/>
- * time   : 2019-09-03 14:29 <br/>
- * version: 1.0.0 <br/>
- * desc   : POST 方法中指定为 form-data <br/>
+ * author : 颜洪毅 <br>
+ * e-mail : yhyzgn@gmail.com <br>
+ * time   : 2019-09-03 14:29 <br>
+ * version: 1.0.0 <br>
+ * desc   : POST 方法中指定为 form-data <br>
  * <p>
  * 用于搭配 {@link com.yhy.http.pigeon.annotation.param.Field}
  *
  * <p>
- * - @POST("/api/post") <br/>
- * - @Form <br/>
- * - Map&lt;String, Object&gt; post(@Query String name, int age, @Field("remark") String ext); <br/>
+ * - @POST("/api/post") <br>
+ * - @Form <br>
+ * - Map&lt;String, Object&gt; post(@Query String name, int age, @Field("remark") String ext); <br>
  */
 @Target(ElementType.METHOD)
 @Retention(RetentionPolicy.RUNTIME)

diff --git a/src/main/java/com/yhy/http/pigeon/annotation/Header.java b/src/main/java/com/yhy/http/pigeon/annotation/Header.java
@@ -3,18 +3,18 @@
 import java.lang.annotation.*;
 
 /**
- * author : 颜洪毅 <br/>
- * e-mail : yhyzgn@gmail.com <br/>
- * time   : 2019-09-03 11:55 <br/>
- * version: 1.0.0 <br/>
- * desc   : Header 参数 <br/>
+ * author : 颜洪毅 <br>
+ * e-mail : yhyzgn@gmail.com <br>
+ * time   : 2019-09-03 11:55 <br>
+ * version: 1.0.0 <br>
+ * desc   : Header 参数 <br>
  * <p>
- * - @GET <br/>
- * - String get(@Header MapMap&lt;String, ?&gt; header); <br/>
+ * - @GET <br>
+ * - String get(@Header MapMap&lt;String, ?&gt; header); <br>
  * <p>
- * - @POST <br/>
- * - @Header(pairName = "Secret", pairValue = "ab12") <br/>
- * - MapMap&lt;String, Object&gt; body(@Header MapMap&lt;String, Object&gt; header, @Body MapMap&lt;String, Object&gt; body); <br/>
+ * - @POST <br>
+ * - @Header(pairName = "Secret", pairValue = "ab12") <br>
+ * - MapMap&lt;String, Object&gt; body(@Header MapMap&lt;String, Object&gt; header, @Body MapMap&lt;String, Object&gt; body); <br>
  */
 @Target({ElementType.METHOD, ElementType.PARAMETER})
 @Retention(RetentionPolicy.RUNTIME)

diff --git a/src/main/java/com/yhy/http/pigeon/annotation/Interceptor.java b/src/main/java/com/yhy/http/pigeon/annotation/Interceptor.java
@@ -3,15 +3,15 @@
 import java.lang.annotation.*;
 
 /**
- * author : 颜洪毅 <br/>
- * e-mail : yhyzgn@gmail.com <br/>
- * time   : 2019-09-04 17:10 <br/>
- * version: 1.0.0 <br/>
- * desc   : 拦截器 <br/>
+ * author : 颜洪毅 <br>
+ * e-mail : yhyzgn@gmail.com <br>
+ * time   : 2019-09-04 17:10 <br>
+ * version: 1.0.0 <br>
+ * desc   : 拦截器 <br>
  * <p>
- * - @GET("/api/get") <br/>
- * - @Interceptor(TestInterceptor.class) <br/>
- * - Map&lt;String, Object&gt; get(String name, int age); <br/>
+ * - @GET("/api/get") <br>
+ * - @Interceptor(TestInterceptor.class) <br>
+ * - Map&lt;String, Object&gt; get(String name, int age); <br>
  */
 @Target(ElementType.METHOD)
 @Retention(RetentionPolicy.RUNTIME)

diff --git a/src/main/java/com/yhy/http/pigeon/annotation/method/DELETE.java b/src/main/java/com/yhy/http/pigeon/annotation/method/DELETE.java
@@ -3,14 +3,14 @@
 import java.lang.annotation.*;
 
 /**
- * author : 颜洪毅 <br/>
- * e-mail : yhyzgn@gmail.com <br/>
- * time   : 2019-09-02 15:52 <br/>
- * version: 1.0.0 <br/>
- * desc   : delete请求 <br/>
+ * author : 颜洪毅 <br>
+ * e-mail : yhyzgn@gmail.com <br>
+ * time   : 2019-09-02 15:52 <br>
+ * version: 1.0.0 <br>
+ * desc   : delete请求 <br>
  * <p>
- * - @DELETE("/api/delete") <br/>
- * - String delete(); <br/>
+ * - @DELETE("/api/delete") <br>
+ * - String delete(); <br>
  */
 @Target(ElementType.METHOD)
 @Retention(RetentionPolicy.RUNTIME)

diff --git a/src/main/java/com/yhy/http/pigeon/annotation/method/GET.java b/src/main/java/com/yhy/http/pigeon/annotation/method/GET.java
@@ -3,14 +3,14 @@
 import java.lang.annotation.*;
 
 /**
- * author : 颜洪毅 <br/>
- * e-mail : yhyzgn@gmail.com <br/>
- * time   : 2019-09-02 15:50 <br/>
- * version: 1.0.0 <br/>
- * desc   : get请求 <br/>
+ * author : 颜洪毅 <br>
+ * e-mail : yhyzgn@gmail.com <br>
+ * time   : 2019-09-02 15:50 <br>
+ * version: 1.0.0 <br>
+ * desc   : get请求 <br>
  * <p>
- * - @GET("/api/get") <br/>
- * - String get(); <br/>
+ * - @GET("/api/get") <br>
+ * - String get(); <br>
  */
 @Target(ElementType.METHOD)
 @Retention(RetentionPolicy.RUNTIME)

diff --git a/src/main/java/com/yhy/http/pigeon/annotation/method/HEAD.java b/src/main/java/com/yhy/http/pigeon/annotation/method/HEAD.java
@@ -3,14 +3,14 @@
 import java.lang.annotation.*;
 
 /**
- * author : 颜洪毅 <br/>
- * e-mail : yhyzgn@gmail.com <br/>
- * time   : 2019-09-02 15:52 <br/>
- * version: 1.0.0 <br/>
- * desc   : head请求 <br/>
+ * author : 颜洪毅 <br>
+ * e-mail : yhyzgn@gmail.com <br>
+ * time   : 2019-09-02 15:52 <br>
+ * version: 1.0.0 <br>
+ * desc   : head请求 <br>
  * <p>
- * - @HEAD("/api/head") <br/>
- * - String head(); <br/>
+ * - @HEAD("/api/head") <br>
+ * - String head(); <br>
  */
 @Target(ElementType.METHOD)
 @Retention(RetentionPolicy.RUNTIME)

diff --git a/src/main/java/com/yhy/http/pigeon/annotation/method/OPTIONS.java b/src/main/java/com/yhy/http/pigeon/annotation/method/OPTIONS.java
@@ -3,14 +3,14 @@
 import java.lang.annotation.*;
 
 /**
- * author : 颜洪毅 <br/>
- * e-mail : yhyzgn@gmail.com <br/>
- * time   : 2019-09-02 15:52 <br/>
- * version: 1.0.0 <br/>
- * desc   : options请求 <br/>
+ * author : 颜洪毅 <br>
+ * e-mail : yhyzgn@gmail.com <br>
+ * time   : 2019-09-02 15:52 <br>
+ * version: 1.0.0 <br>
+ * desc   : options请求 <br>
  * <p>
- * - @OPTIONS("/api/options") <br/>
- * - String options(); <br/>
+ * - @OPTIONS("/api/options") <br>
+ * - String options(); <br>
  */
 @Target(ElementType.METHOD)
 @Retention(RetentionPolicy.RUNTIME)

diff --git a/src/main/java/com/yhy/http/pigeon/annotation/method/PATCH.java b/src/main/java/com/yhy/http/pigeon/annotation/method/PATCH.java
@@ -3,14 +3,14 @@
 import java.lang.annotation.*;
 
 /**
- * author : 颜洪毅 <br/>
- * e-mail : yhyzgn@gmail.com <br/>
- * time   : 2019-09-02 15:52 <br/>
- * version: 1.0.0 <br/>
- * desc   : patch请求 <br/>
+ * author : 颜洪毅 <br>
+ * e-mail : yhyzgn@gmail.com <br>
+ * time   : 2019-09-02 15:52 <br>
+ * version: 1.0.0 <br>
+ * desc   : patch请求 <br>
  * <p>
- * - @PATCH("/api/patch") <br/>
- * - String patch(); <br/>
+ * - @PATCH("/api/patch") <br>
+ * - String patch(); <br>
  */
 @Target(ElementType.METHOD)
 @Retention(RetentionPolicy.RUNTIME)

diff --git a/src/main/java/com/yhy/http/pigeon/annotation/method/POST.java b/src/main/java/com/yhy/http/pigeon/annotation/method/POST.java
@@ -3,14 +3,14 @@
 import java.lang.annotation.*;
 
 /**
- * author : 颜洪毅 <br/>
- * e-mail : yhyzgn@gmail.com <br/>
- * time   : 2019-09-02 15:52 <br/>
- * version: 1.0.0 <br/>
- * desc   : post请求 <br/>
+ * author : 颜洪毅 <br>
+ * e-mail : yhyzgn@gmail.com <br>
+ * time   : 2019-09-02 15:52 <br>
+ * version: 1.0.0 <br>
+ * desc   : post请求 <br>
  * <p>
- * - @POST("/api/post") <br/>
- * - String post(); <br/>
+ * - @POST("/api/post") <br>
+ * - String post(); <br>
  */
 @Target(ElementType.METHOD)
 @Retention(RetentionPolicy.RUNTIME)

diff --git a/src/main/java/com/yhy/http/pigeon/annotation/method/PUT.java b/src/main/java/com/yhy/http/pigeon/annotation/method/PUT.java
@@ -3,14 +3,14 @@
 import java.lang.annotation.*;
 
 /**
- * author : 颜洪毅 <br/>
- * e-mail : yhyzgn@gmail.com <br/>
- * time   : 2019-09-02 15:52 <br/>
- * version: 1.0.0 <br/>
- * desc   : put请求 <br/>
+ * author : 颜洪毅 <br>
+ * e-mail : yhyzgn@gmail.com <br>
+ * time   : 2019-09-02 15:52 <br>
+ * version: 1.0.0 <br>
+ * desc   : put请求 <br>
  * <p>
- * - @PUT("/api/put") <br/>
- * - String put(); <br/>
+ * - @PUT("/api/put") <br>
+ * - String put(); <br>
  */
 @Target(ElementType.METHOD)
 @Retention(RetentionPolicy.RUNTIME)

diff --git a/src/main/java/com/yhy/http/pigeon/annotation/method/TRACE.java b/src/main/java/com/yhy/http/pigeon/annotation/method/TRACE.java
@@ -3,14 +3,14 @@
 import java.lang.annotation.*;
 
 /**
- * author : 颜洪毅 <br/>
- * e-mail : yhyzgn@gmail.com <br/>
- * time   : 2019-09-02 15:52 <br/>
- * version: 1.0.0 <br/>
- * desc   : trace请求 <br/>
+ * author : 颜洪毅 <br>
+ * e-mail : yhyzgn@gmail.com <br>
+ * time   : 2019-09-02 15:52 <br>
+ * version: 1.0.0 <br>
+ * desc   : trace请求 <br>
  * <p>
- * - @TRACE("/api/trace") <br/>
- * - String trace(); <br/>
+ * - @TRACE("/api/trace") <br>
+ * - String trace(); <br>
  */
 @Target(ElementType.METHOD)
 @Retention(RetentionPolicy.RUNTIME)

diff --git a/src/main/java/com/yhy/http/pigeon/annotation/param/Body.java b/src/main/java/com/yhy/http/pigeon/annotation/param/Body.java
@@ -3,14 +3,14 @@
 import java.lang.annotation.*;
 
 /**
- * author : 颜洪毅 <br/>
- * e-mail : yhyzgn@gmail.com <br/>
- * time   : 2019-09-03 14:29 <br/>
- * version: 1.0.0 <br/>
- * desc   : POST Body 参数 <br/>
+ * author : 颜洪毅 <br>
+ * e-mail : yhyzgn@gmail.com <br>
+ * time   : 2019-09-03 14:29 <br>
+ * version: 1.0.0 <br>
+ * desc   : POST Body 参数 <br>
  * <p>
- * - @POST <br/>
- * - Map&lt;String, Object&gt; body(@Header Map&lt;String, Object&gt; header, @Body Map&lt;String, Object&gt; body); <br/>
+ * - @POST <br>
+ * - Map&lt;String, Object&gt; body(@Header Map&lt;String, Object&gt; header, @Body Map&lt;String, Object&gt; body); <br>
  */
 @Target(ElementType.PARAMETER)
 @Retention(RetentionPolicy.RUNTIME)

diff --git a/src/main/java/com/yhy/http/pigeon/annotation/param/Field.java b/src/main/java/com/yhy/http/pigeon/annotation/param/Field.java
@@ -4,21 +4,21 @@
 
 /**
  * author : 颜洪毅
- * e-mail : yhyzgn@gmail.com <br/>
- * time   : 2019-09-03 12:42 <br/>
- * version: 1.0.0 <br/>
- * desc   : POST 参数 <br/>
+ * e-mail : yhyzgn@gmail.com <br>
+ * time   : 2019-09-03 12:42 <br>
+ * version: 1.0.0 <br>
+ * desc   : POST 参数 <br>
  * <p>
  * 必须搭配 {@link com.yhy.http.pigeon.annotation.Form} 使用
  *
  * <p>
- * - @POST("/api/post") <br/>
- * - @Form <br/>
- * - Map&lt;String, Object&gt; post(@Query String name, int age, @Field("remark") String ext); <br/>
+ * - @POST("/api/post") <br>
+ * - @Form <br>
+ * - Map&lt;String, Object&gt; post(@Query String name, int age, @Field("remark") String ext); <br>
  * <p>
- * - @POST("/api/post/cat") <br/>
- * - @Form <br/>
- * - Map&lt;String, Object&gt; post(@Header Map&lt;String, Object&gt; header, @Field Map&lt;String, Object&gt; params); <br/>
+ * - @POST("/api/post/cat") <br>
+ * - @Form <br>
+ * - Map&lt;String, Object&gt; post(@Header Map&lt;String, Object&gt; header, @Field Map&lt;String, Object&gt; params); <br>
  */
 @Target(ElementType.PARAMETER)
 @Retention(RetentionPolicy.RUNTIME)

diff --git a/src/main/java/com/yhy/http/pigeon/annotation/param/Part.java b/src/main/java/com/yhy/http/pigeon/annotation/param/Part.java
@@ -4,10 +4,10 @@
 
 /**
  * author : 颜洪毅
- * e-mail : yhyzgn@gmail.com <br/>
- * time   : 2019-09-03 12:42 <br/>
- * version: 1.0.0 <br/>
- * desc   : multipart 文件上传参数 <br/>
+ * e-mail : yhyzgn@gmail.com <br>
+ * time   : 2019-09-03 12:42 <br>
+ * version: 1.0.0 <br>
+ * desc   : multipart 文件上传参数 <br>
  */
 @Target(ElementType.PARAMETER)
 @Retention(RetentionPolicy.RUNTIME)

diff --git a/src/main/java/com/yhy/http/pigeon/annotation/param/Path.java b/src/main/java/com/yhy/http/pigeon/annotation/param/Path.java
@@ -3,14 +3,14 @@
 import java.lang.annotation.*;
 
 /**
- * author : 颜洪毅 <br/>
- * e-mail : yhyzgn@gmail.com <br/>
- * time   : 2019-09-03 12:42 <br/>
- * version: 1.0.0 <br/>
- * desc   : Path 参数 <br/>
+ * author : 颜洪毅 <br>
+ * e-mail : yhyzgn@gmail.com <br>
+ * time   : 2019-09-03 12:42 <br>
+ * version: 1.0.0 <br>
+ * desc   : Path 参数 <br>
  * <p>
- * - @GET("/api/get/path/{id}/{count}") <br/>
- * - Map&lt;String, Object&gt; path(@Path("id") String alias, @Path int count, String remark); <br/>
+ * - @GET("/api/get/path/{id}/{count}") <br>
+ * - Map&lt;String, Object&gt; path(@Path("id") String alias, @Path int count, String remark); <br>
  */
 @Target(ElementType.PARAMETER)
 @Retention(RetentionPolicy.RUNTIME)

diff --git a/src/main/java/com/yhy/http/pigeon/annotation/param/Query.java b/src/main/java/com/yhy/http/pigeon/annotation/param/Query.java
@@ -3,17 +3,17 @@
 import java.lang.annotation.*;
 
 /**
- * author : 颜洪毅 <br/>
- * e-mail : yhyzgn@gmail.com <br/>
- * time   : 2019-09-03 12:41 <br/>
- * version: 1.0.0 <br/>
- * desc   : URL 参数 <br/>
+ * author : 颜洪毅 <br>
+ * e-mail : yhyzgn@gmail.com <br>
+ * time   : 2019-09-03 12:41 <br>
+ * version: 1.0.0 <br>
+ * desc   : URL 参数 <br>
  * <p>
- * - @GET("/api/get") <br/>
- * - Map&lt;String, Object&gt; get(@Query String name, int age, @Query("remark") String ext); <br/>
+ * - @GET("/api/get") <br>
+ * - Map&lt;String, Object&gt; get(@Query String name, int age, @Query("remark") String ext); <br>
  * <p>
- * - @GET("/api/get") <br/>
- * - Map&lt;String, Object&gt; get(@Header Map&lt;String, Object&gt; header, @Query Map&lt;String, Object&gt; params); <br/>
+ * - @GET("/api/get") <br>
+ * - Map&lt;String, Object&gt; get(@Header Map&lt;String, Object&gt; header, @Query Map&lt;String, Object&gt; params); <br>
  */
 @Target(ElementType.PARAMETER)
 @Retention(RetentionPolicy.RUNTIME)