Commit 44cf070c authored by Ray Koopa's avatar Ray Koopa

Fix some grammar in documentation.

parent e04f3507
......@@ -12,14 +12,14 @@ namespace Syroot.BinaryData
// ---- Read 1 UInt16 ----
/// <summary>
/// Returns an <see cref="UInt16"/> instance read from the underlying stream.
/// Returns a <see cref="UInt16"/> instance read from the underlying stream.
/// </summary>
/// <returns>The value read from the current stream.</returns>
public UInt16 ReadUInt16()
=> BaseStream.ReadUInt16(ByteConverter);
/// <summary>
/// Returns an <see cref="UInt16"/> instance read asynchronously from the underlying stream.
/// Returns a <see cref="UInt16"/> instance read asynchronously from the underlying stream.
/// </summary>
/// <param name="cancellationToken">The token to monitor for cancellation requests.</param>
/// <returns>The value read from the current stream.</returns>
......@@ -50,14 +50,14 @@ namespace Syroot.BinaryData
// ---- Write 1 UInt16 ----
/// <summary>
/// Writes an <see cref="UInt16"/> value to the underlying stream.
/// Writes a <see cref="UInt16"/> value to the underlying stream.
/// </summary>
/// <param name="value">The value to write.</param>
public void Write(UInt16 value)
=> BaseStream.Write(value, ByteConverter);
/// <summary>
/// Writes an <see cref="UInt16"/> value asynchronously to the underlying stream.
/// Writes a <see cref="UInt16"/> value asynchronously to the underlying stream.
/// </summary>
/// <param name="value">The value to write.</param>
/// <param name="cancellationToken">The token to monitor for cancellation requests.</param>
......@@ -66,14 +66,14 @@ namespace Syroot.BinaryData
=> await BaseStream.WriteAsync(value, ByteConverter, cancellationToken);
/// <summary>
/// Writes an <see cref="UInt16"/> value to the underlying stream.
/// Writes a <see cref="UInt16"/> value to the underlying stream.
/// </summary>
/// <param name="value">The value to write.</param>
public void WriteUInt16(UInt16 value)
=> BaseStream.Write(value, ByteConverter);
/// <summary>
/// Writes an <see cref="UInt16"/> value to the underlying stream.
/// Writes a <see cref="UInt16"/> value to the underlying stream.
/// </summary>
/// <param name="value">The value to write.</param>
/// <param name="cancellationToken">The token to monitor for cancellation requests.</param>
......
......@@ -12,14 +12,14 @@ namespace Syroot.BinaryData
// ---- Read 1 UInt32 ----
/// <summary>
/// Returns an <see cref="UInt32"/> instance read from the underlying stream.
/// Returns a <see cref="UInt32"/> instance read from the underlying stream.
/// </summary>
/// <returns>The value read from the current stream.</returns>
public UInt32 ReadUInt32()
=> BaseStream.ReadUInt32(ByteConverter);
/// <summary>
/// Returns an <see cref="UInt32"/> instance read asynchronously from the underlying stream.
/// Returns a <see cref="UInt32"/> instance read asynchronously from the underlying stream.
/// </summary>
/// <param name="cancellationToken">The token to monitor for cancellation requests.</param>
/// <returns>The value read from the current stream.</returns>
......@@ -50,14 +50,14 @@ namespace Syroot.BinaryData
// ---- Write 1 UInt32 ----
/// <summary>
/// Writes an <see cref="UInt32"/> value to the underlying stream.
/// Writes a <see cref="UInt32"/> value to the underlying stream.
/// </summary>
/// <param name="value">The value to write.</param>
public void Write(UInt32 value)
=> BaseStream.Write(value, ByteConverter);
/// <summary>
/// Writes an <see cref="UInt32"/> value asynchronously to the underlying stream.
/// Writes a <see cref="UInt32"/> value asynchronously to the underlying stream.
/// </summary>
/// <param name="value">The value to write.</param>
/// <param name="cancellationToken">The token to monitor for cancellation requests.</param>
......@@ -66,14 +66,14 @@ namespace Syroot.BinaryData
=> await BaseStream.WriteAsync(value, ByteConverter, cancellationToken);
/// <summary>
/// Writes an <see cref="UInt32"/> value to the underlying stream.
/// Writes a <see cref="UInt32"/> value to the underlying stream.
/// </summary>
/// <param name="value">The value to write.</param>
public void WriteUInt32(UInt32 value)
=> BaseStream.Write(value, ByteConverter);
/// <summary>
/// Writes an <see cref="UInt32"/> value to the underlying stream.
/// Writes a <see cref="UInt32"/> value to the underlying stream.
/// </summary>
/// <param name="value">The value to write.</param>
/// <param name="cancellationToken">The token to monitor for cancellation requests.</param>
......
......@@ -12,14 +12,14 @@ namespace Syroot.BinaryData
// ---- Read 1 UInt64 ----
/// <summary>
/// Returns an <see cref="UInt64"/> instance read from the underlying stream.
/// Returns a <see cref="UInt64"/> instance read from the underlying stream.
/// </summary>
/// <returns>The value read from the current stream.</returns>
public UInt64 ReadUInt64()
=> BaseStream.ReadUInt64(ByteConverter);
/// <summary>
/// Returns an <see cref="UInt64"/> instance read asynchronously from the underlying stream.
/// Returns a <see cref="UInt64"/> instance read asynchronously from the underlying stream.
/// </summary>
/// <param name="cancellationToken">The token to monitor for cancellation requests.</param>
/// <returns>The value read from the current stream.</returns>
......@@ -50,14 +50,14 @@ namespace Syroot.BinaryData
// ---- Write 1 UInt64 ----
/// <summary>
/// Writes an <see cref="UInt64"/> value to the underlying stream.
/// Writes a <see cref="UInt64"/> value to the underlying stream.
/// </summary>
/// <param name="value">The value to write.</param>
public void Write(UInt64 value)
=> BaseStream.Write(value, ByteConverter);
/// <summary>
/// Writes an <see cref="UInt64"/> value asynchronously to the underlying stream.
/// Writes a <see cref="UInt64"/> value asynchronously to the underlying stream.
/// </summary>
/// <param name="value">The value to write.</param>
/// <param name="cancellationToken">The token to monitor for cancellation requests.</param>
......@@ -66,14 +66,14 @@ namespace Syroot.BinaryData
=> await BaseStream.WriteAsync(value, ByteConverter, cancellationToken);
/// <summary>
/// Writes an <see cref="UInt64"/> value to the underlying stream.
/// Writes a <see cref="UInt64"/> value to the underlying stream.
/// </summary>
/// <param name="value">The value to write.</param>
public void WriteUInt64(UInt64 value)
=> BaseStream.Write(value, ByteConverter);
/// <summary>
/// Writes an <see cref="UInt64"/> value to the underlying stream.
/// Writes a <see cref="UInt64"/> value to the underlying stream.
/// </summary>
/// <param name="value">The value to write.</param>
/// <param name="cancellationToken">The token to monitor for cancellation requests.</param>
......
......@@ -73,7 +73,7 @@ namespace Syroot.BinaryData
// ---- Write 1 UInt16 ----
/// <summary>
/// Writes an <see cref="UInt16"/> value to the <paramref name="stream"/>.
/// Writes a <see cref="UInt16"/> value to the <paramref name="stream"/>.
/// </summary>
/// <param name="stream">The extended <see cref="Stream"/> instance.</param>
/// <param name="value">The value to write.</param>
......@@ -86,7 +86,7 @@ namespace Syroot.BinaryData
}
/// <summary>
/// Writes an <see cref="UInt16"/> value asynchronously to the <paramref name="stream"/>.
/// Writes a <see cref="UInt16"/> value asynchronously to the <paramref name="stream"/>.
/// </summary>
/// <param name="stream">The extended <see cref="Stream"/> instance.</param>
/// <param name="value">The value to write.</param>
......@@ -101,7 +101,7 @@ namespace Syroot.BinaryData
}
/// <summary>
/// Writes an <see cref="UInt16"/> value to the <paramref name="stream"/>.
/// Writes a <see cref="UInt16"/> value to the <paramref name="stream"/>.
/// </summary>
/// <param name="stream">The extended <see cref="Stream"/> instance.</param>
/// <param name="value">The value to write.</param>
......@@ -112,7 +112,7 @@ namespace Syroot.BinaryData
}
/// <summary>
/// Writes an <see cref="UInt16"/> value asynchronously to the <paramref name="stream"/>.
/// Writes a <see cref="UInt16"/> value asynchronously to the <paramref name="stream"/>.
/// </summary>
/// <param name="stream">The extended <see cref="Stream"/> instance.</param>
/// <param name="value">The value to write.</param>
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment