Skip to content

Commit

Permalink
docs: [Many APIs] fix minor docstring formatting (#8798)
Browse files Browse the repository at this point in the history
* docs: fix minor docstring formatting

PiperOrigin-RevId: 488759662

Source-Link: googleapis/googleapis@0f0eb8b

Source-Link: googleapis/googleapis-gen@a9f9383
Copy-Tag: eyJwIjoiamF2YS1iZXlvbmRjb3JwLWFwcGNvbm5lY3Rpb25zLy5Pd2xCb3QueWFtbCIsImgiOiJhOWY5MzgzNDg4MGNjYmY4ODUyZjVlYzU5YmU2MWI0MTlhNjAxZjM0In0=
Copy-Tag: eyJwIjoiamF2YS1iZXlvbmRjb3JwLWFwcGNvbm5lY3RvcnMvLk93bEJvdC55YW1sIiwiaCI6ImE5ZjkzODM0ODgwY2NiZjg4NTJmNWVjNTliZTYxYjQxOWE2MDFmMzQifQ==
Copy-Tag: eyJwIjoiamF2YS1iZXlvbmRjb3JwLWFwcGdhdGV3YXlzLy5Pd2xCb3QueWFtbCIsImgiOiJhOWY5MzgzNDg4MGNjYmY4ODUyZjVlYzU5YmU2MWI0MTlhNjAxZjM0In0=
Copy-Tag: eyJwIjoiamF2YS1iZXlvbmRjb3JwLWNsaWVudGNvbm5lY3RvcnNlcnZpY2VzLy5Pd2xCb3QueWFtbCIsImgiOiJhOWY5MzgzNDg4MGNjYmY4ODUyZjVlYzU5YmU2MWI0MTlhNjAxZjM0In0=
Copy-Tag: eyJwIjoiamF2YS1iZXlvbmRjb3JwLWNsaWVudGdhdGV3YXlzLy5Pd2xCb3QueWFtbCIsImgiOiJhOWY5MzgzNDg4MGNjYmY4ODUyZjVlYzU5YmU2MWI0MTlhNjAxZjM0In0=

* 🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
  • Loading branch information
2 people authored and alicejli committed Nov 18, 2022
1 parent b30edc0 commit fb855f5
Show file tree
Hide file tree
Showing 30 changed files with 170 additions and 165 deletions.
32 changes: 16 additions & 16 deletions java-beyondcorp-appconnections/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,20 +22,20 @@ If you are using Maven, add this to your pom.xml file:
<dependency>
<groupId>com.google.cloud</groupId>
<artifactId>google-cloud-beyondcorp-appconnections</artifactId>
<version>0.1.0</version>
<version>0.4.0</version>
</dependency>
```

If you are using Gradle without BOM, add this to your dependencies:

```Groovy
implementation 'com.google.cloud:google-cloud-beyondcorp-appconnections:0.1.0'
implementation 'com.google.cloud:google-cloud-beyondcorp-appconnections:0.4.0'
```

If you are using SBT, add this to your dependencies:

```Scala
libraryDependencies += "com.google.cloud" % "google-cloud-beyondcorp-appconnections" % "0.1.0"
libraryDependencies += "com.google.cloud" % "google-cloud-beyondcorp-appconnections" % "0.4.0"
```

## Authentication
Expand Down Expand Up @@ -165,16 +165,16 @@ Java is a registered trademark of Oracle and/or its affiliates.

[product-docs]: https://cloud.google.com/beyondcorp-enterprise/
[javadocs]: https://cloud.google.com/java/docs/reference/google-cloud-beyondcorp-appconnections/latest/overview
[kokoro-badge-image-1]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-beyondcorp-appconnections/java7.svg
[kokoro-badge-link-1]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-beyondcorp-appconnections/java7.html
[kokoro-badge-image-2]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-beyondcorp-appconnections/java8.svg
[kokoro-badge-link-2]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-beyondcorp-appconnections/java8.html
[kokoro-badge-image-3]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-beyondcorp-appconnections/java8-osx.svg
[kokoro-badge-link-3]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-beyondcorp-appconnections/java8-osx.html
[kokoro-badge-image-4]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-beyondcorp-appconnections/java8-win.svg
[kokoro-badge-link-4]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-beyondcorp-appconnections/java8-win.html
[kokoro-badge-image-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-beyondcorp-appconnections/java11.svg
[kokoro-badge-link-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-beyondcorp-appconnections/java11.html
[kokoro-badge-image-1]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java7.svg
[kokoro-badge-link-1]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java7.html
[kokoro-badge-image-2]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java8.svg
[kokoro-badge-link-2]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java8.html
[kokoro-badge-image-3]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java8-osx.svg
[kokoro-badge-link-3]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java8-osx.html
[kokoro-badge-image-4]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java8-win.svg
[kokoro-badge-link-4]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java8-win.html
[kokoro-badge-image-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java11.svg
[kokoro-badge-link-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java11.html
[stability-image]: https://img.shields.io/badge/stability-preview-yellow
[maven-version-image]: https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-beyondcorp-appconnections.svg
[maven-version-link]: https://search.maven.org/search?q=g:com.google.cloud%20AND%20a:google-cloud-beyondcorp-appconnections&core=gav
Expand All @@ -186,9 +186,9 @@ Java is a registered trademark of Oracle and/or its affiliates.
[create-project]: https://cloud.google.com/resource-manager/docs/creating-managing-projects
[cloud-sdk]: https://cloud.google.com/sdk/
[troubleshooting]: https://github.com/googleapis/google-cloud-common/blob/main/troubleshooting/readme.md#troubleshooting
[contributing]: https://github.com/googleapis/java-beyondcorp-appconnections/blob/main/CONTRIBUTING.md
[code-of-conduct]: https://github.com/googleapis/java-beyondcorp-appconnections/blob/main/CODE_OF_CONDUCT.md#contributor-code-of-conduct
[license]: https://github.com/googleapis/java-beyondcorp-appconnections/blob/main/LICENSE
[contributing]: https://github.com/googleapis/google-cloud-java/blob/main/CONTRIBUTING.md
[code-of-conduct]: https://github.com/googleapis/google-cloud-java/blob/main/CODE_OF_CONDUCT.md#contributor-code-of-conduct
[license]: https://github.com/googleapis/google-cloud-java/blob/main/LICENSE
[enable-billing]: https://cloud.google.com/apis/docs/getting-started#enabling_billing
[enable-api]: https://console.cloud.google.com/flows/enableapi?apiid=beyondcorp-appconnections.googleapis.com
[libraries-bom]: https://github.com/GoogleCloudPlatform/cloud-opensource-java/wiki/The-Google-Cloud-Platform-Libraries-BOM
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,11 +49,11 @@

// AUTO-GENERATED DOCUMENTATION AND CLASS.
/**
* Service Description: ## API Overview
* Service Description: API Overview:
*
* <p>The `beyondcorp.googleapis.com` service implements the Google Cloud BeyondCorp API.
*
* <p>## Data Model
* <p>Data Model:
*
* <p>The AppConnectionsService exposes the following resources:
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,11 @@
*
* <p>======================= AppConnectionsServiceClient =======================
*
* <p>Service Description: ## API Overview
* <p>Service Description: API Overview:
*
* <p>The `beyondcorp.googleapis.com` service implements the Google Cloud BeyondCorp API.
*
* <p>## Data Model
* <p>Data Model:
*
* <p>The AppConnectionsService exposes the following resources:
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,10 @@
*
*
* <pre>
* ## API Overview
* API Overview:
* The `beyondcorp.googleapis.com` service implements the Google Cloud
* BeyondCorp API.
* ## Data Model
* Data Model:
* The AppConnectionsService exposes the following resources:
* * AppConnections, named as follows:
* `projects/{project_id}/locations/{location_id}/appConnections/{app_connection_id}`.
Expand Down Expand Up @@ -388,10 +388,10 @@ public AppConnectionsServiceFutureStub newStub(
*
*
* <pre>
* ## API Overview
* API Overview:
* The `beyondcorp.googleapis.com` service implements the Google Cloud
* BeyondCorp API.
* ## Data Model
* Data Model:
* The AppConnectionsService exposes the following resources:
* * AppConnections, named as follows:
* `projects/{project_id}/locations/{location_id}/appConnections/{app_connection_id}`.
Expand Down Expand Up @@ -542,10 +542,10 @@ public final io.grpc.ServerServiceDefinition bindService() {
*
*
* <pre>
* ## API Overview
* API Overview:
* The `beyondcorp.googleapis.com` service implements the Google Cloud
* BeyondCorp API.
* ## Data Model
* Data Model:
* The AppConnectionsService exposes the following resources:
* * AppConnections, named as follows:
* `projects/{project_id}/locations/{location_id}/appConnections/{app_connection_id}`.
Expand Down Expand Up @@ -673,10 +673,10 @@ public void resolveAppConnections(
*
*
* <pre>
* ## API Overview
* API Overview:
* The `beyondcorp.googleapis.com` service implements the Google Cloud
* BeyondCorp API.
* ## Data Model
* Data Model:
* The AppConnectionsService exposes the following resources:
* * AppConnections, named as follows:
* `projects/{project_id}/locations/{location_id}/appConnections/{app_connection_id}`.
Expand Down Expand Up @@ -784,10 +784,10 @@ public com.google.longrunning.Operation deleteAppConnection(
*
*
* <pre>
* ## API Overview
* API Overview:
* The `beyondcorp.googleapis.com` service implements the Google Cloud
* BeyondCorp API.
* ## Data Model
* Data Model:
* The AppConnectionsService exposes the following resources:
* * AppConnections, named as follows:
* `projects/{project_id}/locations/{location_id}/appConnections/{app_connection_id}`.
Expand Down
3 changes: 2 additions & 1 deletion java-beyondcorp-appconnections/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -50,4 +50,5 @@
<module>proto-google-cloud-beyondcorp-appconnections-v1</module>
<module>google-cloud-beyondcorp-appconnections-bom</module>
</modules>
</project>

</project>
Original file line number Diff line number Diff line change
Expand Up @@ -40,12 +40,12 @@ option (google.api.resource_definition) = {
pattern: "projects/{project}/locations/{location}/appGateways/{app_gateway}"
};

// ## API Overview
// API Overview:
//
// The `beyondcorp.googleapis.com` service implements the Google Cloud
// BeyondCorp API.
//
// ## Data Model
// Data Model:
//
// The AppConnectionsService exposes the following resources:
//
Expand Down
32 changes: 16 additions & 16 deletions java-beyondcorp-appconnectors/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,20 +22,20 @@ If you are using Maven, add this to your pom.xml file:
<dependency>
<groupId>com.google.cloud</groupId>
<artifactId>google-cloud-beyondcorp-appconnectors</artifactId>
<version>0.1.0</version>
<version>0.4.0</version>
</dependency>
```

If you are using Gradle without BOM, add this to your dependencies:

```Groovy
implementation 'com.google.cloud:google-cloud-beyondcorp-appconnectors:0.1.0'
implementation 'com.google.cloud:google-cloud-beyondcorp-appconnectors:0.4.0'
```

If you are using SBT, add this to your dependencies:

```Scala
libraryDependencies += "com.google.cloud" % "google-cloud-beyondcorp-appconnectors" % "0.1.0"
libraryDependencies += "com.google.cloud" % "google-cloud-beyondcorp-appconnectors" % "0.4.0"
```

## Authentication
Expand Down Expand Up @@ -165,16 +165,16 @@ Java is a registered trademark of Oracle and/or its affiliates.

[product-docs]: cloud.google.com/beyondcorp-enterprise/
[javadocs]: https://cloud.google.com/java/docs/reference/google-cloud-beyondcorp-appconnectors/latest/overview
[kokoro-badge-image-1]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-beyondcorp-appconnectors/java7.svg
[kokoro-badge-link-1]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-beyondcorp-appconnectors/java7.html
[kokoro-badge-image-2]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-beyondcorp-appconnectors/java8.svg
[kokoro-badge-link-2]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-beyondcorp-appconnectors/java8.html
[kokoro-badge-image-3]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-beyondcorp-appconnectors/java8-osx.svg
[kokoro-badge-link-3]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-beyondcorp-appconnectors/java8-osx.html
[kokoro-badge-image-4]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-beyondcorp-appconnectors/java8-win.svg
[kokoro-badge-link-4]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-beyondcorp-appconnectors/java8-win.html
[kokoro-badge-image-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-beyondcorp-appconnectors/java11.svg
[kokoro-badge-link-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-beyondcorp-appconnectors/java11.html
[kokoro-badge-image-1]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java7.svg
[kokoro-badge-link-1]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java7.html
[kokoro-badge-image-2]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java8.svg
[kokoro-badge-link-2]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java8.html
[kokoro-badge-image-3]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java8-osx.svg
[kokoro-badge-link-3]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java8-osx.html
[kokoro-badge-image-4]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java8-win.svg
[kokoro-badge-link-4]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java8-win.html
[kokoro-badge-image-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java11.svg
[kokoro-badge-link-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java11.html
[stability-image]: https://img.shields.io/badge/stability-preview-yellow
[maven-version-image]: https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-beyondcorp-appconnectors.svg
[maven-version-link]: https://search.maven.org/search?q=g:com.google.cloud%20AND%20a:google-cloud-beyondcorp-appconnectors&core=gav
Expand All @@ -186,9 +186,9 @@ Java is a registered trademark of Oracle and/or its affiliates.
[create-project]: https://cloud.google.com/resource-manager/docs/creating-managing-projects
[cloud-sdk]: https://cloud.google.com/sdk/
[troubleshooting]: https://github.com/googleapis/google-cloud-common/blob/main/troubleshooting/readme.md#troubleshooting
[contributing]: https://github.com/googleapis/java-beyondcorp-appconnectors/blob/main/CONTRIBUTING.md
[code-of-conduct]: https://github.com/googleapis/java-beyondcorp-appconnectors/blob/main/CODE_OF_CONDUCT.md#contributor-code-of-conduct
[license]: https://github.com/googleapis/java-beyondcorp-appconnectors/blob/main/LICENSE
[contributing]: https://github.com/googleapis/google-cloud-java/blob/main/CONTRIBUTING.md
[code-of-conduct]: https://github.com/googleapis/google-cloud-java/blob/main/CODE_OF_CONDUCT.md#contributor-code-of-conduct
[license]: https://github.com/googleapis/google-cloud-java/blob/main/LICENSE
[enable-billing]: https://cloud.google.com/apis/docs/getting-started#enabling_billing
[enable-api]: https://console.cloud.google.com/flows/enableapi?apiid=beyondcorp-appconnectors.googleapis.com
[libraries-bom]: https://github.com/GoogleCloudPlatform/cloud-opensource-java/wiki/The-Google-Cloud-Platform-Libraries-BOM
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,11 +49,11 @@

// AUTO-GENERATED DOCUMENTATION AND CLASS.
/**
* Service Description: ## API Overview
* Service Description: API Overview:
*
* <p>The `beyondcorp.googleapis.com` service implements the Google Cloud BeyondCorp API.
*
* <p>## Data Model
* <p>Data Model:
*
* <p>The AppConnectorsService exposes the following resource:
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,11 @@
*
* <p>======================= AppConnectorsServiceClient =======================
*
* <p>Service Description: ## API Overview
* <p>Service Description: API Overview:
*
* <p>The `beyondcorp.googleapis.com` service implements the Google Cloud BeyondCorp API.
*
* <p>## Data Model
* <p>Data Model:
*
* <p>The AppConnectorsService exposes the following resource:
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,10 @@
*
*
* <pre>
* ## API Overview
* API Overview:
* The `beyondcorp.googleapis.com` service implements the Google Cloud
* BeyondCorp API.
* ## Data Model
* Data Model:
* The AppConnectorsService exposes the following resource:
* * AppConnectors, named as follows:
* `projects/{project_id}/locations/{location_id}/appConnectors/{app_connector_id}`.
Expand Down Expand Up @@ -376,10 +376,10 @@ public AppConnectorsServiceFutureStub newStub(
*
*
* <pre>
* ## API Overview
* API Overview:
* The `beyondcorp.googleapis.com` service implements the Google Cloud
* BeyondCorp API.
* ## Data Model
* Data Model:
* The AppConnectorsService exposes the following resource:
* * AppConnectors, named as follows:
* `projects/{project_id}/locations/{location_id}/appConnectors/{app_connector_id}`.
Expand Down Expand Up @@ -525,10 +525,10 @@ public final io.grpc.ServerServiceDefinition bindService() {
*
*
* <pre>
* ## API Overview
* API Overview:
* The `beyondcorp.googleapis.com` service implements the Google Cloud
* BeyondCorp API.
* ## Data Model
* Data Model:
* The AppConnectorsService exposes the following resource:
* * AppConnectors, named as follows:
* `projects/{project_id}/locations/{location_id}/appConnectors/{app_connector_id}`.
Expand Down Expand Up @@ -652,10 +652,10 @@ public void reportStatus(
*
*
* <pre>
* ## API Overview
* API Overview:
* The `beyondcorp.googleapis.com` service implements the Google Cloud
* BeyondCorp API.
* ## Data Model
* Data Model:
* The AppConnectorsService exposes the following resource:
* * AppConnectors, named as follows:
* `projects/{project_id}/locations/{location_id}/appConnectors/{app_connector_id}`.
Expand Down Expand Up @@ -759,10 +759,10 @@ public com.google.longrunning.Operation reportStatus(
*
*
* <pre>
* ## API Overview
* API Overview:
* The `beyondcorp.googleapis.com` service implements the Google Cloud
* BeyondCorp API.
* ## Data Model
* Data Model:
* The AppConnectorsService exposes the following resource:
* * AppConnectors, named as follows:
* `projects/{project_id}/locations/{location_id}/appConnectors/{app_connector_id}`.
Expand Down
3 changes: 2 additions & 1 deletion java-beyondcorp-appconnectors/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -50,4 +50,5 @@
<module>proto-google-cloud-beyondcorp-appconnectors-v1</module>
<module>google-cloud-beyondcorp-appconnectors-bom</module>
</modules>
</project>

</project>
Original file line number Diff line number Diff line change
Expand Up @@ -34,12 +34,12 @@ option java_package = "com.google.cloud.beyondcorp.appconnectors.v1";
option php_namespace = "Google\\Cloud\\BeyondCorp\\AppConnectors\\V1";
option ruby_package = "Google::Cloud::BeyondCorp::AppConnectors::V1";

// ## API Overview
// API Overview:
//
// The `beyondcorp.googleapis.com` service implements the Google Cloud
// BeyondCorp API.
//
// ## Data Model
// Data Model:
//
// The AppConnectorsService exposes the following resource:
//
Expand Down

0 comments on commit fb855f5

Please sign in to comment.