Added documentation to the MarketOrderService.cs

Author: topnax

Repository/IRepository.cs

@@ -60,7 +60,7 @@ public interface IMarketOrderRepository : IRepository<MarketOrder>
         /// Deletes all market orders of the portfolio entry given by an ID
         /// </summary>
         /// <param name="portfolioEntryId">ID of the entry whose orders should be deleted</param>
-        /// <returns>A flag indicating whether the orders have been successfully deleted</returns>
+        /// <returns>Number of orders deleted</returns>
         public int DeletePortfolioEntryOrders(int portfolioEntryId);
     }
 

Services/Services/MarketOrderService.cs

@@ -1,30 +1,65 @@
 using System;
 using System.Collections.Generic;
-using System.Runtime.CompilerServices;
 using Model;
 using Repository;
 
 namespace Services
 {
     public interface IMarketOrderService
     {
+        /// <summary>
+        /// Creates a new market order and adds it to a repository
+        /// </summary>
+        /// <param name="filledPrice">The agreed price per one piece of the traded asset</param>
+        /// <param name="fee">Fee for trade</param>
+        /// <param name="size">Size of the trade</param>
+        /// <param name="date">Date the trade was made</param>
+        /// <param name="buy">A flag indicating whether the trade is a buy</param>
+        /// <param name="portfolioEntryId">ID of the portfolio entry the trade belongs to</param>
+        /// <returns>Created instance of the `MarketOrder` class</returns>
         MarketOrder CreateMarketOrder(decimal filledPrice, decimal fee, decimal size,
             DateTime date, bool buy, int portfolioEntryId);
 
+        /// <summary>
+        /// Deletes the given order from the repository
+        /// </summary>
+        /// <param name="order">Order to be deleted from the repository</param>
+        /// <returns>A flag indicating whether an order was deleted</returns>
         bool DeleteMarketOrder(MarketOrder order);
 
+        /// <summary>
+        /// Updates the given order in the repository. An order with the same ID in the repository is replaced with the one
+        /// passed.
+        /// </summary>
+        /// <param name="order">Updated order</param>
+        /// <returns>A flag indicating whether an order was updated</returns>
         bool UpdateMarketOrder(MarketOrder order);
 
+        /// <summary>
+        /// Loads and returns a market order from a repository
+        /// </summary>
+        /// <param name="id">ID of the order to be loaded</param>
+        /// <returns>Loaded order from the repository or `null` when no order with the given ID was found in the repository</returns>
         MarketOrder GetMarketOrder(int id);
 
+        /// <summary>
+        /// Gets all orders of a portfolio entry given by an ID.
+        /// </summary>
+        /// <param name="portfolioEntryId">ID of the entry whose orders are to be found</param>
+        /// <returns>List of all orders belonging to the order specified by the given ID</returns>
         List<MarketOrder> GetPortfolioEntryOrders(int portfolioEntryId);
 
+        /// <summary>
+        /// Deletes all orders belonging to the portfolio entry given by it's ID
+        /// </summary>
+        /// <param name="portfolioEntryId">ID of the portfolio entry whose orders are to be deleted</param>
+        /// <returns>Number of deleted orders</returns>
         int DeletePortfolioEntryOrders(int portfolioEntryId);
     }
 
     public class MarketOrderServiceImpl : IMarketOrderService
     {
-        private IMarketOrderRepository _marketOrderRepository;
+        private readonly IMarketOrderRepository _marketOrderRepository;
 
         public MarketOrderServiceImpl(IMarketOrderRepository marketOrderRepository)
         {
@@ -34,8 +69,13 @@ public MarketOrderServiceImpl(IMarketOrderRepository marketOrderRepository)
         public MarketOrder CreateMarketOrder(decimal filledPrice, decimal fee, decimal size, DateTime date, bool buy,
             int portfolioEntryId)
         {
+            // create a MarketOrder instance
             var order = new MarketOrder(filledPrice, fee, size, date, buy, PortfolioEntryId: portfolioEntryId);
+            
+            // add it to the repository
             var id = _marketOrderRepository.Add(order);
+            
+            // return the created instance with the ID generated by the repository
             return order with {Id = id};
         }