From 19955f6b6804a8b467eb7b0bee9ab93299701581 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E9=A2=9C=E6=B4=AA=E6=AF=85?= Date: Tue, 29 Sep 2020 23:39:34 +0800 Subject: [PATCH] java doc --- .../com/yhy/http/pigeon/annotation/Form.java | 16 +++++++-------- .../yhy/http/pigeon/annotation/Header.java | 20 +++++++++---------- .../http/pigeon/annotation/Interceptor.java | 16 +++++++-------- .../http/pigeon/annotation/method/DELETE.java | 14 ++++++------- .../http/pigeon/annotation/method/GET.java | 14 ++++++------- .../http/pigeon/annotation/method/HEAD.java | 14 ++++++------- .../pigeon/annotation/method/OPTIONS.java | 14 ++++++------- .../http/pigeon/annotation/method/PATCH.java | 14 ++++++------- .../http/pigeon/annotation/method/POST.java | 14 ++++++------- .../http/pigeon/annotation/method/PUT.java | 14 ++++++------- .../http/pigeon/annotation/method/TRACE.java | 14 ++++++------- .../http/pigeon/annotation/param/Body.java | 14 ++++++------- .../http/pigeon/annotation/param/Field.java | 20 +++++++++---------- .../http/pigeon/annotation/param/Part.java | 8 ++++---- .../http/pigeon/annotation/param/Path.java | 14 ++++++------- .../http/pigeon/annotation/param/Query.java | 18 ++++++++--------- 16 files changed, 119 insertions(+), 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 index 324d2f0..eb447e0 100644 --- 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 : 颜洪毅
- * e-mail : yhyzgn@gmail.com
- * time : 2019-09-03 14:29
- * version: 1.0.0
- * desc : POST 方法中指定为 form-data
+ * author : 颜洪毅
+ * e-mail : yhyzgn@gmail.com
+ * time : 2019-09-03 14:29
+ * version: 1.0.0
+ * desc : POST 方法中指定为 form-data
*

* 用于搭配 {@link com.yhy.http.pigeon.annotation.param.Field} * *

- * - @POST("/api/post")
- * - @Form
- * - Map<String, Object> post(@Query String name, int age, @Field("remark") String ext);
+ * - @POST("/api/post")
+ * - @Form
+ * - Map<String, Object> post(@Query String name, int age, @Field("remark") String ext);
*/ @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 index 5c4e314..a06b0b0 100644 --- 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 : 颜洪毅
- * e-mail : yhyzgn@gmail.com
- * time : 2019-09-03 11:55
- * version: 1.0.0
- * desc : Header 参数
+ * author : 颜洪毅
+ * e-mail : yhyzgn@gmail.com
+ * time : 2019-09-03 11:55
+ * version: 1.0.0
+ * desc : Header 参数
*

- * - @GET
- * - String get(@Header MapMap<String, ?> header);
+ * - @GET
+ * - String get(@Header MapMap<String, ?> header);
*

- * - @POST
- * - @Header(pairName = "Secret", pairValue = "ab12")
- * - MapMap<String, Object> body(@Header MapMap<String, Object> header, @Body MapMap<String, Object> body);
+ * - @POST
+ * - @Header(pairName = "Secret", pairValue = "ab12")
+ * - MapMap<String, Object> body(@Header MapMap<String, Object> header, @Body MapMap<String, Object> body);
*/ @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 index 0170f2a..057232b 100644 --- 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 : 颜洪毅
- * e-mail : yhyzgn@gmail.com
- * time : 2019-09-04 17:10
- * version: 1.0.0
- * desc : 拦截器
+ * author : 颜洪毅
+ * e-mail : yhyzgn@gmail.com
+ * time : 2019-09-04 17:10
+ * version: 1.0.0
+ * desc : 拦截器
*

