Regenerate all clients with more explicit documentation

The use of "inheritdoc" breaks docfx in many cases. The generator has been improved to generate more explicit documentation. This PR only contains changes due to that generator change.
jskeet · May 13, 2020 · 947a573 · 947a573
1 parent d9c3479
commit 947a573
Show file tree

Hide file tree

Showing 253 changed files with 1,400 additions and 1,122 deletions.
diff --git a/apis/Google.Cloud.Asset.V1/Google.Cloud.Asset.V1/AssetServiceClient.g.cs b/apis/Google.Cloud.Asset.V1/Google.Cloud.Asset.V1/AssetServiceClient.g.cs
@@ -180,15 +180,15 @@ public sealed partial class AssetServiceClientBuilder : gaxgrpc::ClientBuilderBa
 
         partial void InterceptBuildAsync(st::CancellationToken cancellationToken, ref stt::Task<AssetServiceClient> task);
 
-        /// <inheritdoc/>
+        /// <summary>Builds the resulting client.</summary>
         public override AssetServiceClient Build()
         {
             AssetServiceClient client = null;
             InterceptBuild(ref client);
             return client ?? BuildImpl();
         }
 
-        /// <inheritdoc/>
+        /// <summary>Builds the resulting client asynchronously.</summary>
         public override stt::Task<AssetServiceClient> BuildAsync(st::CancellationToken cancellationToken = default)
         {
             stt::Task<AssetServiceClient> task = null;
@@ -210,16 +210,18 @@ private AssetServiceClient BuildImpl()
             return AssetServiceClient.Create(callInvoker, Settings);
         }
 
-        /// <inheritdoc/>
+        /// <summary>Returns the endpoint for this builder type, used if no endpoint is otherwise specified.</summary>
         protected override string GetDefaultEndpoint() => AssetServiceClient.DefaultEndpoint;
 
-        /// <inheritdoc/>
+        /// <summary>
+        /// Returns the default scopes for this builder type, used if no scopes are otherwise specified.
+        /// </summary>
         protected override scg::IReadOnlyList<string> GetDefaultScopes() => AssetServiceClient.DefaultScopes;
 
-        /// <inheritdoc/>
+        /// <summary>Returns the channel pool to use when no other options are specified.</summary>
         protected override gaxgrpc::ChannelPool GetChannelPool() => AssetServiceClient.ChannelPool;
 
-        /// <inheritdoc/>
+        /// <summary>Returns the default <see cref="gaxgrpc::GrpcAdapter"/>to use if not otherwise specified.</summary>
         protected override gaxgrpc::GrpcAdapter DefaultGrpcAdapter => gaxgrpccore::GrpcCoreAdapter.Instance;
     }
 

diff --git a/apis/Google.Cloud.Asset.V1/Google.Cloud.Asset.V1/AssetServiceResourceNames.g.cs b/apis/Google.Cloud.Asset.V1/Google.Cloud.Asset.V1/AssetServiceResourceNames.g.cs
@@ -282,10 +282,11 @@ public FeedName(string projectId, string feedId) : this(ResourceNameType.Project
         /// </summary>
         public string ProjectId { get; }
 
-        /// <inheritdoc/>
+        /// <summary>Whether this instance contains a resource name with a known pattern.</summary>
         public bool IsKnownPattern => Type != ResourceNameType.Unparsed;
 
-        /// <inheritdoc/>
+        /// <summary>The string representation of the resource name.</summary>
+        /// <returns>The string representation of the resource name.</returns>
         public override string ToString()
         {
             switch (Type)
@@ -298,7 +299,7 @@ public override string ToString()
             }
         }
 
-        /// <inheritdoc/>
+        /// <summary>Returns a hash code for this resource name.</summary>
         public override int GetHashCode() => ToString().GetHashCode();
 
         /// <inheritdoc/>

