Migrated Documentation library from NetFlow.DocumentationHelper.Library

This commit is contained in:
2026-01-28 13:15:44 +00:00
parent ab700413fb
commit d20a80c44c
152 changed files with 714 additions and 94 deletions
+31 -1
View File
@@ -1,8 +1,11 @@
using System.Collections.Generic;
using System.Linq;
using OmegaLeo.HelperLib.Shared.Attributes;
namespace GameDevLibrary.Extensions
namespace OmegaLeo.HelperLib.Extensions
{
[Documentation("MathExtensions", "Provides extension methods for mathematical operations.")]
[Changelog("1.2.0", "Fixed root namespace to OmegaLeo.HelperLib.Extensions.", "January 28, 2026")]
public static class MathExtensions
{
/// <summary>
@@ -10,6 +13,15 @@ namespace GameDevLibrary.Extensions
/// </summary>
/// <param name="list"></param>
/// <returns></returns>
[Documentation(nameof(AverageWithNullValidation),
"Calculates the average of a list of integers, returning 0 if the list is empty.",
new[] { "list: The list of integers to calculate the average from." },
@"```csharp
var numbers = new List<int> { 1, 2, 3, 4 };
int average = numbers.AverageWithNullValidation(); // average will be 2 (rounded down)
var emptyList = new List<int>();
int averageEmpty = emptyList.AverageWithNullValidation(); // averageEmpty will be 0
```")]
public static int AverageWithNullValidation(this IEnumerable<int> list)
{
return list.Any() ? (int)list.Average() : 0;
@@ -20,6 +32,15 @@ namespace GameDevLibrary.Extensions
/// </summary>
/// <param name="list"></param>
/// <returns></returns>
[Documentation(nameof(AverageWithNullValidation),
"Calculates the average of a list of doubles, returning 0.0 if the list is empty.",
new[] { "list: The list of doubles to calculate the average from." },
@"```csharp
var numbers = new List<double> { 1.5, 2.5, 3.5 };
double average = numbers.AverageWithNullValidation(); // average will be 2.5
var emptyList = new List<double>();
double averageEmpty = emptyList.AverageWithNullValidation(); // averageEmpty will be 0.0
```")]
public static double AverageWithNullValidation(this IEnumerable<double> list)
{
return list.Any() ? list.Average() : 0.0;
@@ -30,6 +51,15 @@ namespace GameDevLibrary.Extensions
/// </summary>
/// <param name="list"></param>
/// <returns></returns>
[Documentation(nameof(AverageWithNullValidation),
"Calculates the average of a list of floats, returning 0.0f if the list is empty.",
new[] { "list: The list of floats to calculate the average from." },
@"```csharp
var numbers = new List<float> { 1.5f, 2.5f, 3.5f };
float average = numbers.AverageWithNullValidation(); // average will be 2.5f
var emptyList = new List<float>();
float averageEmpty = emptyList.AverageWithNullValidation(); // averageEmpty will be 0.0f
```")]
public static float AverageWithNullValidation(this IEnumerable<float> list)
{
return list.Any() ? list.Average() : 0.0f;