From 2027fe1218b872bef31d0a9cd129db8a8981371c Mon Sep 17 00:00:00 2001 From: Jake Wharton Date: Thu, 20 Mar 2014 23:49:11 -0700 Subject: [PATCH] Changes to make JDK 8 doclint happy. --- retrofit/src/main/java/retrofit/ErrorHandler.java | 2 +- retrofit/src/main/java/retrofit/RestAdapter.java | 5 +++-- retrofit/src/main/java/retrofit/http/FieldMap.java | 2 +- retrofit/src/main/java/retrofit/http/Header.java | 2 +- retrofit/src/main/java/retrofit/http/QueryMap.java | 2 +- retrofit/src/main/java/retrofit/package-info.java | 2 +- 6 files changed, 8 insertions(+), 7 deletions(-) diff --git a/retrofit/src/main/java/retrofit/ErrorHandler.java b/retrofit/src/main/java/retrofit/ErrorHandler.java index 81f09443..9934528c 100644 --- a/retrofit/src/main/java/retrofit/ErrorHandler.java +++ b/retrofit/src/main/java/retrofit/ErrorHandler.java @@ -32,7 +32,7 @@ public interface ErrorHandler { * class MyErrorHandler implements ErrorHandler { * @Override public Throwable handleError(RetrofitError cause) { * Response r = cause.getResponse(); - * if (r != null && r.getStatus() == 401) { + * if (r != null && r.getStatus() == 401) { * return new UnauthorizedException(cause); * } * return cause; diff --git a/retrofit/src/main/java/retrofit/RestAdapter.java b/retrofit/src/main/java/retrofit/RestAdapter.java index be98cca8..18174734 100644 --- a/retrofit/src/main/java/retrofit/RestAdapter.java +++ b/retrofit/src/main/java/retrofit/RestAdapter.java @@ -98,9 +98,10 @@ import rx.schedulers.Schedulers; *
  * public interface MyApi {
  *   @POST("/category/{cat}") // Asynchronous execution.
- *   void categoryList(@Path("cat") String a, @Query("page") int b, Callback<List<Item>> cb);
+ *   void categoryList(@Path("cat") String a, @Query("page") int b,
+ *                     Callback<List<Item>> cb);
  *   @POST("/category/{cat}") // Synchronous execution.
- *   List<Item> categoryList(@Path("cat") String a, @Query("page") int b);
+ *   List<Item> categoryList(@Path("cat") String a, @Query("page") int b);
  * }
  * 
*

diff --git a/retrofit/src/main/java/retrofit/http/FieldMap.java b/retrofit/src/main/java/retrofit/http/FieldMap.java index 8bbfda2c..df1b925e 100644 --- a/retrofit/src/main/java/retrofit/http/FieldMap.java +++ b/retrofit/src/main/java/retrofit/http/FieldMap.java @@ -31,7 +31,7 @@ import static java.lang.annotation.RetentionPolicy.RUNTIME; *

  * @FormUrlEncoded
  * @POST("/things")
- * void things(@FieldMap Map fields);
+ * void things(@FieldMap Map<String, String> fields);
  * }
  * 
* Calling with {@code foo.things(ImmutableMap.of("foo", "bar", "kit", "kat")} yields a request diff --git a/retrofit/src/main/java/retrofit/http/Header.java b/retrofit/src/main/java/retrofit/http/Header.java index 7aadc3af..501b40b8 100644 --- a/retrofit/src/main/java/retrofit/http/Header.java +++ b/retrofit/src/main/java/retrofit/http/Header.java @@ -27,7 +27,7 @@ import static java.lang.annotation.RetentionPolicy.RUNTIME; *

*

  * @GET("/")
- * void foo(@Header("Accept-Language") String lang, Callback<Response> cb);
+ * void foo(@Header("Accept-Language") String lang, Callback<Response> cb);
  * 
*

* Header parameters may be {@code null} which will omit them from the request. diff --git a/retrofit/src/main/java/retrofit/http/QueryMap.java b/retrofit/src/main/java/retrofit/http/QueryMap.java index cb3bb005..46a9c5e0 100644 --- a/retrofit/src/main/java/retrofit/http/QueryMap.java +++ b/retrofit/src/main/java/retrofit/http/QueryMap.java @@ -31,7 +31,7 @@ import static java.lang.annotation.RetentionPolicy.RUNTIME; * Simple Example: *

  * @GET("/search")
- * void list(@QueryMap Map filters);
+ * void list(@QueryMap Map<String, String> filters);
  * 
* Calling with {@code foo.list(ImmutableMap.of("foo", "bar", "kit", "kat"))} yields * {@code /search?foo=bar&kit=kat}. diff --git a/retrofit/src/main/java/retrofit/package-info.java b/retrofit/src/main/java/retrofit/package-info.java index 133eaf17..0c6596b3 100644 --- a/retrofit/src/main/java/retrofit/package-info.java +++ b/retrofit/src/main/java/retrofit/package-info.java @@ -5,7 +5,7 @@ *
  * public interface GitHubService {
  *   @GET("/users/{user}/repos")
- *   List listRepos(@Path("user") String user);
+ *   List<Repo> listRepos(@Path("user") String user);
  * }
  * 
*/ -- GitLab