diff --git a/apis/Google.Cloud.Asset.V1/synth.metadata b/apis/Google.Cloud.Asset.V1/synth.metadata
@@ -4,7 +4,7 @@
       "git": {
         "name": "googleapis",
         "remote": "https://github.com/googleapis/googleapis.git",
-        "sha": "7be2811ad17013a5ea24cd75dfd9e399dd6e18fe"        
+        "sha": "89e89786896d256c70f43e68a975470c4f4f220e"        
       }
     }
   ]

diff --git a/apis/Google.Cloud.AutoML.V1/Google.Cloud.AutoML.V1/AnnotationSpecResourceNames.g.cs b/apis/Google.Cloud.AutoML.V1/Google.Cloud.AutoML.V1/AnnotationSpecResourceNames.g.cs
@@ -250,10 +250,11 @@ public AnnotationSpecName(string projectId, string locationId, string datasetId,
         /// </summary>
         public string ProjectId { get; }
 
-        /// <inheritdoc/>
+        /// <summary>Whether this instance contains a resource name with a known pattern.</summary>
         public bool IsKnownPattern => Type != ResourceNameType.Unparsed;
 
-        /// <inheritdoc/>
+        /// <summary>The string representation of the resource name.</summary>
+        /// <returns>The string representation of the resource name.</returns>
         public override string ToString()
         {
             switch (Type)
@@ -264,7 +265,7 @@ public override string ToString()
             }
         }
 
-        /// <inheritdoc/>
+        /// <summary>Returns a hash code for this resource name.</summary>
         public override int GetHashCode() => ToString().GetHashCode();
 
         /// <inheritdoc/>

diff --git a/apis/Google.Cloud.AutoML.V1/Google.Cloud.AutoML.V1/AutoMlClient.g.cs b/apis/Google.Cloud.AutoML.V1/Google.Cloud.AutoML.V1/AutoMlClient.g.cs
@@ -501,15 +501,15 @@ public sealed partial class AutoMlClientBuilder : gaxgrpc::ClientBuilderBase<Aut
 
         partial void InterceptBuildAsync(st::CancellationToken cancellationToken, ref stt::Task<AutoMlClient> task);
 
-        /// <inheritdoc/>
+        /// <summary>Builds the resulting client.</summary>
         public override AutoMlClient Build()
         {
             AutoMlClient client = null;
             InterceptBuild(ref client);
             return client ?? BuildImpl();
         }
 
-        /// <inheritdoc/>
+        /// <summary>Builds the resulting client asynchronously.</summary>
         public override stt::Task<AutoMlClient> BuildAsync(st::CancellationToken cancellationToken = default)
         {
             stt::Task<AutoMlClient> task = null;
@@ -531,16 +531,18 @@ private AutoMlClient BuildImpl()
             return AutoMlClient.Create(callInvoker, Settings);
         }
 
-        /// <inheritdoc/>
+        /// <summary>Returns the endpoint for this builder type, used if no endpoint is otherwise specified.</summary>
         protected override string GetDefaultEndpoint() => AutoMlClient.DefaultEndpoint;
 
-        /// <inheritdoc/>
+        /// <summary>
+        /// Returns the default scopes for this builder type, used if no scopes are otherwise specified.
+        /// </summary>
         protected override scg::IReadOnlyList<string> GetDefaultScopes() => AutoMlClient.DefaultScopes;
 
-        /// <inheritdoc/>
+        /// <summary>Returns the channel pool to use when no other options are specified.</summary>
         protected override gaxgrpc::ChannelPool GetChannelPool() => AutoMlClient.ChannelPool;
 
-        /// <inheritdoc/>
+        /// <summary>Returns the default <see cref="gaxgrpc::GrpcAdapter"/>to use if not otherwise specified.</summary>
         protected override gaxgrpc::GrpcAdapter DefaultGrpcAdapter => gaxgrpccore::GrpcCoreAdapter.Instance;
     }
 

diff --git a/apis/Google.Cloud.AutoML.V1/Google.Cloud.AutoML.V1/DatasetResourceNames.g.cs b/apis/Google.Cloud.AutoML.V1/Google.Cloud.AutoML.V1/DatasetResourceNames.g.cs
@@ -218,10 +218,11 @@ public DatasetName(string projectId, string locationId, string datasetId) : this
         /// </summary>
         public string ProjectId { get; }
 
