diff --git a/osu.Game.Rulesets.Karaoke.Tests/Helper/TestCaseElementIdHelper.cs b/osu.Game.Rulesets.Karaoke.Tests/Helper/TestCaseElementIdHelper.cs index 5fe78bcd5..7c875d7a7 100644 --- a/osu.Game.Rulesets.Karaoke.Tests/Helper/TestCaseElementIdHelper.cs +++ b/osu.Game.Rulesets.Karaoke.Tests/Helper/TestCaseElementIdHelper.cs @@ -14,10 +14,10 @@ public static class TestCaseElementIdHelper /// So create a tool to convert the number to ElementId. /// /// - /// 1 => 0000001 - /// 2 => 0000002 - /// -1 => fffffff - /// -2 => ffffffe + /// 1 -> 0000001
+ /// 2 -> 0000002
+ /// -1 -> fffffff
+ /// -2 -> ffffffe
///
/// /// diff --git a/osu.Game.Rulesets.Karaoke.Tests/Helper/TestCaseTagHelper.cs b/osu.Game.Rulesets.Karaoke.Tests/Helper/TestCaseTagHelper.cs index ec29dea40..2351ff00a 100644 --- a/osu.Game.Rulesets.Karaoke.Tests/Helper/TestCaseTagHelper.cs +++ b/osu.Game.Rulesets.Karaoke.Tests/Helper/TestCaseTagHelper.cs @@ -50,12 +50,12 @@ private static TObject getMatchByStatement(string? str, string regexStr /// Process test case ruby string format into /// /// - /// [0]:ruby -> has range index with text.
- /// [0,3]:ruby -> has range index with text.
- /// [0]: -> has range index with empty text.
- /// [0,3]: -> has range index with empty text.
- /// [0] -> has range index with empty text.
- /// [0,3] -> has range index with empty text.
+ /// [0]:ruby -> has range index with text.
+ /// [0,3]:ruby -> has range index with text.
+ /// [0]: -> has range index with empty text.
+ /// [0,3]: -> has range index with empty text.
+ /// [0] -> has range index with empty text.
+ /// [0,3] -> has range index with empty text.
///
/// Ruby tag string format /// Ruby tag object @@ -88,12 +88,12 @@ public static RubyTag ParseRubyTag(string? str) /// Process test case romaji string format into /// /// - /// [0]:romaji -> has range index with text.
- /// [0,3]:romaji -> has range index with text.
- /// [0]: -> has range index with empty text.
- /// [0,3]: -> has range index with empty text.
- /// [0] -> has range index with empty text.
- /// [0,3] -> has range index with empty text.
+ /// [0]:romaji -> has range index with text.
+ /// [0,3]:romaji -> has range index with text.
+ /// [0]: -> has range index with empty text.
+ /// [0,3]: -> has range index with empty text.
+ /// [0] -> has range index with empty text.
+ /// [0,3] -> has range index with empty text.
///
/// Romaji tag string format /// Romaji tag object @@ -126,9 +126,9 @@ public static RomajiTag ParseRomajiTag(string? str) /// Process test case time tag string format into /// /// - /// [0,start]:1000 -> has time-tag index with time.
- /// [0,start] -> has time-tag index with no time.
- /// [0,start]: -> has time-tag index with no time.
+ /// [0,start]:1000 -> has time-tag index with time.
+ /// [0,start] -> has time-tag index with no time.
+ /// [0,start]: -> has time-tag index with no time.
///
/// Time tag string format /// Time tag object @@ -156,8 +156,8 @@ public static TimeTag ParseTimeTag(string? str) /// Process test case text index string format into /// /// - /// [0,start] -> has time-tag index with time.
- /// [0,end] -> has time-tag index with time.
+ /// [0,start] -> has time-tag index with time.
+ /// [0,end] -> has time-tag index with time.
///
/// Text tag string format /// Text tag object @@ -181,9 +181,9 @@ public static TextIndex ParseTextIndex(string? str) /// Process test case lyric string format into /// /// - /// [1000,3000]:karaoke -> has time-range and lyric.
- /// [1000,3000]: -> has time-range.
- /// [1000,3000] -> has time-range.
+ /// [1000,3000]:karaoke -> has time-range and lyric.
+ /// [1000,3000]: -> has time-range.
+ /// [1000,3000] -> has time-range.
///
/// Lyric string format /// Id if needed @@ -249,9 +249,9 @@ public static Lyric ParseLyricWithTimeTag(string? str) /// Process test case singer string format into /// /// - /// [0]name:singer001 -> singer with id and name.
- /// [0]romaji:singer001 -> singer with id and romaji.
- /// [0]eg:singer001 -> singer with id and english name.
+ /// [0]name:singer001 -> singer with id and name.
+ /// [0]romaji:singer001 -> singer with id and romaji.
+ /// [0]eg:singer001 -> singer with id and english name.
///
/// Singer string format /// sSinger object diff --git a/osu.Game.Rulesets.Karaoke/Beatmaps/Stages/Classic/ClassicLyricLayout.cs b/osu.Game.Rulesets.Karaoke/Beatmaps/Stages/Classic/ClassicLyricLayout.cs index 24d86cfe1..c116f6d17 100644 --- a/osu.Game.Rulesets.Karaoke/Beatmaps/Stages/Classic/ClassicLyricLayout.cs +++ b/osu.Game.Rulesets.Karaoke/Beatmaps/Stages/Classic/ClassicLyricLayout.cs @@ -47,7 +47,7 @@ public float HorizontalMargin public readonly Bindable LineBindable = new(); /// - /// 's line number. + /// 's line number.
/// will at bottom if is zero. ///
public int Line diff --git a/osu.Game.Rulesets.Karaoke/Beatmaps/Stages/Classic/ClassicStageInfo.cs b/osu.Game.Rulesets.Karaoke/Beatmaps/Stages/Classic/ClassicStageInfo.cs index a060c59a4..3d7de1382 100644 --- a/osu.Game.Rulesets.Karaoke/Beatmaps/Stages/Classic/ClassicStageInfo.cs +++ b/osu.Game.Rulesets.Karaoke/Beatmaps/Stages/Classic/ClassicStageInfo.cs @@ -21,7 +21,7 @@ public class ClassicStageInfo : StageInfo public ClassicStyleCategory StyleCategory { get; set; } = new(); /// - /// The definition for the . + /// The definition for the .
/// Like the line height or font size. ///
public ClassicStageDefinition StageDefinition { get; set; } = new(); diff --git a/osu.Game.Rulesets.Karaoke/Beatmaps/Stages/Preview/PreviewStageTimingCalculator.cs b/osu.Game.Rulesets.Karaoke/Beatmaps/Stages/Preview/PreviewStageTimingCalculator.cs index e8cd41935..362d04e78 100644 --- a/osu.Game.Rulesets.Karaoke/Beatmaps/Stages/Preview/PreviewStageTimingCalculator.cs +++ b/osu.Game.Rulesets.Karaoke/Beatmaps/Stages/Preview/PreviewStageTimingCalculator.cs @@ -74,7 +74,7 @@ public IDictionary CalculateTimings(Lyric lyric) } /// - /// will take the current lyric and the previous n lyrics. + /// will take the current lyric and the previous n lyrics.
/// note that the order should be p3, p2, p1, p0, current. ///
/// diff --git a/osu.Game.Rulesets.Karaoke/Beatmaps/Stages/StageElementCategory.cs b/osu.Game.Rulesets.Karaoke/Beatmaps/Stages/StageElementCategory.cs index 400c666c0..1f7e4a1c2 100644 --- a/osu.Game.Rulesets.Karaoke/Beatmaps/Stages/StageElementCategory.cs +++ b/osu.Game.Rulesets.Karaoke/Beatmaps/Stages/StageElementCategory.cs @@ -20,7 +20,7 @@ public abstract class StageElementCategory where THitObject : KaraokeHitObject, IHasPrimaryKey { /// - /// Default value. + /// Default value.
/// Will use this value as default if there's no mapping result in the ///
public TStageElement DefaultElement { get; protected set; } @@ -39,7 +39,7 @@ public abstract class StageElementCategory public List SortedElements { get; private set; } = new(); /// - /// Mapping between and + /// Mapping between and
/// This is the 1st mapping roles. ///
public IDictionary Mappings { get; protected set; } = new Dictionary(); diff --git a/osu.Game.Rulesets.Karaoke/Bindables/BindableClassWithCurrent.cs b/osu.Game.Rulesets.Karaoke/Bindables/BindableClassWithCurrent.cs index 0618045a7..11957e3b4 100644 --- a/osu.Game.Rulesets.Karaoke/Bindables/BindableClassWithCurrent.cs +++ b/osu.Game.Rulesets.Karaoke/Bindables/BindableClassWithCurrent.cs @@ -8,7 +8,7 @@ namespace osu.Game.Rulesets.Karaoke.Bindables; public class BindableClassWithCurrent : BindableWithCurrent where T : class { /// - /// Raise and once, without any changes actually occurring. + /// Raise and once, without any changes actually occurring.
/// This does not propagate to any outward bound bindables. ///
public void TriggerOtherChange() diff --git a/osu.Game.Rulesets.Karaoke/Edit/Generator/Lyrics/TimeTags/Ja/JaTimeTagGenerator.cs b/osu.Game.Rulesets.Karaoke/Edit/Generator/Lyrics/TimeTags/Ja/JaTimeTagGenerator.cs index 9355815b6..1ea1eefc1 100644 --- a/osu.Game.Rulesets.Karaoke/Edit/Generator/Lyrics/TimeTags/Ja/JaTimeTagGenerator.cs +++ b/osu.Game.Rulesets.Karaoke/Edit/Generator/Lyrics/TimeTags/Ja/JaTimeTagGenerator.cs @@ -17,7 +17,7 @@ public JaTimeTagGenerator(JaTimeTagGeneratorConfig config) } /// - /// Thanks for RhythmKaTTE's author writing this logic into C# + /// Thanks for RhythmKaTTE's author writing this logic into C#.
/// http://juna-idler.blogspot.com/2016/05/rhythmkatte-version-01.html ///
protected override void TimeTagLogic(Lyric lyric, List timeTags) diff --git a/osu.Game.Rulesets.Karaoke/Edit/Generator/Lyrics/TimeTags/Ja/JaTimeTagGeneratorConfig.cs b/osu.Game.Rulesets.Karaoke/Edit/Generator/Lyrics/TimeTags/Ja/JaTimeTagGeneratorConfig.cs index c5b15f7e8..32d18b4eb 100644 --- a/osu.Game.Rulesets.Karaoke/Edit/Generator/Lyrics/TimeTags/Ja/JaTimeTagGeneratorConfig.cs +++ b/osu.Game.Rulesets.Karaoke/Edit/Generator/Lyrics/TimeTags/Ja/JaTimeTagGeneratorConfig.cs @@ -23,7 +23,7 @@ public class JaTimeTagGeneratorConfig : TimeTagGeneratorConfig public Bindable Checkっ { get; } = new BindableBool(); /// - /// Add the if spacing is next of the alphabet. + /// Add the if spacing is next of the alphabet.
/// This feature will work only if enable the ///
[ConfigCategory(CATEGORY_CHECK_WHITE_SPACE)] @@ -31,7 +31,7 @@ public class JaTimeTagGeneratorConfig : TimeTagGeneratorConfig public Bindable CheckWhiteSpaceAlphabet { get; } = new BindableBool(); /// - /// Add the if spacing is next of the digit. + /// Add the if spacing is next of the digit.
/// This feature will work only if enable the ///
[ConfigCategory(CATEGORY_CHECK_WHITE_SPACE)] @@ -39,7 +39,7 @@ public class JaTimeTagGeneratorConfig : TimeTagGeneratorConfig public Bindable CheckWhiteSpaceDigit { get; } = new BindableBool(); /// - /// Add the if spacing is next of the symbol. + /// Add the if spacing is next of the symbol.
/// This feature will work only if enable the ///
[ConfigCategory(CATEGORY_CHECK_WHITE_SPACE)] diff --git a/osu.Game.Rulesets.Karaoke/Edit/Generator/Lyrics/TimeTags/TimeTagGeneratorConfig.cs b/osu.Game.Rulesets.Karaoke/Edit/Generator/Lyrics/TimeTags/TimeTagGeneratorConfig.cs index eeeb8d537..53c87219e 100644 --- a/osu.Game.Rulesets.Karaoke/Edit/Generator/Lyrics/TimeTags/TimeTagGeneratorConfig.cs +++ b/osu.Game.Rulesets.Karaoke/Edit/Generator/Lyrics/TimeTags/TimeTagGeneratorConfig.cs @@ -34,7 +34,7 @@ public abstract class TimeTagGeneratorConfig : GeneratorConfig public Bindable CheckWhiteSpace { get; } = new BindableBool(); /// - /// Add the end instead. + /// Add the end instead.
/// This feature will work only if enable the . ///
[ConfigCategory(CATEGORY_CHECK_WHITE_SPACE)] diff --git a/osu.Game.Rulesets.Karaoke/Edit/Setup/Components/SingerDisplay.cs b/osu.Game.Rulesets.Karaoke/Edit/Setup/Components/SingerDisplay.cs index 59629d713..2fa3b39d8 100644 --- a/osu.Game.Rulesets.Karaoke/Edit/Setup/Components/SingerDisplay.cs +++ b/osu.Game.Rulesets.Karaoke/Edit/Setup/Components/SingerDisplay.cs @@ -26,7 +26,7 @@ namespace osu.Game.Rulesets.Karaoke.Edit.Setup.Components; public partial class SingerDisplay : CompositeDrawable, IHasCurrentValue { /// - /// Invoked when the user has requested the singer corresponding to this + /// Invoked when the user has requested the singer corresponding to this .
/// to be removed from its palette. ///
public event Action? DeleteRequested; diff --git a/osu.Game.Rulesets.Karaoke/Objects/TimeTag.cs b/osu.Game.Rulesets.Karaoke/Objects/TimeTag.cs index b194aa79c..bf92ff651 100644 --- a/osu.Game.Rulesets.Karaoke/Objects/TimeTag.cs +++ b/osu.Game.Rulesets.Karaoke/Objects/TimeTag.cs @@ -56,14 +56,14 @@ public double? Time /// Mark if this romaji is the first letter of the romaji word. /// /// - /// There's the Japanese lyric: - /// 枯れた世界に輝く - /// There's the Romaji: - /// kareta sekai ni kagayaku. - /// And it will be separated as: - /// ka|re|ta se|kai ni ka|ga|ya|ku. - /// If this is the first or(4th) time-tag, then this value should be true. - /// If this ts the 2th or 3th time-tag, then this value should be false. + /// There's the Japanese lyric:
+ /// 枯れた世界に輝く
+ /// There's the Romaji:
+ /// kareta sekai ni kagayaku.
+ /// And it will be separated as:
+ /// ka|re|ta se|kai ni ka|ga|ya|ku.
+ /// If this is the first or(4th) time-tag, then this value should be true.
+ /// If this ts the 2th or 3th time-tag, then this value should be false.
///
public bool InitialRomaji { diff --git a/osu.Game.Rulesets.Karaoke/Objects/Utils/OrderUtils.cs b/osu.Game.Rulesets.Karaoke/Objects/Utils/OrderUtils.cs index c99b5c352..d3c28b2ab 100644 --- a/osu.Game.Rulesets.Karaoke/Objects/Utils/OrderUtils.cs +++ b/osu.Game.Rulesets.Karaoke/Objects/Utils/OrderUtils.cs @@ -74,8 +74,8 @@ public static void ShiftingOrder(IEnumerable objects, int offset) where T /// Re-generate order number if has gap between two order number /// /// - /// Valid: 1, 2, 3, 4 - /// Should be generated: 1, 3, 4, 5, 7 + /// Valid: 1, 2, 3, 4
+ /// Should be generated: 1, 3, 4, 5, 7
///
/// IHasOrder /// objects diff --git a/osu.Game.Rulesets.Karaoke/Objects/Utils/TextTagUtils.cs b/osu.Game.Rulesets.Karaoke/Objects/Utils/TextTagUtils.cs index 235be2cd8..5964987e7 100644 --- a/osu.Game.Rulesets.Karaoke/Objects/Utils/TextTagUtils.cs +++ b/osu.Game.Rulesets.Karaoke/Objects/Utils/TextTagUtils.cs @@ -64,8 +64,8 @@ public static bool EmptyText(T textTag) where T : ITextTag /// Display tag with position format /// /// - /// ka(-2~-1) - /// ra(4~6) + /// ka(-2~-1)
+ /// ra(4~6)
///
/// /// diff --git a/osu.Game.Rulesets.Karaoke/Objects/Utils/TimeTagUtils.cs b/osu.Game.Rulesets.Karaoke/Objects/Utils/TimeTagUtils.cs index aa30e5178..12a9e3262 100644 --- a/osu.Game.Rulesets.Karaoke/Objects/Utils/TimeTagUtils.cs +++ b/osu.Game.Rulesets.Karaoke/Objects/Utils/TimeTagUtils.cs @@ -25,8 +25,8 @@ public static TimeTag ShiftingTimeTag(TimeTag timeTag, int offset) /// Display string with time format /// /// - /// 02:32:155 - /// --:--:--- + /// 02:32:155
+ /// --:--:---
///
/// /// diff --git a/osu.Game.Rulesets.Karaoke/Utils/TextIndexUtils.cs b/osu.Game.Rulesets.Karaoke/Utils/TextIndexUtils.cs index 5c98c3ff4..66a96cce9 100644 --- a/osu.Game.Rulesets.Karaoke/Utils/TextIndexUtils.cs +++ b/osu.Game.Rulesets.Karaoke/Utils/TextIndexUtils.cs @@ -75,8 +75,8 @@ public static T GetValueByState(TextIndex.IndexState state, Func startValu /// Display string with position format /// /// - /// 3 - /// 4(end) + /// 3
+ /// 4(end)
///
/// ///