Skip to content

Commit

Permalink
refactor: change utility classes to internal and update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
sholle7 committed Dec 24, 2024
1 parent 4d4de04 commit 5d97f5d
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 11 deletions.
8 changes: 4 additions & 4 deletions Barchart.Common/Utilities/CurrencyExchangePair.cs
Original file line number Diff line number Diff line change
Expand Up @@ -9,19 +9,19 @@ namespace Barchart.Common.Utilities;
/// <summary>
/// Represents a pair of currencies for which an exchange rate is defined.
/// </summary>
public sealed class CurrencyExchangePair : IEquatable<CurrencyExchangePair>
internal class CurrencyExchangePair : IEquatable<CurrencyExchangePair>
{
#region Properties

/// <summary>
/// The source currency.
/// </summary>
public Currency Source { get; }
internal Currency Source { get; }

/// <summary>
/// The target currency.
/// </summary>
public Currency Target { get; }
internal Currency Target { get; }

#endregion

Expand All @@ -39,7 +39,7 @@ public sealed class CurrencyExchangePair : IEquatable<CurrencyExchangePair>
///<exception cref="ArgumentNullException">
/// Thrown when <paramref name="source"/> or <paramref name="target"/> is <see langword="null"/>.
/// </exception>
public CurrencyExchangePair(Currency source, Currency target)
internal CurrencyExchangePair(Currency source, Currency target)
{
ArgumentNullException.ThrowIfNull(source, nameof(source));
ArgumentNullException.ThrowIfNull(target, nameof(target));
Expand Down
12 changes: 6 additions & 6 deletions Barchart.Common/Utilities/CurrencyInfo.cs
Original file line number Diff line number Diff line change
Expand Up @@ -3,24 +3,24 @@ namespace Barchart.Common.Utilities;
/// <summary>
/// Class representing currency information.
/// </summary>
public class CurrencyInfo
internal class CurrencyInfo
{
#region Properties

/// <summary>
/// The description of the currency.
/// </summary>
public string Description { get; }
internal string Description { get; }

/// <summary>
/// The precision of the currency.
/// </summary>
public int Precision { get; }
internal int Precision { get; }

/// <summary>
/// The alternate description of the currency.
/// </summary>
public string AlternateDescription { get; }
internal string AlternateDescription { get; }

#endregion

Expand All @@ -41,7 +41,7 @@ public class CurrencyInfo
/// <exception cref="ArgumentException">
/// Thrown when <paramref name="description"/> or <paramref name="alternateDescription"/> is <see langword="null"/> or empty.
/// </exception>
public CurrencyInfo(string description, int precision, string alternateDescription)
internal CurrencyInfo(string description, int precision, string alternateDescription)
{
ArgumentException.ThrowIfNullOrEmpty(description);
ArgumentException.ThrowIfNullOrEmpty(alternateDescription);
Expand All @@ -50,6 +50,6 @@ public CurrencyInfo(string description, int precision, string alternateDescripti
Precision = precision;
AlternateDescription = alternateDescription;
}

#endregion

}
1 change: 0 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ A _public_ library of .NET utilities.
- **Core**: Core classes providing various functionalities.
- **Extensions**: Extensions used to extend the functionality of the data types.
- **Interfaces**: Common interfaces meant to be implemented by other classes to provide a common functionalities.
- **Utilities**: Helper classes used throughout the library.

## Installation

Expand Down

0 comments on commit 5d97f5d

Please sign in to comment.