final documentation and compiler message cleanups

Author: forReason

TransactionTable/AccountTransactions/AccountTableHeaders.cs

@@ -1,9 +1,14 @@
 namespace PortfolioPerformanceTableHelper
 {
+    /// <summary>
+    /// is a stringable-enum
+    /// </summary>
     public class AccountTableHeaders
     {
         private AccountTableHeaders(string name) { Name = name; }
-
+        /// <summary>
+        /// returns the string representation of the enumable
+        /// </summary>
         public string Name { get; private set; }
 
         /// <summary>
@@ -101,12 +106,19 @@ public class AccountTableHeaders
         /// </summary>
         public static AccountTableHeaders CashAccount => new AccountTableHeaders("Cash Account");
 
-
+        /// <summary>
+        /// returns all available AccountTableHeaders as array
+        /// </summary>
+        /// <returns></returns>
         public static AccountTableHeaders[] ToArray()
         {
             return new AccountTableHeaders[] { Date, Time,Type,WKN,ISIN,Symbol,SecurityName, ShareAmount,CurrencyGrossAmount,GrossAmount,
                 TransactionCurrency,Value,ExchangeRate,Fees,Taxes,Note,SecuritiesAccount,OffsetAccount,CashAccount };
         }
+        /// <summary>
+        /// returns all available AccountTableHeaders as string array
+        /// </summary>
+        /// <returns></returns>
         public static string[] ToStringArray()
         {
             List<string> list = new List<string>();
@@ -116,6 +128,10 @@ public static string[] ToStringArray()
             }
             return list.ToArray();
         }
+        /// <summary>
+        /// returns the string representation of this type
+        /// </summary>
+        /// <returns></returns>
         public override string ToString()
         {
             return Name;

TransactionTable/AccountTransactions/AccountTransactionsTable.cs

@@ -17,8 +17,12 @@ namespace PortfolioPerformanceTableHelper
     /// </remarks>
     public partial class AccountTransactionsTable : TransactionsTable
     {
-        // Derived class specific properties, fields, and methods go here
-
+        /// <summary>
+        /// creates a new AccountTransactionsTable from the base class TransactionsTable
+        /// </summary>
+        /// <param name="file"></param>
+        /// <param name="splitByMonths"></param>
+        /// <param name="keepTimeSorted"></param>
         public AccountTransactionsTable(FileInfo file, bool splitByMonths, bool keepTimeSorted = true)
             : base(file, splitByMonths, AccountTableHeaders.ToStringArray(), keepTimeSorted)
         {

TransactionTable/AccountTransactions/TransactionPresets/AddFee.cs

@@ -9,7 +9,7 @@ public partial class AccountTransactionsTable : TransactionsTable
         /// Adds a fee transaction to the Account Transactions table.
         /// </summary>
         /// <param name="cashAccount">The cash account associated with the fee transaction.</param>
-        /// <param name="depositDate">The date of the fee transaction.</param>
+        /// <param name="feeDate">The date of the fee transaction.</param>
         /// <param name="amount">The amount of the fee transaction.</param>
         /// <param name="security">An optional <see cref="Objects.Security"/> object representing the security associated with the fee transaction.</param>
         /// <param name="note">An optional note related to the fee transaction.</param>

TransactionTable/AccountTransactions/TransactionPresets/AddInterest.cs

@@ -52,7 +52,7 @@ public void AddInterest(DateTime interestDate, DepositAccount cashAccount,
             {
                 if (taxes > grossAmount)
                 {
-                    throw new ArgumentOutOfRangeException("taxes cant be larger than interest!", nameof(taxes));
+                    throw new ArgumentOutOfRangeException(nameof(taxes), "Taxes can't be larger than interest!");
                 }
             }
             Table table = GetTable(interestDate);

TransactionTable/PortfolioTransactions/PortfolioTableHeaders.cs

@@ -1,9 +1,15 @@
 namespace PortfolioPerformanceTableHelper
 {
+    /// <summary>
+    /// is a string-able enum representation of the table headers
+    /// </summary>
     public class PortfolioTableHeaders
     {
         private PortfolioTableHeaders(string name) { Name = name; }
 
+        /// <summary>
+        /// Gets the string representation of the Table Header.
+        /// </summary>
         public string Name { get; private set; }
         /// <summary>
         /// Represents the date of the transaction. This field should contain a valid date in the format yyyy-MM-dd.
@@ -100,12 +106,19 @@ public class PortfolioTableHeaders
         /// </summary>
         public static PortfolioTableHeaders CashAccount => new PortfolioTableHeaders("Cash Account");
 
-
+        /// <summary>
+        /// returns an array of all availble Portfolio Header Objects
+        /// </summary>
+        /// <returns></returns>
         public static PortfolioTableHeaders[] ToArray()
         {
             return new PortfolioTableHeaders[] { Date, Time,Type,WKN,ISIN,Symbol,SecurityName, ShareAmount,CurrencyGrossAmount,GrossAmount,
                 TransactionCurrency,Value,ExchangeRate,Fees,Taxes,Note,SecuritiesAccount,OffsetSecuritiesAccount,CashAccount };
         }
+        /// <summary>
+        /// returns an array of all availble Portfolio Header Object names as strings
+        /// </summary>
+        /// <returns></returns>
         public static string[] ToStringArray()
         {
             List<string> list = new List<string>();
@@ -115,6 +128,9 @@ public static string[] ToStringArray()
             }
             return list.ToArray();
         }
+        /// <summary>
+        /// Gets the string representation of the Table Header.
+        /// </summary>
         public override string ToString()
         {
             return Name;

TransactionTable/PortfolioTransactions/TransactionPresets/FetchClosestSpotPrice.cs

@@ -1,8 +1,5 @@
 using PortfolioPerformanceTableHelper.Objects;
-using PortfolioPerformanceTableHelper.Objects;
 using QuickCsv.Net.Table_NS;
-using System.Diagnostics;
-using System.Reflection.Metadata.Ecma335;
 
 namespace PortfolioPerformanceTableHelper
 {