Clarified EncodedString ctor comment

This commit is contained in:
Greg Edwards
2015-04-21 21:31:53 -04:00
parent 1900c5fa45
commit d582fbc2b5
2 changed files with 20 additions and 0 deletions

View File

@@ -35,6 +35,11 @@ namespace PkmnFoundations.Support
AssignData(trim);
}
/// <summary>
/// Instances an EncodedString4 from a Unicode string.
/// </summary>
/// <param name="text">text</param>
/// <param name="length">Length of encoded buffer in bytes (not chars)</param>
public EncodedString4(String text, int length)
{
if (length < 2) throw new ArgumentOutOfRangeException("length");

View File

@@ -8,11 +8,21 @@ namespace PkmnFoundations.Support
{
public class EncodedString5
{
/// <summary>
/// Instances an EncodedString5 from its binary representation.
/// </summary>
/// <param name="data">This buffer is copied.</param>
public EncodedString5(byte[] data)
{
RawData = data;
}
/// <summary>
/// Instances an EncodedString5 from its binary representation.
/// </summary>
/// <param name="data">Buffer to copy from</param>
/// <param name="start">Offset in buffer</param>
/// <param name="length">Number of bytes (not chars) to copy</param>
public EncodedString5(byte[] data, int start, int length)
{
if (data.Length < start + length) throw new ArgumentOutOfRangeException("length");
@@ -25,6 +35,11 @@ namespace PkmnFoundations.Support
AssignData(trim);
}
/// <summary>
/// Instances an EncodedString5 from a Unicode string.
/// </summary>
/// <param name="text">text</param>
/// <param name="length">Length of encoded buffer in bytes (not chars)</param>
public EncodedString5(String text, int length)
{
if (length < 2) throw new ArgumentOutOfRangeException("length");