-        /// <inheritdoc/>
+        /// <summary>Whether this instance contains a resource name with a known pattern.</summary>
         public bool IsKnownPattern => Type != ResourceNameType.Unparsed;
 
-        /// <inheritdoc/>
+        /// <summary>The string representation of the resource name.</summary>
+        /// <returns>The string representation of the resource name.</returns>
         public override string ToString()
         {
             switch (Type)
@@ -232,7 +233,7 @@ public override string ToString()
             }
         }
 
-        /// <inheritdoc/>
+        /// <summary>Returns a hash code for this resource name.</summary>
         public override int GetHashCode() => ToString().GetHashCode();
 
         /// <inheritdoc/>

diff --git a/apis/Google.Cloud.AutoML.V1/Google.Cloud.AutoML.V1/ModelEvaluationResourceNames.g.cs b/apis/Google.Cloud.AutoML.V1/Google.Cloud.AutoML.V1/ModelEvaluationResourceNames.g.cs
@@ -250,10 +250,11 @@ public ModelEvaluationName(string projectId, string locationId, string modelId,
         /// </summary>
         public string ProjectId { get; }
 
-        /// <inheritdoc/>
+        /// <summary>Whether this instance contains a resource name with a known pattern.</summary>
         public bool IsKnownPattern => Type != ResourceNameType.Unparsed;
 
-        /// <inheritdoc/>
+        /// <summary>The string representation of the resource name.</summary>
+        /// <returns>The string representation of the resource name.</returns>
         public override string ToString()
         {
             switch (Type)
@@ -264,7 +265,7 @@ public override string ToString()
             }
         }
 
-        /// <inheritdoc/>
+        /// <summary>Returns a hash code for this resource name.</summary>
         public override int GetHashCode() => ToString().GetHashCode();
 
         /// <inheritdoc/>

diff --git a/apis/Google.Cloud.AutoML.V1/Google.Cloud.AutoML.V1/ModelResourceNames.g.cs b/apis/Google.Cloud.AutoML.V1/Google.Cloud.AutoML.V1/ModelResourceNames.g.cs
@@ -218,10 +218,11 @@ public ModelName(string projectId, string locationId, string modelId) : this(Res
         /// </summary>
         public string ProjectId { get; }
 
-        /// <inheritdoc/>
+        /// <summary>Whether this instance contains a resource name with a known pattern.</summary>
         public bool IsKnownPattern => Type != ResourceNameType.Unparsed;
 
-        /// <inheritdoc/>
+        /// <summary>The string representation of the resource name.</summary>
+        /// <returns>The string representation of the resource name.</returns>
         public override string ToString()
         {
             switch (Type)
@@ -232,7 +233,7 @@ public override string ToString()
             }
         }
 
-        /// <inheritdoc/>
+        /// <summary>Returns a hash code for this resource name.</summary>
         public override int GetHashCode() => ToString().GetHashCode();
 
         /// <inheritdoc/>

diff --git a/apis/Google.Cloud.AutoML.V1/Google.Cloud.AutoML.V1/PredictionServiceClient.g.cs b/apis/Google.Cloud.AutoML.V1/Google.Cloud.AutoML.V1/PredictionServiceClient.g.cs
@@ -112,15 +112,15 @@ public sealed partial class PredictionServiceClientBuilder : gaxgrpc::ClientBuil
 
         partial void InterceptBuildAsync(st::CancellationToken cancellationToken, ref stt::Task<PredictionServiceClient> task);
 
-        /// <inheritdoc/>
+        /// <summary>Builds the resulting client.</summary>
         public override PredictionServiceClient Build()
         {
             PredictionServiceClient client = null;
             InterceptBuild(ref client);
             return client ?? BuildImpl();
         }
 
