diff --git a/SteamStorefrontAPI/Endpoints/AppDetails.cs b/SteamStorefrontAPI/Endpoints/AppDetails.cs
index 0a09f24..881c5a4 100644
--- a/SteamStorefrontAPI/Endpoints/AppDetails.cs
+++ b/SteamStorefrontAPI/Endpoints/AppDetails.cs
@@ -9,21 +9,33 @@ using System.Threading.Tasks;
namespace SteamStorefrontAPI
{
+ ///
+ /// Endpoint returning details for an application in the steam store.
public static class AppDetails
{
private static HttpClient client = new HttpClient();
private const string steamBaseUri = "http://store.steampowered.com/api/appdetails";
+ /// Retrieves details for the specified application via an asynchronous operation.
+ /// Steam App ID.
public static async Task GetAsync(int AppId)
{
return await GetAsync(AppId, "", "");
}
+ /// Retrieves details for the specified application via an asynchronous operation.
+ /// Steam App ID.
+ /// Two letter country code to customise currency and date values.
public static async Task GetAsync(int AppId, string CountryCode)
{
return await GetAsync(AppId, CountryCode, "");
}
+ ///
+ /// Retrieves details for the specified application via an asynchronous operation.
+ /// Steam App ID.
+ /// Two letter country code to customise currency and date values.
+ /// Full name of the language in english used for string localization e.g. title, description, release dates.
public static async Task GetAsync(int AppId, string CountryCode, string Language)
{
string steamUri = $"{steamBaseUri}?appids={AppId}";
diff --git a/SteamStorefrontAPI/Endpoints/Featured.cs b/SteamStorefrontAPI/Endpoints/Featured.cs
index a9f7220..352bbe9 100644
--- a/SteamStorefrontAPI/Endpoints/Featured.cs
+++ b/SteamStorefrontAPI/Endpoints/Featured.cs
@@ -9,22 +9,32 @@ using System.Threading.Tasks;
namespace SteamStorefrontAPI
{
+ ///
+ /// Endpoint returning a list of featured items in the steam store.
public static class Featured
{
private static HttpClient client = new HttpClient();
private const string steamBaseUri = "https://store.steampowered.com/api/featured";
-
+ ///
+ /// Retrieves a list of featured items via an asynchronous operation.
public static async Task GetAsync()
{
return await GetAsync(null, null);
}
+ ///
+ /// Retrieves a list of featured items via an asynchronous operation.
+ /// Two letter country code to customise currency and date values.
public static async Task GetAsync(string CountryCode)
{
return await GetAsync(CountryCode, null);
}
+ ///
+ /// Retrieves a list of featured items via an asynchronous operation.
+ /// Two letter country code to customise currency and date values.
+ /// Full name of the language in english used for string localization e.g. name, description.
public static async Task GetAsync(string CountryCode, string Language)
{
string steamUri = steamBaseUri;
diff --git a/SteamStorefrontAPI/Endpoints/FeaturedCategories.cs b/SteamStorefrontAPI/Endpoints/FeaturedCategories.cs
index 1724392..5aa1ed8 100644
--- a/SteamStorefrontAPI/Endpoints/FeaturedCategories.cs
+++ b/SteamStorefrontAPI/Endpoints/FeaturedCategories.cs
@@ -9,21 +9,32 @@ using System.Threading.Tasks;
namespace SteamStorefrontAPI
{
+ ///
+ /// Endpoint returning a list of featured items, grouped by category, in the steam store.
public static class FeaturedCategories
{
private static HttpClient client = new HttpClient();
private const string steamBaseUri = "https://store.steampowered.com/api/featuredcategories";
+ ///
+ /// Retrieves a list of featured items, grouped by category, via an asynchronous operation.
public static async Task> GetAsync()
{
return await GetAsync(null, null);
}
+ ///
+ /// Retrieves a list of featured items, grouped by category, via an asynchronous operation.
+ /// Two letter country code to customise currency and date values.
public static async Task> GetAsync(string CountryCode)
{
return await GetAsync(CountryCode, null);
}
+ ///
+ /// Retrieves a list of featured items, grouped by category, via an asynchronous operation.
+ /// Two letter country code to customise currency and date values.
+ /// Full name of the language in english used for string localization e.g. name, description.
public static async Task> GetAsync(string CountryCode, string Language)
{
string steamUri = steamBaseUri;
diff --git a/SteamStorefrontAPI/Endpoints/PackageDetails.cs b/SteamStorefrontAPI/Endpoints/PackageDetails.cs
index 0093ce9..37a3db5 100644
--- a/SteamStorefrontAPI/Endpoints/PackageDetails.cs
+++ b/SteamStorefrontAPI/Endpoints/PackageDetails.cs
@@ -9,21 +9,35 @@ using System.Threading.Tasks;
namespace SteamStorefrontAPI
{
+ ///
+ /// Endpoint returning details for a package in the steam store.
public static class PackageDetails
{
private static HttpClient client = new HttpClient();
private const string steamBaseUri = "http://store.steampowered.com/api/packagedetails";
+ ///
+ /// Retrieves details for the specified package via an asynchronous operation.
+ /// Steam package ID.
public static async Task GetAsync(int PackageId)
{
return await GetAsync(PackageId, null, null);
}
+ ///
+ /// Retrieves details for the specified package via an asynchronous operation.
+ /// Steam package ID.
+ /// Two letter country code to customise currency and date values.
public static async Task GetAsync(int PackageId, string CountryCode)
{
return await GetAsync(PackageId, CountryCode, null);
}
+ ///
+ /// Retrieves details for the specified package via an asynchronous operation.
+ /// Steam package ID.
+ /// Two letter country code to customise currency and date values.
+ /// Full name of the language in english used for string localization e.g. title, description, release dates.
public static async Task GetAsync(int PackageId, string CountryCode, string Language)
{
string steamUri = $"{steamBaseUri}?packageids={PackageId}";