Xml comments

JKorf · Aug 6, 2024 · 9bb951e · 9bb951e
1 parent 5833d2d
commit 9bb951e
Show file tree

Hide file tree

Showing 9 changed files with 189 additions and 189 deletions.
diff --git a/CoinEx.Net/CoinEx.Net.xml b/CoinEx.Net/CoinEx.Net.xml
diff --git a/CoinEx.Net/Interfaces/Clients/FuturesApi/ICoinExRestClientFuturesApiAccount.cs b/CoinEx.Net/Interfaces/Clients/FuturesApi/ICoinExRestClientFuturesApiAccount.cs
@@ -16,7 +16,7 @@ public interface ICoinExRestClientFuturesApiAccount
         /// Get trading fees for a symbol
         /// <para><a href="https://docs.coinex.com/api/v2/account/fees/http/get-account-trade-fees" /></para>
         /// </summary>
-        /// <param name="symbol">Symbol</param>
+        /// <param name="symbol">Symbol, for example `ETHUSDT`</param>
         /// <param name="ct">Cancelation token</param>
         /// <returns></returns>
         Task<WebCallResult<CoinExTradeFee>> GetTradingFeesAsync(string symbol, CancellationToken ct = default);
@@ -33,7 +33,7 @@ public interface ICoinExRestClientFuturesApiAccount
         /// Set leverage for a symbol
         /// <para><a href="https://docs.coinex.com/api/v2/futures/position/http/adjust-position-leverage" /></para>
         /// </summary>
-        /// <param name="symbol">Symbol</param>
+        /// <param name="symbol">Symbol, for example `ETHUSDT`</param>
         /// <param name="mode">Margin mode</param>
         /// <param name="leverage">Leverage</param>
         /// <param name="ct">Cancelation token</param>

diff --git a/CoinEx.Net/Interfaces/Clients/FuturesApi/ICoinExRestClientFuturesApiExchangeData.cs b/CoinEx.Net/Interfaces/Clients/FuturesApi/ICoinExRestClientFuturesApiExchangeData.cs
@@ -25,7 +25,7 @@ public interface ICoinExRestClientFuturesApiExchangeData
         /// Get list of support symbols
         /// <para><a href="https://docs.coinex.com/api/v2/futures/market/http/list-market" /></para>
         /// </summary>
-        /// <param name="symbols">Filter by symbol name; max 10</param>
+        /// <param name="symbols">Filter by symbol name; max 10, for example `ETHUSDT`</param>
         /// <param name="ct">Cancelation token</param>
         /// <returns></returns>
         Task<WebCallResult<IEnumerable<CoinExFuturesSymbol>>> GetSymbolsAsync(IEnumerable<string>? symbols = null, CancellationToken ct = default);
@@ -34,7 +34,7 @@ public interface ICoinExRestClientFuturesApiExchangeData
         /// Get symbol tickers
         /// <para><a href="https://docs.coinex.com/api/v2/futures/market/http/list-market-ticker" /></para>
         /// </summary>
-        /// <param name="symbols">Fitler by symbol names; max 10</param>
+        /// <param name="symbols">Fitler by symbol names; max 10, for example `ETHUSDT`</param>
         /// <param name="ct">Cancelation Token</param>
         /// <returns></returns>
         Task<WebCallResult<IEnumerable<CoinExFuturesTicker>>> GetTickersAsync(IEnumerable<string>? symbols = null, CancellationToken ct = default);
@@ -43,7 +43,7 @@ public interface ICoinExRestClientFuturesApiExchangeData
         /// Get the orderbook for a symbol
         /// <para><a href="https://docs.coinex.com/api/v2/futures/market/http/list-market-depth" /></para>
         /// </summary>
-        /// <param name="symbol">Symbol</param>
+        /// <param name="symbol">Symbol, for example `ETHUSDT`</param>
         /// <param name="limit">Amount of rows, 5, 10, 20 or 50</param>
         /// <param name="mergeLevel">The merge level, 0.00000000001 up to 1000, 0 for no merging</param>
         /// <param name="ct">Cancelation Token</param>
@@ -54,7 +54,7 @@ public interface ICoinExRestClientFuturesApiExchangeData
         /// Get the trade history for a symbol
         /// <para><a href="https://docs.coinex.com/api/v2/futures/market/http/list-market-deals" /></para>
         /// </summary>
-        /// <param name="symbol">Symbol</param>
+        /// <param name="symbol">Symbol, for example `ETHUSDT`</param>
         /// <param name="limit">Max amount of results</param>
         /// <param name="lastId">The starting point of the query, 0 means to acquire from the latest record</param>
         /// <param name="ct">Cancelation Token</param>
@@ -65,7 +65,7 @@ public interface ICoinExRestClientFuturesApiExchangeData
         /// Get klines/candlesticks
         /// <para><a href="https://docs.coinex.com/api/v2/futures/market/http/list-market-kline" /></para>
         /// </summary>
