Begin Fixing Missing Javadocs in Preparation for Switch Over to Standard Doclet (Azure#25630)

Begin Fixing Missing Javadocs in Preparation for Switch Over to Standard Doclet

Author: alzimmermsft

eng/pipelines/scripts/inject_codesnippets.py

@@ -117,7 +117,7 @@ jobs:
           python3 eng/versioning/update_versions.py --update-type library --build-type ${{parameters.SDKType}} --sr
         condition: and(succeeded(), eq(variables['SetDevVersion'],'true'))
         displayName: Setup Dev versioning
-        
+
       - ${{if ne(parameters.ServiceDirectory, '')}}:
         - task: Powershell@2
           inputs:
@@ -130,7 +130,7 @@ jobs:
             workingDirectory: $(Pipeline.Workspace)
           displayName: Update package properties with dev version
           condition: and(succeeded(), eq(variables['SetDevVersion'],'true'))
-          
+
       - script: |
           pip install markdown2 BeautifulSoup4
         displayName: 'pip install markdown2 and BeautifulSoup4'
@@ -140,7 +140,7 @@ jobs:
         inputs:
           mavenPomFile: pom.xml
           goals: 'deploy'
-          options: '$(DefaultOptions) -T 1C -DskipTests -Dinject-codesnippets -Dgenerate-overview -Dspotbugs.skip=true -Dcheckstyle.skip=true -Drevapi.skip=true -pl $(ProjectList) -am -DaltDeploymentRepository=id::default::file://$(System.DefaultWorkingDirectory)/build' # We include template-module so we ensure it always builds in CI
+          options: '$(DefaultOptions) -T 1C -DskipTests -Dgenerate-overview -Dspotbugs.skip=true -Dcheckstyle.skip=true -Drevapi.skip=true -pl $(ProjectList) -am -DaltDeploymentRepository=id::default::file://$(System.DefaultWorkingDirectory)/build' # We include template-module so we ensure it always builds in CI
           mavenOptions: '$(MemoryOptions) $(LoggingOptions)'
           javaHomeOption: 'JDKVersion'
           jdkVersionOption: $(JavaBuildVersion)

eng/pipelines/templates/jobs/ci.yml

@@ -49,7 +49,12 @@ public class BlobCheckpointStore implements CheckpointStore {
     private static final String BLOB_PATH_SEPARATOR = "/";
     private static final String CHECKPOINT_PATH = "/checkpoint/";
     private static final String OWNERSHIP_PATH = "/ownership/";
+
+    /**
+     * An empty string.
+     */
     public static final String EMPTY_STRING = "";
+
     private static final ByteBuffer UPLOAD_DATA = ByteBuffer.wrap(EMPTY_STRING.getBytes(UTF_8));
 
     private final BlobContainerAsyncClient blobContainerAsyncClient;

sdk/eventhubs/azure-messaging-eventhubs-checkpointstore-blob/src/main/java/com/azure/messaging/eventhubs/checkpointstore/blob/BlobCheckpointStore.java

@@ -14,10 +14,29 @@ public enum Messages {
     private static final String PATH = "eventhubs-checkpointstore-blob-messages.properties";
     private static final Map<String, String> PROPERTIES = CoreUtils.getProperties(PATH);
 
+    /**
+     * No metadata available for blob.
+     */
     public static final String NO_METADATA_AVAILABLE_FOR_BLOB = getMessage("NO_METADATA_AVAILABLE_FOR_BLOB");
+
+    /**
+     * Claim error.
+     */
     public static final String CLAIM_ERROR = getMessage("CLAIM_ERROR");
+
+    /**
+     * Found blob for partition.
+     */
     public static final String FOUND_BLOB_FOR_PARTITION = getMessage("FOUND_BLOB_FOR_PARTITION");
+
+    /**
+     * Blob owner info.
+     */
     public static final String BLOB_OWNER_INFO = getMessage("BLOB_OWNER_INFO");
+
+    /**
+     * Checkpoint info.
+     */
     public static final String CHECKPOINT_INFO = getMessage("CHECKPOINT_INFO");
 
     /**

sdk/eventhubs/azure-messaging-eventhubs-checkpointstore-blob/src/main/java/com/azure/messaging/eventhubs/checkpointstore/blob/Messages.java

@@ -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>

sdk/formrecognizer/azure-ai-formrecognizer-perf/pom.xml

@@ -9,6 +9,9 @@
  * The versions of Azure Form Recognizer supported by this client library.
  */
 public enum DocumentAnalysisServiceVersion implements ServiceVersion {
+    /**
+     * Service version {@code 2021-09-30-preview}.
+     */
     V2021_09_30_PREVIEW("2021-09-30-preview");
 
     private final String version;

sdk/formrecognizer/azure-ai-formrecognizer/src/main/java/com/azure/ai/formrecognizer/DocumentAnalysisServiceVersion.java

@@ -15,6 +15,9 @@
  */
 public final class DocumentModelOperationException extends AzureException {
 
+    /**
+     * the error information for this exception.
+     */
     private DocumentModelOperationError documentModelOperationError;
 
     /**

sdk/formrecognizer/azure-ai-formrecognizer/src/main/java/com/azure/ai/formrecognizer/models/DocumentModelOperationException.java

@@ -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>

sdk/metricsadvisor/azure-ai-metricsadvisor-perf/pom.xml

@@ -9,6 +9,9 @@
  * The versions of Azure Metrics Advisor supported by this client library.
  */
 public enum MetricsAdvisorServiceVersion implements ServiceVersion {
+    /**
+     * Service version {@code v1.0}.
+     */
     V1_0("v1.0");
 
     private final String version;

sdk/metricsadvisor/azure-ai-metricsadvisor/src/main/java/com/azure/ai/metricsadvisor/MetricsAdvisorServiceVersion.java

@@ -37,6 +37,9 @@
     <javaModulesSurefireArgLine>
       --add-opens com.azure.monitor.opentelemetry.exporter/com.azure.monitor.opentelemetry.exporter=ALL-UNNAMED
     </javaModulesSurefireArgLine>
+    <codesnippet.skip>false</codesnippet.skip>
+    <javadocDoclet></javadocDoclet>
+    <javadocDocletOptions></javadocDocletOptions>
   </properties>
 
   <dependencies>