sim1222/osukey
1
1
Fork 0
mirror of https://github.com/osukey/osukey.git synced 2025-05-30 01:47:30 +09:00
Code Issues Packages Projects Releases Wiki Activity

Add xmldoc to some high-level classes to explain their separation

Browse Source
This commit is contained in:
Dean Herbert 2018-04-08 12:58:34 +09:00
parent 81981acc68
commit 421e9e0641
2 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
osu.Game/OsuGame.cs
View File

@ -36,6 +36,10 @@ using osu.Game.Overlays.Volume;
namespace osu.Game 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 class OsuGame : OsuGameBase, IKeyBindingHandler<GlobalAction>
{ {
public Toolbar Toolbar; public Toolbar Toolbar;

5
osu.Game/OsuGameBase.cs
View File

@ -34,6 +34,11 @@ using osu.Game.Skinning;
namespace osu.Game 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 public class OsuGameBase : Framework.Game, ICanAcceptFiles
{ {
protected OsuConfigManager LocalConfig; protected OsuConfigManager LocalConfig;