Skip to content

Commit

Permalink
fixing the xml descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
@Afischbacher
Afischbacher committed Jan 20, 2024
1 parent 208a226 commit 6b099e4
Show file tree
Hide file tree
Showing 4 changed files with 30 additions and 31 deletions.
24 changes: 12 additions & 12 deletions Nhl.Api/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -386,7 +386,7 @@ Returns the all the NHL player game center statistics for a specific player for

##### Returns

Returns the number of face offs won by a player for a specific season and game type
Returns the number of total number of a player statistics for a player for a specific season

##### Parameters

Expand All @@ -405,7 +405,7 @@ Returns the all the NHL player game center statistics for a specific player for

##### Returns

Returns the number of face offs won by a player for a specific season and game type
Returns the number of total number of a player statistics for a player for a specific season

##### Parameters

Expand Down Expand Up @@ -1352,11 +1352,11 @@ Returns the NHL team schedule for the specified team and the specified date and

##### Summary

Returns the number of face offs won by a player for a specific season and game type
Returns the number of total number of a player statistics for a player for a specific season

##### Returns

Returns the number of face offs won by a player for a specific season and game type
Returns the number of total number of a player statistics for a player for a specific season

##### Parameters

Expand All @@ -1372,11 +1372,11 @@ Returns the number of face offs won by a player for a specific season and game t

##### Summary

Returns the number of face offs won by a player for a specific season and game type
Returns the number of total number of a player statistics for a player for a specific season

##### Returns

Returns the number of face offs won by a player for a specific season and game type
Returns the number of total number of a player statistics for a player for a specific season

##### Parameters

Expand Down Expand Up @@ -2631,7 +2631,7 @@ Returns the all the NHL player game center statistics for a specific player for

##### Returns

Returns the number of face offs won by a player for a specific season and game type
Returns the number of total number of a player statistics for a player for a specific season

##### Parameters

Expand All @@ -2650,7 +2650,7 @@ Returns the all the NHL player game center statistics for a specific player for

##### Returns

Returns the number of face offs won by a player for a specific season and game type
Returns the number of total number of a player statistics for a player for a specific season

##### Parameters

Expand Down Expand Up @@ -2783,11 +2783,11 @@ Returns all the NHL team valid game types for all valid NHL seasons for the sele

##### Summary

Returns the number of face offs won by a player for a specific season and game type
Returns the number of total number of a player statistics for a player for a specific season

##### Returns

Returns the number of face offs won by a player for a specific season and game type
Returns the number of total number of a player statistics for a player for a specific season

##### Parameters

Expand All @@ -2803,11 +2803,11 @@ Returns the number of face offs won by a player for a specific season and game t

##### Summary

Returns the number of face offs won by a player for a specific season and game type
Returns the number of total number of a player statistics for a player for a specific season

##### Returns

Returns the number of face offs won by a player for a specific season and game type
Returns the number of total number of a player statistics for a player for a specific season

##### Parameters

Expand Down
12 changes: 6 additions & 6 deletions Nhl.Api/Src/Api/NhlApi.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -720,26 +720,26 @@ public async Task<bool> IsLeagueActiveAsync(CancellationToken cancellationToken
}

/// <summary>
/// Returns the number of face offs won by a player for a specific season and game type
/// Returns the number of total number of a player statistics for a player for a specific season
/// </summary>
/// <param name="playerEnum">The player enumeration identifier, specifying which the NHL player, <see cref="PlayerEnum"/> for more information </param>
/// <param name="playerGameCenterStatistic">The NHL player game center statistic type, <see cref="PlayerGameCenterStatistic"/> for more information on valid game center statistics</param>
/// <param name="seasonYear">The NHL season year to retrieve the team statistics, see <see cref="SeasonYear"/> for more information on valid season years</param>
/// <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation</param>
/// <returns>Returns the number of face offs won by a player for a specific season and game type</returns>
/// <returns>Returns the number of total number of a player statistics for a player for a specific season</returns>
public async Task<int> GetTotalPlayerStatisticValueByTypeAndSeasonAsync(PlayerEnum playerEnum, PlayerGameCenterStatistic playerGameCenterStatistic, string seasonYear, CancellationToken cancellationToken = default)
{
return await _nhlStatisticsApi.GetTotalPlayerStatisticValueByTypeAndSeasonAsync(playerEnum, playerGameCenterStatistic, seasonYear, cancellationToken);
}

