Merge pull request #4 from m-ruiz21/inline-docs

Inline docs
m-ruiz21 · Apr 9, 2023 · 8d79437 · 8d79437
2 parents a248647 + 66a17da
commit 8d79437
Show file tree

Hide file tree

Showing 3 changed files with 47 additions and 3 deletions.
diff --git a/Project2Api/IDbClient/IDbClient.cs b/Project2Api/IDbClient/IDbClient.cs
@@ -10,7 +10,7 @@ public interface IDbClient
         Task<DataTable> ExecuteQueryAsync(string query);
 
         /// <summary>
-        /// Executes query and returns number of affected rows
+        /// Executes query and returns number of affected rows if successful, else -1
         /// </summary>
         Task<int> ExecuteNonQueryAsync(string query);
     }

diff --git a/Project2Api/Models/MenuItem.cs b/Project2Api/Models/MenuItem.cs
@@ -27,6 +27,15 @@ public class MenuItem
         this.Cutlery = MenuItemCutlery;
     }
 
+    /// <summary>
+    /// Creates menu item
+    /// </summary>
+    /// <param name="name"></param>
+    /// <param name="price"></param>
+    /// <param name="category"></param>
+    /// <param name="quantity"></param>
+    /// <param name="MenuItemCutlery"></param>
+    /// <returns>Created menu item</returns>
     public static ErrorOr<MenuItem> Create(
         string name,
         float price,
@@ -42,6 +51,11 @@ public class MenuItem
         return new MenuItem(name, price, category, quantity, MenuItemCutlery);
     }
 
+    /// <summary>
+    /// Creates menu item from request
+    /// </summary>
+    /// <param name="menuItemRequest"></param>
+    /// <returns>Created menu item</returns>
     public static ErrorOr<MenuItem> From(MenuItemRequest menuItemRequest)
     {
         return Create(
@@ -52,7 +66,12 @@ public static ErrorOr<MenuItem> From(MenuItemRequest menuItemRequest)
             menuItemRequest.Cutlery
         );
     }
-
+
+    /// <summary>
+    /// Creates menu item from data row
+    /// </summary>
+    /// <param name="dataRow"></param>
+    /// <returns>Created menu item</returns>    
     public static ErrorOr<MenuItem> From(DataRow dataRow)
     {
         // check if dataRow is null 

diff --git a/Project2Api/Services/MenuItem/IMenuItemService.cs b/Project2Api/Services/MenuItem/IMenuItemService.cs
@@ -6,14 +6,39 @@ namespace Project2Api.Services.MenuItems
 {
     public interface IMenuItemService
     {
+        /// <summary>
+        /// Creates menu item
+        /// </summary>
+        /// <param name="menuItem"></param>
+        /// <returns>Created menu item</returns>
         ErrorOr<MenuItem> CreateMenuItem(MenuItem menuItem);
-
+
+        /// <summary>
+        /// Gets menu item by name
+        /// </summary>
+        /// <param name="name"></param>
+        /// <returns>Menu item</returns>
         ErrorOr<MenuItem> GetMenuItem(string name);
 
+        /// <summary>
+        /// Gets all menu items
+        /// </summary>
+        /// <returns>Dictionary of menu items</returns>
         ErrorOr<Dictionary<string, List<MenuItem>>> GetAllMenuItems();
 
+        /// <summary>
+        /// Updates menu item
+        /// </summary>
+        /// <param name="name"></param>
+        /// <param name="menuItem"></param>
+        /// <returns>Updated menu item</returns>
         ErrorOr<MenuItem> UpdateMenuItem(string name, MenuItem menuItem);
 
+        /// <summary>
+        /// Deletes menu item
+        /// </summary>
+        /// <param name="name"></param>
+        /// <returns>Deleted menu item</returns>
         ErrorOr<IActionResult> DeleteMenuItem(string name);
     }
 }