docs: code documentation improvements

PiperOrigin-RevId: 706891520
googleapis · Dec 17, 2024 · edbf799 · edbf799
1 parent 42f85a6
commit edbf799
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 10 deletions.
diff --git a/google/cloud/kms/v1/autokey.proto b/google/cloud/kms/v1/autokey.proto
@@ -54,9 +54,9 @@ service Autokey {
   // Creates a new [KeyHandle][google.cloud.kms.v1.KeyHandle], triggering the
   // provisioning of a new [CryptoKey][google.cloud.kms.v1.CryptoKey] for CMEK
   // use with the given resource type in the configured key project and the same
-  // location. [GetOperation][Operations.GetOperation] should be used to resolve
-  // the resulting long-running operation and get the resulting
-  // [KeyHandle][google.cloud.kms.v1.KeyHandle] and
+  // location. [GetOperation][google.longrunning.Operations.GetOperation] should
+  // be used to resolve the resulting long-running operation and get the
+  // resulting [KeyHandle][google.cloud.kms.v1.KeyHandle] and
   // [CryptoKey][google.cloud.kms.v1.CryptoKey].
   rpc CreateKeyHandle(CreateKeyHandleRequest)
       returns (google.longrunning.Operation) {

diff --git a/google/cloud/kms/v1/ekm_service.proto b/google/cloud/kms/v1/ekm_service.proto
@@ -288,7 +288,7 @@ message Certificate {
 // [CryptoKeys][google.cloud.kms.v1.CryptoKey] and
 // [CryptoKeyVersions][google.cloud.kms.v1.CryptoKeyVersion] with a
 // [ProtectionLevel][google.cloud.kms.v1.ProtectionLevel] of
-// [EXTERNAL_VPC][CryptoKeyVersion.ProtectionLevel.EXTERNAL_VPC], as well as
+// [EXTERNAL_VPC][google.cloud.kms.v1.ProtectionLevel.EXTERNAL_VPC], as well as
 // performing cryptographic operations using keys created within the
 // [EkmConnection][google.cloud.kms.v1.EkmConnection].
 message EkmConnection {
@@ -354,6 +354,7 @@ message EkmConnection {
     // All [CryptoKeys][google.cloud.kms.v1.CryptoKey] created with this
     // [EkmConnection][google.cloud.kms.v1.EkmConnection] use EKM-side key
     // management operations initiated from Cloud KMS. This means that:
+    //
     // * When a [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion]
     // associated with this [EkmConnection][google.cloud.kms.v1.EkmConnection]
     // is
@@ -362,7 +363,8 @@ message EkmConnection {
     //   external key material.
     // * Destruction of external key material associated with this
     //   [EkmConnection][google.cloud.kms.v1.EkmConnection] can be requested by
-    //   calling [DestroyCryptoKeyVersion][EkmService.DestroyCryptoKeyVersion].
+    //   calling
+    //   [DestroyCryptoKeyVersion][google.cloud.kms.v1.KeyManagementService.DestroyCryptoKeyVersion].
     // * Automatic rotation of key material is supported.
     CLOUD_KMS = 2;
   }
@@ -409,7 +411,7 @@ message EkmConnection {
 // [CryptoKeys][google.cloud.kms.v1.CryptoKey] and
 // [CryptoKeyVersions][google.cloud.kms.v1.CryptoKeyVersion] with a
 // [ProtectionLevel][google.cloud.kms.v1.ProtectionLevel] of
-// [EXTERNAL_VPC][CryptoKeyVersion.ProtectionLevel.EXTERNAL_VPC] in a given
+// [EXTERNAL_VPC][google.cloud.kms.v1.ProtectionLevel.EXTERNAL_VPC] in a given
 // project and location.
 message EkmConfig {
   option (google.api.resource) = {

diff --git a/google/cloud/kms/v1/resources.proto b/google/cloud/kms/v1/resources.proto
@@ -193,7 +193,7 @@ message CryptoKey {
   // where all related cryptographic operations are performed. Only applicable
   // if [CryptoKeyVersions][google.cloud.kms.v1.CryptoKeyVersion] have a
   // [ProtectionLevel][google.cloud.kms.v1.ProtectionLevel] of
-  // [EXTERNAL_VPC][CryptoKeyVersion.ProtectionLevel.EXTERNAL_VPC], with the
+  // [EXTERNAL_VPC][google.cloud.kms.v1.ProtectionLevel.EXTERNAL_VPC], with the
   // resource name in the format `projects/*/locations/*/ekmConnections/*`.
   // Note, this list is non-exhaustive and may apply to additional
   // [ProtectionLevels][google.cloud.kms.v1.ProtectionLevel] in the future.

diff --git a/google/cloud/kms/v1/service.proto b/google/cloud/kms/v1/service.proto
@@ -24,7 +24,6 @@ import "google/cloud/kms/v1/resources.proto";
 import "google/protobuf/field_mask.proto";
 import "google/protobuf/wrappers.proto";
 
-option cc_enable_arenas = true;
 option csharp_namespace = "Google.Cloud.Kms.V1";
 option go_package = "cloud.google.com/go/kms/apiv1/kmspb;kmspb";
 option java_multiple_files = true;
@@ -793,7 +792,9 @@ message ImportCryptoKeyVersionRequest {
   // [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion], the
   // [CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] must be a child of
   // [ImportCryptoKeyVersionRequest.parent][google.cloud.kms.v1.ImportCryptoKeyVersionRequest.parent],
-  // have been previously created via [ImportCryptoKeyVersion][], and be in
+  // have been previously created via
+  // [ImportCryptoKeyVersion][google.cloud.kms.v1.KeyManagementService.ImportCryptoKeyVersion],
+  // and be in
   // [DESTROYED][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState.DESTROYED]
   // or
   // [IMPORT_FAILED][google.cloud.kms.v1.CryptoKeyVersion.CryptoKeyVersionState.IMPORT_FAILED]
@@ -1504,7 +1505,8 @@ message MacVerifyRequest {
   // checksum. [KeyManagementService][google.cloud.kms.v1.KeyManagementService]
   // will report an error if the checksum verification fails. If you receive a
   // checksum error, your client should verify that
-  // CRC32C([MacVerifyRequest.tag][]) is equal to
+  // CRC32C([MacVerifyRequest.mac][google.cloud.kms.v1.MacVerifyRequest.mac]) is
+  // equal to
   // [MacVerifyRequest.mac_crc32c][google.cloud.kms.v1.MacVerifyRequest.mac_crc32c],
   // and if so, perform a limited number of retries. A persistent mismatch may
   // indicate an issue in your computation of the CRC32C checksum. Note: This