Skip to content

Commit 6641231

Browse files
author
adriancole
committed
comply with jdk 8 javadoc strictness
1 parent ab20ed0 commit 6641231

File tree

19 files changed

+104
-109
lines changed

19 files changed

+104
-109
lines changed

feign-core/src/main/java/feign/Body.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,14 @@
1010
/**
1111
* A possibly templated body of a PUT or POST command. variables wrapped in curly braces are expanded before the
1212
* request is submitted.
13-
* <p/>
13+
* <br>
1414
* ex.
15-
* <p/>
15+
* <br>
1616
* <pre>
1717
* &#064;Body(&quot;&lt;v01:getResourceRecordsOfZone&gt;&lt;zoneName&gt;{zoneName}&lt;/zoneName&gt;&lt;rrType&gt;0&lt;/rrType&gt;&lt;/v01:getResourceRecordsOfZone&gt;&quot;)
1818
* List&lt;Record&gt; listByZone(&#64;Named(&quot;zoneName&quot;) String zoneName);
1919
* </pre>
20-
* <p/>
20+
* <br>
2121
* Note that if you'd like curly braces literally in the body, urlencode
2222
* them first.
2323
*

feign-core/src/main/java/feign/Client.java

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,7 @@
1919
import java.io.InputStream;
2020
import java.io.InputStreamReader;
2121
import java.io.OutputStream;
22-
import java.io.OutputStreamWriter;
2322
import java.io.Reader;
24-
import java.io.Writer;
2523
import java.net.HttpURLConnection;
2624
import java.net.URL;
2725
import java.util.Collection;

feign-core/src/main/java/feign/Feign.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636
/**
3737
* Feign's purpose is to ease development against http apis that feign
3838
* restfulness.
39-
* <p/>
39+
* <br>
4040
* In implementation, Feign is a {@link Feign#newInstance factory} for
4141
* generating {@link Target targeted} http apis.
4242
*/
@@ -122,11 +122,11 @@ public static class Defaults {
122122
}
123123

