From efed3461f25a3163bed9fbfb21642a730f4023f0 Mon Sep 17 00:00:00 2001
From: thermalthrottle <biz.mitko@gmail.com>
Date: Sat, 20 Mar 2021 21:56:06 +0200
Subject: [PATCH] StockController comments

---
 .../Business/Business/Sales/DealController.cs |  2 +-
 .../Business/Sales/StockController.cs         | 56 ++++++++++++++++++-
 2 files changed, 55 insertions(+), 3 deletions(-)

diff --git a/LuminousSales/Business/Business/Sales/DealController.cs b/LuminousSales/Business/Business/Sales/DealController.cs
index 0f23917..6d71199 100644
--- a/LuminousSales/Business/Business/Sales/DealController.cs
+++ b/LuminousSales/Business/Business/Sales/DealController.cs
@@ -228,7 +228,7 @@ namespace Business.Business.Sales
         /// Requires Manager Role or better.
         /// </remarks>
         /// <remarks>
-        /// Accepts product id for getting the product
+        /// Accepts deal id for getting the product
         /// </remarks>
 
         public void Delete(int id)
diff --git a/LuminousSales/Business/Business/Sales/StockController.cs b/LuminousSales/Business/Business/Sales/StockController.cs
index 678b296..1f73d3b 100644
--- a/LuminousSales/Business/Business/Sales/StockController.cs
+++ b/LuminousSales/Business/Business/Sales/StockController.cs
@@ -56,7 +56,7 @@ namespace Business.Business.Sales
         /// Requires no special roles.
         /// </remarks>
         /// <returns>
-        /// Returns a ICollection of all Deals.
+        /// Returns a ICollection of all Stocks.
         /// </returns>
 
         public ICollection<Stock> GetAll()
@@ -79,7 +79,7 @@ namespace Business.Business.Sales
         /// Requires Manager role or better.
         /// </remarks>
         /// <returns>
-        /// Returns an object of the role with the given Id. 
+        /// Returns an object of the stock with the given Id. 
         /// </returns>
 
         public Stock Get(int id)
@@ -116,6 +116,17 @@ namespace Business.Business.Sales
             }
         }
 
+        /// <summary>
+        /// Gets stocks made by certain user.
+        /// </summary>
+        /// <remarks>
+        /// Accepts user id for getting the user.
+        /// Requires Admin role.
+        /// </remarks>
+        /// <returns>
+        /// Returns an Collection of all the stocks in the criteria. 
+        /// </returns>
+
         public ICollection<Stock> GetByUser(int id)
         {
             if (currentUser != null || currentUser.RoleId == 3)
@@ -136,6 +147,17 @@ namespace Business.Business.Sales
             }
         }
 
+        /// <summary>
+        /// Gets stocks made by certain user.
+        /// </summary>
+        /// <remarks>
+        /// Accepts username for getting the user.
+        /// Requires Admin role.
+        /// </remarks>
+        /// <returns>
+        /// Returns an Collection of all the stocks in the criteria. 
+        /// </returns>
+
         public ICollection<Stock> GetByUser(string username)
         {
             if (currentUser != null || currentUser.RoleId == 3)
@@ -156,6 +178,16 @@ namespace Business.Business.Sales
             }
         }
 
+        /// <summary>
+        /// Adds Stock to the database.
+        /// </summary>
+        /// <remarks>
+        /// Requires Manager role or better.
+        /// </remarks>
+        /// <remarks>
+        /// Accepts product id for getting the product, amount sold and time of transaction.
+        /// </remarks>
+
         public void Add(int productId, double Amount, DateTime time)
         {
             if (currentUser.RoleId > 1)
@@ -179,6 +211,16 @@ namespace Business.Business.Sales
             }
         }
 
+        /// <summary>
+        /// Adds Stock to the database.
+        /// </summary>
+        /// <remarks>
+        /// Requires Manager role or better.
+        /// </remarks>
+        /// <remarks>
+        /// Accepts product name for getting the product, amount sold and time of transaction.
+        /// </remarks>
+
         public void Add(string productName, double Amount, DateTime time)
         {
             if (currentUser.RoleId > 1)
@@ -205,6 +247,16 @@ namespace Business.Business.Sales
              
         }
 
+        /// <summary>
+        /// Deletes Deal from the database.
+        /// </summary>
+        /// <remarks>
+        /// Requires Manager Role or better.
+        /// </remarks>
+        /// <remarks>
+        /// Accepts stock id for getting the product
+        /// </remarks>
+
         public void Delete(int id)
         {
             if (currentUser.RoleId == 3 )