documentation.

RecrownedAthenaeum/UI/Modular/UIModuleGroup.cs

@@ -7,6 +7,10 @@ using RecrownedAthenaeum.Camera;
 
 namespace RecrownedAthenaeum.UI.Modular
 {
+
+    /// <summary>
+    /// Contains a group of modules and has its own relative coordinate system.
+    /// </summary>
     public class UIModuleGroup : UIModule
     {
         List<UIModule> modules = new List<UIModule>();
@@ -24,6 +28,10 @@ namespace RecrownedAthenaeum.UI.Modular
             }
         }
 
+        /// <summary>
+        /// Draws this group of modules.
+        /// </summary>
+        /// <param name="batch">Batch used to draw the group.</param>
         public override void Draw(SpriteBatch batch)
         {
             if (scissorBounds != null)
@@ -57,6 +65,10 @@ namespace RecrownedAthenaeum.UI.Modular
             }
         }
 
+        /// <summary>
+        /// Updates the group of modules.
+        /// </summary>
+        /// <param name="gameTime">Game time used.</param>
         public override void Update(GameTime gameTime)
         {
             foreach (UIModule module in modules)
@@ -92,6 +104,11 @@ namespace RecrownedAthenaeum.UI.Modular
             modules.Remove(module);
         }
 
+        /// <summary>
+        /// Updates the keyboard state of the modules in this group.
+        /// </summary>
+        /// <param name="state">The new state.</param>
+        /// <returns>Whether or not to continue updating the other listeners.</returns>
         public override bool KeyboardStateChanged(KeyboardState state)
         {
             foreach (UIModule module in modules)
@@ -101,6 +118,11 @@ namespace RecrownedAthenaeum.UI.Modular
             return base.KeyboardStateChanged(state);
         }
 
+        /// <summary>
+        /// Updates the moues state of the modules in this group.
+        /// </summary>
+        /// <param name="state">The new state.</param>
+        /// <returns>Whether or not to continue updating other listeners.</returns>
         public override bool MouseStateChanged(MouseState state)
         {
             foreach (UIModule module in modules)