Switch Javadoc <code>...</code> to {@code ...}

Update Javadoc to use the {@code ...} syntax when possible.
This commit is contained in:
Phillip Webb
2015-06-05 10:10:34 -07:00
parent 6230d905c6
commit 7609c43685
32 changed files with 100 additions and 104 deletions

View File

@@ -26,7 +26,7 @@ import org.springframework.beans.factory.annotation.Qualifier;
/**
* Qualifier annotation for a DataSource to be injected in to Flyway. If used for a second
* data source, the other (main) one would normally be marked as <code>@Primary</code>.
* data source, the other (main) one would normally be marked as {@code @Primary}.
*
* @author Dave Syer
* @since 1.1.0

View File

@@ -33,7 +33,7 @@ import org.springframework.util.ClassUtils;
* and so that there can be a fallback to an embedded database if one can be detected on
* the classpath, only a small set of common configuration properties are supported. To
* inject additional properties into the result you can downcast it, or use
* <code>@ConfigurationProperties</code>.
* {@code @ConfigurationProperties}.
*
* @author Dave Syer
* @since 1.1.0

View File

@@ -45,7 +45,7 @@ import org.springframework.util.StringUtils;
* {@link EnableAutoConfiguration Auto-configuration} to enable/disable Spring's
* {@link EnableMBeanExport} mechanism based on configuration properties.
* <p>
* To disable auto export of annotation beans set <code>spring.jmx.enabled: false</code>.
* To disable auto export of annotation beans set {@code spring.jmx.enabled: false}.
*
* @author Christian Dupuis
*/

View File

@@ -34,7 +34,7 @@ import org.springframework.util.ClassUtils;
* {@link LocalContainerEntityManagerFactoryBean} through a fluent builder pattern. The
* most common options are covered in the builder, but you can always manipulate the
* product of the builder if you need more control, before returning it from a
* <code>@Bean</code> definition.
* {@code @Bean} definition.
*
* @author Dave Syer
* @since 1.1.0
@@ -97,7 +97,7 @@ public class EntityManagerFactoryBuilder {
}
/**
* The names of packages to scan for <code>@Entity</code> annotations.
* The names of packages to scan for {@code @Entity} annotations.
* @param packagesToScan packages to scan
* @return the builder for fluent usage
*/
@@ -107,8 +107,7 @@ public class EntityManagerFactoryBuilder {
}
/**
* The classes whose packages should be scanned for <code>@Entity</code>
* annotations.
* The classes whose packages should be scanned for {@code @Entity} annotations.
* @param basePackageClasses the classes to use
* @return the builder for fluent usage
*/

View File

@@ -28,10 +28,10 @@ import org.springframework.security.config.annotation.web.configuration.WebSecur
/**
* If the user explicitly disables the basic security features and forgets to
* <code>@EnableWebSecurity</code>, and yet still wants a bean of type
* {@code @EnableWebSecurity}, and yet still wants a bean of type
* WebSecurityConfigurerAdapter, he is trying to use a custom security setup. The app
* would fail in a confusing way without this shim configuration, which just helpfully
* defines an empty <code>@EnableWebSecurity</code>.
* defines an empty {@code @EnableWebSecurity}.
*
* @author Dave Syer
*/

View File

@@ -37,9 +37,9 @@ import org.springframework.security.config.annotation.web.configuration.WebSecur
* random and printed on the console at INFO level during startup. In a webapp this
* configuration also secures all web endpoints (except some well-known static resource)
* locations with HTTP basic security. To replace all the default behaviour in a webapp
* provide a <code>@Configuration</code> with <code>@EnableWebSecurity</code>. To just add
* your own layer of application security in front of the defaults, add a
* <code>@Configuration</code> of type {@link WebSecurityConfigurerAdapter}.
* provide a {@code @Configuration} with {@code @EnableWebSecurity}. To just add your own
* layer of application security in front of the defaults, add a {@code @Configuration} of
* type {@link WebSecurityConfigurerAdapter}.
*
* @author Dave Syer
* @author Andy Wilkinson

View File

@@ -67,17 +67,16 @@ import org.springframework.web.servlet.support.RequestDataValueProcessor;
* ). Many aspects of the behavior can be controller with {@link SecurityProperties} via
* externalized application properties (or via an bean definition of that type to set the
* defaults). The user details for authentication are just placeholders
* <code>(username=user,
* password=password)</code> but can easily be customized by providing a bean definition
* of type {@link AuthenticationManager}. Also provides audit logging of authentication
* events.
* {@code (username=user, password=password)} but can easily be customized by providing a
* bean definition of type {@link AuthenticationManager}. Also provides audit logging of
* authentication events.
* <p>
* Some common simple customizations:
* <ul>
* <li>Switch off security completely and permanently: remove Spring Security from the
* classpath or {@link EnableAutoConfiguration#exclude() exclude} this configuration.</li>
* <li>Switch off security temporarily (e.g. for a dev environment): set
* <code>security.basic.enabled: false</code></li>
* {@code security.basic.enabled: false}</li>
* <li>Customize the user details: add an AuthenticationManager bean</li>
* <li>Add form login for user facing resources: add a
* {@link WebSecurityConfigurerAdapter} and use {@link HttpSecurity#formLogin()}</li>

View File

@@ -130,7 +130,7 @@ public class OAuth2RestOperationsConfiguration {
* When the authentication is per cookie but the stored token is an oauth2 one, we can
* pass that on to a client that wants to call downstream. We don't even need an
* OAuth2ClientContextFilter until we need to refresh the access token. To handle
* refresh tokens you need to <code>@EnableOAuth2Client</code>
* refresh tokens you need to {@code @EnableOAuth2Client}
*/
@Configuration
@ConditionalOnMissingBean(OAuth2ClientConfiguration.class)

View File

@@ -42,7 +42,7 @@ import org.springframework.util.ReflectionUtils;
/**
* Configuration for OAuth2 Single Sign On (SSO) when there is an existing
* {@link WebSecurityConfigurerAdapter} provided by the user and annotated with
* <code>@EnableOAuth2Sso</code>. The user-provided configuration is enhanced by adding an
* {@code @EnableOAuth2Sso}. The user-provided configuration is enhanced by adding an
* authentication filter and an authentication entry point.
*
* @author Dave Syer