Skip to content

Commit

Permalink
Javadoc doclint crap.
Browse files Browse the repository at this point in the history
  • Loading branch information
JakeWharton committed Apr 13, 2016
1 parent 44f1ce1 commit 2a53536
Show file tree
Hide file tree
Showing 15 changed files with 25 additions and 25 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
* <pre><code>
* interface MyService {
* &#64;GET("user/me")
* ListenableFuture<User> getUser()
* ListenableFuture&lt;User&gt; getUser()
* }
* </code></pre>
* There are two configurations supported for the {@code ListenableFuture} type parameter:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
* <pre><code>
* interface MyService {
* &#64;GET("user/me")
* CompletableFuture<User> getUser()
* CompletableFuture&lt;User&gt; getUser()
* }
* </code></pre>
* There are two configurations supported for the {@code CompletableFuture} type parameter:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
* <pre><code>
* interface MyService {
* &#64;GET("user/me")
* Observable<User> getUser()
* Observable&lt;User&gt; getUser()
* }
* </code></pre>
* There are three configurations supported for the {@code Observable} type parameter:
Expand Down
6 changes: 3 additions & 3 deletions retrofit/src/main/java/retrofit2/CallAdapter.java
Original file line number Diff line number Diff line change
Expand Up @@ -42,10 +42,10 @@ public interface CallAdapter<T> {
* return a new {@code Async<R>} which invoked {@code call} when run.
* <pre><code>
* &#64;Override
* public <R> Async<R> adapt(final Call<R> call) {
* return Async.create(new Callable<Response<R>>() {
* public &lt;R&gt; Async&lt;R&gt; adapt(final Call&lt;R&gt; call) {
* return Async.create(new Callable&lt;Response&lt;R&gt;&gt;() {
* &#64;Override
* public Response<R> call() throws Exception {
* public Response&lt;R&gt; call() throws Exception {
* return call.execute();
* }
* });
Expand Down
2 changes: 1 addition & 1 deletion retrofit/src/main/java/retrofit2/Retrofit.java
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@
* .build();
*
* MyApi api = retrofit.create(MyApi.class);
* Response<User> user = api.getUser().execute();
* Response&lt;User&gt; user = api.getUser().execute();
* </code></pre>
*
* @author Bob Lee ([email protected])
Expand Down
4 changes: 2 additions & 2 deletions retrofit/src/main/java/retrofit2/http/Field.java
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
* <pre><code>
* &#64;FormUrlEncoded
* &#64;POST("/")
* Call&lt;ResponseBody> example(
* Call&lt;ResponseBody&gt; example(
* &#64;Field("name") String name,
* &#64;Field("occupation") String occupation);
* </code></pre>
Expand All @@ -44,7 +44,7 @@
* <pre><code>
* &#64;FormUrlEncoded
* &#64;POST("/list")
* Call&lt;ResponseBody> example(@Field("name") String... names);
* Call&lt;ResponseBody&gt; example(@Field("name") String... names);
* </code></pre>
* Calling with {@code foo.example("Bob Smith", "Jane Doe")} yields a request body of
* {@code name=Bob+Smith&name=Jane+Doe}.
Expand Down
2 changes: 1 addition & 1 deletion retrofit/src/main/java/retrofit2/http/FieldMap.java
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
* <pre><code>
* &#64;FormUrlEncoded
* &#64;POST("/things")
* Call&lt;ResponseBody> things(@FieldMap Map&lt;String, String&gt; fields);
* Call&lt;ResponseBody&gt; things(@FieldMap Map&lt;String, String&gt; fields);
* </code></pre>
* Calling with {@code foo.things(ImmutableMap.of("foo", "bar", "kit", "kat")} yields a request
* body of {@code foo=bar&kit=kat}.
Expand Down
4 changes: 2 additions & 2 deletions retrofit/src/main/java/retrofit2/http/HTTP.java
Original file line number Diff line number Diff line change
Expand Up @@ -28,14 +28,14 @@
* <pre><code>
* interface Service {
* &#064;HTTP(method = "CUSTOM", path = "custom/endpoint/")
* Call<ResponseBody> customEndpoint();
* Call&lt;ResponseBody&gt; customEndpoint();
* }
* </code></pre>
* This annotation can also used for sending {@code DELETE} with a request body:
* <pre><code>
* interface Service {
* &#064;HTTP(method = "DELETE", path = "remove/", hasBody = true)
* Call<ResponseBody> deleteObject(@Body RequestBody object);
* Call&lt;ResponseBody&gt; deleteObject(@Body RequestBody object);
* }
* </code></pre>
*/
Expand Down
2 changes: 1 addition & 1 deletion retrofit/src/main/java/retrofit2/http/Header.java
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
* Replaces the header with the value of its target.
* <pre><code>
* &#64;GET("/")
* Call&lt;ResponseBody> foo(@Header("Accept-Language") String lang);
* Call&lt;ResponseBody&gt; foo(@Header("Accept-Language") String lang);
* </code></pre>
* 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.
Expand Down
2 changes: 1 addition & 1 deletion retrofit/src/main/java/retrofit2/http/Part.java
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@
* <pre><code>
* &#64;Multipart
* &#64;POST("/")
* Call&lt;ResponseBody> example(
* Call&lt;ResponseBody&gt; example(
* &#64;Part("description") String description,
* &#64;Part(value = "image", encoding = "8-bit") RequestBody image);
* </code></pre>
Expand Down
2 changes: 1 addition & 1 deletion retrofit/src/main/java/retrofit2/http/PartMap.java
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
* <pre><code>
* &#64;Multipart
* &#64;POST("/upload")
* Call&lt;ResponseBody> upload(
* Call&lt;ResponseBody&gt; upload(
* &#64;Part("file") RequestBody file,
* &#64;PartMap Map&lt;String, RequestBody&gt; params);
* </code></pre>
Expand Down
6 changes: 3 additions & 3 deletions retrofit/src/main/java/retrofit2/http/Path.java
Original file line number Diff line number Diff line change
Expand Up @@ -29,17 +29,17 @@
* Simple example:
* <pre><code>
* &#64;GET("/image/{id}")
* Call&lt;ResponseBody> example(@Path("id") int id);
* Call&lt;ResponseBody&gt; example(@Path("id") int id);
* </code></pre>
* Calling with {@code foo.example(1)} yields {@code /image/1}.
* <p>
* Values are URL encoded by default. Disable with {@code encoded=true}.
* <pre><code>
* &#64;GET("/user/{name}")
* Call&lt;ResponseBody> encoded(@Path("name") String name);
* Call&lt;ResponseBody&gt; encoded(@Path("name") String name);
*
* &#64;GET("/user/{name}")
* Call&lt;ResponseBody> notEncoded(@Path(value="name", encoded=true) String name);
* Call&lt;ResponseBody&gt; notEncoded(@Path(value="name", encoded=true) String name);
* </code></pre>
* Calling {@code foo.encoded("John+Doe")} yields {@code /user/John%2BDoe} whereas
* {@code foo.notEncoded("John+Doe")} yields {@code /user/John+Doe}.
Expand Down
8 changes: 4 additions & 4 deletions retrofit/src/main/java/retrofit2/http/Query.java
Original file line number Diff line number Diff line change
Expand Up @@ -32,21 +32,21 @@
* Simple Example:
* <pre><code>
* &#64;GET("/list")
* Call&lt;ResponseBody> list(@Query("page") int page);
* Call&lt;ResponseBody&gt; list(@Query("page") int page);
* </code></pre>
* Calling with {@code foo.list(1)} yields {@code /list?page=1}.
* <p>
* Example with {@code null}:
* <pre><code>
* &#64;GET("/list")
* Call&lt;ResponseBody> list(@Query("category") String category);
* Call&lt;ResponseBody&gt; list(@Query("category") String category);
* </code></pre>
* Calling with {@code foo.list(null)} yields {@code /list}.
* <p>
* Array/Varargs Example:
* <pre><code>
* &#64;GET("/list")
* Call&lt;ResponseBody> list(@Query("category") String... categories);
* Call&lt;ResponseBody&gt; list(@Query("category") String... categories);
* </code></pre>
* Calling with {@code foo.list("bar", "baz")} yields
* {@code /list?category=bar&category=baz}.
Expand All @@ -55,7 +55,7 @@
* to change this behavior.
* <pre><code>
* &#64;GET("/search")
* Call&lt;ResponseBody> list(@Query(value="foo", encoded=true) String foo);
* Call&lt;ResponseBody&gt; list(@Query(value="foo", encoded=true) String foo);
* </code></pre>
* Calling with {@code foo.list("foo+bar"))} yields {@code /search?foo=foo+bar}.
*
Expand Down
4 changes: 2 additions & 2 deletions retrofit/src/main/java/retrofit2/http/QueryMap.java
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
* Simple Example:
* <pre><code>
* &#64;GET("/search")
* Call&lt;ResponseBody> list(@QueryMap Map&lt;String, String&gt; filters);
* Call&lt;ResponseBody&gt; list(@QueryMap Map&lt;String, String&gt; filters);
* </code></pre>
* Calling with {@code foo.list(ImmutableMap.of("foo", "bar", "kit", "kat"))} yields
* {@code /search?foo=bar&kit=kat}.
Expand All @@ -39,7 +39,7 @@
* {@link #encoded() encoded=true} to change this behavior.
* <pre><code>
* &#64;GET("/search")
* Call&lt;ResponseBody> list(@QueryMap(encoded=true) Map&lt;String, String&gt; filters);
* Call&lt;ResponseBody&gt; list(@QueryMap(encoded=true) Map&lt;String, String&gt; filters);
* </code></pre>
* Calling with {@code foo.list(ImmutableMap.of("foo", "foo+bar"))} yields
* {@code /search?foo=foo+bar}.
Expand Down
2 changes: 1 addition & 1 deletion retrofit/src/main/java/retrofit2/http/Url.java
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
* URL resolved against the {@linkplain Retrofit#baseUrl() base URL}.
* <pre><code>
* &#64;GET
* Call&lt;ResponseBody> list(@Url String url);
* Call&lt;ResponseBody&gt; list(@Url String url);
* </code></pre>
* <p>
* See {@linkplain retrofit2.Retrofit.Builder#baseUrl(HttpUrl) base URL} for details of how
Expand Down

0 comments on commit 2a53536

Please sign in to comment.