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

Revamp Javadoc for Azure Java Client libraries #34186

Open
g2vinay opened this issue Mar 23, 2023 · 0 comments
Open

Revamp Javadoc for Azure Java Client libraries #34186

g2vinay opened this issue Mar 23, 2023 · 0 comments
Labels
App Configuration Azure.ApplicationModel.Configuration Azure.Core azure-core Client This issue points to a problem in the data-plane of the library. Cognitive - Form Recognizer Cognitive - Metrics Advisor Cognitive - Text Analytics Container Registry Epic Event Grid Event Hubs KeyVault Monitor Monitor, Monitor Ingestion, Monitor Query Schema Registry Search Service Bus

Comments

@g2vinay
Copy link
Member

g2vinay commented Mar 23, 2023 •
edited

SDK's to be updated with new Javadocs:

Update package and class level documentation of builders, clients and models in your SDKs.
Estimated effort per SDK = 4-5 dev days,

Note: Use JDK 21 to compile your SDK's javadoc as well and fix any compile warnings/errors that come up as part of your PRs. This will ensure our Javadocs are compatible with next Java LTS release (JDK 21)

References to follow for:
Identity Package level Javadoc
Identity Class level Javadoc
Identity Builder level Javadoc

Java Team SDKs

image
@ghost ghost added the needs-triage This is a new issue that needs to be triaged to the appropriate team. label Mar 23, 2023
@g2vinay g2vinay added the Client This issue points to a problem in the data-plane of the library. label Mar 23, 2023
@ghost ghost removed the needs-triage This is a new issue that needs to be triaged to the appropriate team. label Mar 23, 2023
@g2vinay g2vinay added Azure.Core azure-core needs-triage This is a new issue that needs to be triaged to the appropriate team. Search App Configuration Azure.ApplicationModel.Configuration KeyVault labels Mar 23, 2023
@ghost ghost removed the needs-triage This is a new issue that needs to be triaged to the appropriate team. label Mar 23, 2023
@srnagar srnagar added Monitor Monitor, Monitor Ingestion, Monitor Query and removed Monitor - Query labels Aug 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
App Configuration Azure.ApplicationModel.Configuration Azure.Core azure-core Client This issue points to a problem in the data-plane of the library. Cognitive - Form Recognizer Cognitive - Metrics Advisor Cognitive - Text Analytics Container Registry Epic Event Grid Event Hubs KeyVault Monitor Monitor, Monitor Ingestion, Monitor Query Schema Registry Search Service Bus
Projects
Azure SDK for Key Vault
Status: No status
Azure SDK for Search
Status: Done
Java SDKs Azure Core
Status: In Progress
Milestone
No milestone
Development

No branches or pull requests
3 participants
@g2vinay @alzimmermsft @srnagar