From c136c9f1805dbd0b1d37fd33e7b3b34cd7d82836 Mon Sep 17 00:00:00 2001
From: schedpas <schedpas@W7TE0110>
Date: Thu, 16 Jul 2020 08:30:41 +0200
Subject: [PATCH] add some documentation

---
 Pilz.Cryptography/Pilz.Cryptography.csproj |  1 +
 Pilz.IO/EmbeddedFilesContainer.cs          | 45 ++++++++++++++++++++++
 2 files changed, 46 insertions(+)

diff --git a/Pilz.Cryptography/Pilz.Cryptography.csproj b/Pilz.Cryptography/Pilz.Cryptography.csproj
index 7afed73..fc42b31 100644
--- a/Pilz.Cryptography/Pilz.Cryptography.csproj
+++ b/Pilz.Cryptography/Pilz.Cryptography.csproj
@@ -29,6 +29,7 @@
     <DefineConstants>TRACE</DefineConstants>
     <ErrorReport>prompt</ErrorReport>
     <WarningLevel>4</WarningLevel>
+    <DocumentationFile>bin\Release\Pilz.Cryptography.xml</DocumentationFile>
   </PropertyGroup>
   <ItemGroup>
     <Reference Include="Microsoft.VisualBasic" />
diff --git a/Pilz.IO/EmbeddedFilesContainer.cs b/Pilz.IO/EmbeddedFilesContainer.cs
index 9a0114f..f10d0ce 100644
--- a/Pilz.IO/EmbeddedFilesContainer.cs
+++ b/Pilz.IO/EmbeddedFilesContainer.cs
@@ -14,17 +14,32 @@ namespace Pilz.IO
         [JsonProperty("CompressedFiles")]
         private readonly Dictionary<string, byte[]> compressedFiles = new Dictionary<string, byte[]>();
 
+        /// <summary>
+        /// Returns the names of all embedded files.
+        /// </summary>
         [JsonIgnore]
         public IEnumerable<string> AllFileNames
         {
             get => compressedFiles.Keys;
         }
 
+        /// <summary>
+        /// Embeds a file to this container.
+        /// </summary>
+        /// <param name="fileName">The name how it should be called in this container.</param>
+        /// <param name="filePath">The file path to the file that should be embedded.</param>
+        /// <returns>Returns a <see cref="bool"/> that defines if the file as been embedded successfully.</returns>
         public Task<bool> AddFileAsync(string fileName, string filePath)
         {
             return Task.Run(() => AddFile(fileName, filePath));
         }
 
+        /// <summary>
+        /// Embeds a file to this container.
+        /// </summary>
+        /// <param name="fileName">The name how it should be called in this container.</param>
+        /// <param name="filePath">The file path to the file that should be embedded.</param>
+        /// <returns>Returns a <see cref="bool"/> that defines if the file as been embedded successfully.</returns>
         public bool AddFile(string fileName, string filePath)
         {
             bool success;
@@ -63,22 +78,41 @@ namespace Pilz.IO
             return success;
         }
 
+        /// <summary>
+        /// Removes a file from this container.
+        /// </summary>
+        /// <param name="fileName">The name how the file is called.</param>
         public void RemoveFile(string fileName)
         {
             if (compressedFiles.ContainsKey(fileName))
                 compressedFiles.Remove(fileName);
         }
 
+        /// <summary>
+        /// Checks if the given file exists in this container.
+        /// </summary>
+        /// <param name="fileName">The name how the file is called.</param>
+        /// <returns>Returns if the given file exists in this container.</returns>
         public bool HasFile(string fileName)
         {
             return compressedFiles.ContainsKey(fileName);
         }
 
+        /// <summary>
+        /// Gets a file from this container as stream.
+        /// </summary>
+        /// <param name="fileName">The name how the file is called.</param>
+        /// <returns>Returns a stream of the file with the given name.</returns>
         public Task<Stream> GetStreamAsync(string fileName)
         {
             return Task.Run(() => GetStream(fileName));
         }
 
+        /// <summary>
+        /// Gets a file from this container as stream.
+        /// </summary>
+        /// <param name="fileName">The name how the file is called.</param>
+        /// <returns>Returns a stream of the file with the given name.</returns>
         public Stream GetStream(string fileName)
         {
             Stream decompressed = null;
@@ -92,11 +126,22 @@ namespace Pilz.IO
             return decompressed;
         }
 
+        /// <summary>
+        /// Saves a given file to the users temp directory.
+        /// </summary>
+        /// <param name="fileName">The name how the file is called.</param>
+        /// <returns>Returns the file path to the temp file.</returns>
         public Task<string> GetLocalFilePathAsync(string fileName)
         {
             return Task.Run(() => GetLocalFilePath(fileName));
         }
 
+
+        /// <summary>
+        /// Saves a given file to the users temp directory.
+        /// </summary>
+        /// <param name="fileName">The name how the file is called.</param>
+        /// <returns>Returns the file path to the temp file.</returns>
         public string GetLocalFilePath(string fileName)
         {
             string filePath = string.Empty;