Transition Some SDKs to Standard Doclet (Azure#25637)

alzimmermsft · web-flow · commit 04dcc71d26da · 2021-11-23T15:15:54.000-08:00
Transition Some SDKs to Standard Doclet
diff --git a/sdk/confidentialledger/azure-security-confidentialledger/pom.xml b/sdk/confidentialledger/azure-security-confidentialledger/pom.xml
@@ -35,6 +35,9 @@
     <javaModulesSurefireArgLine>
       --add-exports com.azure.core/com.azure.core.implementation.jackson=ALL-UNNAMED
     </javaModulesSurefireArgLine>
+    <codesnippet.skip>false</codesnippet.skip>
+    <javadocDoclet></javadocDoclet>
+    <javadocDocletOptions></javadocDocletOptions>
   </properties>
 
   <dependencies>
diff --git a/sdk/containerregistry/azure-containers-containerregistry-perf/pom.xml b/sdk/containerregistry/azure-containers-containerregistry-perf/pom.xml
@@ -21,6 +21,9 @@
     <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
     <maven.compiler.source>1.8</maven.compiler.source>
     <maven.compiler.target>1.8</maven.compiler.target>
+    <codesnippet.skip>false</codesnippet.skip>
+    <javadocDoclet></javadocDoclet>
+    <javadocDocletOptions></javadocDocletOptions>
   </properties>
 
   <dependencies>
diff --git a/sdk/containerregistry/azure-containers-containerregistry-perf/src/main/java/com/azure/containers/containerregistry/perf/App.java b/sdk/containerregistry/azure-containers-containerregistry-perf/src/main/java/com/azure/containers/containerregistry/perf/App.java
@@ -16,6 +16,11 @@
  * Then run the App's main method via IDE.</p>
  */
 public class App {
+    /**
+     * Runs the Container Registry performance tests.
+     *
+     * @param args Performance test configurations.
+     */
     public static void main(String[] args) {
         PerfStressProgram.run(new Class<?>[]{
             GetManifestPropertiesTest.class,
diff --git a/sdk/containerregistry/azure-containers-containerregistry-perf/src/main/java/com/azure/containers/containerregistry/perf/GetManifestPropertiesTest.java b/sdk/containerregistry/azure-containers-containerregistry-perf/src/main/java/com/azure/containers/containerregistry/perf/GetManifestPropertiesTest.java
@@ -3,16 +3,10 @@
 
 package com.azure.containers.containerregistry.perf;
 
-;
-
-import com.azure.containers.containerregistry.ContainerRepository;
-import com.azure.containers.containerregistry.ContainerRepositoryAsync;
 import com.azure.containers.containerregistry.RegistryArtifact;
 import com.azure.containers.containerregistry.RegistryArtifactAsync;
-import com.azure.containers.containerregistry.models.ArtifactManifestProperties;
 import com.azure.containers.containerregistry.perf.core.ServiceTest;
 import com.azure.perf.test.core.PerfStressOptions;
-import reactor.core.publisher.Flux;
 import reactor.core.publisher.Mono;
 
 import java.util.Arrays;
@@ -24,11 +18,19 @@
 import static com.azure.containers.containerregistry.perf.core.Utils.TEST_PERF_TAG3_NAME;
 import static com.azure.containers.containerregistry.perf.core.Utils.TEST_PERF_TAG4_NAME;
 
+/**
+ * Get manifest properties performance test.
+ */
 public class GetManifestPropertiesTest extends ServiceTest<PerfStressOptions> {
     private final RegistryArtifactAsync registryArtifactAsync;
     private final RegistryArtifact registryArtifact;
     private final List<String> tags;
 
+    /**
+     * Creates the get manifest properties performance test.
+     *
+     * @param options Performance test configuration options.
+     */
     public GetManifestPropertiesTest(PerfStressOptions options) {
         super(options);
 
diff --git a/sdk/containerregistry/azure-containers-containerregistry-perf/src/main/java/com/azure/containers/containerregistry/perf/ListRepositoryTests.java b/sdk/containerregistry/azure-containers-containerregistry-perf/src/main/java/com/azure/containers/containerregistry/perf/ListRepositoryTests.java
@@ -16,8 +16,16 @@
 import static com.azure.containers.containerregistry.perf.core.Utils.TEST_PERF_TAG3_NAME;
 import static com.azure.containers.containerregistry.perf.core.Utils.TEST_PERF_TAG4_NAME;
 
+/**
+ * List repository performance test.
+ */
 public class ListRepositoryTests extends ServiceTest<PerfStressOptions> {
 
+    /**
+     * Creates the list repository performance test.
+     *
+     * @param options Performance test configuration options.
+     */
     public ListRepositoryTests(PerfStressOptions options) {
         super(options);
     }
diff --git a/sdk/containerregistry/azure-containers-containerregistry-perf/src/main/java/com/azure/containers/containerregistry/perf/core/ServiceTest.java b/sdk/containerregistry/azure-containers-containerregistry-perf/src/main/java/com/azure/containers/containerregistry/perf/core/ServiceTest.java
@@ -44,10 +44,15 @@ public abstract class ServiceTest<TOptions extends PerfStressOptions> extends Pe
     final String subscriptionId;
     final TokenCredential tokenCredential;
 
+    /**
+     * The ContainerRegistryClient used in a performance test.
+     */
     protected ContainerRegistryClient containerRegistryClient;
-    protected ContainerRegistryAsyncClient containerRegistryAsyncClient;
-
 
+    /**
+     * The ContainerRegistryAsyncClient used in an asynchronous performance test.
+     */
+    protected ContainerRegistryAsyncClient containerRegistryAsyncClient;
 
     /**
      * The base class for Azure Container Registry performance tests.
@@ -90,6 +95,13 @@ private String getConfigurationValue(String configurationName) {
         return configurationValue;
     }
 
+    /**
+     * Imports an image into a Container Registry.
+     *
+     * @param repositoryName The Container Registry repository name.
+     * @param tags Tags to associate with the image.
+     * @return An asynchronous response that only indicates completion.
+     */
     protected Mono<Void> importImageAsync(String repositoryName, List<String> tags) {
         tags = tags.stream().map(tag -> String.format("%1$s:%2$s", repositoryName, tag)).collect(Collectors.toList());
 
diff --git a/sdk/containerregistry/azure-containers-containerregistry-perf/src/main/java/com/azure/containers/containerregistry/perf/core/Utils.java b/sdk/containerregistry/azure-containers-containerregistry-perf/src/main/java/com/azure/containers/containerregistry/perf/core/Utils.java
@@ -5,17 +5,44 @@
 
 import com.azure.core.util.Configuration;
 
+/**
+ * Utilities for the Container Registry performance tests.
+ */
 public class Utils {
     static final Configuration CONFIGURATION = Configuration.getGlobalConfiguration();
     static final String PROPERTY_CONTAINERREGISTRY_SUBSCRIPTION_ID = "CONTAINERREGISTRY_SUBSCRIPTION_ID";
     static final String PROPERTY_CONTAINERREGISTRY_ENDPOINT = "CONTAINERREGISTRY_ENDPOINT";
     static final String PROPERTY_CONTAINERREGISTRY_NAME = "CONTAINERREGISTRY_REGISTRY_NAME";
     static final String PROPERTY_CONTAINERREGISTRY_RESOURCE_GROUP = "CONTAINERREGISTRY_RESOURCE_GROUP";
     static final String REGISTRY_URI = "registry.hub.docker.com";
+
+    /**
+     * Well-known repository name.
+     */
     public static final String REPOSITORY_NAME = "library/node";
+
+    /**
+     * Well-known tag name.
+     */
     public static final String TEST_PERF_TAG1_NAME = "test-perf-tag1";
+
+    /**
+     * Well-known tag name.
+     */
     public static final String TEST_PERF_TAG2_NAME = "test-perf-tag2";
+
+    /**
+     * Well-known tag name.
+     */
     public static final String TEST_PERF_TAG3_NAME = "test-perf-tag3";
+
+    /**
+     * Well-known tag name.
+     */
     public static final String TEST_PERF_TAG4_NAME = "test-perf-tag4";
+
+    /**
+     * Well-known tag name.
+     */
     public static final String TEST_PERF_TAG5_NAME = "test-perf-tag5";
 }
diff --git a/sdk/deviceupdate/azure-iot-deviceupdate/pom.xml b/sdk/deviceupdate/azure-iot-deviceupdate/pom.xml
@@ -27,6 +27,12 @@
     <url>https://github.com/Azure/azure-sdk-for-java</url>
   </scm>
 
+  <properties>
+    <codesnippet.skip>false</codesnippet.skip>
+    <javadocDoclet></javadocDoclet>
+    <javadocDocletOptions></javadocDocletOptions>
+  </properties>
+
   <dependencies>
     <dependency>
       <groupId>com.azure</groupId>
diff --git a/sdk/mixedreality/azure-mixedreality-authentication/pom.xml b/sdk/mixedreality/azure-mixedreality-authentication/pom.xml
@@ -30,6 +30,12 @@
     <url>https://github.com/Azure/azure-sdk-for-java</url>
   </scm>
 
+  <properties>
+    <codesnippet.skip>false</codesnippet.skip>
+    <javadocDoclet></javadocDoclet>
+    <javadocDocletOptions></javadocDocletOptions>
+  </properties>
+
   <dependencies>
     <dependency>
       <groupId>com.azure</groupId>
diff --git a/sdk/mixedreality/azure-mixedreality-authentication/src/main/java/com/azure/mixedreality/authentication/MixedRealityStsServiceVersion.java b/sdk/mixedreality/azure-mixedreality-authentication/src/main/java/com/azure/mixedreality/authentication/MixedRealityStsServiceVersion.java
@@ -9,6 +9,9 @@
  * The versions of the Azure Mixed Reality STS supported by this client library.
  */
 public enum MixedRealityStsServiceVersion implements ServiceVersion {
+    /**
+     * Service version {@code 2019-02-28-preview}.
+     */
     V2019_02_28_PREVIEW("2019-02-28-preview");
 
     private final String version;
diff --git a/sdk/modelsrepository/azure-iot-modelsrepository/pom.xml b/sdk/modelsrepository/azure-iot-modelsrepository/pom.xml
@@ -40,6 +40,9 @@
       --add-exports com.azure.core/com.azure.core.implementation.http=ALL-UNNAMED
       --add-opens com.azure.iot.modelsrepository/com.azure.iot.modelsrepository=ALL-UNNAMED
     </javaModulesSurefireArgLine>
+    <codesnippet.skip>false</codesnippet.skip>
+    <javadocDoclet></javadocDoclet>
+    <javadocDocletOptions></javadocDocletOptions>
   </properties>
 
   <dependencies>
diff --git a/sdk/modelsrepository/azure-iot-modelsrepository/src/main/java/com/azure/iot/modelsrepository/ModelsRepositoryServiceVersion.java b/sdk/modelsrepository/azure-iot-modelsrepository/src/main/java/com/azure/iot/modelsrepository/ModelsRepositoryServiceVersion.java
@@ -9,6 +9,9 @@
  * The service API versions of Azure Models Repository that are supported by this client.
  */
 public enum ModelsRepositoryServiceVersion implements ServiceVersion {
+    /**
+     * Service version {@code 2021_02_11}.
+     */
     V2021_02_11("2021_02_11");
 
     private final String version;
diff --git a/sdk/quantum/azure-quantum-jobs/pom.xml b/sdk/quantum/azure-quantum-jobs/pom.xml
@@ -35,6 +35,9 @@
    <properties>
     <!-- require minimal code coverage until tests are added -->
     <jacoco.min.linecoverage>0.10</jacoco.min.linecoverage>
+     <codesnippet.skip>false</codesnippet.skip>
+     <javadocDoclet></javadocDoclet>
+     <javadocDocletOptions></javadocDocletOptions>
   </properties>
 
   <dependencies>
diff --git a/sdk/remoterendering/azure-mixedreality-remoterendering/pom.xml b/sdk/remoterendering/azure-mixedreality-remoterendering/pom.xml
@@ -27,6 +27,12 @@
     <url>https://github.com/Azure/azure-sdk-for-java</url>
   </scm>
 
+  <properties>
+    <codesnippet.skip>false</codesnippet.skip>
+    <javadocDoclet></javadocDoclet>
+    <javadocDocletOptions></javadocDocletOptions>
+  </properties>
+
   <dependencies>
     <dependency>
       <groupId>com.azure</groupId>
diff --git a/sdk/remoterendering/azure-mixedreality-remoterendering/src/main/java/com/azure/mixedreality/remoterendering/RemoteRenderingServiceVersion.java b/sdk/remoterendering/azure-mixedreality-remoterendering/src/main/java/com/azure/mixedreality/remoterendering/RemoteRenderingServiceVersion.java
@@ -9,6 +9,9 @@
  * The versions of the RemoteRenderingService supported by this client library.
  */
 public enum RemoteRenderingServiceVersion implements ServiceVersion {
+    /**
+     * Service version {@code 2021-01-01}.
+     */
     V2021_01_01("2021-01-01");
 
     private final String version;
diff --git a/sdk/search/azure-search-perf/pom.xml b/sdk/search/azure-search-perf/pom.xml
@@ -21,6 +21,9 @@
     <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
     <maven.compiler.source>1.8</maven.compiler.source>
     <maven.compiler.target>1.8</maven.compiler.target>
+    <codesnippet.skip>false</codesnippet.skip>
+    <javadocDoclet></javadocDoclet>
+    <javadocDocletOptions></javadocDocletOptions>
   </properties>
 
   <dependencies>
diff --git a/sdk/search/azure-search-perf/src/main/java/com/azure/search/perf/App.java b/sdk/search/azure-search-perf/src/main/java/com/azure/search/perf/App.java
@@ -22,6 +22,11 @@
  * Configurations} section. Then run the App's main method.
  */
 public class App {
+    /**
+     * Runs the Azure Search performance tests.
+     *
+     * @param args Performance tests configuration arguments.
+     */
     public static void main(String[] args) {
         PerfStressProgram.run(
             new Class<?>[]{AutocompleteTest.class, IndexDocumentsTest.class, SearchDocumentsTest.class,
diff --git a/sdk/search/azure-search-perf/src/main/java/com/azure/search/perf/AutocompleteTest.java b/sdk/search/azure-search-perf/src/main/java/com/azure/search/perf/AutocompleteTest.java
@@ -13,6 +13,11 @@
  * Performs autocomplete operations.
  */
 public class AutocompleteTest extends ServiceTest<SearchPerfStressOptions> {
+    /**
+     * Creates an autocomplete operations performance test.
+     *
+     * @param options Performance test configuration options.
+     */
     public AutocompleteTest(SearchPerfStressOptions options) {
         super(options);
     }
diff --git a/sdk/search/azure-search-perf/src/main/java/com/azure/search/perf/IndexDocumentsTest.java b/sdk/search/azure-search-perf/src/main/java/com/azure/search/perf/IndexDocumentsTest.java
@@ -22,6 +22,11 @@ public class IndexDocumentsTest extends ServiceTest<SearchPerfStressOptions> {
     private static volatile AtomicInteger ID_COUNT = new AtomicInteger();
     private final List<Hotel> hotels;
 
+    /**
+     * Creates the document indexing operations performance test.
+     *
+     * @param options Performance test configuration options.
+     */
     public IndexDocumentsTest(SearchPerfStressOptions options) {
         super(options);
 
diff --git a/sdk/search/azure-search-perf/src/main/java/com/azure/search/perf/SearchDocumentsTest.java b/sdk/search/azure-search-perf/src/main/java/com/azure/search/perf/SearchDocumentsTest.java
@@ -14,6 +14,11 @@
  * Performs searching operations.
  */
 public class SearchDocumentsTest extends ServiceTest<SearchPerfStressOptions> {
+    /**
+     * Creates the search operations performance test.
+     *
+     * @param options Performance test configuration options.
+     */
     public SearchDocumentsTest(SearchPerfStressOptions options) {
         super(options);
     }
diff --git a/sdk/search/azure-search-perf/src/main/java/com/azure/search/perf/SuggestTest.java b/sdk/search/azure-search-perf/src/main/java/com/azure/search/perf/SuggestTest.java
@@ -14,6 +14,11 @@
  * Performs suggestion operations.
  */
 public class SuggestTest extends ServiceTest<SearchPerfStressOptions> {
+    /**
+     * Creates the suggestion operations performance test.
+     *
+     * @param options Performance test configuration options.
+     */
     public SuggestTest(SearchPerfStressOptions options) {
         super(options);
     }
diff --git a/sdk/search/azure-search-perf/src/main/java/com/azure/search/perf/core/Address.java b/sdk/search/azure-search-perf/src/main/java/com/azure/search/perf/core/Address.java
@@ -10,22 +10,37 @@
  * Model class representing an address.
  */
 public class Address {
+    /**
+     * Street address
+     */
     @JsonProperty("StreetAddress")
     @SearchableField
     public String streetAddress;
 
+    /**
+     * City
+     */
     @JsonProperty("City")
     @SearchableField(isFilterable = true, isSortable = true, isFacetable = true)
     public String city;
 
+    /**
+     * State or province
+     */
     @JsonProperty("StateProvince")
     @SearchableField(isFilterable = true, isSortable = true, isFacetable = true)
     public String stateProvince;
 
+    /**
+     * Postal code
+     */
     @JsonProperty("PostalCode")
     @SearchableField(isFilterable = true, isSortable = true, isFacetable = true)
     public String postalCode;
 
+    /**
+     * Country
+     */
     @JsonProperty("Country")
     @SearchableField(isFilterable = true, isSortable = true, isFacetable = true)
     public String country;
diff --git a/sdk/search/azure-search-perf/src/main/java/com/azure/search/perf/core/DocumentSize.java b/sdk/search/azure-search-perf/src/main/java/com/azure/search/perf/core/DocumentSize.java
@@ -7,6 +7,13 @@
  * Represents the size of a document.
  */
 public enum DocumentSize {
+    /**
+     * Small document
+     */
     SMALL,
+
+    /**
+     * Large document
+     */
     LARGE
 }
diff --git a/sdk/search/azure-search-perf/src/main/java/com/azure/search/perf/core/Hotel.java b/sdk/search/azure-search-perf/src/main/java/com/azure/search/perf/core/Hotel.java
diff --git a/sdk/search/azure-search-perf/src/main/java/com/azure/search/perf/core/ServiceTest.java b/sdk/search/azure-search-perf/src/main/java/com/azure/search/perf/core/ServiceTest.java
diff --git a/sdk/template/azure-template-perf/pom.xml b/sdk/template/azure-template-perf/pom.xml
diff --git a/sdk/template/azure-template-perf/src/main/java/com/azure/sdk/template/perf/App.java b/sdk/template/azure-template-perf/src/main/java/com/azure/sdk/template/perf/App.java
diff --git a/sdk/template/azure-template-perf/src/main/java/com/azure/sdk/template/perf/GetMessageTest.java b/sdk/template/azure-template-perf/src/main/java/com/azure/sdk/template/perf/GetMessageTest.java