- * - @GET("/api/get")
- * - @Interceptor(TestInterceptor.class)
- * - Map<String, Object> get(String name, int age);
+ * - @GET("/api/get")
+ * - @Interceptor(TestInterceptor.class)
+ * - Map<String, Object> get(String name, int age);
*/ @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 index 0a0ef29..1af4525 100644 --- 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 : 颜洪毅
- * e-mail : yhyzgn@gmail.com
- * time : 2019-09-02 15:52
- * version: 1.0.0
- * desc : delete请求
+ * author : 颜洪毅
+ * e-mail : yhyzgn@gmail.com
+ * time : 2019-09-02 15:52
+ * version: 1.0.0
+ * desc : delete请求
*

- * - @DELETE("/api/delete")
- * - String delete();
+ * - @DELETE("/api/delete")
+ * - String delete();
*/ @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 index 0cf00db..fb72298 100644 --- 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 : 颜洪毅
- * e-mail : yhyzgn@gmail.com
- * time : 2019-09-02 15:50
- * version: 1.0.0
- * desc : get请求
+ * author : 颜洪毅
+ * e-mail : yhyzgn@gmail.com
+ * time : 2019-09-02 15:50
+ * version: 1.0.0
+ * desc : get请求
*

- * - @GET("/api/get")
- * - String get();
+ * - @GET("/api/get")
+ * - String get();
*/ @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 index 4557a66..2d52535 100644 --- 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 : 颜洪毅
- * e-mail : yhyzgn@gmail.com
- * time : 2019-09-02 15:52
- * version: 1.0.0
- * desc : head请求
+ * author : 颜洪毅
+ * e-mail : yhyzgn@gmail.com
+ * time : 2019-09-02 15:52
+ * version: 1.0.0
+ * desc : head请求
*

- * - @HEAD("/api/head")
- * - String head();
+ * - @HEAD("/api/head")
+ * - String head();
*/ @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 index c3b2f27..615d82b 100644 --- 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 : 颜洪毅
- * e-mail : yhyzgn@gmail.com
- * time : 2019-09-02 15:52
- * version: 1.0.0
- * desc : options请求
+ * author : 颜洪毅
+ * e-mail : yhyzgn@gmail.com
+ * time : 2019-09-02 15:52
+ * version: 1.0.0
+ * desc : options请求
*

- * - @OPTIONS("/api/options")
- * - String options();
+ * - @OPTIONS("/api/options")
+ * - String options();
*/ @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 index 22a265e..75ec5b4 100644 --- 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 : 颜洪毅
- * e-mail : yhyzgn@gmail.com
- * time : 2019-09-02 15:52
- * version: 1.0.0
- * desc : patch请求
+ * author : 颜洪毅
+ * e-mail : yhyzgn@gmail.com
+ * time : 2019-09-02 15:52
+ * version: 1.0.0
+ * desc : patch请求
*

- * - @PATCH("/api/patch")
- * - String patch();
+ * - @PATCH("/api/patch")
+ * - String patch();
*/ @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 index f95c4db..c170d5b 100644 --- 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 : 颜洪毅
- * e-mail : yhyzgn@gmail.com
- * time : 2019-09-02 15:52
- * version: 1.0.0
- * desc : post请求
+ * author : 颜洪毅
+ * e-mail : yhyzgn@gmail.com
+ * time : 2019-09-02 15:52
+ * version: 1.0.0
+ * desc : post请求
*

- * - @POST("/api/post")
- * - String post();
+ * - @POST("/api/post")
+ * - String post();
*/ @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 index b03b720..6d00f8c 100644 --- 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 : 颜洪毅
- * e-mail : yhyzgn@gmail.com
- * time : 2019-09-02 15:52
- * version: 1.0.0
- * desc : put请求
+ * author : 颜洪毅
+ * e-mail : yhyzgn@gmail.com
+ * time : 2019-09-02 15:52
+ * version: 1.0.0
+ * desc : put请求
*

- * - @PUT("/api/put")
- * - String put();
+ * - @PUT("/api/put")
+ * - String put();
*/ @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 index ce2b48f..84bc9a1 100644 --- 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 : 颜洪毅
- * e-mail : yhyzgn@gmail.com
- * time : 2019-09-02 15:52
- * version: 1.0.0
- * desc : trace请求
+ * author : 颜洪毅
+ * e-mail : yhyzgn@gmail.com
+ * time : 2019-09-02 15:52
+ * version: 1.0.0
+ * desc : trace请求
*

