Move some inline comments on `const`s to xmldoc instead

This commit is contained in:
Dean Herbert 2021-06-22 15:16:19 +09:00
parent 629c98e6a0
commit e9339d6100
2 changed files with 31 additions and 7 deletions

View File

@ -17,7 +17,9 @@ public class CheckLowDiffOverlaps : ICheck
private const double should_probably_overlap_threshold = 175; // 170 BPM 1/2
private const double should_not_overlap_threshold = 250; // 120 BPM 1/2 = 240 BPM 1/1
// Objects need to overlap this much before being treated as an overlap, else it may just be the borders slightly touching.
/// <summary>
/// Objects need to overlap this much before being treated as an overlap, else it may just be the borders slightly touching.
/// </summary>
private const double overlap_leniency = 5;
public CheckMetadata Metadata { get; } = new CheckMetadata(CheckCategory.Spread, "Missing or unexpected overlaps");

View File

@ -14,14 +14,36 @@ namespace osu.Game.Rulesets.Osu.Edit.Checks
{
public class CheckTimeDistanceEquality : ICheck
{
private const double pattern_lifetime = 600; // Two objects this many ms apart or more are skipped. (200 BPM 2/1)
private const double stack_leniency = 12; // Two objects this distance apart or less are skipped.
/// <summary>
/// Two objects this many ms apart or more are skipped. (200 BPM 2/1)
/// </summary>
private const double pattern_lifetime = 600;
private const double observation_lifetime = 4000; // How long an observation is relevant for comparison. (120 BPM 8/1)
private const double similar_time_leniency = 16; // How different two delta times can be to still be compared. (240 BPM 1/16)
/// <summary>
/// Two objects this distance apart or less are skipped.
/// </summary>
private const double stack_leniency = 12;
/// <summary>
/// How long an observation is relevant for comparison. (120 BPM 8/1)
/// </summary>
private const double observation_lifetime = 4000;
/// <summary>
/// How different two delta times can be to still be compared. (240 BPM 1/16)
/// </summary>
private const double similar_time_leniency = 16;
/// <summary>
/// How many pixels are subtracted from the difference between current and expected distance.
/// </summary>
private const double distance_leniency_absolute_warning = 10;
/// <summary>
/// How much of the current distance that the difference can make out.
/// </summary>
private const double distance_leniency_percent_warning = 0.15;
private const double distance_leniency_absolute_warning = 10; // How many pixels are subtracted from the difference between current and expected distance.
private const double distance_leniency_percent_warning = 0.15; // How much of the current distance that the difference can make out.
private const double distance_leniency_absolute_problem = 20;
private const double distance_leniency_percent_problem = 0.3;