Merge pull request #2074 from andy840119/adjust-the-comment

Use <br/> to change new line in the comment.

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.
     /// </summary>
     /// <example>
-    /// 1 => 0000001
-    /// 2 => 0000002
-    /// -1 => fffffff
-    /// -2 => ffffffe
+    /// 1       -> 0000001<br/>
+    /// 2       -> 0000002<br/>
+    /// -1      -> fffffff<br/>
+    /// -2      -> ffffffe<br/>
     /// </example>
     /// <param name="number"></param>
     /// <returns></returns>

osu.Game.Rulesets.Karaoke.Tests/Helper/TestCaseTagHelper.cs

@@ -50,12 +50,12 @@ private static TObject getMatchByStatement<TObject>(string? str, string regexStr
     /// Process test case ruby string format into <see cref="RubyTag"/>
     /// </summary>
     /// <example>
-    /// [0]:ruby        -> has range index with text. <br/>
-    /// [0,3]:ruby      -> has range index with text. <br/>
-    /// [0]:            -> has range index with empty text. <br/>
-    /// [0,3]:          -> has range index with empty text. <br/>
-    /// [0]             -> has range index with empty text. <br/>
-    /// [0,3]           -> has range index with empty text. <br/>
+    /// [0]:ruby        -> has range index with text.<br/>
+    /// [0,3]:ruby      -> has range index with text.<br/>
+    /// [0]:            -> has range index with empty text.<br/>
+    /// [0,3]:          -> has range index with empty text.<br/>
+    /// [0]             -> has range index with empty text.<br/>
+    /// [0,3]           -> has range index with empty text.<br/>
     /// </example>
     /// <param name="str">Ruby tag string format</param>
     /// <returns><see cref="RubyTag"/>Ruby tag object</returns>
@@ -88,12 +88,12 @@ public static RubyTag ParseRubyTag(string? str)
     /// Process test case romaji string format into <see cref="RomajiTag"/>
     /// </summary>
     /// <example>
-    /// [0]:romaji          -> has range index with text. <br/>
-    /// [0,3]:romaji        -> has range index with text. <br/>
-    /// [0]:                -> has range index with empty text. <br/>
-    /// [0,3]:              -> has range index with empty text. <br/>
-    /// [0]                 -> has range index with empty text. <br/>
-    /// [0,3]               -> has range index with empty text. <br/>
+    /// [0]:romaji          -> has range index with text.<br/>
+    /// [0,3]:romaji        -> has range index with text.<br/>
+    /// [0]:                -> has range index with empty text.<br/>
+    /// [0,3]:              -> has range index with empty text.<br/>
+    /// [0]                 -> has range index with empty text.<br/>
+    /// [0,3]               -> has range index with empty text.<br/>
     /// </example>
     /// <param name="str">Romaji tag string format</param>
     /// <returns><see cref="RomajiTag"/>Romaji tag object</returns>
@@ -126,9 +126,9 @@ public static RomajiTag ParseRomajiTag(string? str)
     /// Process test case time tag string format into <see cref="TimeTag"/>
     /// </summary>
     /// <example>
-    /// [0,start]:1000              -> has time-tag index with time. <br/>
-    /// [0,start]                   -> has time-tag index with no time. <br/>
-    /// [0,start]:                  -> has time-tag index with no time. <br/>
+    /// [0,start]:1000              -> has time-tag index with time.<br/>
+    /// [0,start]                   -> has time-tag index with no time.<br/>
+    /// [0,start]:                  -> has time-tag index with no time.<br/>
     /// </example>
     /// <param name="str">Time tag string format</param>
     /// <returns><see cref="TimeTag"/>Time tag object</returns>
@@ -156,8 +156,8 @@ public static TimeTag ParseTimeTag(string? str)
     /// Process test case text index string format into <see cref="TextIndex"/>
     /// </summary>
     /// <example>
-    /// [0,start]   -> has time-tag index with time. <br/>
-    /// [0,end]     -> has time-tag index with time. <br/>
+    /// [0,start]   -> has time-tag index with time.<br/>
+    /// [0,end]     -> has time-tag index with time.<br/>
     /// </example>
     /// <param name="str">Text tag string format</param>
     /// <returns><see cref="TimeTag"/>Text tag object</returns>
@@ -181,9 +181,9 @@ public static TextIndex ParseTextIndex(string? str)
     /// Process test case lyric string format into <see cref="Lyric"/>
     /// </summary>
     /// <example>
-    /// [1000,3000]:karaoke     -> has time-range and lyric. <br/>
-    /// [1000,3000]:            -> has time-range. <br/>
-    /// [1000,3000]             -> has time-range. <br/>
+    /// [1000,3000]:karaoke     -> has time-range and lyric.<br/>
+    /// [1000,3000]:            -> has time-range.<br/>
+    /// [1000,3000]             -> has time-range.<br/>
     /// </example>
     /// <param name="str">Lyric string format</param>
     /// <param name="id">Id if needed</param>
@@ -249,9 +249,9 @@ public static Lyric ParseLyricWithTimeTag(string? str)
     /// Process test case singer string format into <see cref="Singer"/>
     /// </summary>
     /// <example>
-    /// [0]name:singer001       -> singer with id and name. <br/>
-    /// [0]romaji:singer001     -> singer with id and romaji. <br/>
-    /// [0]eg:singer001         -> singer with id and english name. <br/>
+    /// [0]name:singer001       -> singer with id and name.<br/>
+    /// [0]romaji:singer001     -> singer with id and romaji.<br/>
+    /// [0]eg:singer001         -> singer with id and english name.<br/>
     /// </example>
     /// <param name="str">Singer string format</param>
     /// <returns><see cref="Singer"/>sSinger object</returns>

osu.Game.Rulesets.Karaoke/Beatmaps/Stages/Classic/ClassicLyricLayout.cs

@@ -47,7 +47,7 @@ public float HorizontalMargin
     public readonly Bindable<int> LineBindable = new();
 
     /// <summary>
-    /// <see cref="Lyric"/>'s line number.
+    /// <see cref="Lyric"/>'s line number.<br/>
     /// <see cref="Lyric"/> will at bottom if <see cref="Line"/> is zero.
     /// </summary>
     public int Line

osu.Game.Rulesets.Karaoke/Beatmaps/Stages/Classic/ClassicStageInfo.cs

@@ -21,7 +21,7 @@ public class ClassicStageInfo : StageInfo
     public ClassicStyleCategory StyleCategory { get; set; } = new();
 
     /// <summary>
-    /// The definition for the <see cref="Lyric"/>.
+    /// The definition for the <see cref="Lyric"/>.<br/>
     /// Like the line height or font size.
     /// </summary>
     public ClassicStageDefinition StageDefinition { get; set; } = new();

osu.Game.Rulesets.Karaoke/Beatmaps/Stages/Preview/PreviewStageTimingCalculator.cs

@@ -74,7 +74,7 @@ public IDictionary<int, double> CalculateTimings(Lyric lyric)
     }
 
     /// <summary>
-    /// will take the current lyric and the previous n lyrics.
+    /// will take the current lyric and the previous n lyrics.<br/>
     /// note that the order should be p3, p2, p1, p0, current.
     /// </summary>
     /// <param name="lyric"></param>

osu.Game.Rulesets.Karaoke/Beatmaps/Stages/StageElementCategory.cs

@@ -20,7 +20,7 @@ public abstract class StageElementCategory<TStageElement, THitObject>
     where THitObject : KaraokeHitObject, IHasPrimaryKey
 {
     /// <summary>
-    /// Default value.
+    /// Default value.<br/>
     /// Will use this value as default if there's no mapping result in the <typeparamref name="TStageElement"/>
     /// </summary>
     public TStageElement DefaultElement { get; protected set; }
@@ -39,7 +39,7 @@ public abstract class StageElementCategory<TStageElement, THitObject>
     public List<TStageElement> SortedElements { get; private set; } = new();
 
     /// <summary>
-    /// Mapping between <typeparamref name="THitObject.ID"/> and <typeparamref name="TStageElement.ID"/>
+    /// Mapping between <typeparamref name="THitObject.ID"/> and <typeparamref name="TStageElement.ID"/><br/>
     /// This is the 1st mapping roles.
     /// </summary>
     public IDictionary<ElementId, ElementId> Mappings { get; protected set; } = new Dictionary<ElementId, ElementId>();

osu.Game.Rulesets.Karaoke/Bindables/BindableClassWithCurrent.cs

@@ -8,7 +8,7 @@ namespace osu.Game.Rulesets.Karaoke.Bindables;
 public class BindableClassWithCurrent<T> : BindableWithCurrent<T> where T : class
 {
     /// <summary>
-    /// Raise <see cref="Bindable{T}.ValueChanged"/> and <see cref="Bindable{T}.DisabledChanged"/> once, without any changes actually occurring.
+    /// Raise <see cref="Bindable{T}.ValueChanged"/> and <see cref="Bindable{T}.DisabledChanged"/> once, without any changes actually occurring.<br/>
     /// This does not propagate to any outward bound bindables.
     /// </summary>
     public void TriggerOtherChange()

osu.Game.Rulesets.Karaoke/Edit/Generator/Lyrics/TimeTags/Ja/JaTimeTagGenerator.cs

@@ -17,7 +17,7 @@ public JaTimeTagGenerator(JaTimeTagGeneratorConfig config)
     }
 
     /// <summary>
-    /// Thanks for RhythmKaTTE's author writing this logic into C#
+    /// Thanks for RhythmKaTTE's author writing this logic into C#.<br/>
     /// http://juna-idler.blogspot.com/2016/05/rhythmkatte-version-01.html
     /// </summary>
     protected override void TimeTagLogic(Lyric lyric, List<TimeTag> timeTags)

osu.Game.Rulesets.Karaoke/Edit/Generator/Lyrics/TimeTags/Ja/JaTimeTagGeneratorConfig.cs

@@ -23,23 +23,23 @@ public class JaTimeTagGeneratorConfig : TimeTagGeneratorConfig
     public Bindable<bool> Checkっ { get; } = new BindableBool();
 
     /// <summary>
-    /// Add the <see cref="TimeTag"/> if spacing is next of the alphabet.
+    /// Add the <see cref="TimeTag"/> if spacing is next of the alphabet.<br/>
     /// This feature will work only if enable the <see cref="TimeTagGeneratorConfig.CheckWhiteSpace"/>
     /// </summary>
     [ConfigCategory(CATEGORY_CHECK_WHITE_SPACE)]
     [ConfigSource("Check white space alphabet", "Check white space alphabet.")]
     public Bindable<bool> CheckWhiteSpaceAlphabet { get; } = new BindableBool();
 
     /// <summary>
-    /// Add the <see cref="TimeTag"/> if spacing is next of the digit.
+    /// Add the <see cref="TimeTag"/> if spacing is next of the digit.<br/>
     /// This feature will work only if enable the <see cref="TimeTagGeneratorConfig.CheckWhiteSpace"/>
     /// </summary>
     [ConfigCategory(CATEGORY_CHECK_WHITE_SPACE)]
     [ConfigSource("Check white space digit", "Check white space digit.")]
     public Bindable<bool> CheckWhiteSpaceDigit { get; } = new BindableBool();
 
     /// <summary>
-    /// Add the <see cref="TimeTag"/> if spacing is next of the symbol.
+    /// Add the <see cref="TimeTag"/> if spacing is next of the symbol.<br/>
     /// This feature will work only if enable the <see cref="TimeTagGeneratorConfig.CheckWhiteSpace"/>
     /// </summary>
     [ConfigCategory(CATEGORY_CHECK_WHITE_SPACE)]

osu.Game.Rulesets.Karaoke/Edit/Generator/Lyrics/TimeTags/TimeTagGeneratorConfig.cs

@@ -34,7 +34,7 @@ public abstract class TimeTagGeneratorConfig : GeneratorConfig
     public Bindable<bool> CheckWhiteSpace { get; } = new BindableBool();
 
     /// <summary>
-    /// Add the end <see cref="TimeTag"/> instead.
+    /// Add the end <see cref="TimeTag"/> instead.<br/>
     /// This feature will work only if enable the <see cref="CheckWhiteSpace"/>.
     /// </summary>
     [ConfigCategory(CATEGORY_CHECK_WHITE_SPACE)]

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<Singer>
 {
     /// <summary>
-    /// Invoked when the user has requested the singer corresponding to this <see cref="SingerDisplay"/>
+    /// Invoked when the user has requested the singer corresponding to this <see cref="SingerDisplay"/>.<br/>
     /// to be removed from its palette.
     /// </summary>
     public event Action<SingerDisplay>? DeleteRequested;

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.
     /// </summary>
     /// <example>
-    /// 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:<br/>
+    /// 枯れた世界に輝く<br/>
+    /// There's the Romaji:<br/>
+    /// kareta sekai ni kagayaku.<br/>
+    /// And it will be separated as:<br/>
+    /// ka|re|ta se|kai ni ka|ga|ya|ku.<br/>
+    /// If this is the first or(4th) time-tag, then this value should be true.<br/>
+    /// If this ts the 2th or 3th time-tag, then this value should be false.<br/>
     /// </example>
     public bool InitialRomaji
     {

osu.Game.Rulesets.Karaoke/Objects/Utils/OrderUtils.cs

@@ -74,8 +74,8 @@ public static void ShiftingOrder<T>(IEnumerable<T> objects, int offset) where T
     /// Re-generate order number if has gap between two order number
     /// </summary>
     /// <example>
-    /// Valid: 1, 2, 3, 4
-    /// Should be generated: 1, 3, 4, 5, 7
+    /// Valid: 1, 2, 3, 4<br/>
+    /// Should be generated: 1, 3, 4, 5, 7<br/>
     /// </example>
     /// <typeparam name="T">IHasOrder</typeparam>
     /// <param name="objects">objects</param>

osu.Game.Rulesets.Karaoke/Objects/Utils/TextTagUtils.cs

@@ -64,8 +64,8 @@ public static bool EmptyText<T>(T textTag) where T : ITextTag
     /// Display tag with position format
     /// </summary>
     /// <example>
-    /// ka(-2~-1)
-    /// ra(4~6)
+    /// ka(-2~-1)<br/>
+    /// ra(4~6)<br/>
     /// </example>
     /// <typeparam name="T"></typeparam>
     /// <param name="textTag"></param>

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
     /// </summary>
     /// <example>
-    /// 02:32:155
-    /// --:--:---
+    /// 02:32:155<br/>
+    /// --:--:---<br/>
     /// </example>
     /// <param name="timeTag"></param>
     /// <returns></returns>

osu.Game.Rulesets.Karaoke/Utils/TextIndexUtils.cs

@@ -75,8 +75,8 @@ public static T GetValueByState<T>(TextIndex.IndexState state, Func<T> startValu
     /// Display string with position format
     /// </summary>
     /// <example>
-    /// 3
-    /// 4(end)
+    /// 3<br/>
+    /// 4(end)<br/>
     /// </example>
     /// <param name="textIndex"></param>
     /// <returns></returns>