From 90c048c389e3773e24c7ff19fb023160c838f6b2 Mon Sep 17 00:00:00 2001
From: Alex Barney <thealexbarney@gmail.com>
Date: Mon, 8 Jul 2019 11:01:03 -0500
Subject: [PATCH] Add basic docs for ConcatenationFileSystem

---
 src/LibHac/Fs/ConcatenationFileSystem.cs | 25 ++++++++++++++++++++++++
 1 file changed, 25 insertions(+)

diff --git a/src/LibHac/Fs/ConcatenationFileSystem.cs b/src/LibHac/Fs/ConcatenationFileSystem.cs
index 0cc8dd90..9d1c8273 100644
--- a/src/LibHac/Fs/ConcatenationFileSystem.cs
+++ b/src/LibHac/Fs/ConcatenationFileSystem.cs
@@ -7,14 +7,39 @@ using System.Runtime.InteropServices;
 
 namespace LibHac.Fs
 {
+    /// <summary>
+    /// An <see cref="IFileSystem"/> that stores large files as smaller, separate sub-files.
+    /// </summary>
+    /// <remarks>
+    /// This filesystem is mainly used to allow storing large files on filesystems that have low
+    /// limits on file size such as FAT filesystems. The underlying base filesystem must have
+    /// support for the "Archive" file attribute found in FAT or NTFS filesystems.
+    ///
+    /// A <see cref="ConcatenationFileSystem"/> may contain both standard files or Concatenation files.
+    /// If a directory has the archive attribute set, its contents will be concatenated and treated
+    /// as a single file. These sub-files must follow the naming scheme "00", "01", "02", ...
+    /// Each sub-file except the final one must have the size <see cref="SubFileSize"/> that was specified
+    /// at the creation of the <see cref="ConcatenationFileSystem"/>.
+    /// </remarks>
     public class ConcatenationFileSystem : IFileSystem
     {
         private const long DefaultSubFileSize = 0xFFFF0000; // Hard-coded value used by FS
         private IAttributeFileSystem BaseFileSystem { get; }
         private long SubFileSize { get; }
 
+        /// <summary>
+        /// Initializes a new <see cref="ConcatenationFileSystem"/>.
+        /// </summary>
+        /// <param name="baseFileSystem">The base <see cref="IAttributeFileSystem"/> for the
+        /// new <see cref="ConcatenationFileSystem"/>.</param>
         public ConcatenationFileSystem(IAttributeFileSystem baseFileSystem) : this(baseFileSystem, DefaultSubFileSize) { }
 
+        /// <summary>
+        /// Initializes a new <see cref="ConcatenationFileSystem"/>.
+        /// </summary>
+        /// <param name="baseFileSystem">The base <see cref="IAttributeFileSystem"/> for the
+        /// new <see cref="ConcatenationFileSystem"/>.</param>
+        /// <param name="subFileSize">The size of each sub-file. Once a file exceeds this size, a new sub-file will be created</param>
         public ConcatenationFileSystem(IAttributeFileSystem baseFileSystem, long subFileSize)
         {
             BaseFileSystem = baseFileSystem;