style: Address checkstyle complaints

lpatino10 · lpatino10 · commit 12bedd3a4d76 · 2019-07-23T16:28:03.000-04:00
diff --git a/checkstyle.xml b/checkstyle.xml
@@ -35,7 +35,9 @@
     <!--module name="JavadocMethod"/-->
     <!--module name="JavadocType"/-->
     <!--module name="JavadocVariable"/-->
-    <module name="JavadocStyle"/>
+    <module name="JavadocStyle">
+        <property name="checkHtml" value="false"/>
+    </module>
 
 
     <!-- Checks for Naming Conventions.                  -->
diff --git a/compare-comply/src/main/java/com/ibm/watson/compare_comply/v1/CompareComply.java b/compare-comply/src/main/java/com/ibm/watson/compare_comply/v1/CompareComply.java
@@ -440,7 +440,9 @@ public ServiceCall<FeedbackDeleted> deleteFeedback(DeleteFeedbackOptions deleteF
    * Run Compare and Comply methods over a collection of input documents.
    *
    * **Important:** Batch processing requires the use of the [IBM Cloud Object Storage
-   * service](https://cloud.ibm.com/docs/services/cloud-object-storage?topic=cloud-object-storage-about#about-ibm-cloud-object-storage).
+   * service]
+   * (https://cloud.ibm.com/docs/services/cloud-object-storage
+   * ?topic=cloud-object-storage-about#about-ibm-cloud-object-storage).
    * The use of IBM Cloud Object Storage with Compare and Comply is discussed at [Using batch
    * processing](https://cloud.ibm.com/docs/services/compare-comply?topic=compare-comply-batching#before-you-batch).
    *
diff --git a/speech-to-text/src/main/java/com/ibm/watson/speech_to_text/v1/SpeechToText.java b/speech-to-text/src/main/java/com/ibm/watson/speech_to_text/v1/SpeechToText.java
@@ -813,7 +813,8 @@ public ServiceCall<Void> deleteJob(DeleteJobOptions deleteJobOptions) {
    * create it.
    *
    * **See also:** [Create a custom language
-   * model](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-languageCreate#createModel-language).
+   * model]
+   * (https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-languageCreate#createModel-language).
    *
    * @param createLanguageModelOptions the {@link CreateLanguageModelOptions} containing the options for the call
    * @return a {@link ServiceCall} with a response type of {@link LanguageModel}
@@ -852,7 +853,8 @@ public ServiceCall<LanguageModel> createLanguageModel(CreateLanguageModelOptions
    * list information about it.
    *
    * **See also:** [Listing custom language
-   * models](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-manageLanguageModels#listModels-language).
+   * models]
+   * (https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-manageLanguageModels#listModels-language).
    *
    * @param listLanguageModelsOptions the {@link ListLanguageModelsOptions} containing the options for the call
    * @return a {@link ServiceCall} with a response type of {@link LanguageModels}
@@ -885,7 +887,8 @@ public ServiceCall<LanguageModels> listLanguageModels(ListLanguageModelsOptions
    * list information about it.
    *
    * **See also:** [Listing custom language
-   * models](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-manageLanguageModels#listModels-language).
+   * models]
+   * (https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-manageLanguageModels#listModels-language).
    *
    * @return a {@link ServiceCall} with a response type of {@link LanguageModels}
    */
@@ -900,7 +903,8 @@ public ServiceCall<LanguageModels> listLanguageModels() {
    * that owns a model to list information about it.
    *
    * **See also:** [Listing custom language
-   * models](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-manageLanguageModels#listModels-language).
+   * models]
+   * (https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-manageLanguageModels#listModels-language).
    *
    * @param getLanguageModelOptions the {@link GetLanguageModelOptions} containing the options for the call
    * @return a {@link ServiceCall} with a response type of {@link LanguageModel}
@@ -930,7 +934,9 @@ public ServiceCall<LanguageModel> getLanguageModel(GetLanguageModelOptions getLa
    * service that owns a model to delete it.
    *
    * **See also:** [Deleting a custom language
-   * model](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-manageLanguageModels#deleteModel-language).
+   * model]
+   * (https://cloud.ibm.com/docs/services/speech-to-text
+   * ?topic=speech-to-text-manageLanguageModels#deleteModel-language).
    *
    * @param deleteLanguageModelOptions the {@link DeleteLanguageModelOptions} containing the options for the call
    * @return a {@link ServiceCall} with a response type of Void
@@ -1015,7 +1021,8 @@ public ServiceCall<TrainingResponse> trainLanguageModel(TrainLanguageModelOption
    * credentials for the instance of the service that owns a model to reset it.
    *
    * **See also:** [Resetting a custom language
-   * model](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-manageLanguageModels#resetModel-language).
+   * model]
+   * (https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-manageLanguageModels#resetModel-language).
    *
    * @param resetLanguageModelOptions the {@link ResetLanguageModelOptions} containing the options for the call
    * @return a {@link ServiceCall} with a response type of Void
@@ -1511,7 +1518,8 @@ public ServiceCall<Grammars> listGrammars(ListGrammarsOptions listGrammarsOption
    *
    * **See also:**
    * * [Understanding
-   * grammars](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-grammarUnderstand#grammarUnderstand)
+   * grammars]
+   * (https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-grammarUnderstand#grammarUnderstand)
    * * [Add a grammar to the custom language
    * model](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-grammarAdd#addGrammar).
    *
@@ -1642,7 +1650,8 @@ public ServiceCall<AcousticModel> createAcousticModel(CreateAcousticModelOptions
    * list information about it.
    *
    * **See also:** [Listing custom acoustic
-   * models](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-manageAcousticModels#listModels-acoustic).
+   * models]
+   * (https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-manageAcousticModels#listModels-acoustic).
    *
    * @param listAcousticModelsOptions the {@link ListAcousticModelsOptions} containing the options for the call
    * @return a {@link ServiceCall} with a response type of {@link AcousticModels}
@@ -1675,7 +1684,8 @@ public ServiceCall<AcousticModels> listAcousticModels(ListAcousticModelsOptions
    * list information about it.
    *
    * **See also:** [Listing custom acoustic
-   * models](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-manageAcousticModels#listModels-acoustic).
+   * models]
+   * (https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-manageAcousticModels#listModels-acoustic).
    *
    * @return a {@link ServiceCall} with a response type of {@link AcousticModels}
    */
@@ -1690,7 +1700,8 @@ public ServiceCall<AcousticModels> listAcousticModels() {
    * that owns a model to list information about it.
    *
    * **See also:** [Listing custom acoustic
-   * models](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-manageAcousticModels#listModels-acoustic).
+   * models]
+   * (https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-manageAcousticModels#listModels-acoustic).
    *
    * @param getAcousticModelOptions the {@link GetAcousticModelOptions} containing the options for the call
    * @return a {@link ServiceCall} with a response type of {@link AcousticModel}
@@ -1720,7 +1731,9 @@ public ServiceCall<AcousticModel> getAcousticModel(GetAcousticModelOptions getAc
    * that owns a model to delete it.
    *
    * **See also:** [Deleting a custom acoustic
-   * model](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-manageAcousticModels#deleteModel-acoustic).
+   * model]
+   * (https://cloud.ibm.com/docs/services/speech-to-text
+   * ?topic=speech-to-text-manageAcousticModels#deleteModel-acoustic).
    *
    * @param deleteAcousticModelOptions the {@link DeleteAcousticModelOptions} containing the options for the call
    * @return a {@link ServiceCall} with a response type of Void
@@ -1816,7 +1829,8 @@ public ServiceCall<TrainingResponse> trainAcousticModel(TrainAcousticModelOption
    * model to reset it.
    *
    * **See also:** [Resetting a custom acoustic
-   * model](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-manageAcousticModels#resetModel-acoustic).
+   * model]
+   * (https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-manageAcousticModels#resetModel-acoustic).
    *
    * @param resetAcousticModelOptions the {@link ResetAcousticModelOptions} containing the options for the call
    * @return a {@link ServiceCall} with a response type of Void
@@ -2120,7 +2134,9 @@ public ServiceCall<Void> deleteAudio(DeleteAudioOptions deleteAudioOptions) {
    * data.
    *
    * **See also:** [Information
-   * security](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-information-security#information-security).
+   * security]
+   * (https://cloud.ibm.com/docs/services/speech-to-text
+   * ?topic=speech-to-text-information-security#information-security).
    *
    * @param deleteUserDataOptions the {@link DeleteUserDataOptions} containing the options for the call
    * @return a {@link ServiceCall} with a response type of Void

Original file line number	Diff line number	Diff line change
`@@ -440,7 +440,9 @@ public ServiceCall<FeedbackDeleted> deleteFeedback(DeleteFeedbackOptions deleteF`
`440`	`440`	`* Run Compare and Comply methods over a collection of input documents.`
`441`	`441`	`*`
`442`	`442`	`* Important: Batch processing requires the use of the [IBM Cloud Object Storage`
`443`		`- * service](https://cloud.ibm.com/docs/services/cloud-object-storage?topic=cloud-object-storage-about#about-ibm-cloud-object-storage).`
	`443`	`+ * service]`
	`444`	`+ * (https://cloud.ibm.com/docs/services/cloud-object-storage`
	`445`	`+ * ?topic=cloud-object-storage-about#about-ibm-cloud-object-storage).`
`444`	`446`	`* The use of IBM Cloud Object Storage with Compare and Comply is discussed at [Using batch`
`445`	`447`	`* processing](https://cloud.ibm.com/docs/services/compare-comply?topic=compare-comply-batching#before-you-batch).`
`446`	`448`	`*`
Original file line number	Diff line number	Diff line change
`@@ -813,7 +813,8 @@ public ServiceCall<Void> deleteJob(DeleteJobOptions deleteJobOptions) {`
`813`	`813`	`* create it.`
`814`	`814`	`*`
`815`	`815`	`* See also: [Create a custom language`
`816`		`- * model](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-languageCreate#createModel-language).`
	`816`	`+ * model]`
	`817`	`+ * (https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-languageCreate#createModel-language).`
`817`	`818`	`*`
`818`	`819`	`* @param createLanguageModelOptions the {@link CreateLanguageModelOptions} containing the options for the call`
`819`	`820`	`* @return a {@link ServiceCall} with a response type of {@link LanguageModel}`
`@@ -852,7 +853,8 @@ public ServiceCall<LanguageModel> createLanguageModel(CreateLanguageModelOptions`
`852`	`853`	`* list information about it.`
`853`	`854`	`*`
`854`	`855`	`* See also: [Listing custom language`
`855`		`- * models](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-manageLanguageModels#listModels-language).`
	`856`	`+ * models]`
	`857`	`+ * (https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-manageLanguageModels#listModels-language).`
`856`	`858`	`*`
`857`	`859`	`* @param listLanguageModelsOptions the {@link ListLanguageModelsOptions} containing the options for the call`
`858`	`860`	`* @return a {@link ServiceCall} with a response type of {@link LanguageModels}`
`@@ -885,7 +887,8 @@ public ServiceCall<LanguageModels> listLanguageModels(ListLanguageModelsOptions`
`885`	`887`	`* list information about it.`
`886`	`888`	`*`
`887`	`889`	`* See also: [Listing custom language`
`888`		`- * models](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-manageLanguageModels#listModels-language).`
	`890`	`+ * models]`
	`891`	`+ * (https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-manageLanguageModels#listModels-language).`
`889`	`892`	`*`
`890`	`893`	`* @return a {@link ServiceCall} with a response type of {@link LanguageModels}`
`891`	`894`	`*/`
`@@ -900,7 +903,8 @@ public ServiceCall<LanguageModels> listLanguageModels() {`
`900`	`903`	`* that owns a model to list information about it.`
`901`	`904`	`*`
`902`	`905`	`* See also: [Listing custom language`
`903`		`- * models](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-manageLanguageModels#listModels-language).`
	`906`	`+ * models]`
	`907`	`+ * (https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-manageLanguageModels#listModels-language).`
`904`	`908`	`*`
`905`	`909`	`* @param getLanguageModelOptions the {@link GetLanguageModelOptions} containing the options for the call`
`906`	`910`	`* @return a {@link ServiceCall} with a response type of {@link LanguageModel}`
`@@ -930,7 +934,9 @@ public ServiceCall<LanguageModel> getLanguageModel(GetLanguageModelOptions getLa`
`930`	`934`	`* service that owns a model to delete it.`
`931`	`935`	`*`
`932`	`936`	`* See also: [Deleting a custom language`
`933`		`- * model](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-manageLanguageModels#deleteModel-language).`
	`937`	`+ * model]`
	`938`	`+ * (https://cloud.ibm.com/docs/services/speech-to-text`
	`939`	`+ * ?topic=speech-to-text-manageLanguageModels#deleteModel-language).`
`934`	`940`	`*`
`935`	`941`	`* @param deleteLanguageModelOptions the {@link DeleteLanguageModelOptions} containing the options for the call`
`936`	`942`	`* @return a {@link ServiceCall} with a response type of Void`
`@@ -1015,7 +1021,8 @@ public ServiceCall<TrainingResponse> trainLanguageModel(TrainLanguageModelOption`
`1015`	`1021`	`* credentials for the instance of the service that owns a model to reset it.`
`1016`	`1022`	`*`
`1017`	`1023`	`* See also: [Resetting a custom language`
`1018`		`- * model](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-manageLanguageModels#resetModel-language).`
	`1024`	`+ * model]`
	`1025`	`+ * (https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-manageLanguageModels#resetModel-language).`
`1019`	`1026`	`*`
`1020`	`1027`	`* @param resetLanguageModelOptions the {@link ResetLanguageModelOptions} containing the options for the call`
`1021`	`1028`	`* @return a {@link ServiceCall} with a response type of Void`
`@@ -1511,7 +1518,8 @@ public ServiceCall<Grammars> listGrammars(ListGrammarsOptions listGrammarsOption`
`1511`	`1518`	`*`
`1512`	`1519`	`* See also:`
`1513`	`1520`	`* * [Understanding`
`1514`		`- * grammars](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-grammarUnderstand#grammarUnderstand)`
	`1521`	`+ * grammars]`
	`1522`	`+ * (https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-grammarUnderstand#grammarUnderstand)`
`1515`	`1523`	`* * [Add a grammar to the custom language`
`1516`	`1524`	`* model](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-grammarAdd#addGrammar).`
`1517`	`1525`	`*`
`@@ -1642,7 +1650,8 @@ public ServiceCall<AcousticModel> createAcousticModel(CreateAcousticModelOptions`
`1642`	`1650`	`* list information about it.`
`1643`	`1651`	`*`
`1644`	`1652`	`* See also: [Listing custom acoustic`
`1645`		`- * models](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-manageAcousticModels#listModels-acoustic).`
	`1653`	`+ * models]`
	`1654`	`+ * (https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-manageAcousticModels#listModels-acoustic).`
`1646`	`1655`	`*`
`1647`	`1656`	`* @param listAcousticModelsOptions the {@link ListAcousticModelsOptions} containing the options for the call`
`1648`	`1657`	`* @return a {@link ServiceCall} with a response type of {@link AcousticModels}`
`@@ -1675,7 +1684,8 @@ public ServiceCall<AcousticModels> listAcousticModels(ListAcousticModelsOptions`
`1675`	`1684`	`* list information about it.`
`1676`	`1685`	`*`
`1677`	`1686`	`* See also: [Listing custom acoustic`
`1678`		`- * models](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-manageAcousticModels#listModels-acoustic).`
	`1687`	`+ * models]`
	`1688`	`+ * (https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-manageAcousticModels#listModels-acoustic).`
`1679`	`1689`	`*`
`1680`	`1690`	`* @return a {@link ServiceCall} with a response type of {@link AcousticModels}`
`1681`	`1691`	`*/`
`@@ -1690,7 +1700,8 @@ public ServiceCall<AcousticModels> listAcousticModels() {`
`1690`	`1700`	`* that owns a model to list information about it.`
`1691`	`1701`	`*`
`1692`	`1702`	`* See also: [Listing custom acoustic`
`1693`		`- * models](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-manageAcousticModels#listModels-acoustic).`
	`1703`	`+ * models]`
	`1704`	`+ * (https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-manageAcousticModels#listModels-acoustic).`
`1694`	`1705`	`*`
`1695`	`1706`	`* @param getAcousticModelOptions the {@link GetAcousticModelOptions} containing the options for the call`
`1696`	`1707`	`* @return a {@link ServiceCall} with a response type of {@link AcousticModel}`
`@@ -1720,7 +1731,9 @@ public ServiceCall<AcousticModel> getAcousticModel(GetAcousticModelOptions getAc`
`1720`	`1731`	`* that owns a model to delete it.`
`1721`	`1732`	`*`
`1722`	`1733`	`* See also: [Deleting a custom acoustic`
`1723`		`- * model](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-manageAcousticModels#deleteModel-acoustic).`
	`1734`	`+ * model]`
	`1735`	`+ * (https://cloud.ibm.com/docs/services/speech-to-text`
	`1736`	`+ * ?topic=speech-to-text-manageAcousticModels#deleteModel-acoustic).`
`1724`	`1737`	`*`
`1725`	`1738`	`* @param deleteAcousticModelOptions the {@link DeleteAcousticModelOptions} containing the options for the call`
`1726`	`1739`	`* @return a {@link ServiceCall} with a response type of Void`
`@@ -1816,7 +1829,8 @@ public ServiceCall<TrainingResponse> trainAcousticModel(TrainAcousticModelOption`
`1816`	`1829`	`* model to reset it.`
`1817`	`1830`	`*`
`1818`	`1831`	`* See also: [Resetting a custom acoustic`
`1819`		`- * model](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-manageAcousticModels#resetModel-acoustic).`
	`1832`	`+ * model]`
	`1833`	`+ * (https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-manageAcousticModels#resetModel-acoustic).`
`1820`	`1834`	`*`
`1821`	`1835`	`* @param resetAcousticModelOptions the {@link ResetAcousticModelOptions} containing the options for the call`
`1822`	`1836`	`* @return a {@link ServiceCall} with a response type of Void`
`@@ -2120,7 +2134,9 @@ public ServiceCall<Void> deleteAudio(DeleteAudioOptions deleteAudioOptions) {`
`2120`	`2134`	`* data.`
`2121`	`2135`	`*`
`2122`	`2136`	`* See also: [Information`
`2123`		`- * security](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-information-security#information-security).`
	`2137`	`+ * security]`
	`2138`	`+ * (https://cloud.ibm.com/docs/services/speech-to-text`
	`2139`	`+ * ?topic=speech-to-text-information-security#information-security).`
`2124`	`2140`	`*`
`2125`	`2141`	`* @param deleteUserDataOptions the {@link DeleteUserDataOptions} containing the options for the call`
`2126`	`2142`	`* @return a {@link ServiceCall} with a response type of Void`