oliverbooth/X10D
oliverbooth/X10D
1
0
Fork 0
mirror of https://github.com/oliverbooth/X10D synced 2024-11-09 23:45:42 +00:00
Code Issues

(#15) (#28) Fix xmldoc wording for Read methods

Browse Source 
Methods previously read "Writes [...] to" instead of "Reads [...] from"
This commit is contained in:
Oliver Booth 2021-03-03 18:37:43 +00:00
parent e7ba24aa69
commit ba71f814c0
1 changed files with 14 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
X10D/src/StreamExtensions/StreamExtensions.cs
View File

@ -54,7 +54,7 @@ namespace X10D.StreamExtensions
} }
/// <summary> /// <summary>
/// Writes a two-byte signed integer to the current stream using the system's default endian encoding, and advances /// Reads a two-byte signed integer from the current stream using the system's default endian encoding, and advances
/// the stream position by two bytes. /// the stream position by two bytes.
/// </summary> /// </summary>
/// <param name="stream">The stream from which the value should be read.</param> /// <param name="stream">The stream from which the value should be read.</param>
@ -65,7 +65,7 @@ namespace X10D.StreamExtensions
} }
/// <summary> /// <summary>
/// Writes a two-byte signed integer to the current stream using the specified endian encoding, and advances the /// Reads a two-byte signed integer from the current stream using the specified endian encoding, and advances the
/// stream position by two bytes. /// stream position by two bytes.
/// </summary> /// </summary>
/// <param name="stream">The stream from which the value should be read.</param> /// <param name="stream">The stream from which the value should be read.</param>
@ -78,7 +78,7 @@ namespace X10D.StreamExtensions
} }
/// <summary> /// <summary>
/// Writes a four-byte signed integer to the current stream using the system's default endian encoding, and advances /// Reads a four-byte signed integer from the current stream using the system's default endian encoding, and advances
/// the stream position by four bytes. /// the stream position by four bytes.
/// </summary> /// </summary>
/// <param name="stream">The stream from which the value should be read.</param> /// <param name="stream">The stream from which the value should be read.</param>
@ -89,7 +89,7 @@ namespace X10D.StreamExtensions
} }
/// <summary> /// <summary>
/// Writes a four-byte signed integer to the current stream using the specified endian encoding, and advances the /// Reads a four-byte signed integer from the current stream using the specified endian encoding, and advances the
/// stream position by four bytes. /// stream position by four bytes.
/// </summary> /// </summary>
/// <param name="stream">The stream from which the value should be read.</param> /// <param name="stream">The stream from which the value should be read.</param>
@ -102,8 +102,8 @@ namespace X10D.StreamExtensions
} }
/// <summary> /// <summary>
/// Writes an eight-byte signed integer to the current stream using the system's default endian encoding, and advances /// Reads an eight-byte signed integer from the current stream using the system's default endian encoding, and
/// the stream position by eight bytes. /// advances the stream position by eight bytes.
/// </summary> /// </summary>
/// <param name="stream">The stream from which the value should be read.</param> /// <param name="stream">The stream from which the value should be read.</param>
/// <returns>An eight-byte signed integer read from the stream.</returns> /// <returns>An eight-byte signed integer read from the stream.</returns>
@ -113,7 +113,7 @@ namespace X10D.StreamExtensions
} }
/// <summary> /// <summary>
/// Writes an eight-byte signed integer to the current stream using the specified endian encoding, and advances the /// Reads an eight-byte signed integer from the current stream using the specified endian encoding, and advances the
/// stream position by eight bytes. /// stream position by eight bytes.
/// </summary> /// </summary>
/// <param name="stream">The stream from which the value should be read.</param> /// <param name="stream">The stream from which the value should be read.</param>
@ -126,7 +126,7 @@ namespace X10D.StreamExtensions
} }
/// <summary> /// <summary>
/// Writes a two-byte unsigned integer to the current stream using the system's default endian encoding, and advances /// Reads a two-byte unsigned integer from the current stream using the system's default endian encoding, and advances
/// the stream position by two bytes. /// the stream position by two bytes.
/// </summary> /// </summary>
/// <param name="stream">The stream from which the value should be read.</param> /// <param name="stream">The stream from which the value should be read.</param>
@ -138,7 +138,7 @@ namespace X10D.StreamExtensions
} }
/// <summary> /// <summary>
/// Writes a two-byte unsigned integer to the current stream using the specified endian encoding, and advances the /// Reads a two-byte unsigned integer from the current stream using the specified endian encoding, and advances the
/// stream position by two bytes. /// stream position by two bytes.
/// </summary> /// </summary>
/// <param name="stream">The stream from which the value should be read.</param> /// <param name="stream">The stream from which the value should be read.</param>
@ -152,8 +152,8 @@ namespace X10D.StreamExtensions
} }
/// <summary> /// <summary>
/// Writes a four-byte unsigned integer to the current stream using the system's default endian encoding, and advances /// Reads a four-byte unsigned integer from the current stream using the system's default endian encoding, and
/// the stream position by four bytes. /// advances the stream position by four bytes.
/// </summary> /// </summary>
/// <param name="stream">The stream from which the value should be read.</param> /// <param name="stream">The stream from which the value should be read.</param>
/// <returns>An four-byte unsigned integer read from the stream.</returns> /// <returns>An four-byte unsigned integer read from the stream.</returns>
@ -164,7 +164,7 @@ namespace X10D.StreamExtensions
} }
/// <summary> /// <summary>
/// Writes a four-byte unsigned integer to the current stream using the specified endian encoding, and advances the /// Reads a four-byte unsigned integer from the current stream using the specified endian encoding, and advances the
/// stream position by four bytes. /// stream position by four bytes.
/// </summary> /// </summary>
/// <param name="stream">The stream from which the value should be read.</param> /// <param name="stream">The stream from which the value should be read.</param>
@ -178,7 +178,7 @@ namespace X10D.StreamExtensions
} }
/// <summary> /// <summary>
/// Writes an eight-byte unsigned integer to the current stream using the system's default endian encoding, and /// Reads an eight-byte unsigned integer from the current stream using the system's default endian encoding, and
/// advances the stream position by eight bytes. /// advances the stream position by eight bytes.
/// </summary> /// </summary>
/// <param name="stream">The stream from which the value should be read.</param> /// <param name="stream">The stream from which the value should be read.</param>
@ -190,7 +190,7 @@ namespace X10D.StreamExtensions
} }
/// <summary> /// <summary>
/// Writes an eight-byte unsigned integer to the current stream using the specified endian encoding, and advances the /// Reads an eight-byte unsigned integer from the current stream using the specified endian encoding, and advances the
/// stream position by eight bytes. /// stream position by eight bytes.
/// </summary> /// </summary>
/// <param name="stream">The stream from which the value should be read.</param> /// <param name="stream">The stream from which the value should be read.</param>