From 4699b5ad7c3da198a66636068050d809a419446b Mon Sep 17 00:00:00 2001
From: smoogipoo <smoogipoo@smgi.me>
Date: Thu, 8 Feb 2018 23:47:03 +0900
Subject: [PATCH] Fix a few code styling issues
These are present in the netstandard branch (the rules aren't working there - probably using the wrong configuration).
---
osu.Game/Rulesets/Objects/HitWindows.cs | 4 ++--
osu.Game/Rulesets/Objects/Types/IHasCurve.cs | 3 +++
osu.Game/Rulesets/UI/Scrolling/ScrollingPlayfield.cs | 4 ++--
3 files changed, 7 insertions(+), 4 deletions(-)
diff --git a/osu.Game/Rulesets/Objects/HitWindows.cs b/osu.Game/Rulesets/Objects/HitWindows.cs
index 0ec8389b4f..ddd9f9b5dc 100644
--- a/osu.Game/Rulesets/Objects/HitWindows.cs
+++ b/osu.Game/Rulesets/Objects/HitWindows.cs
@@ -37,7 +37,7 @@ namespace osu.Game.Rulesets.Objects
public double Good { get; protected set; }
/// <summary>
- /// Hit window for an <see cref="HitResult.OK"/> result.
+ /// Hit window for an <see cref="HitResult.Ok"/> result.
/// The user can only achieve this result if <see cref="AllowsOk"/> is true.
/// </summary>
public double Ok { get; protected set; }
@@ -130,7 +130,7 @@ namespace osu.Game.Rulesets.Objects
/// <summary>
/// Given a time offset, whether the <see cref="HitObject"/> can ever be hit in the future with a non-<see cref="HitResult.Miss"/> result.
- /// This happens if <paramref name="timeOffset"/> ≤ <see cref="Meh"/>.
+ /// This happens if <paramref name="timeOffset"/> is less than what is required for a <see cref="Meh"/> result.
/// </summary>
/// <param name="timeOffset">The time offset.</param>
/// <returns>Whether the <see cref="HitObject"/> can be hit at any point in the future from this time offset.</returns>
diff --git a/osu.Game/Rulesets/Objects/Types/IHasCurve.cs b/osu.Game/Rulesets/Objects/Types/IHasCurve.cs
index 0254a829f4..7f03854ea9 100644
--- a/osu.Game/Rulesets/Objects/Types/IHasCurve.cs
+++ b/osu.Game/Rulesets/Objects/Types/IHasCurve.cs
@@ -35,6 +35,7 @@ namespace osu.Game.Rulesets.Objects.Types
/// Ranges from [0, 1] where 0 is the beginning of the curve and 1 is the end of the curve.
/// </para>
/// </summary>
+ /// <param name="obj">The curve.</param>
/// <param name="progress">[0, 1] where 0 is the beginning of the curve and 1 is the end of the curve.</param>
public static Vector2 PositionAt(this IHasCurve obj, double progress)
=> obj.Curve.PositionAt(obj.ProgressAt(progress));
@@ -42,6 +43,7 @@ namespace osu.Game.Rulesets.Objects.Types
/// <summary>
/// Finds the progress along the curve, accounting for repeat logic.
/// </summary>
+ /// <param name="obj">The curve.</param>
/// <param name="progress">[0, 1] where 0 is the beginning of the curve and 1 is the end of the curve.</param>
/// <returns>[0, 1] where 0 is the beginning of the curve and 1 is the end of the curve.</returns>
public static double ProgressAt(this IHasCurve obj, double progress)
@@ -55,6 +57,7 @@ namespace osu.Game.Rulesets.Objects.Types
/// <summary>
/// Determines which span of the curve the progress point is on.
/// </summary>
+ /// <param name="obj">The curve.</param>
/// <param name="progress">[0, 1] where 0 is the beginning of the curve and 1 is the end of the curve.</param>
/// <returns>[0, SpanCount) where 0 is the first run.</returns>
public static int SpanAt(this IHasCurve obj, double progress)
diff --git a/osu.Game/Rulesets/UI/Scrolling/ScrollingPlayfield.cs b/osu.Game/Rulesets/UI/Scrolling/ScrollingPlayfield.cs
index 287e917c7b..e168f6daec 100644
--- a/osu.Game/Rulesets/UI/Scrolling/ScrollingPlayfield.cs
+++ b/osu.Game/Rulesets/UI/Scrolling/ScrollingPlayfield.cs
@@ -52,7 +52,7 @@ namespace osu.Game.Rulesets.UI.Scrolling
protected virtual bool UserScrollSpeedAdjustment => true;
/// <summary>
- /// The container that contains the <see cref="SpeedAdjustmentContainer"/>s and <see cref="DrawableHitObject"/>s.
+ /// The container that contains the <see cref="DrawableHitObject"/>s.
/// </summary>
public new ScrollingHitObjectContainer HitObjects => (ScrollingHitObjectContainer)base.HitObjects;
@@ -61,7 +61,7 @@ namespace osu.Game.Rulesets.UI.Scrolling
/// <summary>
/// Creates a new <see cref="ScrollingPlayfield"/>.
/// </summary>
- /// <param name="scrollingAxes">The axes on which <see cref="DrawableHitObject"/>s in this container should scroll.</param>
+ /// <param name="direction">The direction in which <see cref="DrawableHitObject"/>s in this container should scroll.</param>
/// <param name="customWidth">Whether we want our internal coordinate system to be scaled to a specified width</param>
protected ScrollingPlayfield(ScrollingDirection direction, float? customWidth = null)
: base(customWidth)