Skip to content

Commit 17aaf26

Browse files
philwebbphilwebb
committed
Use consistent javadoc style for annotation links
Closes spring-projectsgh-13920
1 parent 1e44aba commit 17aaf26

File tree

365 files changed

+839
-720
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

365 files changed

+839
-720
lines changed

‎spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/cloudfoundry/EndpointCloudFoundryExtension.java

+2-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,8 @@
2626
import org.springframework.boot.actuate.endpoint.annotation.EndpointExtension;
2727

2828
/**
29-
* Identifies a type as being a Cloud Foundry specific extension for an {@link Endpoint}.
29+
* Identifies a type as being a Cloud Foundry specific extension for an
30+
* {@link Endpoint @Endpoint}.
3031
*
3132
* @author Phillip Webb
3233
* @author Madhura Bhave

‎spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/cloudfoundry/reactive/CloudFoundryReactiveHealthEndpointWebExtension.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@
2828
import org.springframework.boot.actuate.health.ShowDetails;
2929

3030
/**
31-
* Reactive {@link EndpointExtension} for the {@link HealthEndpoint} that always exposes
32-
* full health details.
31+
* Reactive {@link EndpointExtension @EndpointExtension} for the {@link HealthEndpoint}
32+
* that always exposes full health details.
3333
*
3434
* @author Madhura Bhave
3535
* @since 2.0.0

‎spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/cloudfoundry/servlet/CloudFoundryHealthEndpointWebExtension.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,8 @@
2626
import org.springframework.boot.actuate.health.ShowDetails;
2727

2828
/**
29-
* {@link EndpointExtension} for the {@link HealthEndpoint} that always exposes full
30-
* health details.
29+
* {@link EndpointExtension @EndpointExtension} for the {@link HealthEndpoint} that always
30+
* exposes full health details.
3131
*
3232
* @author Madhura Bhave
3333
* @since 2.0.0

‎spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/cloudfoundry/servlet/CloudFoundryInfoEndpointWebExtension.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@
2323
import org.springframework.boot.actuate.info.InfoEndpoint;
2424

2525
/**
26-
* {@link EndpointExtension} for the {@link InfoEndpoint} that always exposes full git
27-
* details.
26+
* {@link EndpointExtension @EndpointExtension} for the {@link InfoEndpoint} that always
27+
* exposes full git details.
2828
*
2929
* @author Madhura Bhave
3030
* @since 2.2.0

‎spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/condition/ConditionsReportEndpoint.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2012-2018 the original author or authors.
2+
* Copyright 2012-2019 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -42,7 +42,7 @@
4242
import org.springframework.util.StringUtils;
4343

4444
/**
45-
* {@link Endpoint} to expose the {@link ConditionEvaluationReport}.
45+
* {@link Endpoint @Endpoint} to expose the {@link ConditionEvaluationReport}.
4646
*
4747
* @author Greg Turnquist
4848
* @author Phillip Webb

‎spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/endpoint/EndpointAutoConfiguration.java

+2-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,8 @@
2727
import org.springframework.core.env.Environment;
2828

2929
/**
30-
* {@link EnableAutoConfiguration Auto-configuration} for {@link Endpoint} support.
30+
* {@link EnableAutoConfiguration Auto-configuration} for {@link Endpoint @Endpoint}
31+
* support.
3132
*
3233
* @author Phillip Webb
3334
* @author Stephane Nicoll

‎spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/endpoint/condition/AbstractEndpointCondition.java

+2-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,8 @@
3333
import org.springframework.util.ClassUtils;
3434

3535
/**
36-
* Base class for {@link Endpoint} related {@link SpringBootCondition} implementations.
36+
* Base class for {@link Endpoint @Endpoint} related {@link SpringBootCondition}
37+
* implementations.
3738
*
3839
* @author Stephane Nicoll
3940
* @author Andy Wilkinson

‎spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/endpoint/condition/ConditionalOnEnabledEndpoint.java

+5-4
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,9 @@
2828
import org.springframework.core.env.Environment;
2929

3030
/**
31-
* {@link Conditional} that checks whether an endpoint is enabled or not. Matches
32-
* according to the endpoints specific {@link Environment} property, falling back to
33-
* {@code management.endpoints.enabled-by-default} or failing that
31+
* {@link Conditional @Conditional} that checks whether an endpoint is enabled or not.
32+
* Matches according to the endpoints specific {@link Environment} property, falling back
33+
* to {@code management.endpoints.enabled-by-default} or failing that
3434
* {@link Endpoint#enableByDefault()}.
3535
* <p>
3636
* When placed on a {@code @Bean} method, the endpoint defaults to the return type of the
@@ -99,7 +99,8 @@
9999

100100
/**
101101
* The endpoint type that should be checked. Inferred when the return type of the
102-
* {@code @Bean} method is either an {@link Endpoint} or an {@link EndpointExtension}.
102+
* {@code @Bean} method is either an {@link Endpoint @Endpoint} or an
103+
* {@link EndpointExtension @EndpointExtension}.
103104
* @return the endpoint type to check
104105
* @since 2.0.6
105106
*/

