Skip to content

Commit

Permalink
Fix the XML documentation of some of the elements
Browse files Browse the repository at this point in the history
  • Loading branch information
aradalvand committed Aug 8, 2023
1 parent 9a0a311 commit e4a26ee
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 10 deletions.
2 changes: 1 addition & 1 deletion src/Sqids/Sqids.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<OutputType>Library</OutputType>

<PackageId>Sqids</PackageId>
<Version>1.0.2</Version>
<Version>1.0.3</Version>
<Description>Official .NET port of Sqids. Generate short YouTube-looking IDs from numbers.</Description>
<PackageTags>Sqids;ID-generator;number-obfuscator;YouTube-ID</PackageTags>
<PackageIconUrl>https://raw.githubusercontent.com/sqids/sqids-dotnet/main/icon.png</PackageIconUrl>
Expand Down
14 changes: 7 additions & 7 deletions src/Sqids/SqidsEncoder.cs
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
namespace Sqids;

/// <summary>
/// The Sqids encoder/decoder.
/// The Sqids encoder/decoder. This is the main class.
/// </summary>
public sealed class SqidsEncoder
{
Expand All @@ -14,7 +14,7 @@ public sealed class SqidsEncoder

/// <summary>
/// The minimum numeric value that can be encoded/decoded using <see cref="SqidsEncoder" />.
/// It's always zero across all ports of Sqids.
/// This is always zero across all ports of Sqids.
/// </summary>
public const int MinValue = 0;

Expand All @@ -35,7 +35,7 @@ public SqidsEncoder() : this(new()) { }
/// <param name="options">
/// The custom options.
/// All properties of <see cref="SqidsOptions" /> are optional and will fall back to their
/// defaults unless explicitly set.
/// defaults if not explicitly set.
/// </param>
public SqidsEncoder(SqidsOptions options)
{
Expand Down Expand Up @@ -209,13 +209,13 @@ private string Encode(ReadOnlySpan<int> numbers, bool partitioned = false)
}

/// <summary>
/// Decodes a string into its original .
/// Decodes an ID into numbers.
/// </summary>
/// <param name="id">The encoded ID.</param>
/// <returns>
/// A collection of integers containing the decoded number(s); or empty an collection if the
/// input string is null, empty, contains fewer characters than the configured minimum length,
/// or includes characters not found in the alphabet.
/// An array of integers containing the decoded number(s) (it would contain only one element
/// if the ID represents a single number); or an empty array if the input ID is null,
/// empty, or includes characters not found in the alphabet.
/// </returns>
public int[] Decode(ReadOnlySpan<char> id)
{
Expand Down
3 changes: 1 addition & 2 deletions src/Sqids/SqidsOptions.cs
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,7 @@ namespace Sqids;

/// <summary>
/// The configuration options for <see cref="SqidsEncoder" />.
/// All properties are optional; any property that isn't explicitly specified when passing an
/// instance of this class to the constructor of <see cref="SqidsEncoder" /> will fall back to its
/// All properties are optional; any property that isn't explicitly specified will fall back to its
/// default value.
/// </summary>
public sealed class SqidsOptions
Expand Down

0 comments on commit e4a26ee

Please sign in to comment.