diff --git a/src/OnePeek.Api/AppMetadataEndpoint.cs b/src/OnePeek.Api/AppMetadataEndpoint.cs
index b156fff..62c4d7e 100644
--- a/src/OnePeek.Api/AppMetadataEndpoint.cs
+++ b/src/OnePeek.Api/AppMetadataEndpoint.cs
@@ -7,11 +7,19 @@ using System.Threading.Tasks;
using System.Xml.Linq;
using System.Linq;
using System.Collections.Generic;
+using System.Diagnostics;
namespace OnePeek.Api
{
public class AppMetadataEndpoint : ApiBase
{
+ ///
+ /// Get app description, images, publisher, rating and more for an app in the specified culture.
+ ///
+ /// The ID of the app. Can be found in the dev portal or the store URI.
+ /// The store where the app is published.
+ /// Culture of the query (returns location specific metadata + ratings).
+ ///
public async Task GetMetadata(string appId, StoreType store, StoreCultureType storeCulture)
{
if (storeCulture == StoreCultureType.Unknown)
@@ -61,6 +69,12 @@ namespace OnePeek.Api
+ ///
+ /// Creates an URI from an image urn (included in the AppImage POCO).
+ ///
+ /// The urn (is part of the AppImage).
+ /// Crops the image accordingly.
+ ///
public Uri GetImageUri(string urn, StoreImageType imageType = StoreImageType.None)
{
string type = imageType.GetEnumDisplayName();
@@ -69,6 +83,12 @@ namespace OnePeek.Api
+ ///
+ /// Returns a stream for a store image.
+ ///
+ /// The urn (is part of the AppImage).
+ /// Crops the image accordingly.
+ ///
public async Task GetImageAsStream(string urn, StoreImageType imageType = StoreImageType.None)
{
string type = imageType.GetEnumDisplayName();
diff --git a/src/OnePeek.Api/AppRatingEndpoint.cs b/src/OnePeek.Api/AppRatingEndpoint.cs
index c4d8041..f26c2ef 100644
--- a/src/OnePeek.Api/AppRatingEndpoint.cs
+++ b/src/OnePeek.Api/AppRatingEndpoint.cs
@@ -10,6 +10,14 @@ namespace OnePeek.Api
{
public class AppRatingEndpoint : ApiBase
{
+ ///
+ /// Get a list of reviews (up to 20 per request) for the specified app.
+ ///
+ /// The ID of the app. Can be found in the dev portal or the store URI.
+ /// The store where the app is published.
+ /// Culture of the query (returns location specific metadata + ratings).
+ /// Sorting criteria.
+ ///
public async Task GetReviews(string appId, StoreType store, StoreCultureType storeCulture, StoreReviewSorting sorting)
{
if (storeCulture == StoreCultureType.Unknown)
diff --git a/src/OnePeek.Api/Configuration.cs b/src/OnePeek.Api/Configuration.cs
index 40817f5..36b12c8 100644
--- a/src/OnePeek.Api/Configuration.cs
+++ b/src/OnePeek.Api/Configuration.cs
@@ -1,7 +1,14 @@
namespace OnePeek.Api
{
+ ///
+ /// Coniguration options for the API
+ ///
public static class Configuration
{
+ ///
+ /// Ratings are returned on a 1-10 scale by default.
+ /// This changes it to a 1-5 scale, which is more suited for displaying it as stars.
+ ///
public static bool UseFiveStarSystem = false;
}
}
diff --git a/src/OnePeek.Api/Extensions/EntityExtensions.cs b/src/OnePeek.Api/Extensions/EntityExtensions.cs
index 5ce8c3b..d7b2b72 100644
--- a/src/OnePeek.Api/Extensions/EntityExtensions.cs
+++ b/src/OnePeek.Api/Extensions/EntityExtensions.cs
@@ -1,14 +1,16 @@
using OnePeek.Entities;
using System;
-using System.Collections.Generic;
-using System.Linq;
-using System.Text;
-using System.Threading.Tasks;
namespace OnePeek.Api.Extensions
{
public static class EntityExtensions
{
+ ///
+ /// Creates an URI from an image.
+ ///
+ /// The appImage is returned as part of API endpoint requests.
+ /// Crops the image accordingly.
+ ///
public static Uri GetUri(this AppImage appImage, StoreImageType imageType = StoreImageType.None)
{
return EndpointUris.GetWindowsPhoneImageUri(appImage.Urn, imageType.GetEnumDisplayName());