diff --git a/LisaTag.cs b/LisaTag.cs
index 50289ba7b..10c6f5898 100644
--- a/LisaTag.cs
+++ b/LisaTag.cs
@@ -36,10 +36,19 @@ using Aaru.Helpers;
namespace Aaru.Decoders
{
+ ///
+ /// Represents a Lisa Office 7/7 sector tag
+ ///
[SuppressMessage("ReSharper", "MemberCanBeInternal"), SuppressMessage("ReSharper", "NotAccessedField.Global"),
SuppressMessage("ReSharper", "MemberCanBePrivate.Global")]
+ [SuppressMessage("ReSharper", "StructMemberCanBeMadeReadOnly")]
public static class LisaTag
{
+ ///
+ /// Decodes tag from a 3.5" Sony micro-floppy
+ ///
+ /// Byte array containing raw tag data
+ /// Decoded tag in Sony's format
public static SonyTag? DecodeSonyTag(byte[] tag)
{
if(tag == null ||
@@ -64,6 +73,11 @@ namespace Aaru.Decoders
return snTag;
}
+ ///
+ /// Decodes tag from a Profile
+ ///
+ /// Byte array containing raw tag data
+ /// Decoded tag in Profile's format
public static ProfileTag? DecodeProfileTag(byte[] tag)
{
if(tag == null ||
@@ -109,6 +123,11 @@ namespace Aaru.Decoders
return phTag;
}
+ ///
+ /// Decodes tag from a Priam
+ ///
+ /// Byte array containing raw tag data
+ /// Decoded tag in Priam's format
public static PriamTag? DecodePriamTag(byte[] tag)
{
if(tag == null ||
@@ -156,6 +175,11 @@ namespace Aaru.Decoders
return pmTag;
}
+ ///
+ /// Decodes tag from any known format
+ ///
+ /// Byte array containing raw tag data
+ /// Decoded tag in Priam's format
public static PriamTag? DecodeTag(byte[] tag)
{
if(tag == null)
diff --git a/Sega/CD.cs b/Sega/CD.cs
index 292543366..7a7aba7fc 100644
--- a/Sega/CD.cs
+++ b/Sega/CD.cs
@@ -40,10 +40,18 @@ using Marshal = Aaru.Helpers.Marshal;
namespace Aaru.Decoders.Sega
{
+ ///
+ /// Represents the IP.BIN from a SEGA CD / MEGA CD
+ ///
[SuppressMessage("ReSharper", "InconsistentNaming"), SuppressMessage("ReSharper", "MemberCanBeInternal"),
SuppressMessage("ReSharper", "MemberCanBePrivate.Global")]
public static class CD
{
+ ///
+ /// Decodes an IP.BIN sector in SEGA CD / MEGA CD format
+ ///
+ /// IP.BIN sector
+ /// Decoded IP.BIN
public static IPBin? DecodeIPBin(byte[] ipbin_sector)
{
if(ipbin_sector == null)
@@ -117,6 +125,11 @@ namespace Aaru.Decoders.Sega
: (IPBin?)null;
}
+ ///
+ /// Pretty prints a decoded IP.BIN in SEGA CD / MEGA CD format
+ ///
+ /// Decoded IP.BIN
+ /// Description of the IP.BIN contents
public static string Prettify(IPBin? decoded)
{
if(decoded == null)
diff --git a/Sega/Dreamcast.cs b/Sega/Dreamcast.cs
index 91bd15350..5944eb2b0 100644
--- a/Sega/Dreamcast.cs
+++ b/Sega/Dreamcast.cs
@@ -40,10 +40,18 @@ using Marshal = Aaru.Helpers.Marshal;
namespace Aaru.Decoders.Sega
{
+ ///
+ /// Represents the IP.BIN from a SEGA Dreamcast
+ ///
[SuppressMessage("ReSharper", "InconsistentNaming"), SuppressMessage("ReSharper", "MemberCanBeInternal"),
SuppressMessage("ReSharper", "MemberCanBePrivate.Global")]
public static class Dreamcast
{
+ ///
+ /// Decodes an IP.BIN sector in Dreamcast format
+ ///
+ /// IP.BIN sector
+ /// Decoded IP.BIN
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;
}
+ ///
+ /// Pretty prints a decoded IP.BIN in Dreamcast format
+ ///
+ /// Decoded IP.BIN
+ /// Description of the IP.BIN contents
public static string Prettify(IPBin? decoded)
{
if(decoded == null)
@@ -257,6 +270,9 @@ namespace Aaru.Decoders.Sega
return IPBinInformation.ToString();
}
+ ///
+ /// SEGA IP.BIN format for Dreamcast
+ ///
[StructLayout(LayoutKind.Sequential, Pack = 1)]
public struct IPBin
{
diff --git a/Sega/Saturn.cs b/Sega/Saturn.cs
index d8225ad2b..c4742a192 100644
--- a/Sega/Saturn.cs
+++ b/Sega/Saturn.cs
@@ -40,10 +40,18 @@ using Marshal = Aaru.Helpers.Marshal;
namespace Aaru.Decoders.Sega
{
+ ///
+ /// Represents the IP.BIN from a SEGA Saturn
+ ///
[SuppressMessage("ReSharper", "InconsistentNaming"), SuppressMessage("ReSharper", "MemberCanBeInternal"),
SuppressMessage("ReSharper", "MemberCanBePrivate.Global")]
public static class Saturn
{
+ ///
+ /// Decodes an IP.BIN sector in Saturn format
+ ///
+ /// IP.BIN sector
+ /// Decoded IP.BIN
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;
}
+ ///
+ /// Pretty prints a decoded IP.BIN in Saturn format
+ ///
+ /// Decoded IP.BIN
+ /// Description of the IP.BIN contents
public static string Prettify(IPBin? decoded)
{
if(decoded == null)