[TA] Enhance the java doc string. (#22813)

sdk/textanalytics/azure-ai-textanalytics/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Release History
 
-## 5.1.0 (2021-07-08)
+## 5.1.0 (2021-07-07)
 #### Feature Added
 - We are now targeting the service's v3.1 API as the default instead of v3.1-preview.4.
 - Added a new class, `HealthcareEntityCategory` to replace the `String` type of property `category` in the `HealthcareEntity`.

sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/TextAnalyticsAsyncClient.java

@@ -85,7 +85,7 @@ public final class TextAnalyticsAsyncClient {
     final AnalyzeActionsAsyncClient analyzeActionsAsyncClient;
 
     /**
-     * Create a {@link TextAnalyticsAsyncClient} that sends requests to the Text Analytics services's endpoint. Each
+     * Creates a {@link TextAnalyticsAsyncClient} that sends requests to the Text Analytics service's endpoint. Each
      * service call goes through the {@link TextAnalyticsClientBuilder#pipeline http pipeline}.
      *
      * @param service The proxy service used to perform REST calls.
@@ -110,18 +110,18 @@ public final class TextAnalyticsAsyncClient {
     }
 
     /**
-     * Get default country hint code.
+     * Gets default country hint code.
      *
-     * @return the default country hint code
+     * @return The default country hint code
      */
     public String getDefaultCountryHint() {
         return defaultCountryHint;
     }
 
     /**
-     * Get default language when the builder is setup.
+     * Gets default language when the builder is setup.
      *
-     * @return the default language
+     * @return The default language
      */
     public String getDefaultLanguage() {
         return defaultLanguage;

sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/TextAnalyticsClient.java

@@ -62,7 +62,7 @@ public final class TextAnalyticsClient {
     private final TextAnalyticsAsyncClient client;
 
     /**
-     * Create a {@code TextAnalyticsClient client} that sends requests to the Text Analytics service's endpoint.
+     * Creates a {@code TextAnalyticsClient client} that sends requests to the Text Analytics service's endpoint.
      * Each service call goes through the {@link TextAnalyticsClientBuilder#pipeline http pipeline}.
      *
      * @param client The {@link TextAnalyticsClient} that the client routes its request through.
@@ -72,7 +72,7 @@ public final class TextAnalyticsClient {
     }
 
     /**
-     * Get default country hint code.
+     * Gets default country hint code.
      *
      * @return The default country hint code
      */
@@ -81,7 +81,7 @@ public String getDefaultCountryHint() {
     }
 
     /**
-     * Get default language when the builder is setup.
+     * Gets default language when the builder is setup.
      *
      * @return The default language
      */

sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/AnalyzeActionsOperationDetail.java

@@ -79,7 +79,7 @@ public void setLastModifiedAt(AnalyzeActionsOperationDetail operationDetail,
     /**
      * Gets the operationId property of the {@link AnalyzeActionsOperationDetail}.
      *
-     * @return the operationId property of the {@link AnalyzeActionsOperationDetail}.
+     * @return The operationId property of the {@link AnalyzeActionsOperationDetail}.
      */
     public String getOperationId() {
         return operationId;
@@ -88,7 +88,7 @@ public String getOperationId() {
     /**
      * Gets the displayName property of the {@link AnalyzeActionsOperationDetail}.
      *
-     * @return the displayName property of the {@link AnalyzeActionsOperationDetail}.
+     * @return The displayName property of the {@link AnalyzeActionsOperationDetail}.
      */
     public String getDisplayName() {
         return displayName;
@@ -97,7 +97,7 @@ public String getDisplayName() {
     /**
      * Gets the failed number of actions.
      *
-     * @return the failed number of actions.
+     * @return The failed number of actions.
      */
     public int getFailedCount() {
         return failedCount;
@@ -106,7 +106,7 @@ public int getFailedCount() {
     /**
      * Gets the in-progress number of actions.
      *
-     * @return the in-progress number of actions.
+     * @return The in-progress number of actions.
      */
     public int getInProgressCount() {
         return inProgressCount;
@@ -115,7 +115,7 @@ public int getInProgressCount() {
     /**
      * Gets the successfully completed number of actions.
      *
-     * @return the successfully completed number of actions.
+     * @return The successfully completed number of actions.
      */
     public int getSucceededCount() {
         return succeededCount;
@@ -124,7 +124,7 @@ public int getSucceededCount() {
     /**
      * Gets the total number of actions.
      *
-     * @return the total number of actions.
+     * @return The total number of actions.
      */
     public int getTotalCount() {
         return totalCount;
@@ -133,7 +133,7 @@ public int getTotalCount() {
     /**
      * Gets the created time of an action.
      *
-     * @return the created time of an action.
+     * @return The created time of an action.
      */
     public OffsetDateTime getCreatedAt() {
         return createdAt;
@@ -142,7 +142,7 @@ public OffsetDateTime getCreatedAt() {
     /**
      * Gets the expiration time of an action.
      *
-     * @return the expiration time of an action.
+     * @return The expiration time of an action.
      */
     public OffsetDateTime getExpiresAt() {
         return expiresAt;
@@ -151,7 +151,7 @@ public OffsetDateTime getExpiresAt() {
     /**
      * Gets the last updated time of an action.
      *
-     * @return the last updated time of an action.
+     * @return The last updated time of an action.
      */
     public OffsetDateTime getLastModifiedAt() {
         return lastModifiedAt;

sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/AnalyzeActionsOptions.java

@@ -13,7 +13,7 @@ public final class AnalyzeActionsOptions {
     private boolean includeStatistics;
 
     /**
-     * Get the value of {@code includeStatistics}.
+     * Gets the value of {@code includeStatistics}.
      *
      * @return The value of {@code includeStatistics}.
      */
@@ -22,7 +22,7 @@ public boolean isIncludeStatistics() {
     }
 
     /**
-     * Set the value of {@code includeStatistics}. The default value is false by default.
+     * Sets the value of {@code includeStatistics}. The default value is false by default.
      * If set to true, indicates that the service should return document and document batch statistics
      * with the results of the operation.
      *

sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/AnalyzeActionsResult.java

@@ -55,48 +55,48 @@ public void setAnalyzeSentimentResults(AnalyzeActionsResult analyzeActionsResult
     }
 
     /**
-     * Get the {@code recognizeEntitiesActionResults} property: The categorized entities recognition action results
+     * Gets the {@code recognizeEntitiesResults} property: The categorized entities recognition action results
      * property.
      *
-     * @return the recognizeEntitiesActionResults value.
+     * @return The recognizeEntitiesResults value.
      */
     public IterableStream<RecognizeEntitiesActionResult> getRecognizeEntitiesResults() {
         return this.recognizeEntitiesResults;
     }
 
     /**
-     * Get the {@code recognizeLinkedEntitiesActionResults} property: The linked entities recognition action results
+     * Gets the {@code recognizeLinkedEntitiesResults} property: The linked entities recognition action results
      * property.
      *
-     * @return the recognizeLinkedEntitiesActionResults value.
+     * @return The recognizeLinkedEntitiesResults value.
      */
     public IterableStream<RecognizeLinkedEntitiesActionResult> getRecognizeLinkedEntitiesResults() {
         return this.recognizeLinkedEntitiesResults;
     }
 
     /**
-     * Get the {@code recognizePiiEntitiesActionResults} property: The PII entities recognition actions results
+     * Gets the {@code recognizePiiEntitiesResults} property: The PII entities recognition actions results
      * property.
      *
-     * @return the recognizePiiEntitiesActionResults value.
+     * @return The recognizePiiEntitiesResults value.
      */
     public IterableStream<RecognizePiiEntitiesActionResult> getRecognizePiiEntitiesResults() {
         return this.recognizePiiEntitiesResults;
     }
 
     /**
-     * Get the {@code extractKeyPhrasesActionResults} property: The key phrases extraction actions results property.
+     * Gets the {@code extractKeyPhrasesResults} property: The key phrases extraction actions results property.
      *
-     * @return the extractKeyPhrasesActionResults value.
+     * @return The extractKeyPhrasesResults value.
      */
     public IterableStream<ExtractKeyPhrasesActionResult> getExtractKeyPhrasesResults() {
         return this.extractKeyPhrasesResults;
     }
 
     /**
-     * Get the {@code analyzeSentimentActionResults} property: The sentiment analysis actions results property.
+     * Gets the {@code analyzeSentimentResults} property: The sentiment analysis actions results property.
      *
-     * @return the analyzeSentimentActionResults value.
+     * @return The analyzeSentimentResults value.
      */
     public IterableStream<AnalyzeSentimentActionResult> getAnalyzeSentimentResults() {
         return this.analyzeSentimentResults;

sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/AnalyzeHealthcareEntitiesOperationDetail.java

@@ -52,7 +52,7 @@ public void setLastModifiedAt(AnalyzeHealthcareEntitiesOperationDetail operation
     /**
      * Gets the operationId property of the {@link AnalyzeHealthcareEntitiesOperationDetail}.
      *
-     * @return the operationId property of the {@link AnalyzeHealthcareEntitiesOperationDetail}.
+     * @return The operationId property of the {@link AnalyzeHealthcareEntitiesOperationDetail}.
      */
     public String getOperationId() {
         return operationId;
@@ -61,7 +61,7 @@ public String getOperationId() {
     /**
      * Gets the created time of an action.
      *
-     * @return the created time of an action.
+     * @return The created time of an action.
      */
     public OffsetDateTime getCreatedAt() {
         return createdAt;
@@ -70,7 +70,7 @@ public OffsetDateTime getCreatedAt() {
     /**
      * Gets the expiration time of an action.
      *
-     * @return the expiration time of an action.
+     * @return The expiration time of an action.
      */
     public OffsetDateTime getExpiresAt() {
         return expiresAt;
@@ -79,7 +79,7 @@ public OffsetDateTime getExpiresAt() {
     /**
      * Gets the last updated time of an action.
      *
-     * @return the last updated time of an action.
+     * @return The last updated time of an action.
      */
     public OffsetDateTime getLastModifiedAt() {
         return lastModifiedAt;

sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/AnalyzeHealthcareEntitiesOptions.java

@@ -11,7 +11,7 @@
 @Fluent
 public final class AnalyzeHealthcareEntitiesOptions extends TextAnalyticsRequestOptions {
     /**
-     * Set the model version. This value indicates which model will be used for scoring, e.g. "latest", "2019-10-01".
+     * Sets the model version. This value indicates which model will be used for scoring, e.g. "latest", "2019-10-01".
      * If a model-version is not specified, the API will default to the latest, non-preview version.
      *
      * @param modelVersion The model version.
@@ -25,12 +25,12 @@ public AnalyzeHealthcareEntitiesOptions setModelVersion(String modelVersion) {
     }
 
     /**
-     * Set the value of {@code includeStatistics}.
+     * Sets the value of {@code includeStatistics}.
      *
      * @param includeStatistics If a boolean value was specified in the request this field will contain
      * information about the document payload.
      *
-     * @return the {@link AnalyzeHealthcareEntitiesOptions} object itself.
+     * @return The {@link AnalyzeHealthcareEntitiesOptions} object itself.
      */
     @Override
     public AnalyzeHealthcareEntitiesOptions setIncludeStatistics(boolean includeStatistics) {
@@ -39,13 +39,13 @@ public AnalyzeHealthcareEntitiesOptions setIncludeStatistics(boolean includeStat
     }
 
     /**
-     * Set the value of {@code disableServiceLogs}.
+     * Sets the value of {@code disableServiceLogs}.
      *
      * @param disableServiceLogs The default value of this property is 'true'. This means, Text Analytics service
      * does not log your input text. Setting this property to 'false', enables the service to log your text input for
      * 48 hours, solely to allow for troubleshooting issues.
      *
-     * @return the {@link AnalyzeHealthcareEntitiesOptions} object itself.
+     * @return The {@link AnalyzeHealthcareEntitiesOptions} object itself.
      */
     @Override
     public AnalyzeHealthcareEntitiesOptions setServiceLogsDisabled(boolean disableServiceLogs) {

sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/AnalyzeHealthcareEntitiesResult.java

@@ -52,7 +52,7 @@ public AnalyzeHealthcareEntitiesResult(String id, TextDocumentStatistics textDoc
     }
 
     /**
-     * Get an {@link IterableStream} of {@link HealthcareEntity}.
+     * Gets an {@link IterableStream} of {@link HealthcareEntity}.
      *
      * @return An {@link IterableStream} of {@link HealthcareEntity}.
      *
@@ -65,7 +65,7 @@ public IterableStream<HealthcareEntity> getEntities() {
     }
 
     /**
-     * Get the {@link IterableStream} of {@link TextAnalyticsWarning Text Analytics warnings}.
+     * Gets the {@link IterableStream} of {@link TextAnalyticsWarning Text Analytics warnings}.
      *
      * @return {@link IterableStream} of {@link TextAnalyticsWarning}.
      */
@@ -74,9 +74,9 @@ public IterableStream<TextAnalyticsWarning> getWarnings() {
     }
 
     /**
-     * Get the {@link IterableStream} of {@link HealthcareEntityRelation}.
+     * Gets the {@link IterableStream} of {@link HealthcareEntityRelation}.
      *
-     * @return the {@link IterableStream} of {@link HealthcareEntityRelation}.
+     * @return The {@link IterableStream} of {@link HealthcareEntityRelation}.
      */
     public IterableStream<HealthcareEntityRelation> getEntityRelations() {
         return this.entityRelations;

sdk/textanalytics/azure-ai-textanalytics/src/main/java/com/azure/ai/textanalytics/models/AnalyzeSentimentAction.java

@@ -25,7 +25,7 @@ public String getModelVersion() {
     }
 
     /**
-     * Set the model version. This value indicates which model will be used for scoring, e.g. "latest", "2019-10-01".
+     * Sets the model version. This value indicates which model will be used for scoring, e.g. "latest", "2019-10-01".
      * If a model-version is not specified, the API will default to the latest, non-preview version.
      *
      * @param modelVersion The model version.
@@ -38,7 +38,7 @@ public AnalyzeSentimentAction setModelVersion(String modelVersion) {
     }
 
     /**
-     * Get the value of {@code disableServiceLogs}.
+     * Gets the value of {@code disableServiceLogs}.
      *
      * @return The value of {@code disableServiceLogs}. The default value of this property is 'false'. This means,
      * Text Analytics service logs your input text for 48 hours, solely to allow for troubleshooting issues. Setting
@@ -49,38 +49,38 @@ public boolean isServiceLogsDisabled() {
     }
 
     /**
-     * Set the value of {@code disableServiceLogs}.
+     * Sets the value of {@code disableServiceLogs}.
      *
      * @param disableServiceLogs The default value of this property is 'false'. This means, Text Analytics service logs
      * your input text for 48 hours, solely to allow for troubleshooting issues. Setting this property to true,
      * disables input logging and may limit our ability to investigate issues that occur.
      *
-     * @return the {@link AnalyzeSentimentAction} object itself.
+     * @return The {@link AnalyzeSentimentAction} object itself.
      */
     public AnalyzeSentimentAction setServiceLogsDisabled(boolean disableServiceLogs) {
         this.disableServiceLogs = disableServiceLogs;
         return this;
     }
 
     /**
-     * Get the value of {@code includeOpinionMining}. The boolean indicator to include opinion mining data in the
+     * Gets the value of {@code includeOpinionMining}. The boolean indicator to include opinion mining data in the
      * returned result. If this flag is specified, you'll get a {@code opinions} property on SentenceSentiment.
      * It is provided by service v3.1 and later.
      *
-     * @return the value of {@code includeOpinionMining}.
+     * @return The value of {@code includeOpinionMining}.
      */
     public boolean isIncludeOpinionMining() {
         return includeOpinionMining;
     }
 
     /**
-     * Set the value of {@code includeOpinionMining}. The boolean indicator to include opinion mining data in the
+     * Sets the value of {@code includeOpinionMining}. The boolean indicator to include opinion mining data in the
      * returned result. If this flag is specified, you'll get a {@code opinions} property on SentenceSentiment.
      * It is provided by service v3.1 and later.
      *
      * @param includeOpinionMining The boolean indicator to include opinion mining data in the returned result.
      *
-     * @return the {@link AnalyzeSentimentAction} object itself.
+     * @return The {@link AnalyzeSentimentAction} object itself.
      */
     public AnalyzeSentimentAction setIncludeOpinionMining(boolean includeOpinionMining) {
         this.includeOpinionMining = includeOpinionMining;