‎spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/endpoint/condition/ConditionalOnExposedEndpoint.java

+7-5
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,12 @@
2828
import org.springframework.core.env.Environment;
2929

3030
/**
31-
* {@link Conditional} that checks whether an endpoint is exposed or not. Matches
32-
* according to the endpoint exposure configuration {@link Environment} properties. This
33-
* is designed as a companion annotation to {@link ConditionalOnEnabledEndpoint}.
31+
* {@link Conditional @Conditional} that checks whether an endpoint is exposed or not.
32+
* Matches according to the endpoint exposure configuration {@link Environment}
33+
* properties. This is designed as a companion annotation to
34+
* {@link ConditionalOnEnabledEndpoint @ConditionalOnEnabledEndpoint}.
3435
* <p>
35-
* For a given {@link Endpoint}, the condition will match if:
36+
* For a given {@link Endpoint @Endpoint}, the condition will match if:
3637
* <ul>
3738
* <li>{@code "management.endpoints.web.exposure.*"} expose this endpoint</li>
3839
* <li>or if JMX is enabled and {@code "management.endpoints.jmx.exposure.*"} expose this
@@ -108,7 +109,8 @@
108109

109110
/**
110111
* The endpoint type that should be checked. Inferred when the return type of the
111-
* {@code @Bean} method is either an {@link Endpoint} or an {@link EndpointExtension}.
112+
* {@code @Bean} method is either an {@link Endpoint @Endpoint} or an
113+
* {@link EndpointExtension @EndpointExtension}.
112114
* @return the endpoint type to check
113115
*/
114116
Class<?> endpoint() default Void.class;

‎spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/endpoint/jmx/JmxEndpointAutoConfiguration.java

+2-1
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,8 @@
4949
import org.springframework.util.ObjectUtils;
5050

