Skip to content
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

[Epic] Improve java doc's quality. #24332

Closed
4 tasks done
Tracked by #23402
chenrujun opened this issue Sep 26, 2021 · 1 comment
Closed
4 tasks done
Tracked by #23402

[Epic] Improve java doc's quality. #24332

chenrujun opened this issue Sep 26, 2021 · 1 comment
Assignees
@backwind1233 @moarychan @saragluna @yiliuTo
Labels
azure-spring All azure-spring related issues Client This issue points to a problem in the data-plane of the library.
Milestone
Spring Cloud Azur...

Comments

@chenrujun
Copy link

chenrujun commented Sep 26, 2021 •
edited by stliu
Loading

Parent issue: #23402

Requirement

As a public library, every public class should have well-formatted java doc.

AutoConfiguration Properties's javadoc will be used to genreated metadta and docs, so these classes' javadoc must be well documented.

Sub issues

Java doc samples

  1. Here is the java doc of OAuth2AuthorizedClientProvider in spring-security-oauth2-client:
    image

1/ Here is java doc of OtherClientRefreshTokenOAuth2AuthorizedClientProvider in spring-security-azure-oauth2-client:
image
@chenrujun chenrujun added Client This issue points to a problem in the data-plane of the library. azure-spring All azure-spring related issues labels Sep 26, 2021
@chenrujun chenrujun mentioned this issue Sep 26, 2021
Closed
@chenrujun chenrujun changed the title Make sure all public class have well-formatted java doc. [All] Make sure all public class have well-formatted java doc. Sep 26, 2021
@chenrujun chenrujun changed the title [All] Make sure all public class have well-formatted java doc. [Common] Make sure all public class have well-formatted java doc. Sep 26, 2021
@chenrujun chenrujun changed the title [Common] Make sure all public class have well-formatted java doc. [Common] Ensure all public class have well-formatted java doc. Sep 26, 2021
@chenrujun chenrujun changed the title [Common] Ensure all public class have well-formatted java doc. Ensure all public class have well-formatted java doc. Sep 26, 2021
@chenrujun chenrujun mentioned this issue Sep 27, 2021
Closed
@chenrujun chenrujun changed the title Ensure all public class have well-formatted java doc. Ensure all public class have high-quality java doc. Sep 28, 2021
@chenrujun chenrujun changed the title Ensure all public class have high-quality java doc. Improve java doc's quality. Sep 28, 2021
This was referenced Sep 28, 2021
Closed
Closed
Closed
Closed
@yiliuTo yiliuTo added this to the [2021] December milestone Oct 11, 2021
@chenrujun chenrujun moved this to Todo in Spring Cloud Azure Nov 5, 2021
@chenrujun chenrujun assigned chenrujun and moarychan and unassigned chenrujun Nov 5, 2021
@chenrujun chenrujun removed this from the Spring Cloud Azure 4.0 GA milestone Nov 24, 2021
@saragluna saragluna moved this from Todo to In Progress in Spring Cloud Azure Jan 6, 2022
@saragluna saragluna changed the title Improve java doc's quality. [Epic] Improve java doc's quality. Jan 6, 2022
@saragluna
Copy link
Member

saragluna commented Jan 14, 2022 •
edited
Loading

Closed in #26288, but we'll keep improving their quality later.

Repository owner moved this from In Progress to Done in Spring Cloud Azure Jan 14, 2022
@chenrujun chenrujun mentioned this issue Mar 10, 2022
Merged
@github-actions github-actions bot locked and limited conversation to collaborators Apr 11, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@backwind1233 backwind1233

@moarychan moarychan

@saragluna saragluna

@yiliuTo yiliuTo

Labels
azure-spring All azure-spring related issues Client This issue points to a problem in the data-plane of the library.
Projects
Spring Cloud Azure
Archived in project
Milestone
Spring Cloud Azure 4.0 Beta3
Development

No branches or pull requests
5 participants
@backwind1233 @chenrujun @moarychan @saragluna @yiliuTo