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.

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

Resolve Missing Javadocs in SDKs #25632

Closed
29 of 30 tasks
alzimmermsft opened this issue Nov 23, 2021 · 2 comments
Closed
29 of 30 tasks

Resolve Missing Javadocs in SDKs #25632

alzimmermsft opened this issue Nov 23, 2021 · 2 comments
Assignees
Labels
Client This issue points to a problem in the data-plane of the library. Docs

Comments

@alzimmermsft
Copy link
Member

alzimmermsft commented Nov 23, 2021

This issue is a tracking issue for resolving missing Javadocs in SDKs. Upon the completion of this issue the codesnippet4javadoc Doclet will be replace with the Standard Doclet.

To verify that a library is compatible with the Standard Doclet the following configurations will need to be added into the POM (if the properties section already exists only add the property values):

<properties>
    <codesnippet.skip>false</codesnippet.skip>
    <javadocDoclet></javadocDoclet>
    <javadocDocletOptions></javadocDocletOptions>
</properties>

Additionally, the build should preferably happen on Java 17 to ensure it works with the latest LTS Doclet tooling.

If any code generation classes are missing Javadocs please file an issue.

When you take an SDKs please leave a comment with which SDKs you'll be fixing or verifying.

The following are SDKs that need to be verified or fixed:

Anything checked off without a name next to it has been completed

  • azure-ai-anomalydetector
  • azure-ai-documenttranslator
  • azure-analytics-purview-administration
  • azure-analytics-purview-catalog
  • azure-analytics-purview-scanning
  • azure-analytics-synapse-accesscontrol (@g2vinay to-do)
  • azure-analytics-synapse-artifacts (@g2vinay to-do)
  • azure-analytics-synapse-managedprivateendpoints (@g2vinay to-do)
  • azure-analytics-synapse-monitoring (@g2vinay to-do)
  • azure-analytics-synapse-spark (@g2vinay to-do)
  • azure-containers-containerregistry-perf
  • azure-data-appconfiguration-perf
  • azure-iot-deviceupdate
  • azure-iot-modelsrepository
  • azure-media-videoanalyzer-edge
  • azure-messaging-eventhubs-track1-perf
  • azure-messaging-eventhubs-track2-perf
  • azure-messaging-servicebus-track1-perf
  • azure-messaging-servicebus-track2-perf
  • azure-mixedreality-authentication
  • azure-mixedreality-remoterendering
  • azure-quantum-jobs
  • Resolve Missing Javadocs in Resource Manager SDKs #25634
  • Resolve Missing Javadocs in Spring SDKs #25635
  • azure-search-perf
  • azure-security-confidentialledger
  • azure-template-perf
  • azure-verticals-agrifood-farming
  • microsoft-azure-storage-perf
  • perf-test-core (@g2vinay to-do)
@weidongxu-microsoft
Copy link
Member

Add one for Azure Stack #25665

@alzimmermsft
Copy link
Member Author

Closing this issue as there are specific issues tracking the areas that still need this to be resolved

@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.
Labels
Client This issue points to a problem in the data-plane of the library. Docs
Projects
None yet
Development

No branches or pull requests

2 participants