docs: fix docstring formatting (#665)

- [ ] Regenerate this pull request now. Committer: @parthea PiperOrigin-RevId: 407854413 Source-Link: googleapis/googleapis@f81b7bd Source-Link: googleapis/googleapis-gen@1f0cfde Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiMWYwY2ZkZTU1MTRmYWUwMjRjNjczYjY3OTgxNzRhYjY3MjdjYjBhNSJ9
googleapis · Nov 6, 2021 · 0016405 · 0016405
1 parent 0410544
commit 0016405
Show file tree

Hide file tree

Showing 12 changed files with 66 additions and 7 deletions.
diff --git a/...loud-resourcemanager/src/main/java/com/google/cloud/resourcemanager/v3/FoldersClient.java b/...loud-resourcemanager/src/main/java/com/google/cloud/resourcemanager/v3/FoldersClient.java
@@ -446,10 +446,10 @@ public final UnaryCallable<ListFoldersRequest, ListFoldersResponse> listFoldersC
    *     suffix wildcard symbol `&#42;`.
    *     <p>The `displayName` field in a query expression should use escaped quotes for values that
    *     include whitespace to prevent unexpected behavior.
-   *     <p>| Field | Description |
+   *     <p>``` | Field | Description |
    *     |-------------------------|----------------------------------------| | displayName |
    *     Filters by displayName. | | parent | Filters by parent (for example: folders/123). | |
-   *     state, lifecycleState | Filters by state. |
+   *     state, lifecycleState | Filters by state. | ```
    *     <p>Some example queries are:
    *     <ul>
    *       <li>Query `displayName=Test&#42;` returns Folder resources whose display name starts with

diff --git a/...esourcemanager/src/main/java/com/google/cloud/resourcemanager/v3/OrganizationsClient.java b/...esourcemanager/src/main/java/com/google/cloud/resourcemanager/v3/OrganizationsClient.java
@@ -267,10 +267,10 @@ public final UnaryCallable<GetOrganizationRequest, Organization> getOrganization
    *
    * @param query Optional. An optional query string used to filter the Organizations to return in
    *     the response. Query rules are case-insensitive.
-   *     <p>| Field | Description |
+   *     <p>``` | Field | Description |
    *     |------------------|--------------------------------------------| | directoryCustomerId,
    *     owner.directoryCustomerId | Filters by directory customer id. | | domain | Filters by
-   *     domain. |
+   *     domain. | ```
    *     <p>Organizations may be queried by `directoryCustomerId` or by `domain`, where the domain
    *     is a G Suite domain, for example:
    *     <ul>

diff --git a/...oud-resourcemanager/src/main/java/com/google/cloud/resourcemanager/v3/ProjectsClient.java b/...oud-resourcemanager/src/main/java/com/google/cloud/resourcemanager/v3/ProjectsClient.java
@@ -451,14 +451,14 @@ public final UnaryCallable<ListProjectsRequest, ListProjectsResponse> listProjec
    * @param query Optional. A query string for searching for projects that the caller has
    *     `resourcemanager.projects.get` permission to. If multiple fields are included in the query,
    *     the it will return results that match any of the fields. Some eligible fields are:
-   *     <p>| Field | Description |
+   *     <p>``` | Field | Description |
    *     |-------------------------|----------------------------------------------| | displayName,
    *     name | Filters by displayName. | | parent | Project's parent. (for example: folders/123,
    *     organizations/&#42;) Prefer parent field over parent.type and parent.id. | | parent.type |
    *     Parent's type: `folder` or `organization`. | | parent.id | Parent's id number (for example:
    *     123) | | id, projectId | Filters by projectId. | | state, lifecycleState | Filters by
    *     state. | | labels | Filters by label name or value. | | labels.&lt;key&gt; (where
-   *     &#42;key&#42; is the name of a label) | Filters by label name. |
+   *     &#42;key&#42; is the name of a label) | Filters by label name. | ```
    *     <p>Search expressions are case insensitive.
    *     <p>Some examples queries:
    *     <p>| Query | Description |

diff --git a/...rcemanager-v3/src/main/java/com/google/cloud/resourcemanager/v3/SearchFoldersRequest.java b/...rcemanager-v3/src/main/java/com/google/cloud/resourcemanager/v3/SearchFoldersRequest.java
@@ -208,11 +208,13 @@ public com.google.protobuf.ByteString getPageTokenBytes() {
    * can be used along with the suffix wildcard symbol `*`.
    * The `displayName` field in a query expression should use escaped quotes
    * for values that include whitespace to prevent unexpected behavior.
+   * ```
    * | Field                   | Description                            |
    * |-------------------------|----------------------------------------|
    * | displayName             | Filters by displayName.                |
    * | parent                  | Filters by parent (for example: folders/123). |
    * | state, lifecycleState   | Filters by state.                      |
+   * ```
    * Some example queries are:
    * * Query `displayName=Test*` returns Folder resources whose display name
    * starts with "Test".
@@ -254,11 +256,13 @@ public java.lang.String getQuery() {
    * can be used along with the suffix wildcard symbol `*`.
    * The `displayName` field in a query expression should use escaped quotes
    * for values that include whitespace to prevent unexpected behavior.
+   * ```
    * | Field                   | Description                            |
    * |-------------------------|----------------------------------------|
    * | displayName             | Filters by displayName.                |
    * | parent                  | Filters by parent (for example: folders/123). |
    * | state, lifecycleState   | Filters by state.                      |
+   * ```
    * Some example queries are:
    * * Query `displayName=Test*` returns Folder resources whose display name
    * starts with "Test".
@@ -818,11 +822,13 @@ public Builder setPageTokenBytes(com.google.protobuf.ByteString value) {
      * can be used along with the suffix wildcard symbol `*`.
      * The `displayName` field in a query expression should use escaped quotes
      * for values that include whitespace to prevent unexpected behavior.
+     * ```
      * | Field                   | Description                            |
      * |-------------------------|----------------------------------------|
      * | displayName             | Filters by displayName.                |
      * | parent                  | Filters by parent (for example: folders/123). |
      * | state, lifecycleState   | Filters by state.                      |
+     * ```
      * Some example queries are:
      * * Query `displayName=Test*` returns Folder resources whose display name
      * starts with "Test".
@@ -863,11 +869,13 @@ public java.lang.String getQuery() {
      * can be used along with the suffix wildcard symbol `*`.
      * The `displayName` field in a query expression should use escaped quotes
      * for values that include whitespace to prevent unexpected behavior.
+     * ```
      * | Field                   | Description                            |
      * |-------------------------|----------------------------------------|
      * | displayName             | Filters by displayName.                |
      * | parent                  | Filters by parent (for example: folders/123). |
      * | state, lifecycleState   | Filters by state.                      |
+     * ```
      * Some example queries are:
      * * Query `displayName=Test*` returns Folder resources whose display name
      * starts with "Test".
@@ -908,11 +916,13 @@ public com.google.protobuf.ByteString getQueryBytes() {
      * can be used along with the suffix wildcard symbol `*`.
      * The `displayName` field in a query expression should use escaped quotes
      * for values that include whitespace to prevent unexpected behavior.
+     * ```
      * | Field                   | Description                            |
      * |-------------------------|----------------------------------------|
      * | displayName             | Filters by displayName.                |
      * | parent                  | Filters by parent (for example: folders/123). |
      * | state, lifecycleState   | Filters by state.                      |
+     * ```
      * Some example queries are:
      * * Query `displayName=Test*` returns Folder resources whose display name
      * starts with "Test".
@@ -952,11 +962,13 @@ public Builder setQuery(java.lang.String value) {
      * can be used along with the suffix wildcard symbol `*`.
      * The `displayName` field in a query expression should use escaped quotes
      * for values that include whitespace to prevent unexpected behavior.
+     * ```
      * | Field                   | Description                            |
      * |-------------------------|----------------------------------------|
      * | displayName             | Filters by displayName.                |
      * | parent                  | Filters by parent (for example: folders/123). |
      * | state, lifecycleState   | Filters by state.                      |
+     * ```
      * Some example queries are:
      * * Query `displayName=Test*` returns Folder resources whose display name
      * starts with "Test".
@@ -992,11 +1004,13 @@ public Builder clearQuery() {
      * can be used along with the suffix wildcard symbol `*`.
      * The `displayName` field in a query expression should use escaped quotes
      * for values that include whitespace to prevent unexpected behavior.
+     * ```
      * | Field                   | Description                            |
      * |-------------------------|----------------------------------------|
      * | displayName             | Filters by displayName.                |
      * | parent                  | Filters by parent (for example: folders/123). |
      * | state, lifecycleState   | Filters by state.                      |
+     * ```
      * Some example queries are:
      * * Query `displayName=Test*` returns Folder resources whose display name
      * starts with "Test".

diff --git a/...r-v3/src/main/java/com/google/cloud/resourcemanager/v3/SearchFoldersRequestOrBuilder.java b/...r-v3/src/main/java/com/google/cloud/resourcemanager/v3/SearchFoldersRequestOrBuilder.java
@@ -76,11 +76,13 @@ public interface SearchFoldersRequestOrBuilder
    * can be used along with the suffix wildcard symbol `*`.
    * The `displayName` field in a query expression should use escaped quotes
    * for values that include whitespace to prevent unexpected behavior.
+   * ```
    * | Field                   | Description                            |
    * |-------------------------|----------------------------------------|
    * | displayName             | Filters by displayName.                |
    * | parent                  | Filters by parent (for example: folders/123). |
    * | state, lifecycleState   | Filters by state.                      |
+   * ```
    * Some example queries are:
    * * Query `displayName=Test*` returns Folder resources whose display name
    * starts with "Test".
@@ -111,11 +113,13 @@ public interface SearchFoldersRequestOrBuilder
    * can be used along with the suffix wildcard symbol `*`.
    * The `displayName` field in a query expression should use escaped quotes
    * for values that include whitespace to prevent unexpected behavior.
+   * ```
    * | Field                   | Description                            |
    * |-------------------------|----------------------------------------|
    * | displayName             | Filters by displayName.                |
    * | parent                  | Filters by parent (for example: folders/123). |
    * | state, lifecycleState   | Filters by state.                      |
+   * ```
    * Some example queries are:
    * * Query `displayName=Test*` returns Folder resources whose display name
    * starts with "Test".

diff --git a/...ager-v3/src/main/java/com/google/cloud/resourcemanager/v3/SearchOrganizationsRequest.java b/...ager-v3/src/main/java/com/google/cloud/resourcemanager/v3/SearchOrganizationsRequest.java
@@ -202,11 +202,13 @@ public com.google.protobuf.ByteString getPageTokenBytes() {
    * <pre>
    * Optional. An optional query string used to filter the Organizations to return in
    * the response. Query rules are case-insensitive.
+   * ```
    * | Field            | Description                                |
    * |------------------|--------------------------------------------|
    * | directoryCustomerId, owner.directoryCustomerId | Filters by directory
    * customer id. |
    * | domain           | Filters by domain.                         |
+   * ```
    * Organizations may be queried by `directoryCustomerId` or by
    * `domain`, where the domain is a G Suite domain, for example:
    * * Query `directorycustomerid:123456789` returns Organization
@@ -237,11 +239,13 @@ public java.lang.String getQuery() {
    * <pre>
    * Optional. An optional query string used to filter the Organizations to return in
    * the response. Query rules are case-insensitive.
+   * ```
    * | Field            | Description                                |
    * |------------------|--------------------------------------------|
    * | directoryCustomerId, owner.directoryCustomerId | Filters by directory
    * customer id. |
    * | domain           | Filters by domain.                         |
+   * ```
    * Organizations may be queried by `directoryCustomerId` or by
    * `domain`, where the domain is a G Suite domain, for example:
    * * Query `directorycustomerid:123456789` returns Organization
@@ -793,11 +797,13 @@ public Builder setPageTokenBytes(com.google.protobuf.ByteString value) {
      * <pre>
      * Optional. An optional query string used to filter the Organizations to return in
      * the response. Query rules are case-insensitive.
+     * ```
      * | Field            | Description                                |
      * |------------------|--------------------------------------------|
      * | directoryCustomerId, owner.directoryCustomerId | Filters by directory
      * customer id. |
      * | domain           | Filters by domain.                         |
+     * ```
      * Organizations may be queried by `directoryCustomerId` or by
      * `domain`, where the domain is a G Suite domain, for example:
      * * Query `directorycustomerid:123456789` returns Organization
@@ -827,11 +833,13 @@ public java.lang.String getQuery() {
      * <pre>
      * Optional. An optional query string used to filter the Organizations to return in
      * the response. Query rules are case-insensitive.
+     * ```
      * | Field            | Description                                |
      * |------------------|--------------------------------------------|
      * | directoryCustomerId, owner.directoryCustomerId | Filters by directory
      * customer id. |
      * | domain           | Filters by domain.                         |
+     * ```
      * Organizations may be queried by `directoryCustomerId` or by
      * `domain`, where the domain is a G Suite domain, for example:
      * * Query `directorycustomerid:123456789` returns Organization
@@ -861,11 +869,13 @@ public com.google.protobuf.ByteString getQueryBytes() {
      * <pre>
      * Optional. An optional query string used to filter the Organizations to return in
      * the response. Query rules are case-insensitive.
+     * ```
      * | Field            | Description                                |
      * |------------------|--------------------------------------------|
      * | directoryCustomerId, owner.directoryCustomerId | Filters by directory
      * customer id. |
      * | domain           | Filters by domain.                         |
+     * ```
      * Organizations may be queried by `directoryCustomerId` or by
      * `domain`, where the domain is a G Suite domain, for example:
      * * Query `directorycustomerid:123456789` returns Organization
@@ -894,11 +904,13 @@ public Builder setQuery(java.lang.String value) {
      * <pre>
      * Optional. An optional query string used to filter the Organizations to return in
      * the response. Query rules are case-insensitive.
+     * ```
      * | Field            | Description                                |
      * |------------------|--------------------------------------------|
      * | directoryCustomerId, owner.directoryCustomerId | Filters by directory
      * customer id. |
      * | domain           | Filters by domain.                         |
+     * ```
      * Organizations may be queried by `directoryCustomerId` or by
      * `domain`, where the domain is a G Suite domain, for example:
      * * Query `directorycustomerid:123456789` returns Organization
@@ -923,11 +935,13 @@ public Builder clearQuery() {
      * <pre>
      * Optional. An optional query string used to filter the Organizations to return in
      * the response. Query rules are case-insensitive.
+     * ```
      * | Field            | Description                                |
      * |------------------|--------------------------------------------|
      * | directoryCustomerId, owner.directoryCustomerId | Filters by directory
      * customer id. |
      * | domain           | Filters by domain.                         |
+     * ```
      * Organizations may be queried by `directoryCustomerId` or by
      * `domain`, where the domain is a G Suite domain, for example:
      * * Query `directorycustomerid:123456789` returns Organization

diff --git a/...rc/main/java/com/google/cloud/resourcemanager/v3/SearchOrganizationsRequestOrBuilder.java b/...rc/main/java/com/google/cloud/resourcemanager/v3/SearchOrganizationsRequestOrBuilder.java
@@ -70,11 +70,13 @@ public interface SearchOrganizationsRequestOrBuilder
    * <pre>
    * Optional. An optional query string used to filter the Organizations to return in
    * the response. Query rules are case-insensitive.
+   * ```
    * | Field            | Description                                |
    * |------------------|--------------------------------------------|
    * | directoryCustomerId, owner.directoryCustomerId | Filters by directory
    * customer id. |
    * | domain           | Filters by domain.                         |
+   * ```
    * Organizations may be queried by `directoryCustomerId` or by
    * `domain`, where the domain is a G Suite domain, for example:
    * * Query `directorycustomerid:123456789` returns Organization
@@ -94,11 +96,13 @@ public interface SearchOrganizationsRequestOrBuilder
    * <pre>
    * Optional. An optional query string used to filter the Organizations to return in
    * the response. Query rules are case-insensitive.
+   * ```
    * | Field            | Description                                |
    * |------------------|--------------------------------------------|
    * | directoryCustomerId, owner.directoryCustomerId | Filters by directory
    * customer id. |
    * | domain           | Filters by domain.                         |
+   * ```
    * Organizations may be queried by `directoryCustomerId` or by
    * `domain`, where the domain is a G Suite domain, for example:
    * * Query `directorycustomerid:123456789` returns Organization