-        /// <param name="symbol">Symbol</param>
+        /// <param name="symbol">Symbol, for example `ETHUSDT`</param>
         /// <param name="interval">Kline interval</param>
         /// <param name="limit">Max amount of results</param>
         /// <param name="priceType">Price type, either LastPrice(default) or IndexPrice</param>
@@ -77,7 +77,7 @@ public interface ICoinExRestClientFuturesApiExchangeData
         /// Get index prices
         /// <para><a href="https://docs.coinex.com/api/v2/futures/market/http/list-market-index" /></para>
         /// </summary>
-        /// <param name="symbols">Filter by symbols</param>
+        /// <param name="symbols">Filter by symbols, for example `ETHUSDT`</param>
         /// <param name="ct">Cancelation Token</param>
         /// <returns></returns>
         Task<WebCallResult<IEnumerable<CoinExIndexPrice>>> GetIndexPricesAsync(IEnumerable<string>? symbols = null, CancellationToken ct = default);
@@ -86,7 +86,7 @@ public interface ICoinExRestClientFuturesApiExchangeData
         /// Get funding rates
         /// <para><a href="https://docs.coinex.com/api/v2/futures/market/http/list-market-funding-rate" /></para>
         /// </summary>
-        /// <param name="symbols">Filter by symbols</param>
+        /// <param name="symbols">Filter by symbols, for example `ETHUSDT`</param>
         /// <param name="ct">Cancelation Token</param>
         /// <returns></returns>
         Task<WebCallResult<IEnumerable<CoinExFundingRate>>> GetFundingRatesAsync(IEnumerable<string>? symbols = null, CancellationToken ct = default);
@@ -95,7 +95,7 @@ public interface ICoinExRestClientFuturesApiExchangeData
         /// Get historical funding rates
         /// <para><a href="https://docs.coinex.com/api/v2/futures/market/http/list-market-funding-rate-history" /></para>
         /// </summary>
-        /// <param name="symbol">Symbol</param>
+        /// <param name="symbol">Symbol, for example `ETHUSDT`</param>
         /// <param name="startTime">Filter by start time</param>
         /// <param name="endTime">Filter by end time</param>
         /// <param name="page">Page number</param>
@@ -108,20 +108,20 @@ public interface ICoinExRestClientFuturesApiExchangeData
         /// Get historical premium index prices
         /// <para><a href="https://docs.coinex.com/api/v2/futures/market/http/list-market-premium-history" /></para>
         /// </summary>
-        /// <param name="symbol">Symbol</param>
+        /// <param name="symbol">Symbol, for example `ETHUSDT`</param>
         /// <param name="startTime">Filter by start time</param>
         /// <param name="endTime">Filter by end time</param>
         /// <param name="page">Page number</param>
         /// <param name="pageSize">Page size</param>
         /// <param name="ct">Cancelation Token</param>
         /// <returns></returns>
         Task<WebCallResult<IEnumerable<CoinExPremiumIndexHistory>>> GetPremiumIndexPriceHistoryAsync(string symbol, DateTime? startTime = null, DateTime? endTime = null, int? page = null, int? pageSize = null, CancellationToken ct = default);
-        
+
         /// <summary>
         /// Get position levels
         /// <para><a href="https://docs.coinex.com/api/v2/futures/market/http/list-market-position-level" /></para>
         /// </summary>
-        /// <param name="symbols">Filter by symbols; max 10</param>
+        /// <param name="symbols">Filter by symbols; max 10, for example `ETHUSDT`</param>
         /// <param name="ct">Cancelation Token</param>
         /// <returns></returns>
         Task<WebCallResult<IEnumerable<CoinExPositionLevels>>> GetPositionLevelsAsync(IEnumerable<string>? symbols = null, CancellationToken ct = default);
@@ -130,7 +130,7 @@ public interface ICoinExRestClientFuturesApiExchangeData
         /// Get liquidation history
         /// <para><a href="https://docs.coinex.com/api/v2/futures/market/http/list-market-liquidation-history" /></para>
         /// </summary>
-        /// <param name="symbol">Symbol</param>
+        /// <param name="symbol">Symbol, for example `ETHUSDT`</param>
         /// <param name="startTime">Filter by start time</param>
         /// <param name="endTime">Filter by end time</param>
         /// <param name="page">Page number</param>
@@ -143,7 +143,7 @@ public interface ICoinExRestClientFuturesApiExchangeData
         /// Get basis rate history
         /// <para><a href="https://docs.coinex.com/api/v2/futures/market/http/list-market-basis-history" /></para>
         /// </summary>
-        /// <param name="symbol">Symbol</param>
+        /// <param name="symbol">Symbol, for example `ETHUSDT`</param>
         /// <param name="startTime">Filter by start time</param>
         /// <param name="endTime">Filter by end time</param>
         /// <param name="ct">Cancelation Token</param>