From d56e380c72e23eeda4cf8ba9315d869a15f5dd92 Mon Sep 17 00:00:00 2001
From: Garry Newman <garrynewman@gmail.com>
Date: Wed, 9 Nov 2016 12:21:57 +0000
Subject: [PATCH] Comments

---
 Facepunch.Steamworks/Client/Friends.cs        | 15 ++++++++++++
 .../Interfaces/Inventory.Definition.cs        | 23 +++++++++++++++++++
 2 files changed, 38 insertions(+)

diff --git a/Facepunch.Steamworks/Client/Friends.cs b/Facepunch.Steamworks/Client/Friends.cs
index b393602..7893415 100644
--- a/Facepunch.Steamworks/Client/Friends.cs
+++ b/Facepunch.Steamworks/Client/Friends.cs
@@ -98,6 +98,15 @@ namespace Facepunch.Steamworks
         }
     }
 
+    /// <summary>
+    /// Handles most interactions with people in Steam, not just friends as the name would suggest.
+    /// </summary>
+    /// <example>
+    /// foreach ( var friend in client.Friends.AllFriends )
+    /// {
+    ///     Console.WriteLine( $"{friend.Id}: {friend.Name}" );
+    /// }
+    /// </example>
     public class Friends
     {
         internal Client client;
@@ -133,6 +142,9 @@ namespace Facepunch.Steamworks
             }
         }
 
+        /// <summary>
+        /// Returns only friends
+        /// </summary>
         public IEnumerable<SteamFriend> AllFriends
         {
             get
@@ -146,6 +158,9 @@ namespace Facepunch.Steamworks
             }
         }
 
+        /// <summary>
+        /// Returns all blocked users
+        /// </summary>
         public IEnumerable<SteamFriend> AllBlocked
         {
             get
diff --git a/Facepunch.Steamworks/Interfaces/Inventory.Definition.cs b/Facepunch.Steamworks/Interfaces/Inventory.Definition.cs
index 0186293..4ac4c84 100644
--- a/Facepunch.Steamworks/Interfaces/Inventory.Definition.cs
+++ b/Facepunch.Steamworks/Interfaces/Inventory.Definition.cs
@@ -144,12 +144,28 @@ namespace Facepunch.Steamworks
             }
         }
 
+        /// <summary>
+        /// Represents a crafting recepie which was defined using the exchange
+        /// section in the item schema.
+        /// </summary>
         public struct Recipe
         {
             public struct Ingredient
             {
+                /// <summary>
+                /// The definition ID of the ingredient.
+                /// </summary>
                 public int DefinitionId;
+
+                /// <summary>
+                /// If we don't know about this item definition this might be null.
+                /// In which case, DefinitionId should still hold the correct id.
+                /// </summary>
                 public Definition Definition;
+
+                /// <summary>
+                /// The amount of this item needed. Generally this will be 1.
+                /// </summary>
                 public int Count;
 
                 internal static Ingredient FromString( string part, Definition[] definitions )
@@ -171,7 +187,14 @@ namespace Facepunch.Steamworks
                 }
             }
 
+            /// <summary>
+            /// The item that this will create.
+            /// </summary>
             public Definition Result;
+
+            /// <summary>
+            /// The items, with quantity required to create this item.
+            /// </summary>
             public Ingredient[] Ingredients;
 
             internal static Recipe FromString( string part, Definition[] definitions, Definition Result )