/// <summary>
/// Returns the number of face offs won by a player for a specific season and game type
/// Returns the number of total number of a player statistics for a player for a specific season
/// </summary>
/// <param name="playerId">The NHL player identifier, Example: 8478402 - Connor McDavid</param>
/// <param name="playerGameCenterStatistic">The NHL player game center statistic type, <see cref="PlayerGameCenterStatistic"/> for more information on valid game center statistics</param>
/// <param name="seasonYear">The NHL season year to retrieve the team statistics, see <see cref="SeasonYear"/> for more information on valid season years</param>
/// <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation</param>
/// <returns>Returns the number of face offs won by a player for a specific season and game type</returns>
/// <returns>Returns the number of total number of a player statistics for a player for a specific season</returns>
public async Task<int> GetTotalPlayerStatisticValueByTypeAndSeasonAsync(int playerId, PlayerGameCenterStatistic playerGameCenterStatistic, string seasonYear, CancellationToken cancellationToken = default)
{
return await _nhlStatisticsApi.GetTotalPlayerStatisticValueByTypeAndSeasonAsync(playerId, playerGameCenterStatistic, seasonYear, cancellationToken);
Expand All @@ -761,7 +761,7 @@ public async Task<List<PlayerDataSearchResult>> GetAllPlayersAsync(CancellationT
/// <param name="playerId">The NHL player identifier, specifying which the NHL player, Example: 8478402 - Connor McDavid </param>
/// <param name="seasonYear">The NHL season year to retrieve the team statistics, see <see cref="SeasonYear"/> for more information on valid season years</param>
/// <param name="cancellationToken">A cancellation token to cancel the asynchronous operation</param>
/// <returns>Returns the number of face offs won by a player for a specific season and game type</returns>
/// <returns>Returns the all the NHL player game center statistics for a specific player for a specific season and game type</returns>
public async Task<(PlayerProfile PlayerProfile, Dictionary<PlayerGameCenterStatistic, int> StatisticsTotals)> GetAllTotalPlayerStatisticValueBySeasonAsync(int playerId, string seasonYear, CancellationToken cancellationToken = default)
{
return await _nhlStatisticsApi.GetAllTotalPlayerStatisticValueBySeasonAsync(playerId, seasonYear, cancellationToken);
Expand All @@ -773,7 +773,7 @@ public async Task<List<PlayerDataSearchResult>> GetAllPlayersAsync(CancellationT
/// <param name="playerEnum">The player enumeration identifier, specifying which the NHL player, <see cref="PlayerEnum"/> for more information </param>
/// <param name="seasonYear">The NHL season year to retrieve the team statistics, see <see cref="SeasonYear"/> for more information on valid season years</param>
/// <param name="cancellationToken">A cancellation token to cancel the asynchronous operation</param>
/// <returns>Returns the number of face offs won by a player for a specific season and game type</returns>
/// <returns>Returns the all the NHL player game center statistics for a specific player for a specific season and game type</returns>
public async Task<(PlayerProfile PlayerProfile, Dictionary<PlayerGameCenterStatistic, int> StatisticsTotals)> GetAllTotalPlayerStatisticValueBySeasonAsync(PlayerEnum playerEnum, string seasonYear, CancellationToken cancellationToken = default)
{
return await _nhlStatisticsApi.GetAllTotalPlayerStatisticValueBySeasonAsync(playerEnum, seasonYear, cancellationToken);
Expand Down
13 changes: 6 additions & 7 deletions Nhl.Api/Src/StatisticsApi/INhlStatisticsApi.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ public interface INhlStatisticsApi
/// <param name="playerGameCenterStatistic">The player game center statistic type, <see cref="PlayerGameCenterStatistic"/> for more information </param>
/// <param name="seasonYear">The NHL season year to retrieve the team statistics, see <see cref="SeasonYear"/> for more information on valid season years</param>
/// <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation</param>
/// <returns>Returns the number of face offs won by a player for a specific season and game type</returns>
/// <returns>Returns the total value of a statistic type for a player for a specific season, including face offs won, hits, shots on goal, missed shots, blocked shots, giveaways, penalties and takeaways</returns>
public Task<int> GetTotalPlayerStatisticValueByTypeAndSeasonAsync(PlayerEnum playerEnum, PlayerGameCenterStatistic playerGameCenterStatistic, string seasonYear, CancellationToken cancellationToken = default);

/// <summary>
Expand All @@ -90,25 +90,24 @@ public interface INhlStatisticsApi
/// <param name="playerGameCenterStatistic">The player game center statistic type, <see cref="PlayerGameCenterStatistic"/> for more information </param>
/// <param name="seasonYear">The NHL season year to retrieve the team statistics, see <see cref="SeasonYear"/> for more information on valid season years</param>
/// <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation</param>
/// <returns>Returns the number of face offs won by a player for a specific season</returns>
/// <returns>Returns the total value of a statistic type for a player for a specific season, including face offs won, hits, shots on goal, missed shots, blocked shots, giveaways, penalties and takeaways</returns>
public Task<int> GetTotalPlayerStatisticValueByTypeAndSeasonAsync(int playerId, PlayerGameCenterStatistic playerGameCenterStatistic, string seasonYear, CancellationToken cancellationToken = default);

/// <summary>
/// Returns the all the NHL player game center statistics for a specific player for a specific season and game type
/// Returns the all the NHL player game center statistics for a specific player for a specific season
/// </summary>
/// <param name="playerId">The NHL player identifier, specifying which the NHL player, Example: 8478402 - Connor McDavid </param>
/// <param name="seasonYear">The NHL season year to retrieve the team statistics, see <see cref="SeasonYear"/> for more information on valid season years</param>
/// <param name="cancellationToken">A cancellation token to cancel the asynchronous operation</param>
/// <returns>Returns the number of face offs won by a player for a specific season and game type</returns>
/// <returns>Returns the number of total number of a player statistics for a player for a specific season</returns>
public Task<(PlayerProfile PlayerProfile, Dictionary<PlayerGameCenterStatistic, int> StatisticsTotals)> GetAllTotalPlayerStatisticValueBySeasonAsync(int playerId, string seasonYear, CancellationToken cancellationToken = default);


/// <summary>
/// Returns the all the NHL player game center statistics for a specific player for a specific season and game type
/// Returns the all the NHL player game center statistics for a specific player for a specific season
/// </summary>
/// <param name="playerEnum">The player enumeration identifier, specifying which the NHL player, <see cref="PlayerEnum"/> for more information </param>
/// <param name="seasonYear">The NHL season year to retrieve the team statistics, see <see cref="SeasonYear"/> for more information on valid season years</param>
/// <param name="cancellationToken">A cancellation token to cancel the asynchronous operation</param>
/// <returns>Returns the number of face offs won by a player for a specific season and game type</returns>
/// <returns>Returns the number of total number of a player statistics for a player for a specific season</returns>
public Task<(PlayerProfile PlayerProfile, Dictionary<PlayerGameCenterStatistic, int> StatisticsTotals)> GetAllTotalPlayerStatisticValueBySeasonAsync(PlayerEnum playerEnum, string seasonYear, CancellationToken cancellationToken = default);
}
12 changes: 6 additions & 6 deletions Nhl.Api/Src/StatisticsApi/NhlStatisticsApi.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -147,13 +147,13 @@ public async Task<List<TeamStatisticsSeason>> GetTeamStatisticsBySeasonAsync(int
}

/// <summary>
/// Returns the number of face offs won by a player for a specific season and game type
/// Returns the number of total number of a player statistics for a player for a specific season
/// </summary>
/// <param name="playerEnum">The player enumeration identifier, specifying which the NHL player, <see cref="PlayerEnum"/> for more information </param>
/// <param name="playerGameCenterStatistic">The NHL player game center statistic type, <see cref="PlayerGameCenterStatistic"/> for more information on valid game center statistics</param>
/// <param name="seasonYear">The NHL season year to retrieve the team statistics, see <see cref="SeasonYear"/> for more information on valid season years</param>
/// <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation</param>
/// <returns>Returns the number of face offs won by a player for a specific season and game type</returns>
/// <returns>Returns the number of total number of a player statistics for a player for a specific season</returns>
public async Task<int> GetTotalPlayerStatisticValueByTypeAndSeasonAsync(PlayerEnum playerEnum, PlayerGameCenterStatistic playerGameCenterStatistic, string seasonYear, CancellationToken cancellationToken = default)
{
var statisticTotal = 0;
Expand Down Expand Up @@ -208,13 +208,13 @@ public async Task<int> GetTotalPlayerStatisticValueByTypeAndSeasonAsync(PlayerEn
}

/// <summary>
/// Returns the number of face offs won by a player for a specific season and game type
/// Returns the number of total number of a player statistics for a player for a specific season
/// </summary>
/// <param name="playerId">The NHL player identifier, specifying which the NHL player, Example: 8478402 - Connor McDavid </param>
/// <param name="playerGameCenterStatistic">The NHL player game center statistic type, <see cref="PlayerGameCenterStatistic"/> for more information on valid game center statistics</param>
/// <param name="seasonYear">The NHL season year to retrieve the team statistics, see <see cref="SeasonYear"/> for more information on valid season years</param>
/// <param name="cancellationToken">A cancellation token to cancel the asynchronous operation</param>
/// <returns>Returns the number of face offs won by a player for a specific season and game type</returns>
/// <returns>Returns the number of total number of a player statistics for a player for a specific season</returns>
public async Task<int> GetTotalPlayerStatisticValueByTypeAndSeasonAsync(int playerId, PlayerGameCenterStatistic playerGameCenterStatistic, string seasonYear, CancellationToken cancellationToken = default)
{
var statisticTotal = 0;
Expand Down Expand Up @@ -273,7 +273,7 @@ public async Task<int> GetTotalPlayerStatisticValueByTypeAndSeasonAsync(int play
/// <param name="playerEnum">The player enumeration identifier, specifying which the NHL player, <see cref="PlayerEnum"/> for more information </param>
/// <param name="seasonYear">The NHL season year to retrieve the team statistics, see <see cref="SeasonYear"/> for more information on valid season years</param>
/// <param name="cancellationToken"> A cancellation token that can be used by other objects or threads to receive notice of cancellation</param>
/// <returns>Returns the number of face offs won by a player for a specific season and game type</returns>
/// <returns>Returns the number of total number of a player statistics for a player for a specific season</returns>
public async Task<(PlayerProfile PlayerProfile, Dictionary<PlayerGameCenterStatistic, int> StatisticsTotals)> GetAllTotalPlayerStatisticValueBySeasonAsync(PlayerEnum playerEnum, string seasonYear, CancellationToken cancellationToken = default)
{
var statisticTotals = new Dictionary<PlayerGameCenterStatistic, int>
Expand Down Expand Up @@ -355,7 +355,7 @@ public async Task<int> GetTotalPlayerStatisticValueByTypeAndSeasonAsync(int play
/// <param name="playerId">The NHL player identifier, specifying which the NHL player, Example: 8478402 - Connor McDavid </param>
/// <param name="seasonYear">The NHL season year to retrieve the team statistics, see <see cref="SeasonYear"/> for more information on valid season years</param>
/// <param name="cancellationToken">A cancellation token to cancel the asynchronous operation</param>
/// <returns>Returns the number of face offs won by a player for a specific season and game type</returns>
/// <returns>Returns the number of total number of a player statistics for a player for a specific season</returns>
public async Task<(PlayerProfile PlayerProfile, Dictionary<PlayerGameCenterStatistic, int> StatisticsTotals)> GetAllTotalPlayerStatisticValueBySeasonAsync(int playerId, string seasonYear, CancellationToken cancellationToken = default)
{
var statisticTotals = new Dictionary<PlayerGameCenterStatistic, int>
Expand Down

0 comments on commit 6b099e4

Please sign in to comment.