Add XML comments

Author: Matthiee

FinancialModelingPrepApi/Abstractions/InstitutionalFund/IInstitutionalFundProvider.cs

@@ -8,9 +8,31 @@ namespace MatthiWare.FinancialModelingPrep.Abstractions.InstitutionalFund
     public interface IInstitutionalFundProvider
     {
         #region 13F
+        /// <summary>
+        /// Complete list of all institutional investment managers by cik 
+        /// </summary>
+        /// <returns></returns>
         public Task<ApiResponse<List<CikListResponse>>> Get13FListAsync();
+
+        /// <summary>
+        /// Cusip mapper
+        /// </summary>
+        /// <param name="cusip"></param>
+        /// <returns></returns>
         public Task<ApiResponse<CusipMapperResponse>> MapCusipAsync(string cusip);
+
+        /// <summary>
+        /// FORM 13F cik search by name 
+        /// </summary>
+        /// <param name="name"></param>
+        /// <returns></returns>
         public Task<ApiResponse<List<CikListResponse>>> SearchCikByName(string name);
+
+        /// <summary>
+        /// FORM 13F get company name by cik
+        /// </summary>
+        /// <param name="cik"></param>
+        /// <returns></returns>
         public Task<ApiResponse<List<CikListResponse>>> GetCompanyNameByCik(string cik);
 
         /// <summary>

FinancialModelingPrepApi/Core/InstitutionalFund/InstitutionalFundProvider.cs

@@ -19,6 +19,7 @@ public InstitutionalFundProvider(FinancialModelingPrepHttpClient client)
             this.client = client ?? throw new System.ArgumentNullException(nameof(client));
         }
 
+        /// <inheritdoc/>
         public Task<ApiResponse<List<CikListResponse>>> Get13FListAsync()
         {
             const string url = "[version]/cik_list";
@@ -31,6 +32,7 @@ public Task<ApiResponse<List<CikListResponse>>> Get13FListAsync()
             return client.GetJsonAsync<List<CikListResponse>>(url, pathParams, null);
         }
 
+        /// <inheritdoc/>
         public Task<ApiResponse<List<CikListResponse>>> GetCompanyNameByCik(string cik)
         {
             const string url = "[version]/cik/[cik]";
@@ -61,6 +63,7 @@ public Task<ApiResponse<List<Form13FResponse>>> GetForm13FAsync(string cik, stri
             return client.GetJsonAsync<List<Form13FResponse>>(url, pathParams, queryString);
         }
 
+        /// <inheritdoc/>
         public async Task<ApiResponse<CusipMapperResponse>> MapCusipAsync(string cusip)
         {
             const string url = "[version]/cusip/[cusip]";
@@ -81,6 +84,7 @@ public async Task<ApiResponse<CusipMapperResponse>> MapCusipAsync(string cusip)
             return ApiResponse.FromSucces(result.Data.First());
         }
 
+        /// <inheritdoc/>
         public Task<ApiResponse<List<CikListResponse>>> SearchCikByName(string name)
         {
             const string url = "[version]/cik-search/[name]";