From 082c5f0d285dd67048f5d619342cf748c44b7d52 Mon Sep 17 00:00:00 2001
From: Chev <11602755+chev2@users.noreply.github.com>
Date: Mon, 11 Jan 2021 23:11:56 -0800
Subject: [PATCH] Update summaries

---
 botw-toolset/Control/TabRSTB.xaml.cs  | 2 +-
 botw-toolset/Control/TabSARC.xaml.cs  | 2 +-
 botw-toolset/Control/TabTSCB.xaml.cs  | 2 +-
 botw-toolset/Control/TabYaz0.xaml.cs  | 2 +-
 botw-toolset/Debugging/BOTWConsole.cs | 3 +++
 botw-toolset/IO/BinaryReaderBig.cs    | 2 +-
 botw-toolset/IO/BinaryWriterBig.cs    | 2 +-
 botw-toolset/IO/EXTM/Grass.cs         | 8 +++++++-
 botw-toolset/IO/EXTM/Water.cs         | 8 +++++++-
 botw-toolset/IO/HGHT.cs               | 5 +++++
 botw-toolset/IO/MATE.cs               | 8 ++++++++
 botw-toolset/IO/SARC/SARC.cs          | 9 +++++++++
 botw-toolset/IO/SARC/SFAT.cs          | 3 +++
 botw-toolset/IO/SARC/SFATNode.cs      | 3 +++
 botw-toolset/IO/SARC/SFNT.cs          | 3 +++
 botw-toolset/IO/TSCB/TSCB.cs          | 6 +++---
 botw-toolset/IO/Yaz0/Yaz0.cs          | 9 +++++++++
 17 files changed, 66 insertions(+), 11 deletions(-)

