aaru-dps/Aaru
1
0
Fork 0
mirror of https://github.com/aaru-dps/Aaru.git synced 2025-12-16 19:24:25 +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 6e744af7f3
commit f7fa226727
4 changed files with 66 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
LisaTag.cs
View File

@@ -36,10 +36,19 @@ using Aaru.Helpers;
namespace Aaru.Decoders
{
/// <summary>
/// Represents a Lisa Office 7/7 sector tag
/// </summary>
[SuppressMessage("ReSharper", "MemberCanBeInternal"), SuppressMessage("ReSharper", "NotAccessedField.Global"),
SuppressMessage("ReSharper", "MemberCanBePrivate.Global")]
[SuppressMessage("ReSharper", "StructMemberCanBeMadeReadOnly")]
public static class LisaTag
{
/// <summary>
/// Decodes tag from a 3.5" Sony micro-floppy
/// </summary>
/// <param name="tag">Byte array containing raw tag data</param>
/// <returns>Decoded tag in Sony's format</returns>
public static SonyTag? DecodeSonyTag(byte[] tag)
{
if(tag == null ||
@@ -64,6 +73,11 @@ namespace Aaru.Decoders
return snTag;
}
/// <summary>
/// Decodes tag from a Profile
/// </summary>
/// <param name="tag">Byte array containing raw tag data</param>
/// <returns>Decoded tag in Profile's format</returns>
public static ProfileTag? DecodeProfileTag(byte[] tag)
{
if(tag == null ||
@@ -109,6 +123,11 @@ namespace Aaru.Decoders
return phTag;
}
/// <summary>
/// Decodes tag from a Priam
/// </summary>
/// <param name="tag">Byte array containing raw tag data</param>
/// <returns>Decoded tag in Priam's format</returns>
public static PriamTag? DecodePriamTag(byte[] tag)
{
if(tag == null ||
@@ -156,6 +175,11 @@ namespace Aaru.Decoders
return pmTag;
}
/// <summary>
/// Decodes tag from any known format
/// </summary>
/// <param name="tag">Byte array containing raw tag data</param>
/// <returns>Decoded tag in Priam's format</returns>
public static PriamTag? DecodeTag(byte[] tag)
{
if(tag == null)

13
Sega/CD.cs
View File

@@ -40,10 +40,18 @@ using Marshal = Aaru.Helpers.Marshal;
namespace Aaru.Decoders.Sega
{
/// <summary>
/// Represents the IP.BIN from a SEGA CD / MEGA CD
/// </summary>
[SuppressMessage("ReSharper", "InconsistentNaming"), SuppressMessage("ReSharper", "MemberCanBeInternal"),
SuppressMessage("ReSharper", "MemberCanBePrivate.Global")]
public static class CD
{
/// <summary>
/// Decodes an IP.BIN sector in SEGA CD / MEGA CD 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)
@@ -117,6 +125,11 @@ namespace Aaru.Decoders.Sega
: (IPBin?)null;
}
/// <summary>
/// Pretty prints a decoded IP.BIN in SEGA CD / MEGA CD 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)

16
Sega/Dreamcast.cs
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
{

13
Sega/Saturn.cs
View File

@@ -40,10 +40,18 @@ using Marshal = Aaru.Helpers.Marshal;
namespace Aaru.Decoders.Sega
{
/// <summary>
/// Represents the IP.BIN from a SEGA Saturn
/// </summary>
[SuppressMessage("ReSharper", "InconsistentNaming"), SuppressMessage("ReSharper", "MemberCanBeInternal"),
SuppressMessage("ReSharper", "MemberCanBePrivate.Global")]
public static class Saturn
{
/// <summary>
/// Decodes an IP.BIN sector in Saturn 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)
@@ -95,6 +103,11 @@ namespace Aaru.Decoders.Sega
return Encoding.ASCII.GetString(ipbin.SegaHardwareID) == "SEGA SEGASATURN " ? ipbin : (IPBin?)null;
}
/// <summary>
/// Pretty prints a decoded IP.BIN in Saturn 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)