Add xmldocs to IPlacementHandler

This commit is contained in:
smoogipoo
2018-10-18 16:46:30 +09:00
parent 0e841628b6
commit 72d48aa7f5

View File

@ -7,9 +7,22 @@ namespace osu.Game.Screens.Edit.Screens.Compose
{ {
public interface IPlacementHandler public interface IPlacementHandler
{ {
/// <summary>
/// Notifies that a placement has begun.
/// </summary>
/// <param name="hitObject">The <see cref="HitObject"/> being placed.</param>
void BeginPlacement(HitObject hitObject); void BeginPlacement(HitObject hitObject);
/// <summary>
/// Notifies that a placement has finished.
/// </summary>
/// <param name="hitObject">The <see cref="HitObject"/> that has been placed.</param>
void EndPlacement(HitObject hitObject); void EndPlacement(HitObject hitObject);
/// <summary>
/// Deletes a <see cref="HitObject"/>.
/// </summary>
/// <param name="hitObject">The <see cref="HitObject"/> to delete.</param>
void Delete(HitObject hitObject); void Delete(HitObject hitObject);
} }
} }