From e92169620711c14e96d9c51fe5c0d057740a5685 Mon Sep 17 00:00:00 2001
From: Riya Mehta <riyamehta@google.com>
Date: Thu, 16 Jan 2025 09:30:02 -0800
Subject: [PATCH] address nits in code comment language + formatting.

---
 .../api/gax/grpc/InstantiatingGrpcChannelProvider.java    | 8 ++++++--
 gax-java/gax/clirr-ignored-differences.xml                | 4 ++--
 2 files changed, 8 insertions(+), 4 deletions(-)

diff --git a/gax-java/gax-grpc/src/main/java/com/google/api/gax/grpc/InstantiatingGrpcChannelProvider.java b/gax-java/gax-grpc/src/main/java/com/google/api/gax/grpc/InstantiatingGrpcChannelProvider.java
index f6c3a71d3b..3ed731220c 100644
--- a/gax-java/gax-grpc/src/main/java/com/google/api/gax/grpc/InstantiatingGrpcChannelProvider.java
+++ b/gax-java/gax-grpc/src/main/java/com/google/api/gax/grpc/InstantiatingGrpcChannelProvider.java
@@ -106,11 +106,15 @@ public final class InstantiatingGrpcChannelProvider implements TransportChannelP
 
   // The public portion of the mTLS MDS root certificate is stored for performing
   // cert verification when establishing an mTLS connection with the MDS. See
-  // https://cloud.google.com/compute/docs/metadata/overview#https-mds-root-certs
+  // {@link <a
+  // href="https://cloud.google.com/compute/docs/metadata/overview#https-mds-root-certs">this</a>
+  // for more information.}
   private static final String MTLS_MDS_ROOT_PATH = "/run/google-mds-mtls/root.crt";
   // The mTLS MDS credentials are formatted as the concatenation of a PEM-encoded certificate chain
   // followed by a PEM-encoded private key. See
-  // https://cloud.google.com/compute/docs/metadata/overview#https-mds-client-certs
+  // {@link <a
+  // href="https://cloud.google.com/compute/docs/metadata/overview#https-mds-client-certs">this</a>
+  // for more information.}
   private static final String MTLS_MDS_CERT_CHAIN_AND_KEY_PATH = "/run/google-mds-mtls/client.key";
 
   static final long DIRECT_PATH_KEEP_ALIVE_TIME_SECONDS = 3600;
diff --git a/gax-java/gax/clirr-ignored-differences.xml b/gax-java/gax/clirr-ignored-differences.xml
index de1df2c512..2056ca53ce 100644
--- a/gax-java/gax/clirr-ignored-differences.xml
+++ b/gax-java/gax/clirr-ignored-differences.xml
@@ -106,13 +106,13 @@
     <className>com/google/api/gax/batching/Batcher</className>
     <method>*</method>
   </difference>
-  <!-- Ignore abstract method addition to an EndpointContext -->
+  <!-- Ignore abstract method addition to an EndpointContext (InternalApi) -->
   <difference>
     <differenceType>7013</differenceType>
     <className>com/google/api/gax/rpc/EndpointContext</className>
     <method>* useS2A()</method>
   </difference>
-  <!-- Ignore method addition to an TransportChannelProvider interface -->
+  <!-- Ignore method addition to TransportChannelProvider interface (InternalExtensionOnly) -->
   <difference>
     <differenceType>7012</differenceType>
     <className>com/google/api/gax/rpc/TransportChannelProvider</className>