- * - @TRACE("/api/trace")
- * - String trace();
+ * - @TRACE("/api/trace")
+ * - String trace();
*/ @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 index 96d65f1..6d17039 100644 --- 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 : 颜洪毅
- * e-mail : yhyzgn@gmail.com
- * time : 2019-09-03 14:29
- * version: 1.0.0
- * desc : POST Body 参数
+ * author : 颜洪毅
+ * e-mail : yhyzgn@gmail.com
+ * time : 2019-09-03 14:29
+ * version: 1.0.0
+ * desc : POST Body 参数
*

- * - @POST
- * - Map<String, Object> body(@Header Map<String, Object> header, @Body Map<String, Object> body);
+ * - @POST
+ * - Map<String, Object> body(@Header Map<String, Object> header, @Body Map<String, Object> body);
*/ @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 index fc49062..cf242af 100644 --- 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
- * time : 2019-09-03 12:42
- * version: 1.0.0
- * desc : POST 参数
+ * e-mail : yhyzgn@gmail.com
+ * time : 2019-09-03 12:42
+ * version: 1.0.0
+ * desc : POST 参数
*

* 必须搭配 {@link com.yhy.http.pigeon.annotation.Form} 使用 * *

- * - @POST("/api/post")
- * - @Form
- * - Map<String, Object> post(@Query String name, int age, @Field("remark") String ext);
+ * - @POST("/api/post")
+ * - @Form
+ * - Map<String, Object> post(@Query String name, int age, @Field("remark") String ext);
*

- * - @POST("/api/post/cat")
- * - @Form
- * - Map<String, Object> post(@Header Map<String, Object> header, @Field Map<String, Object> params);
+ * - @POST("/api/post/cat")
+ * - @Form
+ * - Map<String, Object> post(@Header Map<String, Object> header, @Field Map<String, Object> params);
*/ @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 index 14d9fe2..9166b93 100644 --- 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
- * time : 2019-09-03 12:42
- * version: 1.0.0
- * desc : multipart 文件上传参数
+ * e-mail : yhyzgn@gmail.com
+ * time : 2019-09-03 12:42
+ * version: 1.0.0
+ * desc : multipart 文件上传参数
*/ @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 index e34e02e..079b64b 100644 --- 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 : 颜洪毅
- * e-mail : yhyzgn@gmail.com
- * time : 2019-09-03 12:42
- * version: 1.0.0
- * desc : Path 参数
+ * author : 颜洪毅
+ * e-mail : yhyzgn@gmail.com
+ * time : 2019-09-03 12:42
+ * version: 1.0.0
+ * desc : Path 参数
*

- * - @GET("/api/get/path/{id}/{count}")
- * - Map<String, Object> path(@Path("id") String alias, @Path int count, String remark);
+ * - @GET("/api/get/path/{id}/{count}")
+ * - Map<String, Object> path(@Path("id") String alias, @Path int count, String remark);
*/ @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 index 22a2205..109a0fb 100644 --- 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 : 颜洪毅
- * e-mail : yhyzgn@gmail.com
- * time : 2019-09-03 12:41
- * version: 1.0.0
- * desc : URL 参数
+ * author : 颜洪毅
+ * e-mail : yhyzgn@gmail.com
+ * time : 2019-09-03 12:41
+ * version: 1.0.0
+ * desc : URL 参数
*

- * - @GET("/api/get")
- * - Map<String, Object> get(@Query String name, int age, @Query("remark") String ext);
+ * - @GET("/api/get")
+ * - Map<String, Object> get(@Query String name, int age, @Query("remark") String ext);
*

- * - @GET("/api/get")
- * - Map<String, Object> get(@Header Map<String, Object> header, @Query Map<String, Object> params);
+ * - @GET("/api/get")
+ * - Map<String, Object> get(@Header Map<String, Object> header, @Query Map<String, Object> params);
*/ @Target(ElementType.PARAMETER) @Retention(RetentionPolicy.RUNTIME)