Skip to content
This repository has been archived by the owner on Sep 16, 2023. It is now read-only.

docs: fix docstring formatting #597

Merged
merged 2 commits into from Nov 15, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Expand Up @@ -153,10 +153,10 @@ public TextToSpeechStub getStub() {
* @param languageCode Optional. Recommended.
* [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. If specified, the
* ListVoices call will only return voices that can be used to synthesize this language_code.
* E.g. when specifying "en-NZ", you will get supported "en-\\*" voices; when specifying
* "no", you will get supported "no-\\*" (Norwegian) and "nb-\\*" (Norwegian Bokmal)
* voices; specifying "zh" will also get supported "cmn-\\*" voices; specifying "zh-hk"
* will also get supported "yue-\\*" voices.
* E.g. when specifying `"en-NZ"`, you will get supported `"en-\\*"` voices; when
* specifying `"no"`, you will get supported `"no-\\*"` (Norwegian) and `"nb-\\*"`
* (Norwegian Bokmal) voices; specifying `"zh"` will also get supported `"cmn-\\*"`
* voices; specifying `"zh-hk"` will also get supported `"yue-\\*"` voices.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListVoicesResponse listVoices(String languageCode) {
Expand Down
Expand Up @@ -15,7 +15,9 @@
*/

/**
* The interfaces provided are listed below, along with usage samples.
* A client to Cloud Text-to-Speech API
*
* <p>The interfaces provided are listed below, along with usage samples.
*
* <p>======================= TextToSpeechClient =======================
*
Expand Down
Expand Up @@ -154,11 +154,11 @@ public TextToSpeechStub getStub() {
* @param languageCode Optional. Recommended.
* [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. If not specified, the
* API will return all supported voices. If specified, the ListVoices call will only return
* voices that can be used to synthesize this language_code. E.g. when specifying "en-NZ", you
* will get supported "en-NZ" voices; when specifying "no", you will get supported
* "no-\\&#42;" (Norwegian) and "nb-\\&#42;" (Norwegian Bokmal) voices; specifying "zh" will
* also get supported "cmn-\\&#42;" voices; specifying "zh-hk" will also get supported
* "yue-hk" voices.
* voices that can be used to synthesize this language_code. E.g. when specifying `"en-NZ"`,
* you will get supported `"en-NZ"` voices; when specifying `"no"`, you will get supported
* `"no-\\&#42;"` (Norwegian) and `"nb-\\&#42;"` (Norwegian Bokmal) voices; specifying `"zh"`
* will also get supported `"cmn-\\&#42;"` voices; specifying `"zh-hk"` will also get
* supported `"yue-hk"` voices.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListVoicesResponse listVoices(String languageCode) {
Expand Down
Expand Up @@ -15,7 +15,9 @@
*/

/**
* The interfaces provided are listed below, along with usage samples.
* A client to Cloud Text-to-Speech API
*
* <p>The interfaces provided are listed below, along with usage samples.
*
* <p>======================= TextToSpeechClient =======================
*
Expand Down
Expand Up @@ -120,11 +120,11 @@ public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() {
* Optional. Recommended.
* [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. If
* specified, the ListVoices call will only return voices that can be used to
* synthesize this language_code. E.g. when specifying "en-NZ", you will get
* supported "en-&#92;*" voices; when specifying "no", you will get supported
* "no-&#92;*" (Norwegian) and "nb-&#92;*" (Norwegian Bokmal) voices; specifying "zh"
* will also get supported "cmn-&#92;*" voices; specifying "zh-hk" will also get
* supported "yue-&#92;*" voices.
* synthesize this language_code. E.g. when specifying `"en-NZ"`, you will get
* supported `"en-&#92;*"` voices; when specifying `"no"`, you will get supported
* `"no-&#92;*"` (Norwegian) and `"nb-&#92;*"` (Norwegian Bokmal) voices; specifying
* `"zh"` will also get supported `"cmn-&#92;*"` voices; specifying `"zh-hk"` will
* also get supported `"yue-&#92;*"` voices.
* </pre>
*
* <code>string language_code = 1 [(.google.api.field_behavior) = OPTIONAL];</code>
Expand All @@ -150,11 +150,11 @@ public java.lang.String getLanguageCode() {
* Optional. Recommended.
* [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. If
* specified, the ListVoices call will only return voices that can be used to
* synthesize this language_code. E.g. when specifying "en-NZ", you will get
* supported "en-&#92;*" voices; when specifying "no", you will get supported
* "no-&#92;*" (Norwegian) and "nb-&#92;*" (Norwegian Bokmal) voices; specifying "zh"
* will also get supported "cmn-&#92;*" voices; specifying "zh-hk" will also get
* supported "yue-&#92;*" voices.
* synthesize this language_code. E.g. when specifying `"en-NZ"`, you will get
* supported `"en-&#92;*"` voices; when specifying `"no"`, you will get supported
* `"no-&#92;*"` (Norwegian) and `"nb-&#92;*"` (Norwegian Bokmal) voices; specifying
* `"zh"` will also get supported `"cmn-&#92;*"` voices; specifying `"zh-hk"` will
* also get supported `"yue-&#92;*"` voices.
* </pre>
*
* <code>string language_code = 1 [(.google.api.field_behavior) = OPTIONAL];</code>
Expand Down Expand Up @@ -500,11 +500,11 @@ public Builder mergeFrom(
* Optional. Recommended.
* [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. If
* specified, the ListVoices call will only return voices that can be used to
* synthesize this language_code. E.g. when specifying "en-NZ", you will get
* supported "en-&#92;*" voices; when specifying "no", you will get supported
* "no-&#92;*" (Norwegian) and "nb-&#92;*" (Norwegian Bokmal) voices; specifying "zh"
* will also get supported "cmn-&#92;*" voices; specifying "zh-hk" will also get
* supported "yue-&#92;*" voices.
* synthesize this language_code. E.g. when specifying `"en-NZ"`, you will get
* supported `"en-&#92;*"` voices; when specifying `"no"`, you will get supported
* `"no-&#92;*"` (Norwegian) and `"nb-&#92;*"` (Norwegian Bokmal) voices; specifying
* `"zh"` will also get supported `"cmn-&#92;*"` voices; specifying `"zh-hk"` will
* also get supported `"yue-&#92;*"` voices.
* </pre>
*
* <code>string language_code = 1 [(.google.api.field_behavior) = OPTIONAL];</code>
Expand All @@ -529,11 +529,11 @@ public java.lang.String getLanguageCode() {
* Optional. Recommended.
* [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. If
* specified, the ListVoices call will only return voices that can be used to
* synthesize this language_code. E.g. when specifying "en-NZ", you will get
* supported "en-&#92;*" voices; when specifying "no", you will get supported
* "no-&#92;*" (Norwegian) and "nb-&#92;*" (Norwegian Bokmal) voices; specifying "zh"
* will also get supported "cmn-&#92;*" voices; specifying "zh-hk" will also get
* supported "yue-&#92;*" voices.
* synthesize this language_code. E.g. when specifying `"en-NZ"`, you will get
* supported `"en-&#92;*"` voices; when specifying `"no"`, you will get supported
* `"no-&#92;*"` (Norwegian) and `"nb-&#92;*"` (Norwegian Bokmal) voices; specifying
* `"zh"` will also get supported `"cmn-&#92;*"` voices; specifying `"zh-hk"` will
* also get supported `"yue-&#92;*"` voices.
* </pre>
*
* <code>string language_code = 1 [(.google.api.field_behavior) = OPTIONAL];</code>
Expand All @@ -558,11 +558,11 @@ public com.google.protobuf.ByteString getLanguageCodeBytes() {
* Optional. Recommended.
* [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. If
* specified, the ListVoices call will only return voices that can be used to
* synthesize this language_code. E.g. when specifying "en-NZ", you will get
* supported "en-&#92;*" voices; when specifying "no", you will get supported
* "no-&#92;*" (Norwegian) and "nb-&#92;*" (Norwegian Bokmal) voices; specifying "zh"
* will also get supported "cmn-&#92;*" voices; specifying "zh-hk" will also get
* supported "yue-&#92;*" voices.
* synthesize this language_code. E.g. when specifying `"en-NZ"`, you will get
* supported `"en-&#92;*"` voices; when specifying `"no"`, you will get supported
* `"no-&#92;*"` (Norwegian) and `"nb-&#92;*"` (Norwegian Bokmal) voices; specifying
* `"zh"` will also get supported `"cmn-&#92;*"` voices; specifying `"zh-hk"` will
* also get supported `"yue-&#92;*"` voices.
* </pre>
*
* <code>string language_code = 1 [(.google.api.field_behavior) = OPTIONAL];</code>
Expand All @@ -586,11 +586,11 @@ public Builder setLanguageCode(java.lang.String value) {
* Optional. Recommended.
* [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. If
* specified, the ListVoices call will only return voices that can be used to
* synthesize this language_code. E.g. when specifying "en-NZ", you will get
* supported "en-&#92;*" voices; when specifying "no", you will get supported
* "no-&#92;*" (Norwegian) and "nb-&#92;*" (Norwegian Bokmal) voices; specifying "zh"
* will also get supported "cmn-&#92;*" voices; specifying "zh-hk" will also get
* supported "yue-&#92;*" voices.
* synthesize this language_code. E.g. when specifying `"en-NZ"`, you will get
* supported `"en-&#92;*"` voices; when specifying `"no"`, you will get supported
* `"no-&#92;*"` (Norwegian) and `"nb-&#92;*"` (Norwegian Bokmal) voices; specifying
* `"zh"` will also get supported `"cmn-&#92;*"` voices; specifying `"zh-hk"` will
* also get supported `"yue-&#92;*"` voices.
* </pre>
*
* <code>string language_code = 1 [(.google.api.field_behavior) = OPTIONAL];</code>
Expand All @@ -610,11 +610,11 @@ public Builder clearLanguageCode() {
* Optional. Recommended.
* [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. If
* specified, the ListVoices call will only return voices that can be used to
* synthesize this language_code. E.g. when specifying "en-NZ", you will get
* supported "en-&#92;*" voices; when specifying "no", you will get supported
* "no-&#92;*" (Norwegian) and "nb-&#92;*" (Norwegian Bokmal) voices; specifying "zh"
* will also get supported "cmn-&#92;*" voices; specifying "zh-hk" will also get
* supported "yue-&#92;*" voices.
* synthesize this language_code. E.g. when specifying `"en-NZ"`, you will get
* supported `"en-&#92;*"` voices; when specifying `"no"`, you will get supported
* `"no-&#92;*"` (Norwegian) and `"nb-&#92;*"` (Norwegian Bokmal) voices; specifying
* `"zh"` will also get supported `"cmn-&#92;*"` voices; specifying `"zh-hk"` will
* also get supported `"yue-&#92;*"` voices.
* </pre>
*
* <code>string language_code = 1 [(.google.api.field_behavior) = OPTIONAL];</code>
Expand Down
Expand Up @@ -30,11 +30,11 @@ public interface ListVoicesRequestOrBuilder
* Optional. Recommended.
* [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. If
* specified, the ListVoices call will only return voices that can be used to
* synthesize this language_code. E.g. when specifying "en-NZ", you will get
* supported "en-&#92;*" voices; when specifying "no", you will get supported
* "no-&#92;*" (Norwegian) and "nb-&#92;*" (Norwegian Bokmal) voices; specifying "zh"
* will also get supported "cmn-&#92;*" voices; specifying "zh-hk" will also get
* supported "yue-&#92;*" voices.
* synthesize this language_code. E.g. when specifying `"en-NZ"`, you will get
* supported `"en-&#92;*"` voices; when specifying `"no"`, you will get supported
* `"no-&#92;*"` (Norwegian) and `"nb-&#92;*"` (Norwegian Bokmal) voices; specifying
* `"zh"` will also get supported `"cmn-&#92;*"` voices; specifying `"zh-hk"` will
* also get supported `"yue-&#92;*"` voices.
* </pre>
*
* <code>string language_code = 1 [(.google.api.field_behavior) = OPTIONAL];</code>
Expand All @@ -49,11 +49,11 @@ public interface ListVoicesRequestOrBuilder
* Optional. Recommended.
* [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. If
* specified, the ListVoices call will only return voices that can be used to
* synthesize this language_code. E.g. when specifying "en-NZ", you will get
* supported "en-&#92;*" voices; when specifying "no", you will get supported
* "no-&#92;*" (Norwegian) and "nb-&#92;*" (Norwegian Bokmal) voices; specifying "zh"
* will also get supported "cmn-&#92;*" voices; specifying "zh-hk" will also get
* supported "yue-&#92;*" voices.
* synthesize this language_code. E.g. when specifying `"en-NZ"`, you will get
* supported `"en-&#92;*"` voices; when specifying `"no"`, you will get supported
* `"no-&#92;*"` (Norwegian) and `"nb-&#92;*"` (Norwegian Bokmal) voices; specifying
* `"zh"` will also get supported `"cmn-&#92;*"` voices; specifying `"zh-hk"` will
* also get supported `"yue-&#92;*"` voices.
* </pre>
*
* <code>string language_code = 1 [(.google.api.field_behavior) = OPTIONAL];</code>
Expand Down
Expand Up @@ -59,11 +59,11 @@ message ListVoicesRequest {
// Optional. Recommended.
// [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. If
// specified, the ListVoices call will only return voices that can be used to
// synthesize this language_code. E.g. when specifying "en-NZ", you will get
// supported "en-\*" voices; when specifying "no", you will get supported
// "no-\*" (Norwegian) and "nb-\*" (Norwegian Bokmal) voices; specifying "zh"
// will also get supported "cmn-\*" voices; specifying "zh-hk" will also get
// supported "yue-\*" voices.
// synthesize this language_code. E.g. when specifying `"en-NZ"`, you will get
// supported `"en-\*"` voices; when specifying `"no"`, you will get supported
// `"no-\*"` (Norwegian) and `"nb-\*"` (Norwegian Bokmal) voices; specifying
// `"zh"` will also get supported `"cmn-\*"` voices; specifying `"zh-hk"` will
// also get supported `"yue-\*"` voices.
string language_code = 1 [(google.api.field_behavior) = OPTIONAL];
}

Expand Down