5151
/**
52-
* {@link EnableAutoConfiguration Auto-configuration} for JMX {@link Endpoint} support.
52+
* {@link EnableAutoConfiguration Auto-configuration} for JMX {@link Endpoint @Endpoint}
53+
* support.
5354
*
5455
* @author Andy Wilkinson
5556
* @author Stephane Nicoll

‎spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/endpoint/web/ServletEndpointManagementContextConfiguration.java

+2-1
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,8 @@
3434
import org.springframework.web.servlet.DispatcherServlet;
3535

3636
/**
37-
* {@link ManagementContextConfiguration} for servlet endpoints.
37+
* {@link ManagementContextConfiguration @ManagementContextConfiguration} for servlet
38+
* endpoints.
3839
*
3940
* @author Phillip Webb
4041
* @author Andy Wilkinson

‎spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/endpoint/web/WebEndpointAutoConfiguration.java

+2-1
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,8 @@
5454
import org.springframework.context.annotation.Configuration;
5555

5656
/**
57-
* {@link EnableAutoConfiguration Auto-configuration} for web {@link Endpoint} support.
57+
* {@link EnableAutoConfiguration Auto-configuration} for web {@link Endpoint @Endpoint}
58+
* support.
5859
*
5960
* @author Phillip Webb
6061
* @author Stephane Nicoll

‎spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/endpoint/web/jersey/JerseyWebEndpointManagementContextConfiguration.java

+2-1
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,8 @@
4444
import org.springframework.context.annotation.Bean;
4545

4646
/**
47-
* {@link ManagementContextConfiguration} for Jersey {@link Endpoint} concerns.
47+
* {@link ManagementContextConfiguration @ManagementContextConfiguration} for Jersey
48+
* {@link Endpoint @Endpoint} concerns.
4849
*
4950
* @author Andy Wilkinson
5051
* @author Phillip Webb

‎spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/endpoint/web/reactive/WebFluxEndpointManagementContextConfiguration.java

+2-1
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,8 @@
4444
import org.springframework.web.reactive.DispatcherHandler;
4545

4646
/**
47-
* {@link ManagementContextConfiguration} for Reactive {@link Endpoint} concerns.
47+
* {@link ManagementContextConfiguration @ManagementContextConfiguration} for Reactive
48+
* {@link Endpoint @Endpoint} concerns.
4849
*
4950
* @author Andy Wilkinson
5051
* @author Phillip Webb

‎spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/endpoint/web/servlet/WebMvcEndpointManagementContextConfiguration.java

+2-1
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,8 @@
4444
import org.springframework.web.servlet.DispatcherServlet;
4545

4646
/**
47-
* {@link ManagementContextConfiguration} for Spring MVC {@link Endpoint} concerns.
47+
* {@link ManagementContextConfiguration @ManagementContextConfiguration} for Spring MVC
48+
* {@link Endpoint @Endpoint} concerns.
4849
*
4950
* @author Andy Wilkinson
5051
* @author Phillip Webb

‎spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/health/ConditionalOnEnabledHealthIndicator.java

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2012-2017 the original author or authors.
2+
* Copyright 2012-2019 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -25,9 +25,9 @@
2525
import org.springframework.context.annotation.Conditional;
2626

2727
/**
28-
* {@link Conditional} that checks whether or not a default health indicator is enabled.
29-
* Matches if the value of the {@code management.health.<name>.enabled} property is
30-
* {@code true}. Otherwise, matches if the value of the
28+
* {@link Conditional @Conditional} that checks whether or not a default health indicator
29+
* is enabled. Matches if the value of the {@code management.health.<name>.enabled}
30+
* property is {@code true}. Otherwise, matches if the value of the
3131
* {@code management.health.defaults.enabled} property is {@code true} or if it is not
3232
* configured.
3333
*

‎spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/info/ConditionalOnEnabledInfoContributor.java

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2012-2017 the original author or authors.
2+
* Copyright 2012-2019 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -25,9 +25,9 @@
2525
import org.springframework.context.annotation.Conditional;
2626

2727
/**
28-
* {@link Conditional} that checks whether or not a default info contributor is enabled.
29-
* Matches if the value of the {@code management.info.<name>.enabled} property is
30-
* {@code true}. Otherwise, matches if the value of the
28+
* {@link Conditional @Conditional} that checks whether or not a default info contributor
29+
* is enabled. Matches if the value of the {@code management.info.<name>.enabled} property
30+
* is {@code true}. Otherwise, matches if the value of the
3131
* {@code management.info.defaults.enabled} property is {@code true} or if it is not
3232
* configured.
3333
*

‎spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/jolokia/JolokiaEndpoint.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2012-2018 the original author or authors.
2+
* Copyright 2012-2019 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -26,7 +26,7 @@
2626
import org.springframework.boot.actuate.endpoint.web.annotation.ServletEndpoint;
2727

2828
/**
29-
* {@link Endpoint} to expose a Jolokia {@link AgentServlet}.
29+
* {@link Endpoint @Endpoint} to expose a Jolokia {@link AgentServlet}.
3030
*
3131
* @author Phillip Webb
3232
* @since 2.0.0

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

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2012-2018 the original author or authors.
2+
* Copyright 2012-2019 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -22,7 +22,8 @@
2222
import org.springframework.boot.context.properties.ConfigurationProperties;
2323

2424
/**
25-
* {@link ConfigurationProperties} for configuring Micrometer-based metrics.
25+
* {@link ConfigurationProperties @ConfigurationProperties} for configuring
26+
* Micrometer-based metrics.
2627
*
2728
* @author Jon Schneider
2829
* @author Alexander Abramov

‎spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/export/appoptics/AppOpticsProperties.java

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2012-2018 the original author or authors.
2+
* Copyright 2012-2019 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -22,7 +22,8 @@
2222
import org.springframework.boot.context.properties.ConfigurationProperties;
2323

2424
/**
25-
* {@link ConfigurationProperties} for configuring AppOptics metrics export.
25+
* {@link ConfigurationProperties @ConfigurationProperties} for configuring AppOptics
26+
* metrics export.
2627
*
2728
* @author Stephane Nicoll
2829
* @since 2.1.0

‎spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/export/atlas/AtlasProperties.java

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2012-2018 the original author or authors.
2+
* Copyright 2012-2019 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -22,7 +22,8 @@
2222
import org.springframework.boot.context.properties.ConfigurationProperties;
2323

2424
/**
25-
* {@link ConfigurationProperties} for configuring Atlas metrics export.
25+
* {@link ConfigurationProperties @ConfigurationProperties} for configuring Atlas metrics
26+
* export.
2627
*
2728
* @author Jon Schneider
2829
* @author Stephane Nicoll

‎spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/export/datadog/DatadogProperties.java

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2012-2018 the original author or authors.
2+
* Copyright 2012-2019 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -20,7 +20,8 @@
2020
import org.springframework.boot.context.properties.ConfigurationProperties;
2121

2222
/**
23-
* {@link ConfigurationProperties} for configuring Datadog metrics export.
23+
* {@link ConfigurationProperties @ConfigurationProperties} for configuring Datadog
24+
* metrics export.
2425
*
2526
* @author Jon Schneider
2627
* @author Stephane Nicoll

‎spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/export/dynatrace/DynatraceProperties.java

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2012-2018 the original author or authors.
2+
* Copyright 2012-2019 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -20,7 +20,8 @@
2020
import org.springframework.boot.context.properties.ConfigurationProperties;
2121

2222
/**
23-
* {@link ConfigurationProperties} for configuring Dynatrace metrics export.
23+
* {@link ConfigurationProperties @ConfigurationProperties} for configuring Dynatrace
24+
* metrics export.
2425
*
2526
* @author Andy Wilkinson
2627
* @since 2.1.0

‎spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/export/elastic/ElasticProperties.java

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2012-2018 the original author or authors.
2+
* Copyright 2012-2019 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -20,7 +20,8 @@
2020
import org.springframework.boot.context.properties.ConfigurationProperties;
2121

2222
/**
23-
* {@link ConfigurationProperties} for configuring Elastic metrics export.
23+
* {@link ConfigurationProperties @ConfigurationProperties} for configuring Elastic
24+
* metrics export.
2425
*
2526
* @author Andy Wilkinson
2627
* @since 2.1.0

‎spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/export/ganglia/GangliaProperties.java

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2012-2018 the original author or authors.
2+
* Copyright 2012-2019 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -24,7 +24,8 @@
2424
import org.springframework.boot.context.properties.ConfigurationProperties;
2525

2626
/**
27-
* {@link ConfigurationProperties} for configuring Ganglia metrics export.
27+
* {@link ConfigurationProperties @ConfigurationProperties} for configuring Ganglia
28+
* metrics export.
2829
*
2930
* @author Jon Schneider
3031
* @author Stephane Nicoll

‎spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/export/graphite/GraphiteProperties.java

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2012-2018 the original author or authors.
2+
* Copyright 2012-2019 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -24,7 +24,8 @@
2424
import org.springframework.boot.context.properties.ConfigurationProperties;
2525

2626
/**
27-
* {@link ConfigurationProperties} for configuring Graphite metrics export.
27+
* {@link ConfigurationProperties @ConfigurationProperties} for configuring Graphite
28+
* metrics export.
2829
*
2930
* @author Jon Schneider
3031
* @author Stephane Nicoll

‎spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/export/humio/HumioProperties.java

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2012-2018 the original author or authors.
2+
* Copyright 2012-2019 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -24,7 +24,8 @@
2424
import org.springframework.boot.context.properties.ConfigurationProperties;
2525

2626
/**
27-
* {@link ConfigurationProperties} for configuring Humio metrics export.
27+
* {@link ConfigurationProperties @ConfigurationProperties} for configuring Humio metrics
28+
* export.
2829
*
2930
* @author Andy Wilkinson
3031
* @since 2.1.0

0 commit comments

Comments
 (0)