Skip to content

Commit 6ce1433

Browse files
Updated documentation.
1 parent b2631f0 commit 6ce1433

File tree

3 files changed

+37
-13
lines changed

3 files changed

+37
-13
lines changed

Open.Serialization/DefaultMethods.cs

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,9 @@ namespace Open.Serialization
1212
// But retained public for use externally.
1313
public static class DefaultMethods
1414
{
15-
/// <inheritdoc cref="IDeserializeObjectAsync.DeserializeAsync(Stream, Type, CancellationToken))" />
15+
/// <summary>
16+
/// Deserializes a stream to the specified type.
17+
/// </summary>
1618
public static async ValueTask<object?> DeserializeAsync(IDeserializeObject deserializer, Stream source, Type type)
1719
{
1820
if (deserializer is null) throw new ArgumentNullException(nameof(deserializer));
@@ -24,7 +26,9 @@ public static class DefaultMethods
2426
return deserializer.Deserialize(text, type);
2527
}
2628

27-
/// <inheritdoc cref="ISerializeObjectAsync.SerializeAsync(Stream, object, Type, CancellationToken)"/>
29+
/// <summary>
30+
/// Serializes the provided item to a stream.
31+
/// </summary>
2832
public static async ValueTask SerializeAsync(ISerializeObject serializer, Stream target, object? item, Type type)
2933
{
3034
if (serializer is null) throw new ArgumentNullException(nameof(serializer));
@@ -35,7 +39,9 @@ public static async ValueTask SerializeAsync(ISerializeObject serializer, Stream
3539
await writer.WriteAsync(text).ConfigureAwait(false);
3640
}
3741

38-
/// <inheritdoc cref="IDeserializeAsync.DeserializeAsync{T}(Stream, CancellationToken)"/>
42+
/// <summary>
43+
/// Deserializes a stream to the specified type.
44+
/// </summary>
3945
public static async ValueTask<T> DeserializeAsync<T>(IDeserialize deserializer, Stream source)
4046
{
4147
if (deserializer is null) throw new ArgumentNullException(nameof(deserializer));
@@ -46,7 +52,9 @@ public static async ValueTask<T> DeserializeAsync<T>(IDeserialize deserializer,
4652
return deserializer.Deserialize<T>(text);
4753
}
4854

49-
/// <inheritdoc cref="ISerializeAsync.SerializeAsync{T}(Stream, T, CancellationToken)"/>
55+
/// <summary>
56+
/// Serializes the provided item to a stream.
57+
/// </summary>
5058
public static async ValueTask SerializeAsync<T>(ISerialize serializer, Stream target, T item)
5159
{
5260
if (serializer is null) throw new ArgumentNullException(nameof(serializer));
@@ -58,7 +66,9 @@ public static async ValueTask SerializeAsync<T>(ISerialize serializer, Stream ta
5866
}
5967

6068

61-
/// <inheritdoc cref="IDeserializeAsync{T}.DeserializeAsync(Stream, CancellationToken)"/>
69+
/// <summary>
70+
/// Deserializes a stream to the specified type.
71+
/// </summary>
6272
public static async ValueTask<T> DeserializeAsync<T>(IDeserialize<T> deserializer, Stream source)
6373
{
6474
if (deserializer is null) throw new ArgumentNullException(nameof(deserializer));
@@ -69,7 +79,9 @@ public static async ValueTask<T> DeserializeAsync<T>(IDeserialize<T> deserialize
6979
return deserializer.Deserialize(text);
7080
}
7181

72-
/// <inheritdoc cref="ISerializeAsync{T}.SerializeAsync(Stream, T, CancellationToken)"/>
82+
/// <summary>
83+
/// Serializes the provided item to a stream.
84+
/// </summary>
7385
public static async ValueTask SerializeAsync<T>(ISerialize<T> serializer, Stream target, T item)
7486
{
7587
if (serializer is null) throw new ArgumentNullException(nameof(serializer));

Open.Serialization/Open.Serialization.csproj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Part of the "Open" set of libraries.
1717
<RepositoryUrl>https://github.com/electricessence/Open.Serialization</RepositoryUrl>
1818
<RepositoryType>git</RepositoryType>
1919
<PackageTags>serialization</PackageTags>
20-
<Version>2.0.1</Version>
20+
<Version>2.1.0</Version>
2121
<Nullable>enable</Nullable>
2222
<PackageReleaseNotes></PackageReleaseNotes>
2323
</PropertyGroup>

Open.Serialization/Open.Serialization.xml

Lines changed: 18 additions & 6 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)