Skip to content

Commit 7e84540

Browse files
committed
Fix Javadoc for headers configurer methods
Fixes: gh-7123
1 parent f1187bd commit 7e84540

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

config/src/main/java/org/springframework/security/config/annotation/web/configurers/HeadersConfigurer.java

+10-10
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ public HeadersConfigurer<H> addHeaderWriter(HeaderWriter headerWriter) {
118118
* X-Content-Type-Options: nosniff
119119
* </pre>
120120
*
121-
* @return the ContentTypeOptionsConfig for additional customizations
121+
* @return the {@link ContentTypeOptionsConfig} for additional customizations
122122
*/
123123
public ContentTypeOptionsConfig contentTypeOptions() {
124124
return contentTypeOptions.enable();
@@ -191,7 +191,7 @@ private ContentTypeOptionsConfig enable() {
191191
* >X-XSS-Protection header</a>
192192
* </p>
193193
*
194-
* @return the {@link HeadersConfigurer} for additional customizations
194+
* @return the {@link XXssConfig} for additional customizations
195195
*/
196196
public XXssConfig xssProtection() {
197197
return xssProtection.enable();
@@ -304,7 +304,7 @@ private XXssConfig enable() {
304304
* <li>Expires: 0</li>
305305
* </ul>
306306
*
307-
* @return the {@link HeadersConfigurer} for additional customizations
307+
* @return the {@link CacheControlConfig} for additional customizations
308308
*/
309309
public CacheControlConfig cacheControl() {
310310
return cacheControl.enable();
@@ -375,7 +375,7 @@ private CacheControlConfig enable() {
375375
* href="https://tools.ietf.org/html/rfc6797">HTTP Strict Transport Security
376376
* (HSTS)</a>.
377377
*
378-
* @return the {@link HeadersConfigurer} for additional customizations
378+
* @return the {@link HstsConfig} for additional customizations
379379
*/
380380
public HstsConfig httpStrictTransportSecurity() {
381381
return hsts.enable();
@@ -511,7 +511,7 @@ private HstsConfig enable() {
511511
/**
512512
* Allows customizing the {@link XFrameOptionsHeaderWriter}.
513513
*
514-
* @return the {@link HeadersConfigurer} for additional customizations
514+
* @return the {@link FrameOptionsConfig} for additional customizations
515515
*/
516516
public FrameOptionsConfig frameOptions() {
517517
return frameOptions.enable();
@@ -598,7 +598,7 @@ private FrameOptionsConfig enable() {
598598
* Allows customizing the {@link HpkpHeaderWriter} which provides support for <a
599599
* href="https://tools.ietf.org/html/rfc7469">HTTP Public Key Pinning (HPKP)</a>.
600600
*
601-
* @return the {@link HeadersConfigurer} for additional customizations
601+
* @return the {@link HpkpConfig} for additional customizations
602602
*
603603
* @since 4.1
604604
*/
@@ -808,7 +808,7 @@ private HpkpConfig enable() {
808808
*
809809
* @see ContentSecurityPolicyHeaderWriter
810810
* @since 4.1
811-
* @return the ContentSecurityPolicyConfig for additional configuration
811+
* @return the {@link ContentSecurityPolicyConfig} for additional configuration
812812
* @throws IllegalArgumentException if policyDirectives is null or empty
813813
*/
814814
public ContentSecurityPolicyConfig contentSecurityPolicy(String policyDirectives) {
@@ -979,7 +979,7 @@ private <T> void addIfNotNull(List<T> values, T value) {
979979
*
980980
* @see ReferrerPolicyHeaderWriter
981981
* @since 4.2
982-
* @return the ReferrerPolicyConfig for additional configuration
982+
* @return the {@link ReferrerPolicyConfig} for additional configuration
983983
*/
984984
public ReferrerPolicyConfig referrerPolicy() {
985985
this.referrerPolicy.writer = new ReferrerPolicyHeaderWriter();
@@ -1001,7 +1001,7 @@ public ReferrerPolicyConfig referrerPolicy() {
10011001
*
10021002
* @see ReferrerPolicyHeaderWriter
10031003
* @since 4.2
1004-
* @return the ReferrerPolicyConfig for additional configuration
1004+
* @return the {@link ReferrerPolicyConfig} for additional configuration
10051005
* @throws IllegalArgumentException if policy is null or empty
10061006
*/
10071007
public ReferrerPolicyConfig referrerPolicy(ReferrerPolicy policy) {
@@ -1071,7 +1071,7 @@ public HeadersConfigurer<H> and() {
10711071
*
10721072
* @see FeaturePolicyHeaderWriter
10731073
* @since 5.1
1074-
* @return the {@link FeaturePolicyHeaderWriter} for additional configuration
1074+
* @return the {@link FeaturePolicyConfig} for additional configuration
10751075
* @throws IllegalArgumentException if policyDirectives is {@code null} or empty
10761076
*/
10771077
public FeaturePolicyConfig featurePolicy(String policyDirectives) {

0 commit comments

Comments
 (0)