From 7e845409f185f759c1ea739bb7935964549b8765 Mon Sep 17 00:00:00 2001
From: Eleftheria Stein
Date: Wed, 24 Jul 2019 09:11:44 -0400
Subject: [PATCH] Fix Javadoc for headers configurer methods
Fixes: gh-7123
---
.../web/configurers/HeadersConfigurer.java | 20 +++++++++----------
1 file changed, 10 insertions(+), 10 deletions(-)
diff --git a/config/src/main/java/org/springframework/security/config/annotation/web/configurers/HeadersConfigurer.java b/config/src/main/java/org/springframework/security/config/annotation/web/configurers/HeadersConfigurer.java
index 77c840d5a0..f27a6bf6ce 100644
--- a/config/src/main/java/org/springframework/security/config/annotation/web/configurers/HeadersConfigurer.java
+++ b/config/src/main/java/org/springframework/security/config/annotation/web/configurers/HeadersConfigurer.java
@@ -118,7 +118,7 @@ public class HeadersConfigurer> extends
* X-Content-Type-Options: nosniff
*
*
- * @return the ContentTypeOptionsConfig for additional customizations
+ * @return the {@link ContentTypeOptionsConfig} for additional customizations
*/
public ContentTypeOptionsConfig contentTypeOptions() {
return contentTypeOptions.enable();
@@ -191,7 +191,7 @@ public class HeadersConfigurer> extends
* >X-XSS-Protection header
*
*
- * @return the {@link HeadersConfigurer} for additional customizations
+ * @return the {@link XXssConfig} for additional customizations
*/
public XXssConfig xssProtection() {
return xssProtection.enable();
@@ -304,7 +304,7 @@ public class HeadersConfigurer> extends
* Expires: 0
*
*
- * @return the {@link HeadersConfigurer} for additional customizations
+ * @return the {@link CacheControlConfig} for additional customizations
*/
public CacheControlConfig cacheControl() {
return cacheControl.enable();
@@ -375,7 +375,7 @@ public class HeadersConfigurer> extends
* href="https://tools.ietf.org/html/rfc6797">HTTP Strict Transport Security
* (HSTS).
*
- * @return the {@link HeadersConfigurer} for additional customizations
+ * @return the {@link HstsConfig} for additional customizations
*/
public HstsConfig httpStrictTransportSecurity() {
return hsts.enable();
@@ -511,7 +511,7 @@ public class HeadersConfigurer> extends
/**
* Allows customizing the {@link XFrameOptionsHeaderWriter}.
*
- * @return the {@link HeadersConfigurer} for additional customizations
+ * @return the {@link FrameOptionsConfig} for additional customizations
*/
public FrameOptionsConfig frameOptions() {
return frameOptions.enable();
@@ -598,7 +598,7 @@ public class HeadersConfigurer> extends
* Allows customizing the {@link HpkpHeaderWriter} which provides support for HTTP Public Key Pinning (HPKP).
*
- * @return the {@link HeadersConfigurer} for additional customizations
+ * @return the {@link HpkpConfig} for additional customizations
*
* @since 4.1
*/
@@ -808,7 +808,7 @@ public class HeadersConfigurer> extends
*
* @see ContentSecurityPolicyHeaderWriter
* @since 4.1
- * @return the ContentSecurityPolicyConfig for additional configuration
+ * @return the {@link ContentSecurityPolicyConfig} for additional configuration
* @throws IllegalArgumentException if policyDirectives is null or empty
*/
public ContentSecurityPolicyConfig contentSecurityPolicy(String policyDirectives) {
@@ -979,7 +979,7 @@ public class HeadersConfigurer> extends
*
* @see ReferrerPolicyHeaderWriter
* @since 4.2
- * @return the ReferrerPolicyConfig for additional configuration
+ * @return the {@link ReferrerPolicyConfig} for additional configuration
*/
public ReferrerPolicyConfig referrerPolicy() {
this.referrerPolicy.writer = new ReferrerPolicyHeaderWriter();
@@ -1001,7 +1001,7 @@ public class HeadersConfigurer> extends
*
* @see ReferrerPolicyHeaderWriter
* @since 4.2
- * @return the ReferrerPolicyConfig for additional configuration
+ * @return the {@link ReferrerPolicyConfig} for additional configuration
* @throws IllegalArgumentException if policy is null or empty
*/
public ReferrerPolicyConfig referrerPolicy(ReferrerPolicy policy) {
@@ -1071,7 +1071,7 @@ public class HeadersConfigurer> extends
*
* @see FeaturePolicyHeaderWriter
* @since 5.1
- * @return the {@link FeaturePolicyHeaderWriter} for additional configuration
+ * @return the {@link FeaturePolicyConfig} for additional configuration
* @throws IllegalArgumentException if policyDirectives is {@code null} or empty
*/
public FeaturePolicyConfig featurePolicy(String policyDirectives) {