cloudevents
/
sdk-csharp
mirror of https://github.com/cloudevents/sdk-csharp.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fix XML documentation for existing ToCloudEventBatch methods 

Signed-off-by: Jon Skeet <jonskeet@google.com>
This commit is contained in:
Jon Skeet 2021-06-29 14:22:53 +01:00 committed by Jon Skeet
parent a2a4c71880
commit 626089ea1e
2 changed files with 22 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
src/CloudNative.CloudEvents.AspNetCore/HttpRequestExtensions.cs
View File

@ -118,9 +118,9 @@ namespace CloudNative.CloudEvents.AspNetCore
/// </summary>
/// <param name="httpRequest">The HTTP request to decode. Must not be null.</param>
/// <param name="formatter">The event formatter to use to process the request body. Must not be null.</param>
/// <param name="extensionAttributes">The extension attributes to use when populating the CloudEvent. May be null.</param>
/// <returns>The decoded CloudEvent.</returns>
/// <exception cref="ArgumentException">The request does not contain a CloudEvent.</exception>
/// <param name="extensionAttributes">The extension attributes to use when populating the CloudEvents. May be null.</param>
/// <returns>The decoded batch of CloudEvents.</returns>
/// <exception cref="ArgumentException">The request does not contain a CloudEvent batch.</exception>
public static Task<IReadOnlyList<CloudEvent>> ToCloudEventBatchAsync(
this HttpRequest httpRequest,
CloudEventFormatter formatter,
@ -132,9 +132,9 @@ namespace CloudNative.CloudEvents.AspNetCore
/// </summary>
/// <param name="httpRequest">The HTTP request to decode. Must not be null.</param>
/// <param name="formatter">The event formatter to use to process the request body. Must not be null.</param>
/// <param name="extensionAttributes">The extension attributes to use when populating the CloudEvent. May be null.</param>
/// <returns>The decoded CloudEvent.</returns>
/// <exception cref="ArgumentException">The request does not contain a CloudEvent.</exception>
/// <param name="extensionAttributes">The extension attributes to use when populating the CloudEvents. May be null.</param>
/// <returns>The decoded batch of CloudEvents.</returns>
/// <exception cref="ArgumentException">The request does not contain a CloudEvent batch.</exception>
public static async Task<IReadOnlyList<CloudEvent>> ToCloudEventBatchAsync(
this HttpRequest httpRequest,
CloudEventFormatter formatter,

32
src/CloudNative.CloudEvents/Http/HttpClientExtensions.cs
View File

@ -177,12 +177,12 @@ namespace CloudNative.CloudEvents.Http
}
/// <summary>
/// Converts this HTTP response message into a CloudEvent object
/// Converts this HTTP response message into a CloudEvent batch.
/// </summary>
/// <param name="httpResponseMessage">The HTTP response message to convert. Must not be null.</param>
/// <param name="formatter">The event formatter to use to parse the CloudEvent. Must not be null.</param>
/// <param name="extensionAttributes">The extension attributes to use when parsing the CloudEvent. May be null.</param>
/// <returns>A reference to a validated CloudEvent instance.</returns>
/// <param name="formatter">The event formatter to use to parse the CloudEvents. Must not be null.</param>
/// <param name="extensionAttributes">The extension attributes to use when parsing the CloudEvents. May be null.</param>
/// <returns>The decoded batch of CloudEvents.</returns>
public static Task<IReadOnlyList<CloudEvent>> ToCloudEventBatchAsync(
this HttpResponseMessage httpResponseMessage,
CloudEventFormatter formatter,
@ -190,12 +190,12 @@ namespace CloudNative.CloudEvents.Http
ToCloudEventBatchAsync(httpResponseMessage, formatter, (IEnumerable<CloudEventAttribute>) extensionAttributes);
/// <summary>
/// Converts this HTTP response message into a CloudEvent object
/// Converts this HTTP response message into a CloudEvent batch.
/// </summary>
/// <param name="httpResponseMessage">The HTTP response message to convert. Must not be null.</param>
/// <param name="formatter">The event formatter to use to parse the CloudEvent. Must not be null.</param>
/// <param name="extensionAttributes">The extension attributes to use when parsing the CloudEvent. May be null.</param>
/// <returns>A reference to a validated CloudEvent instance.</returns>
/// <param name="formatter">The event formatter to use to parse the CloudEvents. Must not be null.</param>
/// <param name="extensionAttributes">The extension attributes to use when parsing the CloudEvents. May be null.</param>
/// <returns>The decoded batch of CloudEvents.</returns>
public static Task<IReadOnlyList<CloudEvent>> ToCloudEventBatchAsync(
this HttpResponseMessage httpResponseMessage,
CloudEventFormatter formatter,
@ -206,12 +206,12 @@ namespace CloudNative.CloudEvents.Http
}
/// <summary>
/// Converts this HTTP request message into a CloudEvent object.
/// Converts this HTTP request message into a CloudEvent batch.
/// </summary>
/// <param name="httpRequestMessage">The HTTP request message to convert. Must not be null.</param>
/// <param name="formatter">The event formatter to use to parse the CloudEvent. Must not be null.</param>
/// <param name="extensionAttributes">The extension attributes to use when parsing the CloudEvent. May be null.</param>
/// <returns>A reference to a validated CloudEvent instance.</returns>
/// <param name="formatter">The event formatter to use to parse the CloudEvents. Must not be null.</param>
/// <param name="extensionAttributes">The extension attributes to use when parsing the CloudEvents. May be null.</param>
/// <returns>The decoded batch of CloudEvents.</returns>
public static Task<IReadOnlyList<CloudEvent>> ToCloudEventBatchAsync(
this HttpRequestMessage httpRequestMessage,
CloudEventFormatter formatter,
@ -219,12 +219,12 @@ namespace CloudNative.CloudEvents.Http
ToCloudEventBatchAsync(httpRequestMessage, formatter, (IEnumerable<CloudEventAttribute>) extensionAttributes);
/// <summary>
/// Converts this HTTP request message into a CloudEvent object.
/// Converts this HTTP request message into a CloudEvent batch.
/// </summary>
/// <param name="httpRequestMessage">The HTTP request message to convert. Must not be null.</param>
/// <param name="formatter">The event formatter to use to parse the CloudEvent. Must not be null.</param>
/// <param name="extensionAttributes">The extension attributes to use when parsing the CloudEvent. May be null.</param>
/// <returns>A reference to a validated CloudEvent instance.</returns>
/// <param name="formatter">The event formatter to use to parse the CloudEvents. Must not be null.</param>
/// <param name="extensionAttributes">The extension attributes to use when parsing the CloudEvents. May be null.</param>
/// <returns>The decoded batch of CloudEvents.</returns>
public static Task<IReadOnlyList<CloudEvent>> ToCloudEventBatchAsync(
this HttpRequestMessage httpRequestMessage,
CloudEventFormatter formatter,