From 2a53536aad6e67702e8b2be66d66c4a6b21bb4c4 Mon Sep 17 00:00:00 2001 From: Jake Wharton Date: Tue, 12 Apr 2016 23:47:54 -0400 Subject: [PATCH] Javadoc doclint crap. --- .../retrofit2/adapter/guava/GuavaCallAdapterFactory.java | 2 +- .../retrofit2/adapter/java8/Java8CallAdapterFactory.java | 2 +- .../adapter/rxjava/RxJavaCallAdapterFactory.java | 2 +- retrofit/src/main/java/retrofit2/CallAdapter.java | 6 +++--- retrofit/src/main/java/retrofit2/Retrofit.java | 2 +- retrofit/src/main/java/retrofit2/http/Field.java | 4 ++-- retrofit/src/main/java/retrofit2/http/FieldMap.java | 2 +- retrofit/src/main/java/retrofit2/http/HTTP.java | 4 ++-- retrofit/src/main/java/retrofit2/http/Header.java | 2 +- retrofit/src/main/java/retrofit2/http/Part.java | 2 +- retrofit/src/main/java/retrofit2/http/PartMap.java | 2 +- retrofit/src/main/java/retrofit2/http/Path.java | 6 +++--- retrofit/src/main/java/retrofit2/http/Query.java | 8 ++++---- retrofit/src/main/java/retrofit2/http/QueryMap.java | 4 ++-- retrofit/src/main/java/retrofit2/http/Url.java | 2 +- 15 files changed, 25 insertions(+), 25 deletions(-) diff --git a/retrofit-adapters/guava/src/main/java/retrofit2/adapter/guava/GuavaCallAdapterFactory.java b/retrofit-adapters/guava/src/main/java/retrofit2/adapter/guava/GuavaCallAdapterFactory.java index fab09161b5..df40799c58 100644 --- a/retrofit-adapters/guava/src/main/java/retrofit2/adapter/guava/GuavaCallAdapterFactory.java +++ b/retrofit-adapters/guava/src/main/java/retrofit2/adapter/guava/GuavaCallAdapterFactory.java @@ -35,7 +35,7 @@ * 

  * interface MyService {
  *   @GET("user/me")
- *   ListenableFuture getUser()
+ *   ListenableFuture<User> getUser()
  * }
  *
* There are two configurations supported for the {@code ListenableFuture} type parameter: diff --git a/retrofit-adapters/java8/src/main/java/retrofit2/adapter/java8/Java8CallAdapterFactory.java b/retrofit-adapters/java8/src/main/java/retrofit2/adapter/java8/Java8CallAdapterFactory.java index 6dff5ec02b..b0bd0efb0c 100644 --- a/retrofit-adapters/java8/src/main/java/retrofit2/adapter/java8/Java8CallAdapterFactory.java +++ b/retrofit-adapters/java8/src/main/java/retrofit2/adapter/java8/Java8CallAdapterFactory.java @@ -34,7 +34,7 @@ * 

  * interface MyService {
  *   @GET("user/me")
- *   CompletableFuture getUser()
+ *   CompletableFuture<User> getUser()
  * }
  *
* There are two configurations supported for the {@code CompletableFuture} type parameter: diff --git a/retrofit-adapters/rxjava/src/main/java/retrofit2/adapter/rxjava/RxJavaCallAdapterFactory.java b/retrofit-adapters/rxjava/src/main/java/retrofit2/adapter/rxjava/RxJavaCallAdapterFactory.java index 44a6ef8423..f0feb4b21d 100644 --- a/retrofit-adapters/rxjava/src/main/java/retrofit2/adapter/rxjava/RxJavaCallAdapterFactory.java +++ b/retrofit-adapters/rxjava/src/main/java/retrofit2/adapter/rxjava/RxJavaCallAdapterFactory.java @@ -40,7 +40,7 @@ * 

  * interface MyService {
  *   @GET("user/me")
- *   Observable getUser()
+ *   Observable<User> getUser()
  * }
  *