diff --git a/botw-toolset/Control/TabRSTB.xaml.cs b/botw-toolset/Control/TabRSTB.xaml.cs
index 093fdec..f84506d 100644
--- a/botw-toolset/Control/TabRSTB.xaml.cs
+++ b/botw-toolset/Control/TabRSTB.xaml.cs
@@ -3,7 +3,7 @@
 namespace BOTWToolset.Control
 {
     /// <summary>
-    /// Interaction logic for TabRSTB.xaml
+    /// Interaction logic for the RSTB tab.
     /// </summary>
     public partial class TabRSTB : UserControl
     {
diff --git a/botw-toolset/Control/TabSARC.xaml.cs b/botw-toolset/Control/TabSARC.xaml.cs
index 203b756..c5e50ab 100644
--- a/botw-toolset/Control/TabSARC.xaml.cs
+++ b/botw-toolset/Control/TabSARC.xaml.cs
@@ -7,7 +7,7 @@ using System.Windows.Controls;
 namespace BOTWToolset.Control
 {
     /// <summary>
-    /// Interaction logic for TabSARC.xaml
+    /// Interaction logic for the SARC tab.
     /// </summary>
     public partial class TabSARC : UserControl
     {
diff --git a/botw-toolset/Control/TabTSCB.xaml.cs b/botw-toolset/Control/TabTSCB.xaml.cs
index 31df0f3..08b306a 100644
--- a/botw-toolset/Control/TabTSCB.xaml.cs
+++ b/botw-toolset/Control/TabTSCB.xaml.cs
@@ -16,7 +16,7 @@ using System.Windows.Media.Imaging;
 namespace BOTWToolset.Control
 {
     /// <summary>
-    /// Control tab for TSCB management
+    /// Interaction logic for the TSCB tab.
     /// </summary>
     public partial class TabTSCB : UserControl
     {
diff --git a/botw-toolset/Control/TabYaz0.xaml.cs b/botw-toolset/Control/TabYaz0.xaml.cs
index 28615c5..830f711 100644
--- a/botw-toolset/Control/TabYaz0.xaml.cs
+++ b/botw-toolset/Control/TabYaz0.xaml.cs
@@ -9,7 +9,7 @@ using System.Windows.Controls;
 namespace BOTWToolset.Control
 {
     /// <summary>
-    /// Interaction logic for TabYaz0.xaml
+    /// Interaction logic for the Yaz0 tab.
     /// </summary>
     public partial class TabYaz0 : UserControl
     {
diff --git a/botw-toolset/Debugging/BOTWConsole.cs b/botw-toolset/Debugging/BOTWConsole.cs
index 27d47ad..fd6c9b8 100644
--- a/botw-toolset/Debugging/BOTWConsole.cs
+++ b/botw-toolset/Debugging/BOTWConsole.cs
@@ -6,6 +6,9 @@ using System.Windows.Threading;
 
 namespace BOTWToolset.Debugging
 {
+    /// <summary>
+    /// Allows for printing debug info to an in-app console.
+    /// </summary>
     static class BOTWConsole
     {
         private readonly static TextBox _console;
diff --git a/botw-toolset/IO/BinaryReaderBig.cs b/botw-toolset/IO/BinaryReaderBig.cs
index 310ec22..e51c82f 100644
--- a/botw-toolset/IO/BinaryReaderBig.cs
+++ b/botw-toolset/IO/BinaryReaderBig.cs
@@ -6,7 +6,7 @@ using System.Text;
 namespace BOTWToolset.IO
 {
     /// <summary>
-    /// Big-endian variant of BinaryReader
+    /// Big-endian variant of BinaryReader.
     /// </summary>
     public class BinaryReaderBig : BinaryReader
     {
diff --git a/botw-toolset/IO/BinaryWriterBig.cs b/botw-toolset/IO/BinaryWriterBig.cs
index 3b014ab..452bece 100644
--- a/botw-toolset/IO/BinaryWriterBig.cs
+++ b/botw-toolset/IO/BinaryWriterBig.cs
@@ -6,7 +6,7 @@ using System.Text;
 namespace BOTWToolset.IO
 {
     /// <summary>
-    /// Big-endian variant of BinaryWriter
+    /// Big-endian variant of BinaryWriter.
     /// </summary>
     public class BinaryWriterBig : BinaryWriter
     {
diff --git a/botw-toolset/IO/EXTM/Grass.cs b/botw-toolset/IO/EXTM/Grass.cs
index 663192a..0a33e90 100644
--- a/botw-toolset/IO/EXTM/Grass.cs
+++ b/botw-toolset/IO/EXTM/Grass.cs
@@ -3,7 +3,8 @@
 namespace BOTWToolset.IO.EXTM
 {
     /// <summary>
-    /// Stores info on grass data in an .extm file
+    /// Interacts with grass data in an .extm file, used in conjunction with <see cref="TSCB.TSCB"/>.
+    /// More info found on the <see href="https://zeldamods.org/wiki/Grass.extm">ZeldaMods wiki</see>.
     /// </summary>
     class Grass
     {
@@ -19,6 +20,11 @@ namespace BOTWToolset.IO.EXTM
         public byte B { get => _b; set => _b = value; }
         private byte _b;
 
+        /// <summary>
+        /// Gets an array of <see cref="Grass"/> from an array of bytes.
+        /// </summary>
+        /// <param name="bytes">The array of bytes to retrieve <see cref="Grass"/> data from.</param>
+        /// <returns><see cref="Grass"/>[] data.</returns>
         public static Grass[] FromBytes(byte[] bytes)
         {
             using (var r = new BinaryReaderBig(new MemoryStream(bytes)))
diff --git a/botw-toolset/IO/EXTM/Water.cs b/botw-toolset/IO/EXTM/Water.cs
index f2c308a..d663dbf 100644
--- a/botw-toolset/IO/EXTM/Water.cs
+++ b/botw-toolset/IO/EXTM/Water.cs
@@ -3,7 +3,8 @@
 namespace BOTWToolset.IO.EXTM
 {
     /// <summary>
-    /// Stores info on water data in an .extm file
+    /// Interacts with water data in an .extm file, used in conjunction with <see cref="TSCB.TSCB"/>.
+    /// More info found on the <see href="https://zeldamods.org/wiki/Water.extm">ZeldaMods wiki</see>.
     /// </summary>
     class Water
     {
@@ -29,6 +30,11 @@ namespace BOTWToolset.IO.EXTM
             }
         }
 
+        /// <summary>
+        /// Gets an array of <see cref="Water"/> from an array of bytes.
+        /// </summary>
+        /// <param name="bytes">The array of bytes to retrieve <see cref="Water"/> data from.</param>
+        /// <returns><see cref="Water"/>[] data.</returns>
         public static Water[] FromBytes(byte[] bytes)
         {
             using (var r = new BinaryReaderBig(new MemoryStream(bytes)))
diff --git a/botw-toolset/IO/HGHT.cs b/botw-toolset/IO/HGHT.cs
index 8f0e270..2634835 100644
--- a/botw-toolset/IO/HGHT.cs
+++ b/botw-toolset/IO/HGHT.cs
@@ -9,6 +9,11 @@ namespace BOTWToolset.IO
     {
         public ushort[] Heights;
 
+        /// <summary>
+        /// Retrieves a <see cref="HGHT"/> array from a set of bytes.
+        /// </summary>
+        /// <param name="bytes">The array of bytes to read.</param>
+        /// <returns><see cref="HGHT"/> array.</returns>
         public static HGHT FromBytes(byte[] bytes)
         {
             using (var r = new BinaryReader(new MemoryStream(bytes)))
diff --git a/botw-toolset/IO/MATE.cs b/botw-toolset/IO/MATE.cs
index 4ff0a1d..f492512 100644
--- a/botw-toolset/IO/MATE.cs
+++ b/botw-toolset/IO/MATE.cs
@@ -2,6 +2,9 @@
 
 namespace BOTWToolset.IO
 {
+    /// <summary>
+    /// Contains data for .mate files.
+    /// </summary>
     public class MATE
     {
         public byte Material0 { get => _material0; set => _material0 = value; }
@@ -13,6 +16,11 @@ namespace BOTWToolset.IO
         public byte BlendWeight { get => _blendWeight; set => _blendWeight = value; }
         private byte _blendWeight;
 
+        /// <summary>
+        /// Retrieves a <see cref="MATE"/> array from a set of bytes.
+        /// </summary>
+        /// <param name="bytes">The array of bytes to read.</param>
+        /// <returns><see cref="MATE"/> array.</returns>
         public static MATE[] FromBytes(byte[] bytes)
         {
             using (var r = new BinaryReader(new MemoryStream(bytes)))
diff --git a/botw-toolset/IO/SARC/SARC.cs b/botw-toolset/IO/SARC/SARC.cs
index 83c2b4a..4d84835 100644
--- a/botw-toolset/IO/SARC/SARC.cs
+++ b/botw-toolset/IO/SARC/SARC.cs
@@ -5,6 +5,10 @@ using System.Linq;
 
 namespace BOTWToolset.IO.SARC
 {
+    /// <summary>
+    /// Stores info on a SARC archive file.
+    /// More info found on the <see href="https://zeldamods.org/wiki/SARC">ZeldaMods wiki</see>.
+    /// </summary>
     public class SARC
     {
         //SARC header
@@ -32,6 +36,11 @@ namespace BOTWToolset.IO.SARC
 
         public byte[][] Files;
 
+        /// <summary>
+        /// Gets a <see cref="SARC"/> from a data stream.
+        /// </summary>
+        /// <param name="stream">Data stream to get <see cref="SARC"/> info from.</param>
+        /// <returns><see cref="SARC"/> with the stream's data.</returns>
         public static SARC FromBytes(Stream stream)
         {
             SARC s = new SARC();
diff --git a/botw-toolset/IO/SARC/SFAT.cs b/botw-toolset/IO/SARC/SFAT.cs
index 77bc37d..10c2ae4 100644
--- a/botw-toolset/IO/SARC/SFAT.cs
+++ b/botw-toolset/IO/SARC/SFAT.cs
@@ -1,5 +1,8 @@
 namespace BOTWToolset.IO.SARC
 {
+    /// <summary>
+    /// Stores info on the SFAT header (SARC file allocation table), used in conjunction with <see cref="SARC"/>.
+    /// </summary>
     public struct SFAT
     {
         public string Magic { get => _magic; set => _magic = value; }
diff --git a/botw-toolset/IO/SARC/SFATNode.cs b/botw-toolset/IO/SARC/SFATNode.cs
index 8959bea..f1b8131 100644
--- a/botw-toolset/IO/SARC/SFATNode.cs
+++ b/botw-toolset/IO/SARC/SFATNode.cs
@@ -1,5 +1,8 @@
 namespace BOTWToolset.IO.SARC
 {
+    /// <summary>
+    /// Contains information on stored archive files in the SARC, used in conjunction with <see cref="SFAT"/> and <see cref="SARC"/>.
+    /// </summary>
     public struct SFATNode
     {
         public uint FileNameHash { get => _fileNameHash; set => _fileNameHash = value; }
diff --git a/botw-toolset/IO/SARC/SFNT.cs b/botw-toolset/IO/SARC/SFNT.cs
index 6b2681a..c6c2a5f 100644
--- a/botw-toolset/IO/SARC/SFNT.cs
+++ b/botw-toolset/IO/SARC/SFNT.cs
@@ -1,5 +1,8 @@
 namespace BOTWToolset.IO.SARC
 {
+    /// <summary>
+    /// Stores info on the SFNT header (SARC file name table), used in conjunction with <see cref="SARC"/>.
+    /// </summary>
     public struct SFNT
     {
         public string Magic { get => _magic; set => _magic = value; }
diff --git a/botw-toolset/IO/TSCB/TSCB.cs b/botw-toolset/IO/TSCB/TSCB.cs
index dfbf140..5a9674e 100644
--- a/botw-toolset/IO/TSCB/TSCB.cs
+++ b/botw-toolset/IO/TSCB/TSCB.cs
@@ -7,7 +7,8 @@ using System.Linq;
 namespace BOTWToolset.IO.TSCB
 {
     /// <summary>
-    /// Interacts with .tcsb files.
+    /// Interacts with .tcsb (terrain scene binary) files.
+    /// More info found on the <see href="https://zeldamods.org/wiki/TSCB">ZeldaMods wiki</see>.
     /// </summary>
     public class TSCB
     {
@@ -218,7 +219,7 @@ namespace BOTWToolset.IO.TSCB
         /// <summary>
         /// Writes TSCB data to a byte array.
         /// </summary>
-        /// <param name="tscb">TSCBInfo that contains data to write.</param>
+        /// <param name="tscb"><see cref="TSCB"/> that contains data to write.</param>
         /// <returns>Byte array containing the TSCB data.</returns>
         public static byte[] GetBytes(TSCB tscb)
         {
@@ -312,7 +313,6 @@ namespace BOTWToolset.IO.TSCB
                 b.AddRange(System.Text.Encoding.ASCII.GetBytes(filename));
             }
 
-            // TODO: Make this an actual function
             return b.ToArray();
         }
     }
diff --git a/botw-toolset/IO/Yaz0/Yaz0.cs b/botw-toolset/IO/Yaz0/Yaz0.cs
index 7c0a5ce..092a6ef 100644
--- a/botw-toolset/IO/Yaz0/Yaz0.cs
+++ b/botw-toolset/IO/Yaz0/Yaz0.cs
@@ -7,6 +7,10 @@ using System.Linq;
 
 namespace BOTWToolset.IO.Yaz0
 {
+    /// <summary>
+    /// Interacts with Yaz0-encoded data, and allows for encoding data to Yaz0.
+    /// More info on the <see href="https://zeldamods.org/wiki/Yaz0">ZeldaMods wiki</see>.
+    /// </summary>
     public class Yaz0
     {
         public string Magic { get => _magic; set => _magic = value; }
@@ -23,6 +27,11 @@ namespace BOTWToolset.IO.Yaz0
         private static int s_num_bytes1, s_match_pos;
         private static bool s_prev_flag = false;
 
+        /// <summary>
+        /// Returns a <see cref="Yaz0"/> from a Yaz0-encoded file on disk.
+        /// </summary>
+        /// <param name="file">The file (full path) to read.</param>
+        /// <returns><see cref="Yaz0"/> containing the file's data.</returns>
         public static Yaz0 ReadFile(string file)
         {
             if (File.Exists(file))