search

Azure / azure-sdk-for-java

This repository is for active development of the Azure SDK for Java. For consumers of the SDK we recommend visiting our public developer docs at https://docs.microsoft.com/java/azure/ or our versioned developer docs at https://azure.github.io/azure-sdk-for-java.
MIT License
2.31k stars 1.96k forks source link

Resolve Missing Javadocs in Resource Manager SDKs #25634

Closed alzimmermsft closed 2 years ago

alzimmermsft commented 2 years ago

This issue is a tracking issue for resolving missing Javadocs in resourcemanager SDKs and is being tracked by #25632.

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:

weidongxu-microsoft commented 2 years ago

PR for Lite https://github.com/Azure/azure-sdk-for-java/pull/25647, merged

weidongxu-microsoft commented 2 years ago

PR for Premium https://github.com/Azure/azure-sdk-for-java/pull/25656

weidongxu-microsoft commented 2 years ago

Verified premium with local run of mvn -DskipTests -Dspotbugs.skip=true -Dcheckstyle.skip=true -Drevapi.skip=true clean install with Java 17.