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 @@ using osu.Game.Overlays.Volume; namespace osu.Game { + /// + /// The full osu! experience. Builds on top of to add menus and binding logic + /// for initial components that are generally retrieved via DI. + /// public class OsuGame : OsuGameBase, IKeyBindingHandler { 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 @@ using osu.Game.Skinning; namespace osu.Game { + /// + /// The most basic that can be used to host osu! components and systems. + /// Unlike , this class will not load any kind of UI, allowing it to be used + /// for provide dependencies to test cases without interfering with them. + /// public class OsuGameBase : Framework.Game, ICanAcceptFiles { protected OsuConfigManager LocalConfig;