Switch Javadoc <code>...</code> to {@code ...}
Update Javadoc to use the {@code ...} syntax when possible.
This commit is contained in:
Phillip Webb
@@ -86,17 +86,16 @@ import org.springframework.util.StringUtils;
|
||||
* The default shell authentication method uses a username and password combination. If no
|
||||
* configuration is provided the default username is 'user' and the password will be
|
||||
* printed to console during application startup. Those default values can be overridden
|
||||
* by using <code>shell.auth.simple.username</code> and
|
||||
* <code>shell.auth.simple.password</code>.
|
||||
* by using {@code shell.auth.simple.username} and {@code shell.auth.simple.password}.
|
||||
* <p>
|
||||
* If a Spring Security {@link AuthenticationManager} is detected, this configuration will
|
||||
* create a {@link CRaSHPlugin} to forward shell authentication requests to Spring
|
||||
* Security. This authentication method will get enabled if <code>shell.auth</code> is set
|
||||
* to <code>spring</code> or if no explicit <code>shell.auth</code> is provided and a
|
||||
* Security. This authentication method will get enabled if {@code shell.auth} is set to
|
||||
* {@code spring} or if no explicit {@code shell.auth} is provided and a
|
||||
* {@link AuthenticationManager} is available. In the latter case shell access will be
|
||||
* restricted to users having roles that match those configured in
|
||||
* {@link ManagementServerProperties}. Required roles can be overridden by
|
||||
* <code>shell.auth.spring.roles</code>.
|
||||
* {@code shell.auth.spring.roles}.
|
||||
* <p>
|
||||
* To add customizations to the shell simply define beans of type {@link CRaSHPlugin} in
|
||||
* the application context. Those beans will get auto detected during startup and
|
||||
@@ -106,9 +105,9 @@ import org.springframework.util.StringUtils;
|
||||
* <p>
|
||||
* Additional shell commands can be implemented using the guide and documentation at <a
|
||||
* href="http://www.crashub.org">crashub.org</a>. By default Boot will search for commands
|
||||
* using the following classpath scanning pattern <code>classpath*:/commands/**</code>. To
|
||||
* add different locations or override the default use
|
||||
* <code>shell.command_path_patterns</code> in your application configuration.
|
||||
* using the following classpath scanning pattern {@code classpath*:/commands/**}. To add
|
||||
* different locations or override the default use {@code shell.command_path_patterns} in
|
||||
* your application configuration.
|
||||
*
|
||||
* @author Christian Dupuis
|
||||
* @see ShellProperties
|
||||
|
||||
@@ -40,11 +40,11 @@ import org.springframework.context.annotation.Configuration;
|
||||
* <p>
|
||||
* This configuration will get automatically enabled as soon as the Jolokia
|
||||
* {@link AgentServlet} is on the classpath. To disable it set
|
||||
* <code>endpoints.jolokia.enabled: false</code> or <code>endpoints.enabled: false</code>.
|
||||
* {@code endpoints.jolokia.enabled: false} or {@code endpoints.enabled: false}.
|
||||
*
|
||||
* <p>
|
||||
* Additional configuration parameters for Jolokia can be provided by specifying
|
||||
* <code>jolokia.config.*</code> properties. See the <a
|
||||
* {@code jolokia.config.*} properties. See the <a
|
||||
* href="http://jolokia.org">http://jolokia.org</a> web site for more information on
|
||||
* supported configuration parameters.
|
||||
*
|
||||
|
||||
@@ -63,12 +63,12 @@ import com.codahale.metrics.MetricRegistry;
|
||||
* {@link MetricRegistry} will be created and the default counter and gauge services will
|
||||
* switch to using it instead of the default repository. Users can create "special"
|
||||
* Dropwizard metrics by prefixing their metric names with the appropriate type (e.g.
|
||||
* "histogram.*", "meter.*". "timer.*") and sending them to the <code>GaugeService</code>
|
||||
* or <code>CounterService</code>.
|
||||
* "histogram.*", "meter.*". "timer.*") and sending them to the {@code GaugeService} or
|
||||
* {@code CounterService}.
|
||||
* <p>
|
||||
* By default all metric updates go to all {@link MetricWriter} instances in the
|
||||
* application context via a {@link MetricCopyExporter} firing every 5 seconds (disable
|
||||
* this by setting <code>spring.metrics.export.enabled=false</code>).
|
||||
* this by setting {@code spring.metrics.export.enabled=false}).
|
||||
*
|
||||
* @see GaugeService
|
||||
* @see CounterService
|
||||
|
||||
@@ -64,8 +64,8 @@ import com.fasterxml.jackson.databind.ser.impl.SimpleFilterProvider;
|
||||
* <p>
|
||||
* To protect sensitive information from being exposed, certain property values are masked
|
||||
* if their names end with a set of configurable values (default "password" and "secret").
|
||||
* Configure property names by using <code>endpoints.configprops.keys_to_sanitize</code>
|
||||
* in your Spring Boot application configuration.
|
||||
* Configure property names by using {@code endpoints.configprops.keys_to_sanitize} in
|
||||
* your Spring Boot application configuration.
|
||||
*
|
||||
* @author Christian Dupuis
|
||||
* @author Dave Syer
|
||||
|
||||
@@ -20,10 +20,10 @@ import org.springframework.boot.actuate.endpoint.Endpoint;
|
||||
|
||||
/**
|
||||
* A strategy for the MVC layer on top of an {@link Endpoint}. Implementations are allowed
|
||||
* to use <code>@RequestMapping</code> and the full Spring MVC machinery, but should not
|
||||
* use <code>@Controller</code> or <code>@RequestMapping</code> at the type level (since
|
||||
* that would lead to a double mapping of paths, once by the regular MVC handler mappings
|
||||
* and once by the {@link EndpointHandlerMapping}).
|
||||
* to use {@code @RequestMapping} and the full Spring MVC machinery, but should not use
|
||||
* {@code @Controller} or {@code @RequestMapping} at the type level (since that would lead
|
||||
* to a double mapping of paths, once by the regular MVC handler mappings and once by the
|
||||
* {@link EndpointHandlerMapping}).
|
||||
*
|
||||
* @author Dave Syer
|
||||
*/
|
||||
|
||||
@@ -184,7 +184,7 @@ public final class Health {
|
||||
}
|
||||
|
||||
/**
|
||||
* Create new Builder instance, setting status to given <code>status</code>.
|
||||
* Create new Builder instance, setting status to given {@code status}.
|
||||
* @param status the {@link Status} to use
|
||||
*/
|
||||
public Builder(Status status) {
|
||||
@@ -194,8 +194,8 @@ public final class Health {
|
||||
}
|
||||
|
||||
/**
|
||||
* Create new Builder instance, setting status to given <code>status</code> and
|
||||
* details to given <code>details</code>.
|
||||
* Create new Builder instance, setting status to given {@code status} and details
|
||||
* to given {@code details}.
|
||||
* @param status the {@link Status} to use
|
||||
* @param details the details {@link Map} to use
|
||||
*/
|
||||
@@ -217,7 +217,7 @@ public final class Health {
|
||||
}
|
||||
|
||||
/**
|
||||
* Record detail using <code>key</code> and <code>value</code>.
|
||||
* Record detail using {@code key} and {@code value}.
|
||||
* @param key the detail key
|
||||
* @param data the detail data
|
||||
* @return this {@link Builder} instance
|
||||
@@ -271,7 +271,7 @@ public final class Health {
|
||||
}
|
||||
|
||||
/**
|
||||
* Set status to given <code>statusCode</code>.
|
||||
* Set status to given {@code statusCode}.
|
||||
* @param statusCode the status code
|
||||
* @return this {@link Builder} instance
|
||||
*/
|
||||
|
||||
@@ -26,11 +26,11 @@ import org.springframework.jmx.export.naming.ObjectNamingStrategy;
|
||||
import org.springframework.util.StringUtils;
|
||||
|
||||
/**
|
||||
* MBean naming strategy for metric keys. A metric name of
|
||||
* <code>counter.foo.bar.spam</code> translates to an object name with
|
||||
* <code>type=counter</code>, <code>name=foo</code> and <code>value=bar.spam</code>. This
|
||||
* results in a more or less pleasing view with no tweaks in jconsole or jvisualvm. The
|
||||
* domain is copied from the input key and the type in the input key is discarded.
|
||||
* MBean naming strategy for metric keys. A metric name of {@code counter.foo.bar.spam}
|
||||
* translates to an object name with {@code type=counter}, {@code name=foo} and
|
||||
* {@code value=bar.spam}. This results in a more or less pleasing view with no tweaks in
|
||||
* jconsole or jvisualvm. The domain is copied from the input key and the type in the
|
||||
* input key is discarded.
|
||||
*
|
||||
* @author Dave Syer
|
||||
* @since 1.3.0
|
||||
|
||||
@@ -38,8 +38,8 @@ import org.springframework.jmx.export.naming.ObjectNamingStrategy;
|
||||
* A {@link MetricWriter} for MBeans. Each metric is registered as an individual MBean, so
|
||||
* (for instance) it can be graphed and monitored. The object names are provided by an
|
||||
* {@link ObjectNamingStrategy}, where the default is a
|
||||
* {@link DefaultMetricNamingStrategy} which provides <code>type</code>, <code>name</code>
|
||||
* and <code>value</code> keys by splitting up the metric name on periods.
|
||||
* {@link DefaultMetricNamingStrategy} which provides {@code type}, {@code name} and
|
||||
* {@code value} keys by splitting up the metric name on periods.
|
||||
*
|
||||
* @author Dave Syer
|
||||
* @since 1.3.0
|
||||
|
||||
@@ -35,7 +35,7 @@ import org.springframework.util.Assert;
|
||||
* {@link MultiMetricRepository} implementation backed by a redis store. Metric values are
|
||||
* stored as zset values and the timestamps as regular values, both against a key composed
|
||||
* of the group name prefixed with a constant prefix (default "spring.groups."). The group
|
||||
* names are stored as a zset under "keys." + <code>[prefix]</code>.
|
||||
* names are stored as a zset under "keys." + {@code [prefix]}.
|
||||
*
|
||||
* @author Dave Syer
|
||||
*/
|
||||
|
||||
@@ -38,7 +38,7 @@ public interface PrefixMetricWriter {
|
||||
|
||||
/**
|
||||
* Increment the value of a metric (or decrement if the delta is negative). The name
|
||||
* of the metric to increment is <code>group + "." + delta.name</code>.
|
||||
* of the metric to increment is {@code group + "." + delta.name}.
|
||||
* @param group the name of the group
|
||||
* @param delta the amount to increment by
|
||||
*/
|
||||
|
||||
Reference in New Issue
Block a user