Append names description on doc comments.

KyouyamaKazusa0805 · Mar 12, 2021 · c69f280 · c69f280
1 parent dcaf52b
commit c69f280
Show file tree

Hide file tree

Showing 3 changed files with 148 additions and 0 deletions.
diff --git a/src/Sudoku.Solving/Manual/Fishes/FishStepInfo.cs b/src/Sudoku.Solving/Manual/Fishes/FishStepInfo.cs
@@ -30,6 +30,43 @@ public abstract record FishStepInfo(
 		/// <summary>
 		/// Indicates the size of this fish instance.
 		/// </summary>
+		/// <remarks>
+		/// The name of the corresponding names are:
+		/// <list type="table">
+		/// <item>
+		/// <term>1</term>
+		/// <description>Cyclops (But out of use)</description>
+		/// </item>
+		/// <item>
+		/// <term>2</term>
+		/// <description>X-Wing</description>
+		/// </item>
+		/// <item>
+		/// <term>3</term>
+		/// <description>Swordfish</description>
+		/// </item>
+		/// <item>
+		/// <term>4</term>
+		/// <description>Jellyfish</description>
+		/// </item>
+		/// <item>
+		/// <term>5</term>
+		/// <description>Squirmbag or Starfish</description>
+		/// </item>
+		/// <item>
+		/// <term>6</term>
+		/// <description>Whale</description>
+		/// </item>
+		/// <item>
+		/// <term>7</term>
+		/// <description>Leviathan</description>
+		/// </item>
+		/// <item>
+		/// <term>&gt; 7</term>
+		/// <description>No name</description>
+		/// </item>
+		/// </list>
+		/// </remarks>
 		public int Size => BaseSets.Count;
 
 		/// <summary>

diff --git a/src/Sudoku.Solving/Manual/Wings/Regular/RegularWingStepInfo.cs b/src/Sudoku.Solving/Manual/Wings/Regular/RegularWingStepInfo.cs
@@ -43,6 +43,43 @@ public sealed record RegularWingStepInfo(
 		/// <summary>
 		/// Indicates the size of this regular wing.
 		/// </summary>
+		/// <remarks>
+		/// All names are:
+		/// <list type="table">
+		/// <item>
+		/// <term>2</term>
+		/// <description>XY-Wing</description>
+		/// </item>
+		/// <item>
+		/// <term>3</term>
+		/// <description>XYZ-Wing</description>
+		/// </item>
+		/// <item>
+		/// <term>4</term>
+		/// <description>WXYZ-Wing or XYZW-Wing</description>
+		/// </item>
+		/// <item>
+		/// <term>5</term>
+		/// <description>VWXYZ-Wing</description>
+		/// </item>
+		/// <item>
+		/// <term>6</term>
+		/// <description>UVWXYZ-Wing</description>
+		/// </item>
+		/// <item>
+		/// <term>7</term>
+		/// <description>TUVWXYZ-Wing</description>
+		/// </item>
+		/// <item>
+		/// <term>8</term>
+		/// <description>STUVWXYZ-Wing</description>
+		/// </item>
+		/// <item>
+		/// <term>9</term>
+		/// <description>RSTUVWXYZ-Wing</description>
+		/// </item>
+		/// </list>
+		/// </remarks>
 		public int Size => PopCount((uint)DigitsMask);
 
 		/// <inheritdoc/>

diff --git a/src/Sudoku.Solving/Sudoku.Solving.xml b/src/Sudoku.Solving/Sudoku.Solving.xml
@@ -3401,6 +3401,43 @@
             <summary>
             Indicates the size of this fish instance.
             </summary>
+            <remarks>
+            The name of the corresponding names are:
+            <list type="table">
+            <item>
+            <term>1</term>
+            <description>Cyclops (But out of use)</description>
+            </item>
+            <item>
+            <term>2</term>
+            <description>X-Wing</description>
+            </item>
+            <item>
+            <term>3</term>
+            <description>Swordfish</description>
+            </item>
+            <item>
+            <term>4</term>
+            <description>Jellyfish</description>
+            </item>
+            <item>
+            <term>5</term>
+            <description>Squirmbag or Starfish</description>
+            </item>
+            <item>
+            <term>6</term>
+            <description>Whale</description>
+            </item>
+            <item>
+            <term>7</term>
+            <description>Leviathan</description>
+            </item>
+            <item>
+            <term>&gt; 7</term>
+            <description>No name</description>
+            </item>
+            </list>
+            </remarks>
         </member>
         <member name="P:Sudoku.Solving.Manual.Fishes.FishStepInfo.Rank">
             <summary>
@@ -9245,6 +9282,43 @@
             <summary>
             Indicates the size of this regular wing.
             </summary>
+            <remarks>
+            All names are:
+            <list type="table">
+            <item>
+            <term>2</term>
+            <description>XY-Wing</description>
+            </item>
+            <item>
+            <term>3</term>
+            <description>XYZ-Wing</description>
+            </item>
+            <item>
+            <term>4</term>
+            <description>WXYZ-Wing or XYZW-Wing</description>
+            </item>
+            <item>
+            <term>5</term>
+            <description>VWXYZ-Wing</description>
+            </item>
+            <item>
+            <term>6</term>
+            <description>UVWXYZ-Wing</description>
+            </item>
+            <item>
+            <term>7</term>
+            <description>TUVWXYZ-Wing</description>
+            </item>
+            <item>
+            <term>8</term>
+            <description>STUVWXYZ-Wing</description>
+            </item>
+            <item>
+            <term>9</term>
+            <description>RSTUVWXYZ-Wing</description>
+            </item>
+            </list>
+            </remarks>
         </member>
         <member name="P:Sudoku.Solving.Manual.Wings.Regular.RegularWingStepInfo.Difficulty">
             <inheritdoc/>