Skip to content

Commit f4ac1d9

Browse files
committed
Add additional class and function comments
1 parent 161a287 commit f4ac1d9

File tree

3 files changed

+21
-2
lines changed

3 files changed

+21
-2
lines changed

Runtime/Chance.cs

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
namespace Zigurous.Math
22
{
3+
/// <summary>
4+
/// Provides functions for generating random chance values.
5+
/// </summary>
36
public static class Chance
47
{
58
public enum Coin { Heads, Tails }
@@ -187,7 +190,7 @@ public static int CustomDiceRoll(int[] values, int x)
187190
}
188191

189192
/// <summary>
190-
/// Returns `true` or `false`, with 50-50 odds.
193+
/// Returns true or false, with 50-50 odds.
191194
/// </summary>
192195
public static bool RandomBool() => UnityEngine.Random.value < 0.5f;
193196

@@ -197,7 +200,7 @@ public static int CustomDiceRoll(int[] values, int x)
197200
public static Coin CoinFlip() => UnityEngine.Random.value < 0.5f ? Coin.Heads : Coin.Tails;
198201

199202
/// <summary>
200-
/// Returns `1.0f` or `-1.0f`, with 50-50 odds.
203+
/// Returns 1.0f or -1.0f, with 50-50 odds.
201204
/// </summary>
202205
public static float PositiveOrNegative() => UnityEngine.Random.value < 0.5f ? 1.0f : -1.0f;
203206

Runtime/FloatEqualityComparer.cs

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,25 @@
22

33
namespace Zigurous.Math
44
{
5+
/// <summary>
6+
/// Determines equality between float values given an amount of decimal
7+
/// digits to compare.
8+
/// </summary>
59
public sealed class FloatEqualityComparer : IEqualityComparer<float>
610
{
11+
/// <summary>
12+
/// The number of decimal digits to compare when determining equality.
13+
/// </summary>
714
public int digits = 3;
815

16+
/// <summary>
17+
/// Determines whether the specified floats are equal.
18+
/// </summary>
919
public bool Equals(float x, float y) => System.Math.Round(x, this.digits) == System.Math.Round(y, this.digits);
1020

21+
/// <summary>
22+
/// Returns a hash code for the specified float value.
23+
/// </summary>
1124
public int GetHashCode(float f) => System.Math.Round(f, this.digits).GetHashCode();
1225

1326
}

Runtime/Processors.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22

33
namespace Zigurous.Math
44
{
5+
/// <summary>
6+
/// Provides functions for processing input values.
7+
/// </summary>
58
public static class Processors
69
{
710
/// <summary>

0 commit comments

Comments
 (0)