Add XML comments to public entities.

This commit is contained in:
2021-08-17 13:56:04 +01:00
parent 6e744af7f3
commit f7fa226727
4 changed files with 66 additions and 0 deletions

View File

@@ -40,10 +40,18 @@ using Marshal = Aaru.Helpers.Marshal;
namespace Aaru.Decoders.Sega
{
/// <summary>
/// Represents the IP.BIN from a SEGA Dreamcast
/// </summary>
[SuppressMessage("ReSharper", "InconsistentNaming"), SuppressMessage("ReSharper", "MemberCanBeInternal"),
SuppressMessage("ReSharper", "MemberCanBePrivate.Global")]
public static class Dreamcast
{
/// <summary>
/// Decodes an IP.BIN sector in Dreamcast format
/// </summary>
/// <param name="ipbin_sector">IP.BIN sector</param>
/// <returns>Decoded IP.BIN</returns>
public static IPBin? DecodeIPBin(byte[] ipbin_sector)
{
if(ipbin_sector == null)
@@ -105,6 +113,11 @@ namespace Aaru.Decoders.Sega
return Encoding.ASCII.GetString(ipbin.SegaHardwareID) == "SEGA SEGAKATANA " ? ipbin : (IPBin?)null;
}
/// <summary>
/// Pretty prints a decoded IP.BIN in Dreamcast format
/// </summary>
/// <param name="decoded">Decoded IP.BIN</param>
/// <returns>Description of the IP.BIN contents</returns>
public static string Prettify(IPBin? decoded)
{
if(decoded == null)
@@ -257,6 +270,9 @@ namespace Aaru.Decoders.Sega
return IPBinInformation.ToString();
}
/// <summary>
/// SEGA IP.BIN format for Dreamcast
/// </summary>
[StructLayout(LayoutKind.Sequential, Pack = 1)]
public struct IPBin
{