Spring/spring-boot
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Polish "Don't use markdown syntax in javadoc or error messages"

Browse Source 
See 2f6651c3cb.

Closes gh-28408
This commit is contained in:
Andy Wilkinson
2021-10-22 10:08:27 +01:00
parent 2f6651c3cb
commit 7f976dab9e
14 changed files with 27 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -44,7 +44,7 @@ public class MetricsProperties {
/**
* Whether meter IDs starting with the specified name should be enabled. The longest
* match wins, the key {@code "all"} can also be used to configure all meters.
* match wins, the key 'all' can also be used to configure all meters.
*/
private final Map<String, Boolean> enable = new LinkedHashMap<>();
@@ -220,15 +220,15 @@ public class MetricsProperties {
* Whether meter IDs starting with the specified name should publish percentile
* histograms. For monitoring systems that support aggregable percentile
* calculation based on a histogram, this can be set to true. For other systems,
* this has no effect. The longest match wins, the key {@code "all"} can also be
* used to configure all meters.
* this has no effect. The longest match wins, the key 'all' can also be used to
* configure all meters.
*/
private final Map<String, Boolean> percentilesHistogram = new LinkedHashMap<>();
/**
* Specific computed non-aggregable percentiles to ship to the backend for meter
* IDs starting-with the specified name. The longest match wins, the key
* {@code "all"} can also be used to configure all meters.
* IDs starting-with the specified name. The longest match wins, the key 'all' can
* also be used to configure all meters.
*/
private final Map<String, double[]> percentiles = new LinkedHashMap<>();

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

@@ -51,8 +51,8 @@ public class ManagementServerProperties {
private InetAddress address;
/**
* Management endpoint base path (for instance, {@code '/management'}). Requires a
* custom management.server.port.
* Management endpoint base path (for instance, '/management'). Requires a custom
* management.server.port.
*/
private String basePath = "";
@@ -128,8 +128,8 @@ public class ManagementServerProperties {
public static class Servlet {
/**
* Management endpoint context-path (for instance, {@code '/management'}).
* Requires a custom management.server.port.
* Management endpoint context-path (for instance, '/management'). Requires a
* custom management.server.port.
*/
private String contextPath = "";

2
spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/endpoint/web/documentation/AbstractEndpointDocumentationTests.java
View File

@@ -61,7 +61,7 @@ public abstract class AbstractEndpointDocumentationTests {
protected String describeEnumValues(Class<? extends Enum<?>> enumType) {
return StringUtils.collectionToDelimitedString(Stream.of(enumType.getEnumConstants())
.map((constant) -> "'" + constant.name() + "'").collect(Collectors.toList()), ", ");
.map((constant) -> "`" + constant.name() + "`").collect(Collectors.toList()), ", ");
}
protected OperationPreprocessor limit(String... keys) {

2
spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/endpoint/web/documentation/ConfigurationPropertiesReportEndpointDocumentationTests.java
View File

@@ -46,7 +46,7 @@ class ConfigurationPropertiesReportEndpointDocumentationTests extends MockMvcEnd
preprocessResponse(limit("contexts", getApplicationContext().getId(), "beans")),
responseFields(fieldWithPath("contexts").description("Application contexts keyed by id."),
fieldWithPath("contexts.*.beans.*")
.description("@ConfigurationProperties beans keyed by bean name."),
.description("`@ConfigurationProperties` beans keyed by bean name."),
fieldWithPath("contexts.*.beans.*.prefix")
.description("Prefix applied to the names of the bean's properties."),
subsectionWithPath("contexts.*.beans.*.properties")

2
spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/endpoint/web/documentation/HealthEndpointDocumentationTests.java
View File

@@ -81,7 +81,7 @@ class HealthEndpointDocumentationTests extends MockMvcEndpointDocumentationTests
.description("The nested components that make up the health.").optional();
FieldDescriptor componentDetails = subsectionWithPath("components.*.details")
.description("Details of the health of a specific part of the application. "
+ "Presence is controlled by 'management.endpoint.health.show-details'.")
+ "Presence is controlled by `management.endpoint.health.show-details`.")
.optional();
this.mockMvc.perform(get("/actuator/health").accept(MediaType.APPLICATION_JSON)).andExpect(status().isOk())
.andDo(document("health",

2
spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/endpoint/web/documentation/MetricsEndpointDocumentationTests.java
View File

@@ -70,7 +70,7 @@ class MetricsEndpointDocumentationTests extends MockMvcEndpointDocumentationTest
"id:Compressed Class Space"))
.andExpect(status().isOk())
.andDo(document("metrics/metric-with-tags", requestParameters(parameterWithName("tag")
.description("A tag to use for drill-down in the form 'name:value'."))));
.description("A tag to use for drill-down in the form `name:value`."))));
}
@Configuration(proxyBeanMethods = false)

2
spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/endpoint/web/documentation/ThreadDumpEndpointDocumentationTests.java
View File

@@ -117,7 +117,7 @@ class ThreadDumpEndpointDocumentationTests extends MockMvcEndpointDocumentationT
.optional().type(JsonFieldType.NUMBER),
fieldWithPath("threads.[].lockOwnerId")
.description("ID of the thread that owns the object on which "
+ "the thread is blocked. '-1' if the "
+ "the thread is blocked. `-1` if the "
+ "thread is not blocked."),
fieldWithPath("threads.[].lockOwnerName")
.description("Name of the thread that owns the "