124124
/**
125-
* <p/>
125+
* <br>
126126
* Configuration keys are formatted as unresolved <a href=
127127
* "http://docs.oracle.com/javase/6/docs/jdk/api/javadoc/doclet/com/sun/javadoc/SeeTag.html"
128128
* >see tags</a>.
129-
* <p/>
129+
* <br>
130130
* For example.
131131
* <ul>
132132
* <li>{@code Route53}: would match a class such as
@@ -138,7 +138,7 @@ public static class Defaults {
138138
* <li>{@code Route53#listByNameAndType(String, String)}: would match a
139139
* method such as {@code denominator.route53.Route53#listAt(String, String)}
140140
* </ul>
141-
* <p/>
141+
* <br>
142142
* Note that there is no whitespace expected in a key!
143143
*/
144144
public static String configKey(Method method) {

feign-core/src/main/java/feign/Headers.java

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
/**
1010
* Expands headers supplied in the {@code value}. Variables are permitted as values.
11-
* <p/>
11+
* <br>
1212
* <pre>
1313
* &#64;RequestLine("GET /")
1414
* &#64;Headers("Cache-Control: max-age=640000")
@@ -21,13 +21,13 @@
2121
* }) void post(&#64;Named("token") String token);
2222
* ...
2323
* </pre>
24-
* <p/>
24+
* <br>
2525
* <strong>Note:</strong> Headers do not overwrite each other. All headers with the same name will
2626
* be included in the request.
27-
* <h4>Relationship to JAXRS</h4>
28-
* <p/>
27+
* <br><br><b>Relationship to JAXRS</b><br>
28+
* <br>
2929
* The following two forms are identical.
30-
* <p/>
30+
* <br>
3131
* Feign:
3232
* <pre>
3333
* &#64;RequestLine("POST /")
@@ -36,7 +36,7 @@
3636
* }) void post(&#64;Named("token") String token);
3737
* ...
3838
* </pre>
39-
* <p/>
39+
* <br>
4040
* JAX-RS:
4141
* <pre>
4242
* &#64;POST &#64;Path("/")

feign-core/src/main/java/feign/Request.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,9 @@
2525

2626
/**
2727
* An immutable request to an http server.
28-
* <p/>
29-
* <h4>Note</h4>
30-
* <p/>
28+
* <br>
29+
* <br><br><b>Note</b><br>
30+
* <br>
3131
* Since {@link Feign} is designed for non-binary apis, and expectations are
3232
* that any request can be replayed, we only support a String body.
3333
*/

feign-core/src/main/java/feign/RequestLine.java

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
/**
99
* Expands the request-line supplied in the {@code value}, permitting path and query variables,
1010
* or just the http method.
11-
* <p/>
11+
* <br>
1212
* <pre>
1313
* ...
1414
* &#64;RequestLine("POST /servers")
@@ -24,25 +24,25 @@
2424
* </pre>
2525
* HTTP version suffix is optional, but permitted. There are no guarantees this version will impact that
2626
* sent by the client.
27-
* <p/>
27+
* <br>
2828
* <pre>
2929
* &#64;RequestLine("POST /servers HTTP/1.1")
3030
* ...
3131
* </pre>
32-
* <p/>
32+
* <br>
3333
* <strong>Note:</strong> Query params do not overwrite each other. All queries with the same name will
3434
* be included in the request.
35-
* <h4>Relationship to JAXRS</h4>
36-
* <p/>
35+
* <br><br><b>Relationship to JAXRS</b><br>
36+
* <br>
3737
* The following two forms are identical.
38-
* <p/>
38+
* <br>
3939
* Feign:
4040
* <pre>
4141
* &#64;RequestLine("GET /servers/{serverId}?count={count}")
4242
* void get(&#64;Named("serverId") String serverId, &#64;Named("count") int count);
4343
* ...
4444
* </pre>
45-
* <p/>
45+
* <br>
4646
* JAX-RS:
4747
* <pre>
4848
* &#64;GET &#64;Path("/servers/{serverId}")

feign-core/src/main/java/feign/RequestTemplate.java

Lines changed: 33 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,9 @@
3737

3838
/**
3939
* Builds a request to an http target. Not thread safe.
40-
* <p/>
41-
* <h4>relationship to JAXRS 2.0</h4>
42-
* <p/>
40+
* <br>
41+
* <br><br><b>relationship to JAXRS 2.0</b><br>
42+
* <br>
4343
* A combination of {@code javax.ws.rs.client.WebTarget} and
4444
* {@code javax.ws.rs.client.Invocation.Builder}, ensuring you can modify any
4545
* part of the request. However, this object is mutable, so needs to be guarded
@@ -74,20 +74,20 @@ public RequestTemplate(RequestTemplate toCopy) {
7474
/**
7575
* Targets a template to this target, adding the {@link #url() base url} and
7676
* any authentication headers.
77-
* <p/>
78-
* <p/>
77+
* <br>
78+
* <br>
7979
* For example:
80-
* <p/>
80+
* <br>
8181
* <pre>
8282
* public Request apply(RequestTemplate input) {
8383
* input.insert(0, url());
8484
* input.replaceHeader(&quot;X-Auth&quot;, currentToken);
8585
* return input.asRequest();
8686
* }
8787
* </pre>
88-
* <p/>
89-
* <h4>relationship to JAXRS 2.0</h4>
90-
* <p/>
88+
* <br>
89+
* <br><br><b>relationship to JAXRS 2.0</b><br>
90+
* <br>
9191
* This call is similar to
9292
* {@code javax.ws.rs.client.WebTarget.resolveTemplates(templateValues, true)}
9393
* , except that the template values apply to any part of the request, not
@@ -151,7 +151,7 @@ private static String urlEncode(Object arg) {
151151
/**
152152
* Expands a {@code template}, such as {@code username}, using the {@code variables} supplied. Any unresolved
153153
* parameters will remain.
154-
* <p/>
154+
* <br>
155155
* Note that if you'd like curly braces literally in the {@code template},
156156
* urlencode them first.
157157
*
@@ -227,16 +227,16 @@ public String url() {
227227
/**
228228
* Replaces queries with the specified {@code configKey} with url decoded
229229
* {@code values} supplied.
230-
* <p/>
230+
* <br>
231231
* When the {@code value} is {@code null}, all queries with the {@code configKey}
232232
* are removed.
233-
* <p/>
234-
* <h4>relationship to JAXRS 2.0</h4>
235-
* <p/>
233+
* <br>
234+
* <br><br><b>relationship to JAXRS 2.0</b><br>
235+
* <br>
236236
* Like {@code WebTarget.query}, except the values can be templatized.
237-
* <p/>
237+
* <br>
238238
* ex.
239-
* <p/>
239+
* <br>
240240
* <pre>
241241
* template.query(&quot;Signature&quot;, &quot;{signature}&quot;);
242242
* </pre>
@@ -274,13 +274,13 @@ private String encodeIfNotVariable(String in) {
274274
/**
275275
* Replaces all existing queries with the newly supplied url decoded
276276
* queries.
277-
* <p/>
278-
* <h4>relationship to JAXRS 2.0</h4>
279-
* <p/>
277+
* <br>
278+
* <br><br><b>relationship to JAXRS 2.0</b><br>
279+
* <br>
280280
* Like {@code WebTarget.queries}, except the values can be templatized.
281-
* <p/>
281+
* <br>
282282
* ex.
283-
* <p/>
283+
* <br>
284284
* <pre>
285285
* template.queries(ImmutableMultimap.of(&quot;Signature&quot;, &quot;{signature}&quot;));
286286
* </pre>
@@ -323,17 +323,17 @@ public Map<String, Collection<String>> queries() {
323323
/**
324324
* Replaces headers with the specified {@code configKey} with the
325325
* {@code values} supplied.
326-
* <p/>
326+
* <br>
327327
* When the {@code value} is {@code null}, all headers with the {@code configKey}
328328
* are removed.
329-
* <p/>
330-
* <h4>relationship to JAXRS 2.0</h4>
331-
* <p/>
329+
* <br>
330+
* <br><br><b>relationship to JAXRS 2.0</b><br>
331+
* <br>
332332
* Like {@code WebTarget.queries} and {@code javax.ws.rs.client.Invocation.Builder.header},
333333
* except the values can be templatized.
334-
* <p/>
334+
* <br>
335335
* ex.
336-
* <p/>
336+
* <br>
337337
* <pre>
338338
* template.query(&quot;X-Application-Version&quot;, &quot;{version}&quot;);
339339
* </pre>
@@ -364,14 +364,14 @@ public RequestTemplate header(String configKey, Iterable<String> values) {
364364

365365
/**
366366
* Replaces all existing headers with the newly supplied headers.
367-
* <p/>
368-
* <h4>relationship to JAXRS 2.0</h4>
369-
* <p/>
367+
* <br>
368+
* <br><br><b>relationship to JAXRS 2.0</b><br>
369+
* <br>
370370
* Like {@code Invocation.Builder.headers(MultivaluedMap)}, except the
371371
* values can be templatized.
372-
* <p/>
372+
* <br>
373373
* ex.
374-
* <p/>
374+
* <br>
375375
* <pre>
376376
* template.headers(ImmutableMultimap.of(&quot;X-Application-Version&quot;, &quot;{version}&quot;));
377377
* </pre>
@@ -399,7 +399,7 @@ public Map<String, Collection<String>> headers() {
399399

400400
/**
401401
* replaces the {@link feign.Util#CONTENT_LENGTH} header.
402-
* <p/>
402+
* <br>
403403
* Usually populated by {@link feign.codec.BodyEncoder} or {@link feign.codec.FormEncoder}
404404
*
405405
* @see Request#body()

feign-core/src/main/java/feign/Response.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ private Response(int status, String reason, Map<String, Collection<String>> head
6161
/**
6262
* status code. ex {@code 200}
6363
*
64-
* @see <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html" />
64+
* See <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html" >rfc2616</a>
6565
*/
6666
public int status() {
6767
return status;
@@ -86,9 +86,9 @@ public interface Body extends Closeable {
8686

8787
/**
8888
* length in bytes, if known. Null if not.
89-
* <p/>
90-
* <h4>Note</h4> This is an integer as most implementations cannot do
91-
* bodies > 2GB. Moreover, the scope of this interface doesn't include
89+
* <br>
90+
* <br><br><b>Note</b><br> This is an integer as most implementations cannot do
91+
* bodies greater than 2GB. Moreover, the scope of this interface doesn't include
9292
* large bodies.
9393
*/
9494
Integer length();

feign-core/src/main/java/feign/Retryer.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ public void continueOrPropagate(RetryableException e) {
7979

8080
/**
8181
* Calculates the time interval to a retry attempt.
82-
* <p/>
82+
* <br>
8383
* The interval increases exponentially with each attempt, at a rate of
8484
* nextInterval *= 1.5 (where 1.5 is the backoff factor), to the maximum
8585
* interval.

feign-core/src/main/java/feign/Target.java

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@
2121
import static feign.Util.emptyToNull;
2222

2323
/**
24-
* <h4>relationship to JAXRS 2.0</h4>
25-
* <p/>
24+
* <br><br><b>relationship to JAXRS 2.0</b><br>
25+
* <br>
2626
* Similar to {@code javax.ws.rs.client.WebTarget}, as it produces requests.
2727
* However, {@link RequestTemplate} is a closer match to {@code WebTarget}.
2828
*
@@ -41,20 +41,20 @@ public interface Target<T> {
4141
/**
4242
* Targets a template to this target, adding the {@link #url() base url} and
4343
* any authentication headers.
44-
* <p/>
45-
* <p/>
44+
* <br>
45+
* <br>
4646
* For example:
47-
* <p/>
47+
* <br>
4848
* <pre>
4949
* public Request apply(RequestTemplate input) {
5050
* input.insert(0, url());
5151
* input.replaceHeader(&quot;X-Auth&quot;, currentToken);
5252
* return input.asRequest();
5353
* }
5454
* </pre>
55-
* <p/>
56-
* <h4>relationship to JAXRS 2.0</h4>
57-
* <p/>
55+
* <br>
56+
* <br><br><b>relationship to JAXRS 2.0</b><br>
57+
* <br>
5858
* This call is similar to {@code javax.ws.rs.client.WebTarget.request()},
5959
* except that we expect transient, but necessary decoration to be applied
6060
* on invocation.

0 commit comments

Comments
 (0)