h1or4dme8/osu-lazer
1
0
Fork 0
mirror of https://github.com/ppy/osu.git synced 2025-01-13 16:32:54 +08:00
Code Issues Releases Wiki Activity

Update and improve code documentation

Browse Source 
Co-authored-by: Dean Herbert <pe@ppy.sh>
This commit is contained in:
Salman Ahmed 2021-06-22 12:05:17 +03:00 committed by GitHub
parent ece63b9ba1
commit 71e2815e7e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 4 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
osu.Game/Skinning/RulesetSkinProvidingContainer.cs
View File

@ -13,8 +13,7 @@ namespace osu.Game.Skinning
{ {
/// <summary> /// <summary>
/// A type of <see cref="SkinProvidingContainer"/> specialized for <see cref="DrawableRuleset"/> and other gameplay-related components. /// A type of <see cref="SkinProvidingContainer"/> specialized for <see cref="DrawableRuleset"/> and other gameplay-related components.
/// Providing access to the <see cref="SkinManager"/> skin sources and the beatmap skin each surrounded with the ruleset legacy skin transformer. /// Providing access to parent skin sources and the beatmap skin each surrounded with the ruleset legacy skin transformer.
/// While also limiting lookups from falling back to any parent <see cref="ISkinSource"/>s out of this container.
/// </summary> /// </summary>
public class RulesetSkinProvidingContainer : SkinProvidingContainer public class RulesetSkinProvidingContainer : SkinProvidingContainer
{ {
@ -22,7 +21,7 @@ namespace osu.Game.Skinning
protected readonly IBeatmap Beatmap; protected readonly IBeatmap Beatmap;
/// <remarks> /// <remarks>
/// This container already re-exposes all <see cref="SkinManager"/> skin sources in a ruleset-usable form. /// This container already re-exposes all parent <see cref="ISkinSource"/> sources in a ruleset-usable form.
/// Therefore disallow falling back to any parent <see cref="ISkinSource"/> any further. /// Therefore disallow falling back to any parent <see cref="ISkinSource"/> any further.
/// </remarks> /// </remarks>
protected override bool AllowFallingBackToParent => false; protected override bool AllowFallingBackToParent => false;

4
osu.Game/Skinning/SkinManager.cs
View File

@ -34,8 +34,8 @@ namespace osu.Game.Skinning
/// Handles the storage and retrieval of <see cref="Skin"/>s. /// Handles the storage and retrieval of <see cref="Skin"/>s.
/// </summary> /// </summary>
/// <remarks> /// <remarks>
/// This is also exposed and cached as <see cref="ISkinSource"/> on a game-wide level for general components across the game. /// This is also exposed and cached as <see cref="ISkinSource"/> to allow for any component to potentially have skinning support.
/// Lookups from gameplay components are instead covered by <see cref="RulesetSkinProvidingContainer"/>, and are never hit here. /// For gameplay components, see <see cref="RulesetSkinProvidingContainer"/> which adds extra legacy and toggle logic that may affect the lookup process.
/// </remarks> /// </remarks>
[ExcludeFromDynamicCompile] [ExcludeFromDynamicCompile]
public class SkinManager : ArchiveModelManager<SkinInfo, SkinFileInfo>, ISkinSource, IStorageResourceProvider public class SkinManager : ArchiveModelManager<SkinInfo, SkinFileInfo>, ISkinSource, IStorageResourceProvider