Skip to content

Commit 2f6651c

Browse files
committed
Don't use markdown syntax in javadoc or error messages
Closes gh-28408
1 parent d6a1001 commit 2f6651c

File tree

25 files changed

+40
-40
lines changed

25 files changed

+40
-40
lines changed

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ public class MetricsProperties {
4444

4545
/**
4646
* Whether meter IDs starting with the specified name should be enabled. The longest
47-
* match wins, the key `all` can also be used to configure all meters.
47+
* match wins, the key {@code "all"} can also be used to configure all meters.
4848
*/
4949
private final Map<String, Boolean> enable = new LinkedHashMap<>();
5050

@@ -220,15 +220,15 @@ public static class Distribution {
220220
* Whether meter IDs starting with the specified name should publish percentile
221221
* histograms. For monitoring systems that support aggregable percentile
222222
* calculation based on a histogram, this can be set to true. For other systems,
223-
* this has no effect. The longest match wins, the key `all` can also be used to
224-
* configure all meters.
223+
* this has no effect. The longest match wins, the key {@code "all"} can also be
224+
* used to configure all meters.
225225
*/
226226
private final Map<String, Boolean> percentilesHistogram = new LinkedHashMap<>();
227227

228228
/**
229229
* Specific computed non-aggregable percentiles to ship to the backend for meter
230-
* IDs starting-with the specified name. The longest match wins, the key `all` can
231-
* also be used to configure all meters.
230+
* IDs starting-with the specified name. The longest match wins, the key
231+
* {@code "all"} can also be used to configure all meters.
232232
*/
233233
private final Map<String, double[]> percentiles = new LinkedHashMap<>();
234234

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -51,8 +51,8 @@ public class ManagementServerProperties {
5151
private InetAddress address;
5252

5353
/**
54-
* Management endpoint base path (for instance, `/management`). Requires a custom
55-
* management.server.port.
54+
* Management endpoint base path (for instance, {@code '/management'}). Requires a
55+
* custom management.server.port.
5656
*/
5757
private String basePath = "";
5858

@@ -128,8 +128,8 @@ private String cleanBasePath(String basePath) {
128128
public static class Servlet {
129129

130130
/**
131-
* Management endpoint context-path (for instance, `/management`). Requires a
132-
* custom management.server.port.
131+
* Management endpoint context-path (for instance, {@code '/management'}).
132+
* Requires a custom management.server.port.
133133
*/
134134
private String contextPath = "";
135135

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ public abstract class AbstractEndpointDocumentationTests {
6161

6262
protected String describeEnumValues(Class<? extends Enum<?>> enumType) {
6363
return StringUtils.collectionToDelimitedString(Stream.of(enumType.getEnumConstants())
64-
.map((constant) -> "`" + constant.name() + "`").collect(Collectors.toList()), ", ");
64+
.map((constant) -> "'" + constant.name() + "'").collect(Collectors.toList()), ", ");
6565
}
6666

6767
protected OperationPreprocessor limit(String... keys) {

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ void configProps() throws Exception {
4646
preprocessResponse(limit("contexts", getApplicationContext().getId(), "beans")),
4747
responseFields(fieldWithPath("contexts").description("Application contexts keyed by id."),
4848
fieldWithPath("contexts.*.beans.*")
49-
.description("`@ConfigurationProperties` beans keyed by bean name."),
49+
.description("@ConfigurationProperties beans keyed by bean name."),
5050
fieldWithPath("contexts.*.beans.*.prefix")
5151
.description("Prefix applied to the names of the bean's properties."),
5252
subsectionWithPath("contexts.*.beans.*.properties")

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ void health() throws Exception {
8181
.description("The nested components that make up the health.").optional();
8282
FieldDescriptor componentDetails = subsectionWithPath("components.*.details")
8383
.description("Details of the health of a specific part of the application. "
84-
+ "Presence is controlled by `management.endpoint.health.show-details`.")
84+
+ "Presence is controlled by 'management.endpoint.health.show-details'.")
8585
.optional();
8686
this.mockMvc.perform(get("/actuator/health").accept(MediaType.APPLICATION_JSON)).andExpect(status().isOk())
8787
.andDo(document("health",

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ void metricWithTags() throws Exception {
7070
"id:Compressed Class Space"))
7171
.andExpect(status().isOk())
7272
.andDo(document("metrics/metric-with-tags", requestParameters(parameterWithName("tag")
73-
.description("A tag to use for drill-down in the form `name:value`."))));
73+
.description("A tag to use for drill-down in the form 'name:value'."))));
7474
}
7575

7676
@Configuration(proxyBeanMethods = false)

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ void jsonThreadDump() throws Exception {
117117
.optional().type(JsonFieldType.NUMBER),
118118
fieldWithPath("threads.[].lockOwnerId")
119119
.description("ID of the thread that owns the object on which "
120-
+ "the thread is blocked. `-1` if the "
120+
+ "the thread is blocked. '-1' if the "
121121
+ "thread is not blocked."),
122122
fieldWithPath("threads.[].lockOwnerName")
123123
.description("Name of the thread that owns the "

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/amqp/RabbitProperties.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -853,12 +853,12 @@ public static class Template {
853853
private Boolean mandatory;
854854

855855
/**
856-
* Timeout for `receive()` operations.
856+
* Timeout for {@code receive()} operations.
857857
*/
858858
private Duration receiveTimeout;
859859

860860
/**
861-
* Timeout for `sendAndReceive()` operations.
861+
* Timeout for {@code sendAndReceive()} operations.
862862
*/
863863
private Duration replyTimeout;
864864

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/batch/BatchProperties.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ public static class Job {
8282

8383
/**
8484
* Comma-separated list of job names to execute on startup (for instance,
85-
* `job1,job2`). By default, all Jobs found in the context are executed.
85+
* {@code "job1,job2"}). By default, all Jobs found in the context are executed.
8686
*/
8787
private String names = "";
8888

spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/data/redis/RedisUrlSyntaxFailureAnalyzer.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ protected FailureAnalysis analyze(Throwable rootFailure, RedisUrlSyntaxException
4646
}
4747
if (!"redis".equals(uri.getScheme()) && !"rediss".equals(uri.getScheme())) {
4848
return new FailureAnalysis(getUnsupportedSchemeDescription(cause.getUrl(), uri.getScheme()),
49-
"Use the scheme 'redis://` for insecure or `rediss://` for secure Redis standalone configuration.",
49+
"Use the scheme 'redis://' for insecure or 'rediss://' for secure Redis standalone configuration.",
5050
cause);
5151
}
5252
}

0 commit comments

Comments
 (0)