docs: fix docstring formatting (#234)

- [ ] Regenerate this pull request now. Committer: @parthea PiperOrigin-RevId: 405938813 Source-Link: googleapis/googleapis@3792423 Source-Link: https://github.com/googleapis/googleapis-gen/commit/0e3178849f8ebefce89b080743dcbef812af5063 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiMGUzMTc4ODQ5ZjhlYmVmY2U4OWIwODA3NDNkY2JlZjgxMmFmNTA2MyJ9
googleapis · Nov 3, 2021 · 510d7b6 · 510d7b6
1 parent c1f98d1
commit 510d7b6
Show file tree

Hide file tree

Showing 19 changed files with 177 additions and 159 deletions.
diff --git a/...cloud-retail-v2/src/main/java/com/google/cloud/retail/v2/AddFulfillmentPlacesRequest.java b/...cloud-retail-v2/src/main/java/com/google/cloud/retail/v2/AddFulfillmentPlacesRequest.java
@@ -308,7 +308,7 @@ public com.google.protobuf.ByteString getTypeBytes() {
    * IDs will be automatically ignored.
    * At least 1 value is required, and a maximum of 2000 values are allowed.
    * Each value must be a string with a length limit of 10 characters, matching
-   * the pattern [a-zA-Z0-9_-]+, such as "store1" or "REGION-2". Otherwise, an
+   * the pattern `[a-zA-Z0-9_-]+`, such as "store1" or "REGION-2". Otherwise, an
    * INVALID_ARGUMENT error is returned.
    * If the total number of place IDs exceeds 2000 for this
    * [type][google.cloud.retail.v2.AddFulfillmentPlacesRequest.type] after
@@ -334,7 +334,7 @@ public com.google.protobuf.ProtocolStringList getPlaceIdsList() {
    * IDs will be automatically ignored.
    * At least 1 value is required, and a maximum of 2000 values are allowed.
    * Each value must be a string with a length limit of 10 characters, matching
-   * the pattern [a-zA-Z0-9_-]+, such as "store1" or "REGION-2". Otherwise, an
+   * the pattern `[a-zA-Z0-9_-]+`, such as "store1" or "REGION-2". Otherwise, an
    * INVALID_ARGUMENT error is returned.
    * If the total number of place IDs exceeds 2000 for this
    * [type][google.cloud.retail.v2.AddFulfillmentPlacesRequest.type] after
@@ -360,7 +360,7 @@ public int getPlaceIdsCount() {
    * IDs will be automatically ignored.
    * At least 1 value is required, and a maximum of 2000 values are allowed.
    * Each value must be a string with a length limit of 10 characters, matching
-   * the pattern [a-zA-Z0-9_-]+, such as "store1" or "REGION-2". Otherwise, an
+   * the pattern `[a-zA-Z0-9_-]+`, such as "store1" or "REGION-2". Otherwise, an
    * INVALID_ARGUMENT error is returned.
    * If the total number of place IDs exceeds 2000 for this
    * [type][google.cloud.retail.v2.AddFulfillmentPlacesRequest.type] after
@@ -387,7 +387,7 @@ public java.lang.String getPlaceIds(int index) {
    * IDs will be automatically ignored.
    * At least 1 value is required, and a maximum of 2000 values are allowed.
    * Each value must be a string with a length limit of 10 characters, matching
-   * the pattern [a-zA-Z0-9_-]+, such as "store1" or "REGION-2". Otherwise, an
+   * the pattern `[a-zA-Z0-9_-]+`, such as "store1" or "REGION-2". Otherwise, an
    * INVALID_ARGUMENT error is returned.
    * If the total number of place IDs exceeds 2000 for this
    * [type][google.cloud.retail.v2.AddFulfillmentPlacesRequest.type] after
@@ -1230,7 +1230,7 @@ private void ensurePlaceIdsIsMutable() {
      * IDs will be automatically ignored.
      * At least 1 value is required, and a maximum of 2000 values are allowed.
      * Each value must be a string with a length limit of 10 characters, matching
-     * the pattern [a-zA-Z0-9_-]+, such as "store1" or "REGION-2". Otherwise, an
+     * the pattern `[a-zA-Z0-9_-]+`, such as "store1" or "REGION-2". Otherwise, an
      * INVALID_ARGUMENT error is returned.
      * If the total number of place IDs exceeds 2000 for this
      * [type][google.cloud.retail.v2.AddFulfillmentPlacesRequest.type] after
@@ -1256,7 +1256,7 @@ public com.google.protobuf.ProtocolStringList getPlaceIdsList() {
      * IDs will be automatically ignored.
      * At least 1 value is required, and a maximum of 2000 values are allowed.
      * Each value must be a string with a length limit of 10 characters, matching
-     * the pattern [a-zA-Z0-9_-]+, such as "store1" or "REGION-2". Otherwise, an
+     * the pattern `[a-zA-Z0-9_-]+`, such as "store1" or "REGION-2". Otherwise, an
      * INVALID_ARGUMENT error is returned.
      * If the total number of place IDs exceeds 2000 for this
      * [type][google.cloud.retail.v2.AddFulfillmentPlacesRequest.type] after
@@ -1282,7 +1282,7 @@ public int getPlaceIdsCount() {
      * IDs will be automatically ignored.
      * At least 1 value is required, and a maximum of 2000 values are allowed.
      * Each value must be a string with a length limit of 10 characters, matching
-     * the pattern [a-zA-Z0-9_-]+, such as "store1" or "REGION-2". Otherwise, an
+     * the pattern `[a-zA-Z0-9_-]+`, such as "store1" or "REGION-2". Otherwise, an
      * INVALID_ARGUMENT error is returned.
      * If the total number of place IDs exceeds 2000 for this
      * [type][google.cloud.retail.v2.AddFulfillmentPlacesRequest.type] after
@@ -1309,7 +1309,7 @@ public java.lang.String getPlaceIds(int index) {
      * IDs will be automatically ignored.
      * At least 1 value is required, and a maximum of 2000 values are allowed.
      * Each value must be a string with a length limit of 10 characters, matching
-     * the pattern [a-zA-Z0-9_-]+, such as "store1" or "REGION-2". Otherwise, an
+     * the pattern `[a-zA-Z0-9_-]+`, such as "store1" or "REGION-2". Otherwise, an
      * INVALID_ARGUMENT error is returned.
      * If the total number of place IDs exceeds 2000 for this
      * [type][google.cloud.retail.v2.AddFulfillmentPlacesRequest.type] after
@@ -1336,7 +1336,7 @@ public com.google.protobuf.ByteString getPlaceIdsBytes(int index) {
      * IDs will be automatically ignored.
      * At least 1 value is required, and a maximum of 2000 values are allowed.
      * Each value must be a string with a length limit of 10 characters, matching
-     * the pattern [a-zA-Z0-9_-]+, such as "store1" or "REGION-2". Otherwise, an
+     * the pattern `[a-zA-Z0-9_-]+`, such as "store1" or "REGION-2". Otherwise, an
      * INVALID_ARGUMENT error is returned.
      * If the total number of place IDs exceeds 2000 for this
      * [type][google.cloud.retail.v2.AddFulfillmentPlacesRequest.type] after
@@ -1370,7 +1370,7 @@ public Builder setPlaceIds(int index, java.lang.String value) {
      * IDs will be automatically ignored.
      * At least 1 value is required, and a maximum of 2000 values are allowed.
      * Each value must be a string with a length limit of 10 characters, matching
-     * the pattern [a-zA-Z0-9_-]+, such as "store1" or "REGION-2". Otherwise, an
+     * the pattern `[a-zA-Z0-9_-]+`, such as "store1" or "REGION-2". Otherwise, an
      * INVALID_ARGUMENT error is returned.
      * If the total number of place IDs exceeds 2000 for this
      * [type][google.cloud.retail.v2.AddFulfillmentPlacesRequest.type] after
@@ -1403,7 +1403,7 @@ public Builder addPlaceIds(java.lang.String value) {
      * IDs will be automatically ignored.
      * At least 1 value is required, and a maximum of 2000 values are allowed.
      * Each value must be a string with a length limit of 10 characters, matching
-     * the pattern [a-zA-Z0-9_-]+, such as "store1" or "REGION-2". Otherwise, an
+     * the pattern `[a-zA-Z0-9_-]+`, such as "store1" or "REGION-2". Otherwise, an
      * INVALID_ARGUMENT error is returned.
      * If the total number of place IDs exceeds 2000 for this
      * [type][google.cloud.retail.v2.AddFulfillmentPlacesRequest.type] after
@@ -1433,7 +1433,7 @@ public Builder addAllPlaceIds(java.lang.Iterable<java.lang.String> values) {
      * IDs will be automatically ignored.
      * At least 1 value is required, and a maximum of 2000 values are allowed.
      * Each value must be a string with a length limit of 10 characters, matching
-     * the pattern [a-zA-Z0-9_-]+, such as "store1" or "REGION-2". Otherwise, an
+     * the pattern `[a-zA-Z0-9_-]+`, such as "store1" or "REGION-2". Otherwise, an
      * INVALID_ARGUMENT error is returned.
      * If the total number of place IDs exceeds 2000 for this
      * [type][google.cloud.retail.v2.AddFulfillmentPlacesRequest.type] after
@@ -1462,7 +1462,7 @@ public Builder clearPlaceIds() {
      * IDs will be automatically ignored.
      * At least 1 value is required, and a maximum of 2000 values are allowed.
      * Each value must be a string with a length limit of 10 characters, matching
-     * the pattern [a-zA-Z0-9_-]+, such as "store1" or "REGION-2". Otherwise, an
+     * the pattern `[a-zA-Z0-9_-]+`, such as "store1" or "REGION-2". Otherwise, an
      * INVALID_ARGUMENT error is returned.
      * If the total number of place IDs exceeds 2000 for this
      * [type][google.cloud.retail.v2.AddFulfillmentPlacesRequest.type] after

diff --git a/...ail-v2/src/main/java/com/google/cloud/retail/v2/AddFulfillmentPlacesRequestOrBuilder.java b/...ail-v2/src/main/java/com/google/cloud/retail/v2/AddFulfillmentPlacesRequestOrBuilder.java
@@ -127,7 +127,7 @@ public interface AddFulfillmentPlacesRequestOrBuilder
    * IDs will be automatically ignored.
    * At least 1 value is required, and a maximum of 2000 values are allowed.
    * Each value must be a string with a length limit of 10 characters, matching
-   * the pattern [a-zA-Z0-9_-]+, such as "store1" or "REGION-2". Otherwise, an
+   * the pattern `[a-zA-Z0-9_-]+`, such as "store1" or "REGION-2". Otherwise, an
    * INVALID_ARGUMENT error is returned.
    * If the total number of place IDs exceeds 2000 for this
    * [type][google.cloud.retail.v2.AddFulfillmentPlacesRequest.type] after
@@ -151,7 +151,7 @@ public interface AddFulfillmentPlacesRequestOrBuilder
    * IDs will be automatically ignored.
    * At least 1 value is required, and a maximum of 2000 values are allowed.
    * Each value must be a string with a length limit of 10 characters, matching
-   * the pattern [a-zA-Z0-9_-]+, such as "store1" or "REGION-2". Otherwise, an
+   * the pattern `[a-zA-Z0-9_-]+`, such as "store1" or "REGION-2". Otherwise, an
    * INVALID_ARGUMENT error is returned.
    * If the total number of place IDs exceeds 2000 for this
    * [type][google.cloud.retail.v2.AddFulfillmentPlacesRequest.type] after
@@ -175,7 +175,7 @@ public interface AddFulfillmentPlacesRequestOrBuilder
    * IDs will be automatically ignored.
    * At least 1 value is required, and a maximum of 2000 values are allowed.
    * Each value must be a string with a length limit of 10 characters, matching
-   * the pattern [a-zA-Z0-9_-]+, such as "store1" or "REGION-2". Otherwise, an
+   * the pattern `[a-zA-Z0-9_-]+`, such as "store1" or "REGION-2". Otherwise, an
    * INVALID_ARGUMENT error is returned.
    * If the total number of place IDs exceeds 2000 for this
    * [type][google.cloud.retail.v2.AddFulfillmentPlacesRequest.type] after
@@ -200,7 +200,7 @@ public interface AddFulfillmentPlacesRequestOrBuilder
    * IDs will be automatically ignored.
    * At least 1 value is required, and a maximum of 2000 values are allowed.
    * Each value must be a string with a length limit of 10 characters, matching
-   * the pattern [a-zA-Z0-9_-]+, such as "store1" or "REGION-2". Otherwise, an
+   * the pattern `[a-zA-Z0-9_-]+`, such as "store1" or "REGION-2". Otherwise, an
    * INVALID_ARGUMENT error is returned.
    * If the total number of place IDs exceeds 2000 for this
    * [type][google.cloud.retail.v2.AddFulfillmentPlacesRequest.type] after

diff --git a/...google-cloud-retail-v2/src/main/java/com/google/cloud/retail/v2/CompleteQueryRequest.java b/...google-cloud-retail-v2/src/main/java/com/google/cloud/retail/v2/CompleteQueryRequest.java
@@ -419,13 +419,13 @@ public com.google.protobuf.ByteString getLanguageCodesBytes(int index) {
    * <pre>
    * The device type context for completion suggestions.
    * It is useful to apply different suggestions on different device types, e.g.
-   * DESKTOP, MOBILE. If it is empty, the suggestions are across all device
+   * `DESKTOP`, `MOBILE`. If it is empty, the suggestions are across all device
    * types.
    * Supported formats:
-   * * UNKNOWN_DEVICE_TYPE
-   * * DESKTOP
-   * * MOBILE
-   * * A customized string starts with OTHER_, e.g. OTHER_IPHONE.
+   * * `UNKNOWN_DEVICE_TYPE`
+   * * `DESKTOP`
+   * * `MOBILE`
+   * * A customized string starts with `OTHER_`, e.g. `OTHER_IPHONE`.
    * </pre>
    *
    * <code>string device_type = 4;</code>
@@ -450,13 +450,13 @@ public java.lang.String getDeviceType() {
    * <pre>
    * The device type context for completion suggestions.
    * It is useful to apply different suggestions on different device types, e.g.
-   * DESKTOP, MOBILE. If it is empty, the suggestions are across all device
+   * `DESKTOP`, `MOBILE`. If it is empty, the suggestions are across all device
    * types.
    * Supported formats:
-   * * UNKNOWN_DEVICE_TYPE
-   * * DESKTOP
-   * * MOBILE
-   * * A customized string starts with OTHER_, e.g. OTHER_IPHONE.
+   * * `UNKNOWN_DEVICE_TYPE`
+   * * `DESKTOP`
+   * * `MOBILE`
+   * * A customized string starts with `OTHER_`, e.g. `OTHER_IPHONE`.
    * </pre>
    *
    * <code>string device_type = 4;</code>
@@ -1584,13 +1584,13 @@ public Builder addLanguageCodesBytes(com.google.protobuf.ByteString value) {
      * <pre>
      * The device type context for completion suggestions.
      * It is useful to apply different suggestions on different device types, e.g.
-     * DESKTOP, MOBILE. If it is empty, the suggestions are across all device
+     * `DESKTOP`, `MOBILE`. If it is empty, the suggestions are across all device
      * types.
      * Supported formats:
-     * * UNKNOWN_DEVICE_TYPE
-     * * DESKTOP
-     * * MOBILE
-     * * A customized string starts with OTHER_, e.g. OTHER_IPHONE.
+     * * `UNKNOWN_DEVICE_TYPE`
+     * * `DESKTOP`
+     * * `MOBILE`
+     * * A customized string starts with `OTHER_`, e.g. `OTHER_IPHONE`.
      * </pre>
      *
      * <code>string device_type = 4;</code>
@@ -1614,13 +1614,13 @@ public java.lang.String getDeviceType() {
      * <pre>
      * The device type context for completion suggestions.
      * It is useful to apply different suggestions on different device types, e.g.
-     * DESKTOP, MOBILE. If it is empty, the suggestions are across all device
+     * `DESKTOP`, `MOBILE`. If it is empty, the suggestions are across all device
      * types.
      * Supported formats:
-     * * UNKNOWN_DEVICE_TYPE
-     * * DESKTOP
-     * * MOBILE
-     * * A customized string starts with OTHER_, e.g. OTHER_IPHONE.
+     * * `UNKNOWN_DEVICE_TYPE`
+     * * `DESKTOP`
+     * * `MOBILE`
+     * * A customized string starts with `OTHER_`, e.g. `OTHER_IPHONE`.
      * </pre>
      *
      * <code>string device_type = 4;</code>
@@ -1644,13 +1644,13 @@ public com.google.protobuf.ByteString getDeviceTypeBytes() {
      * <pre>
      * The device type context for completion suggestions.
      * It is useful to apply different suggestions on different device types, e.g.
-     * DESKTOP, MOBILE. If it is empty, the suggestions are across all device
+     * `DESKTOP`, `MOBILE`. If it is empty, the suggestions are across all device
      * types.
      * Supported formats:
-     * * UNKNOWN_DEVICE_TYPE
-     * * DESKTOP
-     * * MOBILE
-     * * A customized string starts with OTHER_, e.g. OTHER_IPHONE.
+     * * `UNKNOWN_DEVICE_TYPE`
+     * * `DESKTOP`
+     * * `MOBILE`
+     * * A customized string starts with `OTHER_`, e.g. `OTHER_IPHONE`.
      * </pre>
      *
      * <code>string device_type = 4;</code>
@@ -1673,13 +1673,13 @@ public Builder setDeviceType(java.lang.String value) {
      * <pre>
      * The device type context for completion suggestions.
      * It is useful to apply different suggestions on different device types, e.g.
-     * DESKTOP, MOBILE. If it is empty, the suggestions are across all device
+     * `DESKTOP`, `MOBILE`. If it is empty, the suggestions are across all device
      * types.
      * Supported formats:
-     * * UNKNOWN_DEVICE_TYPE
-     * * DESKTOP
-     * * MOBILE
-     * * A customized string starts with OTHER_, e.g. OTHER_IPHONE.
+     * * `UNKNOWN_DEVICE_TYPE`
+     * * `DESKTOP`
+     * * `MOBILE`
+     * * A customized string starts with `OTHER_`, e.g. `OTHER_IPHONE`.
      * </pre>
      *
      * <code>string device_type = 4;</code>
@@ -1698,13 +1698,13 @@ public Builder clearDeviceType() {
      * <pre>
      * The device type context for completion suggestions.
      * It is useful to apply different suggestions on different device types, e.g.
-     * DESKTOP, MOBILE. If it is empty, the suggestions are across all device
+     * `DESKTOP`, `MOBILE`. If it is empty, the suggestions are across all device
      * types.
      * Supported formats:
-     * * UNKNOWN_DEVICE_TYPE
-     * * DESKTOP
-     * * MOBILE
-     * * A customized string starts with OTHER_, e.g. OTHER_IPHONE.
+     * * `UNKNOWN_DEVICE_TYPE`
+     * * `DESKTOP`
+     * * `MOBILE`
+     * * A customized string starts with `OTHER_`, e.g. `OTHER_IPHONE`.
      * </pre>
      *
      * <code>string device_type = 4;</code>

diff --git a/...oud-retail-v2/src/main/java/com/google/cloud/retail/v2/CompleteQueryRequestOrBuilder.java b/...oud-retail-v2/src/main/java/com/google/cloud/retail/v2/CompleteQueryRequestOrBuilder.java
@@ -195,13 +195,13 @@ public interface CompleteQueryRequestOrBuilder
    * <pre>
    * The device type context for completion suggestions.
    * It is useful to apply different suggestions on different device types, e.g.
-   * DESKTOP, MOBILE. If it is empty, the suggestions are across all device
+   * `DESKTOP`, `MOBILE`. If it is empty, the suggestions are across all device
    * types.
    * Supported formats:
-   * * UNKNOWN_DEVICE_TYPE
-   * * DESKTOP
-   * * MOBILE
-   * * A customized string starts with OTHER_, e.g. OTHER_IPHONE.
+   * * `UNKNOWN_DEVICE_TYPE`
+   * * `DESKTOP`
+   * * `MOBILE`
+   * * A customized string starts with `OTHER_`, e.g. `OTHER_IPHONE`.
    * </pre>
    *
    * <code>string device_type = 4;</code>
@@ -215,13 +215,13 @@ public interface CompleteQueryRequestOrBuilder
    * <pre>
    * The device type context for completion suggestions.
    * It is useful to apply different suggestions on different device types, e.g.
-   * DESKTOP, MOBILE. If it is empty, the suggestions are across all device
+   * `DESKTOP`, `MOBILE`. If it is empty, the suggestions are across all device
    * types.
    * Supported formats:
-   * * UNKNOWN_DEVICE_TYPE
-   * * DESKTOP
-   * * MOBILE
-   * * A customized string starts with OTHER_, e.g. OTHER_IPHONE.
+   * * `UNKNOWN_DEVICE_TYPE`
+   * * `DESKTOP`
+   * * `MOBILE`
+   * * A customized string starts with `OTHER_`, e.g. `OTHER_IPHONE`.
    * </pre>
    *
    * <code>string device_type = 4;</code>