Skip to content

Commit

Permalink
fix: updated all xml comments that ensure only one code tag is presen…
Browse files Browse the repository at this point in the history
…t in the example tag.
  • Loading branch information
dtanglr committed Jul 14, 2024
1 parent fbba84d commit 3a54bdd
Show file tree
Hide file tree
Showing 11 changed files with 27 additions and 60 deletions.
6 changes: 2 additions & 4 deletions src/Primitively.Abstractions/ByteAttribute.cs
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,10 @@
/// <code>
/// [Byte]
/// public partial record struct Example;
/// </code>
/// <code>
///
/// [Byte(Minimum = 1)]
/// public partial record struct Example;
/// </code>
/// <code>
///
/// [Byte(Minimum = 1, Maximum = 100)]
/// public partial record struct Example;
/// </code>
Expand Down
15 changes: 3 additions & 12 deletions src/Primitively.Abstractions/DoubleAttribute.cs
Original file line number Diff line number Diff line change
Expand Up @@ -9,22 +9,13 @@
/// <code>
/// [Double]
/// public partial record struct Example;
/// </code>
/// </example>
/// <example>
/// <code>
///
/// [Double(Minimum = 1.10d)]
/// public partial record struct Example;
/// </code>
/// </example>
/// <example>
/// <code>
///
/// [Double(Minimum = -10.10d, Maximum = 10.10d)]
/// public partial record struct Example;
/// </code>
/// </example>
/// <example>
/// <code>
///
/// [Double(2, Minimum = -10.10d, Maximum = 10.10d)]
/// public partial record struct Example;
/// </code>
Expand Down
15 changes: 5 additions & 10 deletions src/Primitively.Abstractions/GuidAttribute.cs
Original file line number Diff line number Diff line change
Expand Up @@ -9,24 +9,19 @@
/// <code>
/// [Guid] // e.g. 2c48c152-7cb7-4f51-8f01-704454f36e60
/// public partial record struct Example;
/// </code>
/// <code>
///
/// [Guid(Specifier.B)] // e.g. {2c48c152-7cb7-4f51-8f01-704454f36e60}
/// public partial record struct Example;
/// </code>
/// <code>
///
/// [Guid(Specifier.D)] // e.g. 2c48c152-7cb7-4f51-8f01-704454f36e60 (Default)
/// public partial record struct Example;
/// </code>
/// <code>
///
/// [Guid(Specifier.N)] // e.g. 2c48c1527cb74f518f01704454f36e60
/// public partial record struct Example;
/// </code>
/// <code>
///
/// [Guid(Specifier.P)] // e.g. (2c48c152-7cb7-4f51-8f01-704454f36e60)
/// public partial record struct Example;
/// </code>
/// <code>
///
/// [Guid(Specifier.X)] // e.g. {0x2c48c152,0x7cb7,0x4f51,{0x8f,0x01,0x70,0x44,0x54,0xf3,0x6e,0x60}}
/// public partial record struct Example;
/// </code>
Expand Down
6 changes: 2 additions & 4 deletions src/Primitively.Abstractions/IntAttribute.cs
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,10 @@
/// <code>
/// [Int]
/// public partial record struct Example;
/// </code>
/// <code>
///
/// [Int(Minimum = 0)]
/// public partial record struct Example;
/// </code>
/// <code>
///
/// [Int(Minimum = 1000, Maximum = 2000)]
/// public partial record struct Example;
/// </code>
Expand Down
6 changes: 2 additions & 4 deletions src/Primitively.Abstractions/LongAttribute.cs
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,10 @@
/// <code>
/// [Long]
/// public partial record struct Example;
/// </code>
/// <code>
///
/// [Long(Minimum = 0)]
/// public partial record struct Example;
/// </code>
/// <code>
///
/// [Long(Minimum = 1000, Maximum = 2000)]
/// public partial record struct Example;
/// </code>
Expand Down
6 changes: 2 additions & 4 deletions src/Primitively.Abstractions/SByteAttribute.cs
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,10 @@
/// <code>
/// [SByte]
/// public partial record struct Example;
/// </code>
/// <code>
///
/// [SByte(Minimum = 0)]
/// public partial record struct Example;
/// </code>
/// <code>
///
/// [SByte(Minimum = -10, Maximum = 10)]
/// public partial record struct Example;
/// </code>
Expand Down
6 changes: 2 additions & 4 deletions src/Primitively.Abstractions/ShortAttribute.cs
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,10 @@
/// <code>
/// [Short]
/// public partial record struct Example;
/// </code>
/// <code>
///
/// [Short(Minimum = 0)]
/// public partial record struct Example;
/// </code>
/// <code>
///
/// [Short(Minimum = -10, Maximum = 10)]
/// public partial record struct Example;
/// </code>
Expand Down
9 changes: 3 additions & 6 deletions src/Primitively.Abstractions/SingleAttribute.cs
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,13 @@
/// <code>
/// [Single]
/// public partial record struct Example;
/// </code>
/// <code>
///
/// [Single(Minimum = 1.10f)]
/// public partial record struct Example;
/// </code>
/// <code>
///
/// [Single(Minimum = -10.10f, Maximum = 10.10f)]
/// public partial record struct Example;
/// </code>
/// <code>
///
/// [Single(2, Minimum = -10.10f, Maximum = 10.10f)]
/// public partial record struct Example;
/// </code>
Expand Down
6 changes: 2 additions & 4 deletions src/Primitively.Abstractions/UIntAttribute.cs
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,10 @@
/// <code>
/// [UInt]
/// public partial record struct Example;
/// </code>
/// <code>
///
/// [UInt(Minimum = 1000000)]
/// public partial record struct Example;
/// </code>
/// <code>
///
/// [UInt(Minimum = 2000000, Maximum = 4000000)]
/// public partial record struct Example;
/// </code>
Expand Down
6 changes: 2 additions & 4 deletions src/Primitively.Abstractions/ULongAttribute.cs
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,10 @@
/// <code>
/// [ULong]
/// public partial record struct Example;
/// </code>
/// <code>
///
/// [ULong(Minimum = 100000)]
/// public partial record struct Example;
/// </code>
/// <code>
///
/// [ULong(Minimum = 20000000, Maximum = 40000000)]
/// public partial record struct Example;
/// </code>
Expand Down
6 changes: 2 additions & 4 deletions src/Primitively.Abstractions/UShortAttribute.cs
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,10 @@
/// <code>
/// [UShort]
/// public partial record struct Example;
/// </code>
/// <code>
///
/// [UShort(Minimum = 10000)]
/// public partial record struct Example;
/// </code>
/// <code>
///
/// [UShort(Minimum = 10000, Maximum = 60000)]
/// public partial record struct Example;
/// </code>
Expand Down

0 comments on commit 3a54bdd

Please sign in to comment.