aaru-dps/Aaru.Checksums
1
0
Fork 0
mirror of https://github.com/aaru-dps/Aaru.Checksums.git synced 2025-12-16 19:24:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add XML comments to public entities.

Browse Source
This commit is contained in:
Natalia Portillo
2021-08-17 13:56:04 +01:00
parent b7f3192eff
commit 8ca59cbcd0
6 changed files with 63 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
CDChecksums.cs
View File

@@ -45,8 +45,21 @@ namespace Aaru.Checksums
static byte[] _eccBTable;
static uint[] _edcTable;
/// <summary>
/// Checks the EDC and ECC of a CD sector
/// </summary>
/// <param name="buffer">CD sector</param>
/// <returns><c>true</c> if all checks were correct, <c>false</c> if any of them weren't, and <c>null</c> if none of them are present.</returns>
public static bool? CheckCdSector(byte[] buffer) => CheckCdSector(buffer, out _, out _, out _);
/// <summary>
/// Checks the EDC and ECC of a CD sector
/// </summary>
/// <param name="buffer">CD sector</param>
/// <param name="correctEccP"><c>true</c> if ECC P is correct, <c>false</c> if it isn't, and <c>null</c> if there is no ECC P in sector.</param>
/// <param name="correctEccQ"><c>true</c> if ECC Q is correct, <c>false</c> if it isn't, and <c>null</c> if there is no ECC Q in sector.</param>
/// <param name="correctEdc"><c>true</c> if EDC is correct, <c>false</c> if it isn't, and <c>null</c> if there is no EDC in sector.</param>
/// <returns><c>true</c> if all checks were correct, <c>false</c> if any of them weren't, and <c>null</c> if none of them are present.</returns>
public static bool? CheckCdSector(byte[] buffer, out bool? correctEccP, out bool? correctEccQ,
out bool? correctEdc)
{