-        /// <inheritdoc/>
+        /// <summary>Builds the resulting client asynchronously.</summary>
         public override stt::Task<PredictionServiceClient> BuildAsync(st::CancellationToken cancellationToken = default)
         {
             stt::Task<PredictionServiceClient> task = null;
@@ -142,16 +142,18 @@ private PredictionServiceClient BuildImpl()
             return PredictionServiceClient.Create(callInvoker, Settings);
         }
 
-        /// <inheritdoc/>
+        /// <summary>Returns the endpoint for this builder type, used if no endpoint is otherwise specified.</summary>
         protected override string GetDefaultEndpoint() => PredictionServiceClient.DefaultEndpoint;
 
-        /// <inheritdoc/>
+        /// <summary>
+        /// Returns the default scopes for this builder type, used if no scopes are otherwise specified.
+        /// </summary>
         protected override scg::IReadOnlyList<string> GetDefaultScopes() => PredictionServiceClient.DefaultScopes;
 
-        /// <inheritdoc/>
+        /// <summary>Returns the channel pool to use when no other options are specified.</summary>
         protected override gaxgrpc::ChannelPool GetChannelPool() => PredictionServiceClient.ChannelPool;
 
-        /// <inheritdoc/>
+        /// <summary>Returns the default <see cref="gaxgrpc::GrpcAdapter"/>to use if not otherwise specified.</summary>
         protected override gaxgrpc::GrpcAdapter DefaultGrpcAdapter => gaxgrpccore::GrpcCoreAdapter.Instance;
     }
 

diff --git a/apis/Google.Cloud.AutoML.V1/synth.metadata b/apis/Google.Cloud.AutoML.V1/synth.metadata
@@ -4,7 +4,7 @@
       "git": {
         "name": "googleapis",
         "remote": "https://github.com/googleapis/googleapis.git",
-        "sha": "371206424e6db4df2cb3734bb1013dcaac9dbe4b"        
+        "sha": "89e89786896d256c70f43e68a975470c4f4f220e"        
       }
     }
   ]

diff --git a/...uery.DataTransfer.V1/Google.Cloud.BigQuery.DataTransfer.V1/DataTransferServiceClient.g.cs b/...uery.DataTransfer.V1/Google.Cloud.BigQuery.DataTransfer.V1/DataTransferServiceClient.g.cs
@@ -291,15 +291,15 @@ public sealed partial class DataTransferServiceClientBuilder : gaxgrpc::ClientBu
 
         partial void InterceptBuildAsync(st::CancellationToken cancellationToken, ref stt::Task<DataTransferServiceClient> task);
 
-        /// <inheritdoc/>
+        /// <summary>Builds the resulting client.</summary>
         public override DataTransferServiceClient Build()
         {
             DataTransferServiceClient client = null;
             InterceptBuild(ref client);
             return client ?? BuildImpl();
         }
 
-        /// <inheritdoc/>
+        /// <summary>Builds the resulting client asynchronously.</summary>
         public override stt::Task<DataTransferServiceClient> BuildAsync(st::CancellationToken cancellationToken = default)
         {
             stt::Task<DataTransferServiceClient> task = null;
@@ -321,16 +321,18 @@ private DataTransferServiceClient BuildImpl()
             return DataTransferServiceClient.Create(callInvoker, Settings);
         }
 
-        /// <inheritdoc/>
+        /// <summary>Returns the endpoint for this builder type, used if no endpoint is otherwise specified.</summary>
         protected override string GetDefaultEndpoint() => DataTransferServiceClient.DefaultEndpoint;
 
-        /// <inheritdoc/>
+        /// <summary>
+        /// Returns the default scopes for this builder type, used if no scopes are otherwise specified.
+        /// </summary>
         protected override scg::IReadOnlyList<string> GetDefaultScopes() => DataTransferServiceClient.DefaultScopes;
 
-        /// <inheritdoc/>
+        /// <summary>Returns the channel pool to use when no other options are specified.</summary>
         protected override gaxgrpc::ChannelPool GetChannelPool() => DataTransferServiceClient.ChannelPool;
 
