From 7f976dab9e6bcde491db9bd833b0ac5a9fd43bc6 Mon Sep 17 00:00:00 2001 From: Andy Wilkinson Date: Fri, 22 Oct 2021 10:08:27 +0100 Subject: [PATCH] Polish "Don't use markdown syntax in javadoc or error messages" See 2f6651c3cbe4546158b97a5d02d47634855cf88a. Closes gh-28408 --- .../autoconfigure/metrics/MetricsProperties.java | 10 +++++----- .../web/server/ManagementServerProperties.java | 8 ++++---- .../AbstractEndpointDocumentationTests.java | 2 +- ...tionPropertiesReportEndpointDocumentationTests.java | 2 +- .../HealthEndpointDocumentationTests.java | 2 +- .../MetricsEndpointDocumentationTests.java | 2 +- .../ThreadDumpEndpointDocumentationTests.java | 2 +- .../boot/autoconfigure/amqp/RabbitProperties.java | 4 ++-- .../boot/autoconfigure/batch/BatchProperties.java | 2 +- .../boot/autoconfigure/jackson/JacksonProperties.java | 2 +- .../boot/autoconfigure/mail/MailProperties.java | 2 +- .../boot/autoconfigure/web/ServerProperties.java | 2 +- .../autoconfigure/web/reactive/WebFluxProperties.java | 6 +++--- .../autoconfigure/web/servlet/WebMvcProperties.java | 8 ++++---- 14 files changed, 27 insertions(+), 27 deletions(-) diff --git a/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/MetricsProperties.java b/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/MetricsProperties.java index 4e7428a447d7..c0fb4a021973 100644 --- a/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/MetricsProperties.java +++ b/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/MetricsProperties.java @@ -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 enable = new LinkedHashMap<>(); @@ -220,15 +220,15 @@ public static class Distribution { * 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 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 percentiles = new LinkedHashMap<>(); diff --git a/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/web/server/ManagementServerProperties.java b/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/web/server/ManagementServerProperties.java index 5d781c26e8d6..2c0b0e46bfc2 100644 --- a/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/web/server/ManagementServerProperties.java +++ b/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/web/server/ManagementServerProperties.java @@ -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 @@ private String cleanBasePath(String basePath) { 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 = ""; diff --git a/spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/endpoint/web/documentation/AbstractEndpointDocumentationTests.java b/spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/endpoint/web/documentation/AbstractEndpointDocumentationTests.java index b8eeb6d9dba2..e496dfb07d29 100644 --- a/spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/endpoint/web/documentation/AbstractEndpointDocumentationTests.java +++ b/spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/endpoint/web/documentation/AbstractEndpointDocumentationTests.java @@ -61,7 +61,7 @@ public abstract class AbstractEndpointDocumentationTests { protected String describeEnumValues(Class> 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) { diff --git a/spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/endpoint/web/documentation/ConfigurationPropertiesReportEndpointDocumentationTests.java b/spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/endpoint/web/documentation/ConfigurationPropertiesReportEndpointDocumentationTests.java index 1abd5ecced3b..a7059faca8c1 100644 --- a/spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/endpoint/web/documentation/ConfigurationPropertiesReportEndpointDocumentationTests.java +++ b/spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/endpoint/web/documentation/ConfigurationPropertiesReportEndpointDocumentationTests.java @@ -46,7 +46,7 @@ void configProps() throws Exception { 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") diff --git a/spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/endpoint/web/documentation/HealthEndpointDocumentationTests.java b/spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/endpoint/web/documentation/HealthEndpointDocumentationTests.java index 32a0bdeef659..df3a8f30d631 100644 --- a/spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/endpoint/web/documentation/HealthEndpointDocumentationTests.java +++ b/spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/endpoint/web/documentation/HealthEndpointDocumentationTests.java @@ -81,7 +81,7 @@ void health() throws Exception { .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", diff --git a/spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/endpoint/web/documentation/MetricsEndpointDocumentationTests.java b/spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/endpoint/web/documentation/MetricsEndpointDocumentationTests.java index 5d496368d00d..aa01ae3d639f 100644 --- a/spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/endpoint/web/documentation/MetricsEndpointDocumentationTests.java +++ b/spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/endpoint/web/documentation/MetricsEndpointDocumentationTests.java @@ -70,7 +70,7 @@ void metricWithTags() throws Exception { "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) diff --git a/spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/endpoint/web/documentation/ThreadDumpEndpointDocumentationTests.java b/spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/endpoint/web/documentation/ThreadDumpEndpointDocumentationTests.java index eb613a18bd83..a95b7d1dc65a 100644 --- a/spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/endpoint/web/documentation/ThreadDumpEndpointDocumentationTests.java +++ b/spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/endpoint/web/documentation/ThreadDumpEndpointDocumentationTests.java @@ -117,7 +117,7 @@ void jsonThreadDump() throws Exception { .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 " diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/amqp/RabbitProperties.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/amqp/RabbitProperties.java index d1b283347abb..159821596be0 100644 --- a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/amqp/RabbitProperties.java +++ b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/amqp/RabbitProperties.java @@ -853,12 +853,12 @@ public static class Template { private Boolean mandatory; /** - * Timeout for {@code receive()} operations. + * Timeout for receive() operations. */ private Duration receiveTimeout; /** - * Timeout for {@code sendAndReceive()} operations. + * Timeout for sendAndReceive() operations. */ private Duration replyTimeout; diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/batch/BatchProperties.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/batch/BatchProperties.java index 7b3073d1b76b..4b631977cef3 100644 --- a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/batch/BatchProperties.java +++ b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/batch/BatchProperties.java @@ -82,7 +82,7 @@ public static class Job { /** * Comma-separated list of job names to execute on startup (for instance, - * {@code "job1,job2"}). By default, all Jobs found in the context are executed. + * 'job1,job2'). By default, all Jobs found in the context are executed. */ private String names = ""; diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jackson/JacksonProperties.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jackson/JacksonProperties.java index 460967120a38..35caabd3b9fa 100644 --- a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jackson/JacksonProperties.java +++ b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jackson/JacksonProperties.java @@ -45,7 +45,7 @@ public class JacksonProperties { /** * Date format string or a fully-qualified date format class name. For instance, - * {@code "yyyy-MM-dd HH:mm:ss"}. + * 'yyyy-MM-dd HH:mm:ss'. */ private String dateFormat; diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/mail/MailProperties.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/mail/MailProperties.java index 8e1419c2d5a7..18fa6cb9071c 100644 --- a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/mail/MailProperties.java +++ b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/mail/MailProperties.java @@ -37,7 +37,7 @@ public class MailProperties { private static final Charset DEFAULT_CHARSET = StandardCharsets.UTF_8; /** - * SMTP server host. For instance, {@code "smtp.example.com"}. + * SMTP server host. For instance, 'smtp.example.com'. */ private String host; diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/web/ServerProperties.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/web/ServerProperties.java index f5785fd91ae9..873155039da7 100644 --- a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/web/ServerProperties.java +++ b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/web/ServerProperties.java @@ -996,7 +996,7 @@ public static class Remoteip { /** * Name of the HTTP header from which the remote IP is extracted. For - * instance, {@code "X-FORWARDED-FOR"}. + * instance, 'X-FORWARDED-FOR'. */ private String remoteIpHeader; diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/web/reactive/WebFluxProperties.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/web/reactive/WebFluxProperties.java index 26dd9e433e39..78aa9f7e5918 100644 --- a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/web/reactive/WebFluxProperties.java +++ b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/web/reactive/WebFluxProperties.java @@ -88,17 +88,17 @@ public void setStaticPathPattern(String staticPathPattern) { public static class Format { /** - * Date format to use, for example {@code "dd/MM/yyyy"}. + * Date format to use, for example 'dd/MM/yyyy'. */ private String date; /** - * Time format to use, for example {@code "HH:mm:ss"}. + * Time format to use, for example 'HH:mm:ss'. */ private String time; /** - * Date-time format to use, for example {@code "yyyy-MM-dd HH:mm:ss"}. + * Date-time format to use, for example 'yyyy-MM-dd HH:mm:ss'. */ private String dateTime; diff --git a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/web/servlet/WebMvcProperties.java b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/web/servlet/WebMvcProperties.java index e7c6a3339046..f6f5212a67dc 100644 --- a/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/web/servlet/WebMvcProperties.java +++ b/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/web/servlet/WebMvcProperties.java @@ -42,7 +42,7 @@ public class WebMvcProperties { /** - * Formatting strategy for message codes. For instance, {@code PREFIX_ERROR_CODE}. + * Formatting strategy for message codes. For instance, 'PREFIX_ERROR_CODE'. */ private DefaultMessageCodesResolver.Format messageCodesResolverFormat; @@ -493,17 +493,17 @@ public void setUseRegisteredSuffixPattern(boolean useRegisteredSuffixPattern) { public static class Format { /** - * Date format to use, for example {@code "dd/MM/yyyy"}. + * Date format to use, for example 'dd/MM/yyyy'. */ private String date; /** - * Time format to use, for example {@code "HH:mm:ss"}. + * Time format to use, for example 'HH:mm:ss'. */ private String time; /** - * Date-time format to use, for example {@code "yyyy-MM-dd HH:mm:ss"}. + * Date-time format to use, for example 'yyyy-MM-dd HH:mm:ss'. */ private String dateTime;