Skip to content

Commit e82913d

Browse files
committed
Align appendix edits with source code
Port editing changes from append to java source files to ensure that IDE meta-data also reflects the improvements. Closes gh-10870
1 parent 3e5b7dd commit e82913d

File tree

59 files changed

+375
-358
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

59 files changed

+375
-358
lines changed

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/endpoint/web/servlet/CorsEndpointProperties.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ public class CorsEndpointProperties {
5656
private List<String> exposedHeaders = new ArrayList<>();
5757

5858
/**
59-
* Set whether credentials are supported. When not set, credentials are not supported.
59+
* Whether credentials are supported. When not set, credentials are not supported.
6060
*/
6161
private Boolean allowCredentials;
6262

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/health/HealthIndicatorProperties.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ public class HealthIndicatorProperties {
3838

3939
/**
4040
* Mapping of health statuses to HTTP status codes. By default, registered health
41-
* statuses map to sensible defaults (i.e. UP maps to 200).
41+
* statuses map to sensible defaults (for example, UP maps to 200).
4242
*/
4343
private final Map<String, Integer> httpMapping = new HashMap<>();
4444

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/jolokia/JolokiaProperties.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,12 +33,12 @@
3333
public class JolokiaProperties {
3434

3535
/**
36-
* Enable Jolokia.
36+
* Whether to enable Jolokia.
3737
*/
3838
private boolean enabled;
3939

4040
/**
41-
* Path at which Jolokia will be available.
41+
* Path at which Jolokia is available.
4242
*/
4343
private String path = "/jolokia";
4444

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/MetricsProperties.java

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,9 @@ public class MetricsProperties {
3030
private Web web = new Web();
3131

3232
/**
33-
* Whether or not auto-configured MeterRegistry implementations should be bound to the
34-
* global static registry on Metrics. For testing, set this to 'false' to maximize
35-
* test independence.
33+
* Whether auto-configured MeterRegistry implementations should be bound to the global
34+
* static registry on Metrics. For testing, set this to 'false' to maximize test
35+
* independence.
3636
*/
3737
private boolean useGlobalRegistry = true;
3838

@@ -73,8 +73,8 @@ public void setServer(Server server) {
7373
public static class Client {
7474

7575
/**
76-
* Whether or not instrumented requests record percentiles histogram buckets
77-
* by default.
76+
* Whether instrumented requests record percentiles histogram buckets by
77+
* default.
7878
*/
7979
private boolean recordRequestPercentiles;
8080

@@ -104,10 +104,10 @@ public void setRequestsMetricName(String requestsMetricName) {
104104
public static class Server {
105105

106106
/**
107-
* Whether or not requests handled by Spring MVC or WebFlux should be
108-
* automatically timed. If the number of time series emitted grows too large
109-
* on account of request mapping timings, disable this and use 'Timed' on a
110-
* per request mapping basis as needed.
107+
* Whether requests handled by Spring MVC or WebFlux should be automatically
108+
* timed. If the number of time series emitted grows too large on account of
109+
* request mapping timings, disable this and use 'Timed' on a per request
110+
* mapping basis as needed.
111111
*/
112112
private boolean autoTimeRequests = true;
113113

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/export/StepRegistryProperties.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,17 +34,17 @@ public abstract class StepRegistryProperties {
3434
private Duration step = Duration.ofMinutes(1);
3535

3636
/**
37-
* Enable publishing to the backend.
37+
* Whether exporting of metrics to this backend is enabled.
3838
*/
3939
private Boolean enabled;
4040

4141
/**
42-
* Connection timeout for requests to the backend.
42+
* Connection timeout for requests to this backend.
4343
*/
4444
private Duration connectTimeout;
4545

4646
/**
47-
* Read timeout for requests to the backend.
47+
* Read timeout for requests to this backend.
4848
*/
4949
private Duration readTimeout;
5050

@@ -54,7 +54,7 @@ public abstract class StepRegistryProperties {
5454
private Integer numThreads;
5555

5656
/**
57-
* Number of measurements per request to use for the backend. If more measurements
57+
* Number of measurements per request to use for this backend. If more measurements
5858
* are found, then multiple requests will be made.
5959
*/
6060
private Integer batchSize;

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/web/server/ManagementServerProperties.java

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,12 +47,14 @@ public class ManagementServerProperties implements SecurityPrerequisite {
4747
private Ssl ssl;
4848

4949
/**
50-
* Network address that the management endpoints should bind to.
50+
* Network address that to which the management endpoints should bind to. Requires a
51+
* custom management.server.port.
5152
*/
5253
private InetAddress address;
5354

5455
/**
55-
* Management endpoint context-path.
56+
* Management endpoint context-path. For instance, '/actuator'. Requires a custom
57+
* management.server.port.
5658
*/
5759
private String contextPath = "";
5860

0 commit comments

Comments
 (0)