Skip to content

Add javadoc to CachingUserDetailsService #14211

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.

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

Closed
wants to merge 1 commit into from
Closed

Add javadoc to CachingUserDetailsService #14211

wants to merge 1 commit into from

Conversation

FdHerrera
Copy link

Add javadoc to CachingUserDetailsService, closes gh-10914

@spring-projects-issues spring-projects-issues added the status: waiting-for-triage An issue we've not yet triaged label Nov 29, 2023
@sjohnr sjohnr self-assigned this Nov 30, 2023
@sjohnr sjohnr added in: docs An issue in Documentation or samples type: enhancement A general enhancement and removed status: waiting-for-triage An issue we've not yet triaged labels Nov 30, 2023
@sjohnr
Copy link
Member

sjohnr commented Nov 30, 2023

@FdHerrera thanks for the PR! I want to mention that based on reviewing gh-10914, I believe we should be updating/enhancing the reference documentation to include information about CachingUserDetailsService. Adding javadoc is good too, though so thanks for doing that. Any chance you could add something to the reference docs? Let me know if you have any questions about it.

@FdHerrera
Copy link
Author

I'll figure out how to add a docs, never done that before.
Maybe we can close this MR and add the doc in another one?

@sjohnr
Copy link
Member

sjohnr commented Dec 1, 2023

You can add them under this PR and we can update the title. The docs are located under docs/modules/ROOT/pages and you can preview them by running ./gradlew antora. It will download a Node.js bundle and build the docs into a local docs site under docs/build/site.

@sjohnr
Copy link
Member

sjohnr commented Dec 1, 2023

You can also run ./gradlew format to fix the formatting violation in the javadoc you added.

@FdHerrera FdHerrera closed this by deleting the head repository Dec 8, 2023
@FdHerrera
Copy link
Author

Sorry, will create a new MR because wasn't able to fix a problem with conflicts in my fork 😅

@sjohnr sjohnr added the status: duplicate A duplicate of another issue label Dec 26, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
in: docs An issue in Documentation or samples status: duplicate A duplicate of another issue type: enhancement A general enhancement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

No introduction to CachingUserDetailsService in the documentation
3 participants