sim1222/osukey
1
1
Fork 0
mirror of https://github.com/osukey/osukey.git synced 2025-07-02 08:49:59 +09:00
Code Issues Packages Projects Releases Wiki Activity

Add doc comments a bit

Browse Source
This commit is contained in:
ekrctb
2020-12-08 23:11:22 +09:00
parent 1f36bbecd1
commit 5ca98b0033
2 changed files with 9 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
osu.Game.Rulesets.Catch/Objects/Drawables/CaughtObject.cs
View File

@ -12,6 +12,9 @@ using osuTK.Graphics;
namespace osu.Game.Rulesets.Catch.Objects.Drawables namespace osu.Game.Rulesets.Catch.Objects.Drawables
{ {
/// <summary>
/// Represents a <see cref="PalpableCatchHitObject"/> caught by the catcher.
/// </summary>
[Cached(typeof(IHasCatchObjectState))] [Cached(typeof(IHasCatchObjectState))]
public abstract class CaughtObject : SkinnableDrawable, IHasCatchObjectState public abstract class CaughtObject : SkinnableDrawable, IHasCatchObjectState
{ {

6
osu.Game.Rulesets.Catch/Objects/Drawables/IHasCatchObjectState.cs
View File

@ -7,6 +7,9 @@ using osuTK.Graphics;
namespace osu.Game.Rulesets.Catch.Objects.Drawables namespace osu.Game.Rulesets.Catch.Objects.Drawables
{ {
/// <summary>
/// Provides a visual state of a <see cref="PalpableCatchHitObject"/>.
/// </summary>
public interface IHasCatchObjectState public interface IHasCatchObjectState
{ {
PalpableCatchHitObject HitObject { get; } PalpableCatchHitObject HitObject { get; }
@ -17,6 +20,9 @@ namespace osu.Game.Rulesets.Catch.Objects.Drawables
Vector2 Scale { get; } Vector2 Scale { get; }
} }
/// <summary>
/// Provides a visual state of a <see cref="Fruit"/>.
/// </summary>
public interface IHasFruitState : IHasCatchObjectState public interface IHasFruitState : IHasCatchObjectState
{ {
Bindable<FruitVisualRepresentation> VisualRepresentation { get; } Bindable<FruitVisualRepresentation> VisualRepresentation { get; }