From 421e9e0641d0d42d2b4a32b9f585d3c97c6eaaac Mon Sep 17 00:00:00 2001
From: Dean Herbert <pe@ppy.sh>
Date: Sun, 8 Apr 2018 12:58:34 +0900
Subject: [PATCH] Add xmldoc to some high-level classes to explain their
 separation

---
 osu.Game/OsuGame.cs     | 4 ++++
 osu.Game/OsuGameBase.cs | 5 +++++
 2 files changed, 9 insertions(+)

diff --git a/osu.Game/OsuGame.cs b/osu.Game/OsuGame.cs
index 89447b8ed6..2f6f8ff348 100644
--- a/osu.Game/OsuGame.cs
+++ b/osu.Game/OsuGame.cs
@@ -36,6 +36,10 @@
 
 namespace osu.Game
 {
+    /// <summary>
+    /// The full osu! experience. Builds on top of <see cref="OsuGameBase"/> to add menus and binding logic
+    /// for initial components that are generally retrieved via DI.
+    /// </summary>
     public class OsuGame : OsuGameBase, IKeyBindingHandler<GlobalAction>
     {
         public Toolbar Toolbar;
diff --git a/osu.Game/OsuGameBase.cs b/osu.Game/OsuGameBase.cs
index 54a279e977..533a04286b 100644
--- a/osu.Game/OsuGameBase.cs
+++ b/osu.Game/OsuGameBase.cs
@@ -34,6 +34,11 @@
 
 namespace osu.Game
 {
+    /// <summary>
+    /// The most basic <see cref="Game"/> that can be used to host osu! components and systems.
+    /// Unlike <see cref="OsuGame"/>, this class will not load any kind of UI, allowing it to be used
+    /// for provide dependencies to test cases without interfering with them.
+    /// </summary>
     public class OsuGameBase : Framework.Game, ICanAcceptFiles
     {
         protected OsuConfigManager LocalConfig;