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 Resource Manager SDKs #25634

Closed
85 of 98 tasks
alzimmermsft opened this issue Nov 23, 2021 · 3 comments
Closed
85 of 98 tasks

Resolve Missing Javadocs in Resource Manager SDKs #25634

alzimmermsft opened this issue Nov 23, 2021 · 3 comments
Assignees
Labels
Docs Mgmt This issue is related to a management-plane library.

Comments

@alzimmermsft
Copy link
Member

alzimmermsft commented Nov 23, 2021

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:

  • azure-resourcemanager
  • azure-resourcemanager-advisor
  • azure-resourcemanager-apimanagement
  • azure-resourcemanager-appconfiguration
  • azure-resourcemanager-applicationinsights
  • azure-resourcemanager-appplatform
  • azure-resourcemanager-automation
  • azure-resourcemanager-azurearcdata
  • azure-resourcemanager-azurestack
  • azure-resourcemanager-azurestackhci
  • azure-resourcemanager-baremetalinfrastructure
  • azure-resourcemanager-batch
  • azure-resourcemanager-batchai
  • azure-resourcemanager-billing
  • azure-resourcemanager-botservice
  • azure-resourcemanager-cdn
  • azure-resourcemanager-changeanalysis
  • azure-resourcemanager-commerce
  • azure-resourcemanager-consumption
  • azure-resourcemanager-containerservice
  • azure-resourcemanager-cosmos
  • azure-resourcemanager-costmanagement
  • azure-resourcemanager-customerinsights
  • azure-resourcemanager-databox
  • azure-resourcemanager-databoxedge
  • azure-resourcemanager-databricks
  • azure-resourcemanager-datadog
  • azure-resourcemanager-datalakeanalytics
  • azure-resourcemanager-datalakestore
  • azure-resourcemanager-datamigration
  • azure-resourcemanager-delegatednetwork
  • azure-resourcemanager-deploymentmanager
  • azure-resourcemanager-deviceprovisioningservices
  • azure-resourcemanager-devspaces
  • azure-resourcemanager-devtestlabs
  • azure-resourcemanager-dns
  • azure-resourcemanager-elastic
  • azure-resourcemanager-eventhubs
  • azure-resourcemanager-extendedlocation
  • azure-resourcemanager-frontdoor
  • azure-resourcemanager-hanaonazure
  • azure-resourcemanager-hdinsight
  • azure-resourcemanager-healthbot
  • azure-resourcemanager-healthcareapis
  • azure-resourcemanager-hybridcompute
  • azure-resourcemanager-hybridkubernetes
  • azure-resourcemanager-hybridnetwork
  • azure-resourcemanager-imagebuilder
  • azure-resourcemanager-iothub
  • azure-resourcemanager-keyvault
  • azure-resourcemanager-kubernetesconfiguration
  • azure-resourcemanager-kusto
  • azure-resourcemanager-labservices
  • azure-resourcemanager-loganalytics
  • azure-resourcemanager-logic
  • azure-resourcemanager-logz
  • azure-resourcemanager-machinelearningservices
  • azure-resourcemanager-maintenance
  • azure-resourcemanager-managedapplications
  • azure-resourcemanager-maps
  • azure-resourcemanager-mariadb
  • azure-resourcemanager-marketplaceordering
  • azure-resourcemanager-mediaservices
  • azure-resourcemanager-mixedreality
  • azure-resourcemanager-msi
  • azure-resourcemanager-mysql
  • azure-resourcemanager-mysqlflexibleserver
  • azure-resourcemanager-netapp
  • azure-resourcemanager-operationsmanagement
  • azure-resourcemanager-peering
  • azure-resourcemanager-policyinsights
  • azure-resourcemanager-postgresql
  • azure-resourcemanager-postgresqlflexibleserver
  • azure-resourcemanager-powerbidedicated
  • azure-resourcemanager-privatedns
  • azure-resourcemanager-purview
  • azure-resourcemanager-recoveryservices
  • azure-resourcemanager-recoveryservicesbackup
  • azure-resourcemanager-redisenterprise
  • azure-resourcemanager-relay
  • azure-resourcemanager-resourcegraph
  • azure-resourcemanager-resourcehealth
  • azure-resourcemanager-resourcemover
  • azure-resourcemanager-samples
  • azure-resourcemanager-security
  • azure-resourcemanager-servicebus
  • azure-resourcemanager-servicefabric
  • azure-resourcemanager-sqlvirtualmachine
  • azure-resourcemanager-storagecache
  • azure-resourcemanager-storageimportexport
  • azure-resourcemanager-storagepool
  • azure-resourcemanager-streamanalytics
  • azure-resourcemanager-subscription
  • azure-resourcemanager-support
  • azure-resourcemanager-timeseriesinsights
  • azure-resourcemanager-trafficmanager
  • azure-resourcemanager-videoanalyzer
  • azure-resourcemanager-vmwarecloudsimple
@alzimmermsft alzimmermsft added Mgmt This issue is related to a management-plane library. Docs labels Nov 23, 2021
@weidongxu-microsoft weidongxu-microsoft added this to the [2022] January milestone Nov 24, 2021
@weidongxu-microsoft
Copy link
Member

weidongxu-microsoft commented Nov 24, 2021

PR for Lite #25647, merged

@weidongxu-microsoft
Copy link
Member

PR for Premium #25656

@weidongxu-microsoft
Copy link
Member

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

@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
Docs Mgmt This issue is related to a management-plane library.
Projects
None yet
Development

No branches or pull requests

2 participants