Skip to content

Commit

Permalink
docs: fix docstring formatting
Browse files Browse the repository at this point in the history
Committer: @parthea
PiperOrigin-RevId: 476410563

Source-Link: googleapis/googleapis@7f579ee

Source-Link: googleapis/googleapis-gen@ae0240e
Copy-Tag: eyJwIjoiYXBpcy9Hb29nbGUuQ2xvdWQuTGFuZ3VhZ2UuVjEvLk93bEJvdC55YW1sIiwiaCI6ImFlMDI0MGUwOTdhMTk2YzA3MGUxNWRlYWFlNjY0NjRiNDJjOGUwMTQifQ==
  • Loading branch information
gcf-owl-bot[bot] authored and jskeet committed Sep 24, 2022
1 parent 96d71ba commit 191e5de
Show file tree
Hide file tree
Showing 3 changed files with 41 additions and 76 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -292,8 +292,6 @@ public enum EncodingType {

#region Messages
/// <summary>
/// ################################################################ #
///
/// Represents the input to API methods.
/// </summary>
public sealed partial class Document : pb::IMessage<Document>
Expand Down Expand Up @@ -747,8 +745,8 @@ public Sentence Clone() {
private global::Google.Cloud.Language.V1.Sentiment sentiment_;
/// <summary>
/// For calls to [AnalyzeSentiment][] or if
/// [AnnotateTextRequest.Features.extract_document_sentiment][google.cloud.language.v1.AnnotateTextRequest.Features.extract_document_sentiment]
/// is set to true, this field will contain the sentiment for the sentence.
/// [AnnotateTextRequest.Features.extract_document_sentiment][google.cloud.language.v1.AnnotateTextRequest.Features.extract_document_sentiment] is set to
/// true, this field will contain the sentiment for the sentence.
/// </summary>
[global::System.Diagnostics.DebuggerNonUserCodeAttribute]
[global::System.CodeDom.Compiler.GeneratedCode("protoc", null)]
Expand Down Expand Up @@ -1076,9 +1074,9 @@ public float Salience {
private global::Google.Cloud.Language.V1.Sentiment sentiment_;
/// <summary>
/// For calls to [AnalyzeEntitySentiment][] or if
/// [AnnotateTextRequest.Features.extract_entity_sentiment][google.cloud.language.v1.AnnotateTextRequest.Features.extract_entity_sentiment]
/// is set to true, this field will contain the aggregate sentiment expressed
/// for this entity in the provided document.
/// [AnnotateTextRequest.Features.extract_entity_sentiment][google.cloud.language.v1.AnnotateTextRequest.Features.extract_entity_sentiment] is set to
/// true, this field will contain the aggregate sentiment expressed for this
/// entity in the provided document.
/// </summary>
[global::System.Diagnostics.DebuggerNonUserCodeAttribute]
[global::System.CodeDom.Compiler.GeneratedCode("protoc", null)]
Expand Down Expand Up @@ -3739,9 +3737,9 @@ public EntityMention Clone() {
private global::Google.Cloud.Language.V1.Sentiment sentiment_;
/// <summary>
/// For calls to [AnalyzeEntitySentiment][] or if
/// [AnnotateTextRequest.Features.extract_entity_sentiment][google.cloud.language.v1.AnnotateTextRequest.Features.extract_entity_sentiment]
/// is set to true, this field will contain the sentiment expressed for this
/// mention of the entity in the provided document.
/// [AnnotateTextRequest.Features.extract_entity_sentiment][google.cloud.language.v1.AnnotateTextRequest.Features.extract_entity_sentiment] is set to
/// true, this field will contain the sentiment expressed for this mention of
/// the entity in the provided document.
/// </summary>
[global::System.Diagnostics.DebuggerNonUserCodeAttribute]
[global::System.CodeDom.Compiler.GeneratedCode("protoc", null)]
Expand Down Expand Up @@ -4045,9 +4043,7 @@ public string Content {
private int beginOffset_;
/// <summary>
/// The API calculates the beginning offset of the content in the original
/// document according to the
/// [EncodingType][google.cloud.language.v1.EncodingType] specified in the API
/// request.
/// document according to the [EncodingType][google.cloud.language.v1.EncodingType] specified in the API request.
/// </summary>
[global::System.Diagnostics.DebuggerNonUserCodeAttribute]
[global::System.CodeDom.Compiler.GeneratedCode("protoc", null)]
Expand Down Expand Up @@ -5448,8 +5444,7 @@ public AnalyzeSentimentResponse Clone() {
/// <summary>
/// The language of the text, which will be the same as the language specified
/// in the request or, if not specified, the automatically-detected language.
/// See [Document.language][google.cloud.language.v1.Document.language] field
/// for more details.
/// See [Document.language][google.cloud.language.v1.Document.language] field for more details.
/// </summary>
[global::System.Diagnostics.DebuggerNonUserCodeAttribute]
[global::System.CodeDom.Compiler.GeneratedCode("protoc", null)]
Expand Down Expand Up @@ -5966,8 +5961,7 @@ public AnalyzeEntitySentimentResponse Clone() {
/// <summary>
/// The language of the text, which will be the same as the language specified
/// in the request or, if not specified, the automatically-detected language.
/// See [Document.language][google.cloud.language.v1.Document.language] field
/// for more details.
/// See [Document.language][google.cloud.language.v1.Document.language] field for more details.
/// </summary>
[global::System.Diagnostics.DebuggerNonUserCodeAttribute]
[global::System.CodeDom.Compiler.GeneratedCode("protoc", null)]
Expand Down Expand Up @@ -6437,8 +6431,7 @@ public AnalyzeEntitiesResponse Clone() {
/// <summary>
/// The language of the text, which will be the same as the language specified
/// in the request or, if not specified, the automatically-detected language.
/// See [Document.language][google.cloud.language.v1.Document.language] field
/// for more details.
/// See [Document.language][google.cloud.language.v1.Document.language] field for more details.
/// </summary>
[global::System.Diagnostics.DebuggerNonUserCodeAttribute]
[global::System.CodeDom.Compiler.GeneratedCode("protoc", null)]
Expand Down Expand Up @@ -6923,8 +6916,7 @@ public AnalyzeSyntaxResponse Clone() {
/// <summary>
/// The language of the text, which will be the same as the language specified
/// in the request or, if not specified, the automatically-detected language.
/// See [Document.language][google.cloud.language.v1.Document.language] field
/// for more details.
/// See [Document.language][google.cloud.language.v1.Document.language] field for more details.
/// </summary>
[global::System.Diagnostics.DebuggerNonUserCodeAttribute]
[global::System.CodeDom.Compiler.GeneratedCode("protoc", null)]
Expand Down Expand Up @@ -8363,8 +8355,7 @@ public AnnotateTextResponse Clone() {
/// <summary>
/// The language of the text, which will be the same as the language specified
/// in the request or, if not specified, the automatically-detected language.
/// See [Document.language][google.cloud.language.v1.Document.language] field
/// for more details.
/// See [Document.language][google.cloud.language.v1.Document.language] field for more details.
/// </summary>
[global::System.Diagnostics.DebuggerNonUserCodeAttribute]
[global::System.CodeDom.Compiler.GeneratedCode("protoc", null)]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -532,10 +532,8 @@ public virtual AnalyzeEntitiesResponse AnalyzeEntities(Document document, Encodi
AnalyzeEntitiesAsync(document, encodingType, gaxgrpc::CallSettings.FromCancellationToken(cancellationToken));

/// <summary>
/// Finds entities, similar to
/// [AnalyzeEntities][google.cloud.language.v1.LanguageService.AnalyzeEntities]
/// in the text and analyzes sentiment associated with each entity and its
/// mentions.
/// Finds entities, similar to [AnalyzeEntities][google.cloud.language.v1.LanguageService.AnalyzeEntities] in the text and analyzes
/// sentiment associated with each entity and its mentions.
/// </summary>
/// <param name="request">The request object containing all of the parameters for the API call.</param>
/// <param name="callSettings">If not null, applies overrides to this RPC call.</param>
Expand All @@ -544,10 +542,8 @@ public virtual AnalyzeEntitySentimentResponse AnalyzeEntitySentiment(AnalyzeEnti
throw new sys::NotImplementedException();

/// <summary>
/// Finds entities, similar to
/// [AnalyzeEntities][google.cloud.language.v1.LanguageService.AnalyzeEntities]
/// in the text and analyzes sentiment associated with each entity and its
/// mentions.
/// Finds entities, similar to [AnalyzeEntities][google.cloud.language.v1.LanguageService.AnalyzeEntities] in the text and analyzes
/// sentiment associated with each entity and its mentions.
/// </summary>
/// <param name="request">The request object containing all of the parameters for the API call.</param>
/// <param name="callSettings">If not null, applies overrides to this RPC call.</param>
Expand All @@ -556,10 +552,8 @@ public virtual AnalyzeEntitySentimentResponse AnalyzeEntitySentiment(AnalyzeEnti
throw new sys::NotImplementedException();

/// <summary>
/// Finds entities, similar to
/// [AnalyzeEntities][google.cloud.language.v1.LanguageService.AnalyzeEntities]
/// in the text and analyzes sentiment associated with each entity and its
/// mentions.
/// Finds entities, similar to [AnalyzeEntities][google.cloud.language.v1.LanguageService.AnalyzeEntities] in the text and analyzes
/// sentiment associated with each entity and its mentions.
/// </summary>
/// <param name="request">The request object containing all of the parameters for the API call.</param>
/// <param name="cancellationToken">A <see cref="st::CancellationToken"/> to use for this RPC.</param>
Expand All @@ -568,10 +562,8 @@ public virtual AnalyzeEntitySentimentResponse AnalyzeEntitySentiment(AnalyzeEnti
AnalyzeEntitySentimentAsync(request, gaxgrpc::CallSettings.FromCancellationToken(cancellationToken));

/// <summary>
/// Finds entities, similar to
/// [AnalyzeEntities][google.cloud.language.v1.LanguageService.AnalyzeEntities]
/// in the text and analyzes sentiment associated with each entity and its
/// mentions.
/// Finds entities, similar to [AnalyzeEntities][google.cloud.language.v1.LanguageService.AnalyzeEntities] in the text and analyzes
/// sentiment associated with each entity and its mentions.
/// </summary>
/// <param name="document">
/// Required. Input document.
Expand All @@ -589,10 +581,8 @@ public virtual AnalyzeEntitySentimentResponse AnalyzeEntitySentiment(Document do
}, callSettings);

/// <summary>
/// Finds entities, similar to
/// [AnalyzeEntities][google.cloud.language.v1.LanguageService.AnalyzeEntities]
/// in the text and analyzes sentiment associated with each entity and its
/// mentions.
/// Finds entities, similar to [AnalyzeEntities][google.cloud.language.v1.LanguageService.AnalyzeEntities] in the text and analyzes
/// sentiment associated with each entity and its mentions.
/// </summary>
/// <param name="document">
/// Required. Input document.
Expand All @@ -610,10 +600,8 @@ public virtual AnalyzeEntitySentimentResponse AnalyzeEntitySentiment(Document do
}, callSettings);

/// <summary>
/// Finds entities, similar to
/// [AnalyzeEntities][google.cloud.language.v1.LanguageService.AnalyzeEntities]
/// in the text and analyzes sentiment associated with each entity and its
/// mentions.
/// Finds entities, similar to [AnalyzeEntities][google.cloud.language.v1.LanguageService.AnalyzeEntities] in the text and analyzes
/// sentiment associated with each entity and its mentions.
/// </summary>
/// <param name="document">
/// Required. Input document.
Expand Down Expand Up @@ -1011,10 +999,8 @@ public override AnalyzeEntitiesResponse AnalyzeEntities(AnalyzeEntitiesRequest r
}

/// <summary>
/// Finds entities, similar to
/// [AnalyzeEntities][google.cloud.language.v1.LanguageService.AnalyzeEntities]
/// in the text and analyzes sentiment associated with each entity and its
/// mentions.
/// Finds entities, similar to [AnalyzeEntities][google.cloud.language.v1.LanguageService.AnalyzeEntities] in the text and analyzes
/// sentiment associated with each entity and its mentions.
/// </summary>
/// <param name="request">The request object containing all of the parameters for the API call.</param>
/// <param name="callSettings">If not null, applies overrides to this RPC call.</param>
Expand All @@ -1026,10 +1012,8 @@ public override AnalyzeEntitySentimentResponse AnalyzeEntitySentiment(AnalyzeEnt
}

/// <summary>
/// Finds entities, similar to
/// [AnalyzeEntities][google.cloud.language.v1.LanguageService.AnalyzeEntities]
/// in the text and analyzes sentiment associated with each entity and its
/// mentions.
/// Finds entities, similar to [AnalyzeEntities][google.cloud.language.v1.LanguageService.AnalyzeEntities] in the text and analyzes
/// sentiment associated with each entity and its mentions.
/// </summary>
/// <param name="request">The request object containing all of the parameters for the API call.</param>
/// <param name="callSettings">If not null, applies overrides to this RPC call.</param>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
// source: google/cloud/language/v1/language_service.proto
// </auto-generated>
// Original file comments:
// Copyright 2019 Google LLC.
// Copyright 2022 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -174,10 +174,8 @@ public abstract partial class LanguageServiceBase
}

/// <summary>
/// Finds entities, similar to
/// [AnalyzeEntities][google.cloud.language.v1.LanguageService.AnalyzeEntities]
/// in the text and analyzes sentiment associated with each entity and its
/// mentions.
/// Finds entities, similar to [AnalyzeEntities][google.cloud.language.v1.LanguageService.AnalyzeEntities] in the text and analyzes
/// sentiment associated with each entity and its mentions.
/// </summary>
/// <param name="request">The request received from the client.</param>
/// <param name="context">The context of the server-side call handler being invoked.</param>
Expand Down Expand Up @@ -361,10 +359,8 @@ protected LanguageServiceClient(ClientBaseConfiguration configuration) : base(co
return CallInvoker.AsyncUnaryCall(__Method_AnalyzeEntities, null, options, request);
}
/// <summary>
/// Finds entities, similar to
/// [AnalyzeEntities][google.cloud.language.v1.LanguageService.AnalyzeEntities]
/// in the text and analyzes sentiment associated with each entity and its
/// mentions.
/// Finds entities, similar to [AnalyzeEntities][google.cloud.language.v1.LanguageService.AnalyzeEntities] in the text and analyzes
/// sentiment associated with each entity and its mentions.
/// </summary>
/// <param name="request">The request to send to the server.</param>
/// <param name="headers">The initial metadata to send with the call. This parameter is optional.</param>
Expand All @@ -377,10 +373,8 @@ protected LanguageServiceClient(ClientBaseConfiguration configuration) : base(co
return AnalyzeEntitySentiment(request, new grpc::CallOptions(headers, deadline, cancellationToken));
}
/// <summary>
/// Finds entities, similar to
/// [AnalyzeEntities][google.cloud.language.v1.LanguageService.AnalyzeEntities]
/// in the text and analyzes sentiment associated with each entity and its
/// mentions.
/// Finds entities, similar to [AnalyzeEntities][google.cloud.language.v1.LanguageService.AnalyzeEntities] in the text and analyzes
/// sentiment associated with each entity and its mentions.
/// </summary>
/// <param name="request">The request to send to the server.</param>
/// <param name="options">The options for the call.</param>
Expand All @@ -391,10 +385,8 @@ protected LanguageServiceClient(ClientBaseConfiguration configuration) : base(co
return CallInvoker.BlockingUnaryCall(__Method_AnalyzeEntitySentiment, null, options, request);
}
/// <summary>
/// Finds entities, similar to
/// [AnalyzeEntities][google.cloud.language.v1.LanguageService.AnalyzeEntities]
/// in the text and analyzes sentiment associated with each entity and its
/// mentions.
/// Finds entities, similar to [AnalyzeEntities][google.cloud.language.v1.LanguageService.AnalyzeEntities] in the text and analyzes
/// sentiment associated with each entity and its mentions.
/// </summary>
/// <param name="request">The request to send to the server.</param>
/// <param name="headers">The initial metadata to send with the call. This parameter is optional.</param>
Expand All @@ -407,10 +399,8 @@ protected LanguageServiceClient(ClientBaseConfiguration configuration) : base(co
return AnalyzeEntitySentimentAsync(request, new grpc::CallOptions(headers, deadline, cancellationToken));
}
/// <summary>
/// Finds entities, similar to
/// [AnalyzeEntities][google.cloud.language.v1.LanguageService.AnalyzeEntities]
/// in the text and analyzes sentiment associated with each entity and its
/// mentions.
/// Finds entities, similar to [AnalyzeEntities][google.cloud.language.v1.LanguageService.AnalyzeEntities] in the text and analyzes
/// sentiment associated with each entity and its mentions.
/// </summary>
/// <param name="request">The request to send to the server.</param>
/// <param name="options">The options for the call.</param>
Expand Down

0 comments on commit 191e5de

Please sign in to comment.