Minor documentation additions

antonpup · Sep 18, 2016 · 6fbb183 · 6fbb183
1 parent d1ee372
commit 6fbb183
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 2 deletions.
diff --git a/Dota2GSI/Dota2GSI/GameState.cs b/Dota2GSI/Dota2GSI/GameState.cs
@@ -171,6 +171,10 @@ private String GetNode(string name)
                 return "";
         }
 
+        /// <summary>
+        /// Returns the json string that generated this GameState instance
+        /// </summary>
+        /// <returns>Json string</returns>
         public override string ToString()
         {
             return json;

diff --git a/Dota2GSI/Dota2GSI/Nodes/Abilities.cs b/Dota2GSI/Dota2GSI/Nodes/Abilities.cs
@@ -53,6 +53,9 @@ public Ability this[int index]
             }
         }
 
+        /// <summary>
+        /// Gets the IEnumerable of Abilities
+        /// </summary>
         public IEnumerator<Ability> GetEnumerator()
         {
             return abilities.GetEnumerator();
@@ -63,11 +66,13 @@ IEnumerator IEnumerable.GetEnumerator()
             return abilities.GetEnumerator();
         }
 
+        /// <summary>
+        /// Returns the json string that generated this Abilities instance
+        /// </summary>
+        /// <returns>Json string</returns>
         public override string ToString()
         {
             return json;
         }
-
-
     }
 }
diff --git a/Dota2GSI/Dota2GSI/Nodes/Auth.cs b/Dota2GSI/Dota2GSI/Nodes/Auth.cs
@@ -1,5 +1,8 @@
 namespace Dota2GSI.Nodes
 {
+    /// <summary>
+    /// A class representing the authentication information for GSI
+    /// </summary>
     public class Auth : Node
     {
         /// <summary>

diff --git a/Dota2GSI/Dota2GSI/Nodes/Map.cs b/Dota2GSI/Dota2GSI/Nodes/Map.cs
@@ -87,6 +87,9 @@ public enum PlayerTeam
         Radiant
     }
 
+    /// <summary>
+    /// Class representing information about the map
+    /// </summary>
     public class Map : Node
     {
         /// <summary>