* There are three configurations supported for the {@code Observable} type parameter: diff --git a/retrofit/src/main/java/retrofit2/CallAdapter.java b/retrofit/src/main/java/retrofit2/CallAdapter.java index cbbcf7fc68..2f56683b88 100644 --- a/retrofit/src/main/java/retrofit2/CallAdapter.java +++ b/retrofit/src/main/java/retrofit2/CallAdapter.java @@ -42,10 +42,10 @@ public interface CallAdapter { * return a new {@code Async} which invoked {@code call} when run. * 

    * @Override
-   * public  Async adapt(final Call call) {
-   *   return Async.create(new Callable>() {
+   * public <R> Async<R> adapt(final Call<R> call) {
+   *   return Async.create(new Callable<Response<R>>() {
    *     @Override
-   *     public Response call() throws Exception {
+   *     public Response<R> call() throws Exception {
    *       return call.execute();
    *     }
    *   });
diff --git a/retrofit/src/main/java/retrofit2/Retrofit.java b/retrofit/src/main/java/retrofit2/Retrofit.java
index 6cc905c765..b194d4ed5e 100644
--- a/retrofit/src/main/java/retrofit2/Retrofit.java
+++ b/retrofit/src/main/java/retrofit2/Retrofit.java
@@ -50,7 +50,7 @@
  *     .build();
  *
  * MyApi api = retrofit.create(MyApi.class);
- * Response user = api.getUser().execute();
+ * Response<User> user = api.getUser().execute();
  *
* * @author Bob Lee (bob@squareup.com) diff --git a/retrofit/src/main/java/retrofit2/http/Field.java b/retrofit/src/main/java/retrofit2/http/Field.java index b947311563..4dbd1bf11a 100644 --- a/retrofit/src/main/java/retrofit2/http/Field.java +++ b/retrofit/src/main/java/retrofit2/http/Field.java @@ -33,7 +33,7 @@ * 

  * @FormUrlEncoded
  * @POST("/")
- * Call<ResponseBody> example(
+ * Call<ResponseBody> example(
  *     @Field("name") String name,
  *     @Field("occupation") String occupation);
  *
@@ -44,7 +44,7 @@ * 

  * @FormUrlEncoded
  * @POST("/list")
- * Call<ResponseBody> example(@Field("name") String... names);
+ * Call<ResponseBody> example(@Field("name") String... names);
  *
* Calling with {@code foo.example("Bob Smith", "Jane Doe")} yields a request body of * {@code name=Bob+Smith&name=Jane+Doe}. diff --git a/retrofit/src/main/java/retrofit2/http/FieldMap.java b/retrofit/src/main/java/retrofit2/http/FieldMap.java index d3b26cb3d9..a7eb1ee860 100644 --- a/retrofit/src/main/java/retrofit2/http/FieldMap.java +++ b/retrofit/src/main/java/retrofit2/http/FieldMap.java @@ -29,7 +29,7 @@ * 

  * @FormUrlEncoded
  * @POST("/things")
- * Call<ResponseBody> things(@FieldMap Map<String, String> fields);
+ * Call<ResponseBody> things(@FieldMap Map<String, String> fields);
  *
* Calling with {@code foo.things(ImmutableMap.of("foo", "bar", "kit", "kat")} yields a request * body of {@code foo=bar&kit=kat}. diff --git a/retrofit/src/main/java/retrofit2/http/HTTP.java b/retrofit/src/main/java/retrofit2/http/HTTP.java index 28320d3eb6..101eecf3be 100644 --- a/retrofit/src/main/java/retrofit2/http/HTTP.java +++ b/retrofit/src/main/java/retrofit2/http/HTTP.java @@ -28,14 +28,14 @@ * 

  * interface Service {
  *   @HTTP(method = "CUSTOM", path = "custom/endpoint/")
- *   Call customEndpoint();
+ *   Call<ResponseBody> customEndpoint();
  * }
  *
* This annotation can also used for sending {@code DELETE} with a request body: * 

  * interface Service {
  *   @HTTP(method = "DELETE", path = "remove/", hasBody = true)
- *   Call deleteObject(@Body RequestBody object);
+ *   Call<ResponseBody> deleteObject(@Body RequestBody object);
  * }
  *
*/ diff --git a/retrofit/src/main/java/retrofit2/http/Header.java b/retrofit/src/main/java/retrofit2/http/Header.java index 7b7afd08e3..8ce5cb8d05 100644 --- a/retrofit/src/main/java/retrofit2/http/Header.java +++ b/retrofit/src/main/java/retrofit2/http/Header.java @@ -26,7 +26,7 @@ * Replaces the header with the value of its target. * 

  * @GET("/")
- * Call<ResponseBody> foo(@Header("Accept-Language") String lang);
+ * Call<ResponseBody> foo(@Header("Accept-Language") String lang);
  *
* Header parameters may be {@code null} which will omit them from the request. Passing a * {@link java.util.List List} or array will result in a header for each non-{@code null} item. diff --git a/retrofit/src/main/java/retrofit2/http/Part.java b/retrofit/src/main/java/retrofit2/http/Part.java index 44a1457ce0..f320c088f9 100644 --- a/retrofit/src/main/java/retrofit2/http/Part.java +++ b/retrofit/src/main/java/retrofit2/http/Part.java @@ -43,7 +43,7 @@ * 

  * @Multipart
  * @POST("/")
- * Call<ResponseBody> example(
+ * Call<ResponseBody> example(
  *     @Part("description") String description,
  *     @Part(value = "image", encoding = "8-bit") RequestBody image);
  *
diff --git a/retrofit/src/main/java/retrofit2/http/PartMap.java b/retrofit/src/main/java/retrofit2/http/PartMap.java index 1a30ef40fd..79eae21471 100644 --- a/retrofit/src/main/java/retrofit2/http/PartMap.java +++ b/retrofit/src/main/java/retrofit2/http/PartMap.java @@ -37,7 +37,7 @@ * 

  * @Multipart
  * @POST("/upload")
- * Call<ResponseBody> upload(
+ * Call<ResponseBody> upload(
  *     @Part("file") RequestBody file,
  *     @PartMap Map<String, RequestBody> params);
  *
diff --git a/retrofit/src/main/java/retrofit2/http/Path.java b/retrofit/src/main/java/retrofit2/http/Path.java index 3652a8538b..4d8c6f0544 100644 --- a/retrofit/src/main/java/retrofit2/http/Path.java +++ b/retrofit/src/main/java/retrofit2/http/Path.java @@ -29,17 +29,17 @@ * Simple example: * 

  * @GET("/image/{id}")
- * Call<ResponseBody> example(@Path("id") int id);
+ * Call<ResponseBody> example(@Path("id") int id);
  *
* Calling with {@code foo.example(1)} yields {@code /image/1}. *

* Values are URL encoded by default. Disable with {@code encoded=true}. * 


  * @GET("/user/{name}")
- * Call<ResponseBody> encoded(@Path("name") String name);
+ * Call<ResponseBody> encoded(@Path("name") String name);
  *
  * @GET("/user/{name}")
- * Call<ResponseBody> notEncoded(@Path(value="name", encoded=true) String name);
+ * Call<ResponseBody> notEncoded(@Path(value="name", encoded=true) String name);
  *
* Calling {@code foo.encoded("John+Doe")} yields {@code /user/John%2BDoe} whereas * {@code foo.notEncoded("John+Doe")} yields {@code /user/John+Doe}. diff --git a/retrofit/src/main/java/retrofit2/http/Query.java b/retrofit/src/main/java/retrofit2/http/Query.java index ace0cc41d0..01d294f3aa 100644 --- a/retrofit/src/main/java/retrofit2/http/Query.java +++ b/retrofit/src/main/java/retrofit2/http/Query.java @@ -32,21 +32,21 @@ * Simple Example: * 

  * @GET("/list")
- * Call<ResponseBody> list(@Query("page") int page);
+ * Call<ResponseBody> list(@Query("page") int page);
  *
* Calling with {@code foo.list(1)} yields {@code /list?page=1}. *

* Example with {@code null}: * 


  * @GET("/list")
- * Call<ResponseBody> list(@Query("category") String category);
+ * Call<ResponseBody> list(@Query("category") String category);
  *
* Calling with {@code foo.list(null)} yields {@code /list}. *

* Array/Varargs Example: * 


  * @GET("/list")
- * Call<ResponseBody> list(@Query("category") String... categories);
+ * Call<ResponseBody> list(@Query("category") String... categories);
  *
* Calling with {@code foo.list("bar", "baz")} yields * {@code /list?category=bar&category=baz}. @@ -55,7 +55,7 @@ * to change this behavior. * 

  * @GET("/search")
- * Call<ResponseBody> list(@Query(value="foo", encoded=true) String foo);
+ * Call<ResponseBody> list(@Query(value="foo", encoded=true) String foo);
  *
* Calling with {@code foo.list("foo+bar"))} yields {@code /search?foo=foo+bar}. * diff --git a/retrofit/src/main/java/retrofit2/http/QueryMap.java b/retrofit/src/main/java/retrofit2/http/QueryMap.java index 0604653d30..27e6ae8362 100644 --- a/retrofit/src/main/java/retrofit2/http/QueryMap.java +++ b/retrofit/src/main/java/retrofit2/http/QueryMap.java @@ -30,7 +30,7 @@ * Simple Example: * 

  * @GET("/search")
- * Call<ResponseBody> list(@QueryMap Map<String, String> filters);
+ * Call<ResponseBody> list(@QueryMap Map<String, String> filters);
  *
* Calling with {@code foo.list(ImmutableMap.of("foo", "bar", "kit", "kat"))} yields * {@code /search?foo=bar&kit=kat}. @@ -39,7 +39,7 @@ * {@link #encoded() encoded=true} to change this behavior. * 

  * @GET("/search")
- * Call<ResponseBody> list(@QueryMap(encoded=true) Map<String, String> filters);
+ * Call<ResponseBody> list(@QueryMap(encoded=true) Map<String, String> filters);
  *
* Calling with {@code foo.list(ImmutableMap.of("foo", "foo+bar"))} yields * {@code /search?foo=foo+bar}. diff --git a/retrofit/src/main/java/retrofit2/http/Url.java b/retrofit/src/main/java/retrofit2/http/Url.java index d2e7946e26..31187ca3d4 100644 --- a/retrofit/src/main/java/retrofit2/http/Url.java +++ b/retrofit/src/main/java/retrofit2/http/Url.java @@ -28,7 +28,7 @@ * URL resolved against the {@linkplain Retrofit#baseUrl() base URL}. * 

  * @GET
- * Call<ResponseBody> list(@Url String url);
+ * Call<ResponseBody> list(@Url String url);
  *
*

* See {@linkplain retrofit2.Retrofit.Builder#baseUrl(HttpUrl) base URL} for details of how