h1or4dme8/osu-lazer
1
0
Fork 0
mirror of https://github.com/ppy/osu.git synced 2024-11-11 15:47:26 +08:00
Code Issues Releases Wiki Activity

Reformat xmldoc

Browse Source
This commit is contained in:
Bartłomiej Dach 2023-08-21 08:23:58 +02:00
parent 56b1062c2f
commit dd1ac461db
No known key found for this signature in database
1 changed files with 12 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
osu.Game/Rulesets/Objects/SliderPath.cs
View File

@ -201,13 +201,20 @@ namespace osu.Game.Rulesets.Objects
/// Returns the progress values at which (control point) segments of the path end.
/// Ranges from 0 (beginning of the path) to 1 (end of the path) to infinity (beyond the end of the path).
/// </summary>
/// <example>In case <see cref="Distance"/> is less than <see cref="CalculatedDistance"/>,
/// <remarks>
/// <see cref="PositionAt"/> truncates the progression values to [0,1],
/// so you can't use this method in conjunction with that one to retrieve the positions of segment ends beyond the end of the path.
/// </remarks>
/// <example>
/// <para>
/// In case <see cref="Distance"/> is less than <see cref="CalculatedDistance"/>,
/// the last segment ends after the end of the path, hence it returns a value greater than 1.
/// <para/>
/// </para>
/// <para>
/// In case <see cref="Distance"/> is greater than <see cref="CalculatedDistance"/>,
/// the last segment ends before the end of the path, hence it returns a value less than 1.</example>
/// <remarks><see cref="PositionAt"/> truncates the progression values to [0,1],
/// so you can't use this method to retrieve the positions of segment ends beyond the end of the path.</remarks>
/// the last segment ends before the end of the path, hence it returns a value less than 1.
/// </para>
/// </example>
public IEnumerable<double> GetSegmentEnds()
{
ensureValid();