Skip to content

Commit 2c24a48

Browse files
committed
Refine xmldoc
1 parent 07b866a commit 2c24a48

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

osu.Game/Rulesets/Difficulty/DifficultyCalculator.cs

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -150,10 +150,14 @@ public List<TimedDifficultyAttributes> CalculateTimed([NotNull] IEnumerable<Mod>
150150
}
151151

152152
/// <summary>
153-
/// Calculates the difficulty of the beatmap using a specific mod combination and returns enumerable <see cref="TimedDifficultyAttributes"/> representing the difficulty at every relevant time value in the beatmap.
153+
/// Calculates the difficulty of the beatmap using a specific mod combination and returns
154+
/// a lazy-evaluated enumerable of <see cref="TimedDifficultyAttributes"/> representing the difficulty at every relevant time value in the beatmap.
154155
/// </summary>
155156
/// <remarks>
156-
/// The returned task represents the operations related to the initialization the difficulty calculation (pre-processing).<br />
157+
/// The returned task represents the operations related to the initialisation of the difficulty calculation (pre-processing).
158+
/// The pre-processing in question can be cancelled via <paramref name="cancellationToken"/>.
159+
/// Once the pre-processing is done, the returned enumerable no longer respects the <paramref name="cancellationToken"/>.
160+
/// Enumeration will be lazy and blocking; callers are expected to stop enumerating if they no longer wish to receive timed difficulty attributes.
157161
/// </remarks>
158162
/// <param name="mods">The mods that should be applied to the beatmap.</param>
159163
/// <param name="cancellationToken">The cancellation token for pre-processing.</param>

0 commit comments

Comments
 (0)