From 193df6ec8e7418c92528a267edf7cc3290564556 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Franti=C5=A1ek=20Boh=C3=A1=C4=8Dek?=
 <fandabohacek@gmail.com>
Date: Sat, 29 Jan 2022 19:28:04 +0100
Subject: [PATCH] docs: add missing nosfile documentation

---
 .../NosSmooth.Data.NOSFiles/Errors/UnknownFileTypeError.cs | 4 ++++
 Data/NosSmooth.Data.NOSFiles/Files/RawFile.cs              | 7 +++++++
 2 files changed, 11 insertions(+)

diff --git a/Data/NosSmooth.Data.NOSFiles/Errors/UnknownFileTypeError.cs b/Data/NosSmooth.Data.NOSFiles/Errors/UnknownFileTypeError.cs
index 67c9883..8d17a81 100644
--- a/Data/NosSmooth.Data.NOSFiles/Errors/UnknownFileTypeError.cs
+++ b/Data/NosSmooth.Data.NOSFiles/Errors/UnknownFileTypeError.cs
@@ -9,4 +9,8 @@ using Remora.Results;
 
 namespace NosSmooth.Data.NOSFiles.Errors;
 
+/// <summary>
+/// The file type of the file does not have a reader registered.
+/// </summary>
+/// <param name="file">The file.</param>
 public record UnknownFileTypeError(RawFile file) : NotFoundError($"Could not find reader for the given file {file.Path}.");
\ No newline at end of file
diff --git a/Data/NosSmooth.Data.NOSFiles/Files/RawFile.cs b/Data/NosSmooth.Data.NOSFiles/Files/RawFile.cs
index ba7f5af..e2b1595 100644
--- a/Data/NosSmooth.Data.NOSFiles/Files/RawFile.cs
+++ b/Data/NosSmooth.Data.NOSFiles/Files/RawFile.cs
@@ -10,6 +10,13 @@ using System.Security.Cryptography;
 
 namespace NosSmooth.Data.NOSFiles.Files;
 
+/// <summary>
+/// A file.
+/// </summary>
+/// <param name="FileType">The type of the file, if known.</param>
+/// <param name="Path">The path to the file.</param>
+/// <param name="Length">The length of the content.</param>
+/// <param name="Content">The binary content of the file.</param>
 [SuppressMessage("StyleCop.CSharp.NamingRules", "SA1313:Parameter names should begin with lower-case letter", Justification = "Upper case is standard.")]
 public record struct RawFile
 (
-- 
2.48.1