Skip to content

Incorrect Javadoc for methods in HeadersConfigurer #7123

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
eleftherias opened this issue Jul 23, 2019 · 0 comments
Closed

Incorrect Javadoc for methods in HeadersConfigurer #7123

eleftherias opened this issue Jul 23, 2019 · 0 comments
Assignees
@eleftherias
Labels
in: docs An issue in Documentation or samples type: bug A general bug
Milestone
5.2.0.M4

Comments

@eleftherias
Copy link
Contributor

Summary

The Javadoc for some methods, including xssProtection(), cacheControl(), httpStrictTransportSecurity(), has an incorrect return type.

Actual Behavior

The return type is listed as HeadersConfigurer

Expected Behavior

The return type should be the matching configurer for each method.
XXssConfig for xssProtection()
CacheControlConfig for cacheControl()
etc
@eleftherias eleftherias added this to the 5.2.0.M4 milestone Jul 23, 2019
@eleftherias eleftherias self-assigned this Jul 23, 2019
@eleftherias eleftherias added in: docs An issue in Documentation or samples type: bug A general bug labels Jul 23, 2019
kostya05983 pushed a commit to kostya05983/spring-security that referenced this issue Aug 26, 2019
@eleftherias @kostya05983
Fix Javadoc for headers configurer methods
cdec7f0 
Fixes: spring-projectsgh-7123
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@eleftherias eleftherias

Labels
in: docs An issue in Documentation or samples type: bug A general bug
Projects
None yet
Milestone
5.2.0.M4
Development

No branches or pull requests
1 participant
@eleftherias