Skip to content

Commit 9ce36aa

Browse files
committed
#31 - Tidy related javadoc
1 parent 4bd1504 commit 9ce36aa

File tree

2 files changed

+15
-6
lines changed

2 files changed

+15
-6
lines changed

client/src/main/java/io/avaje/http/client/HttpClientContext.java

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -172,15 +172,16 @@ interface Builder {
172172
* Disable or enable built in request and response logging.
173173
* <p>
174174
* By default request logging is enabled. Set this to false to stop
175-
* the default {@link RequestLogger} being registered to log
176-
* request and response headers and bodies etc.
175+
* the default {@link RequestLogger} being registered to log request
176+
* and response headers and bodies etc.
177177
* <p>
178178
* With logging level set to {@code DEBUG} for
179-
* {@code io.avaje.http.client.RequestLogger} the request and
180-
* response are logged with headers only.
179+
* {@code io.avaje.http.client.RequestLogger} the request and response
180+
* are logged as a summary with response status and time.
181181
* <p>
182182
* Set the logging level to {@code TRACE} to include the request
183-
* and response body payloads (with truncation for large bodies).
183+
* and response headers and body payloads with truncation for large
184+
* bodies.
184185
*
185186
* <h3>Suppression</h3>
186187
* <p>
@@ -190,7 +191,7 @@ interface Builder {
190191
* Logging of Authorization headers is suppressed.
191192
* {@link AuthTokenProvider} requests are suppressed.
192193
*
193-
* @param requestLogging To turn disable/enable the registration of the default logger
194+
* @param requestLogging Disable/enable the registration of the default logger
194195
* @see RequestLogger
195196
*/
196197
Builder requestLogging(boolean requestLogging);

client/src/main/java/io/avaje/http/client/RequestLogger.java

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,14 @@
1616
* This implementation logs the request and response with the same
1717
* single logging entry rather than separate logging of the request
1818
* and response.
19+
* <p>
20+
* With logging level set to {@code DEBUG} for
21+
* {@code io.avaje.http.client.RequestLogger} the request and response
22+
* are logged as a summary with response status and time.
23+
* <p>
24+
* Set the logging level to {@code TRACE} to include the request
25+
* and response headers and body payloads with truncation for large
26+
* bodies.
1927
*/
2028
public class RequestLogger implements RequestListener {
2129

0 commit comments

Comments
 (0)