-        /// <inheritdoc/>
+        /// <summary>Returns the default <see cref="gaxgrpc::GrpcAdapter"/>to use if not otherwise specified.</summary>
         protected override gaxgrpc::GrpcAdapter DefaultGrpcAdapter => gaxgrpccore::GrpcCoreAdapter.Instance;
     }
 

diff --git a/...uery.DataTransfer.V1/Google.Cloud.BigQuery.DataTransfer.V1/DatatransferResourceNames.g.cs b/...uery.DataTransfer.V1/Google.Cloud.BigQuery.DataTransfer.V1/DatatransferResourceNames.g.cs
@@ -263,10 +263,11 @@ public DataSourceName(string projectId, string dataSourceId) : this(ResourceName
         /// </summary>
         public string ProjectId { get; }
 
-        /// <inheritdoc/>
+        /// <summary>Whether this instance contains a resource name with a known pattern.</summary>
         public bool IsKnownPattern => Type != ResourceNameType.Unparsed;
 
-        /// <inheritdoc/>
+        /// <summary>The string representation of the resource name.</summary>
+        /// <returns>The string representation of the resource name.</returns>
         public override string ToString()
         {
             switch (Type)
@@ -278,7 +279,7 @@ public override string ToString()
             }
         }
 
-        /// <inheritdoc/>
+        /// <summary>Returns a hash code for this resource name.</summary>
         public override int GetHashCode() => ToString().GetHashCode();
 
         /// <inheritdoc/>

diff --git a/...BigQuery.DataTransfer.V1/Google.Cloud.BigQuery.DataTransfer.V1/TransferResourceNames.g.cs b/...BigQuery.DataTransfer.V1/Google.Cloud.BigQuery.DataTransfer.V1/TransferResourceNames.g.cs
@@ -269,10 +269,11 @@ public TransferConfigName(string projectId, string transferConfigId) : this(Reso
         /// </summary>
         public string TransferConfigId { get; }
 
-        /// <inheritdoc/>
+        /// <summary>Whether this instance contains a resource name with a known pattern.</summary>
         public bool IsKnownPattern => Type != ResourceNameType.Unparsed;
 
-        /// <inheritdoc/>
+        /// <summary>The string representation of the resource name.</summary>
+        /// <returns>The string representation of the resource name.</returns>
         public override string ToString()
         {
             switch (Type)
@@ -284,7 +285,7 @@ public override string ToString()
             }
         }
 
-        /// <inheritdoc/>
+        /// <summary>Returns a hash code for this resource name.</summary>
         public override int GetHashCode() => ToString().GetHashCode();
 
         /// <inheritdoc/>
@@ -571,10 +572,11 @@ public RunName(string projectId, string transferConfigId, string runId) : this(R
         /// </summary>
         public string TransferConfigId { get; }
 
-        /// <inheritdoc/>
+        /// <summary>Whether this instance contains a resource name with a known pattern.</summary>
         public bool IsKnownPattern => Type != ResourceNameType.Unparsed;
 
-        /// <inheritdoc/>
+        /// <summary>The string representation of the resource name.</summary>
+        /// <returns>The string representation of the resource name.</returns>
         public override string ToString()
         {
             switch (Type)
@@ -586,7 +588,7 @@ public override string ToString()
             }
         }
 
-        /// <inheritdoc/>
+        /// <summary>Returns a hash code for this resource name.</summary>
         public override int GetHashCode() => ToString().GetHashCode();
 
         /// <inheritdoc/>

diff --git a/apis/Google.Cloud.BigQuery.DataTransfer.V1/synth.metadata b/apis/Google.Cloud.BigQuery.DataTransfer.V1/synth.metadata
@@ -1,12 +1,11 @@
 {
-  "updateTime": "2020-04-08T05:37:35.012840Z",
   "sources": [
     {
       "git": {
         "name": "googleapis",
         "remote": "https://github.com/googleapis/googleapis.git",
-        "sha": "af7da29c24814a1c873c22f477e9dd8dd5a17b0b"
+        "sha": "89e89786896d256c70f43e68a975470c4f4f220e"        
       }
     }
   ]
-}
+}