Add summary of ReadBitsInt{Be,Le}() methods

This commit is contained in:
Petr Pucil 2020-10-03 17:52:06 +02:00
parent 1b66a9a85f
commit 4fa7e16050
1 changed files with 8 additions and 1 deletions

View File

@ -287,6 +287,10 @@ namespace Kaitai
BitsLeft = 0;
}
/// <summary>
/// Read a n-bit integer in a big-endian manner from the stream
/// </summary>
/// <returns></returns>
public ulong ReadBitsIntBe(int n)
{
int bitsNeeded = n - BitsLeft;
@ -324,7 +328,10 @@ namespace Kaitai
return ReadBitsIntBe(n);
}
//Method ported from algorithm specified @ issue#155
/// <summary>
/// Read a n-bit integer in a little-endian manner from the stream
/// </summary>
/// <returns></returns>
public ulong ReadBitsIntLe(int n)
{
int bitsNeeded = n - BitsLeft;