Polish "Don't use markdown syntax in javadoc or error messages"
See 2f6651c3cb.
Closes gh-28408
This commit is contained in:
Andy Wilkinson
parent
2f6651c3cb
commit
7f976dab9e
|
|
@ -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<>();
|
||||
|
||||
|
|
|
|||
|
|
@ -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 = "";
|
||||
|
||||
|
|
|
|||
|
|
@ -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) {
|
||||
|
|
|
|||
|
|
@ -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")
|
||||
|
|
|
|||
|
|
@ -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",
|
||||
|
|
|
|||
|
|
@ -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)
|
||||
|
|
|
|||
|
|
@ -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 "
|
||||
|
|
|
|||
|
|
@ -853,12 +853,12 @@ public class RabbitProperties {
|
|||
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;
|
||||
|
||||
|
|
|
|||
|
|
@ -82,7 +82,7 @@ public class BatchProperties {
|
|||
|
||||
/**
|
||||
* 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 = "";
|
||||
|
||||
|
|
|
|||
|
|
@ -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;
|
||||
|
||||
|
|
|
|||
|
|
@ -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;
|
||||
|
||||
|
|
|
|||
|
|
@ -996,7 +996,7 @@ public class ServerProperties {
|
|||
|
||||
/**
|
||||
* 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;
|
||||
|
||||
|
|
|
|||
|
|
@ -88,17 +88,17 @@ public class WebFluxProperties {
|
|||
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;
|
||||
|
||||
|
|
|
|||
|
|
@ -42,7 +42,7 @@ import org.springframework.validation.DefaultMessageCodesResolver;
|
|||
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 class WebMvcProperties {
|
|||
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;
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue