Skip to content

Commit 0f574ed

Browse files
authored
Merge pull request #108 from Tynamix/feature/Fix_comments
Feature/fix comments
2 parents d4fa4fa + 05c733e commit 0f574ed

27 files changed

+157
-142
lines changed

Tynamix.ObjectFiller/Filler.cs

Lines changed: 48 additions & 48 deletions
Large diffs are not rendered by default.

Tynamix.ObjectFiller/HashStack.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ internal bool Push(T item)
7272
/// Removes and returns the last added element.
7373
/// </summary>
7474
/// <returns>
75-
/// The item of type <see cref="T"/>
75+
/// The item of type <typeparamref name="T"/>
7676
/// </returns>
7777
internal T Pop()
7878
{
@@ -91,7 +91,7 @@ internal void Clear()
9191
}
9292

9393
/// <summary>
94-
/// Checks if the <see cref="HashStack{T}"/> contains the <see cref="item"/>
94+
/// Checks if the <see cref="HashStack{T}"/> contains the <paramref name="item"/>
9595
/// </summary>
9696
/// <param name="item">
9797
/// The item.

Tynamix.ObjectFiller/IInterfaceMocker.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ namespace Tynamix.ObjectFiller
1717
public interface IInterfaceMocker
1818
{
1919
/// <summary>
20-
/// Creates a mock of the interface with type <see cref="T"/>
20+
/// Creates a mock of the interface with type <typeparamref name="T"/>
2121
/// </summary>
2222
/// <typeparam name="T">Type of the interface</typeparam>
2323
/// <returns>Mock of the interface</returns>

Tynamix.ObjectFiller/Plugins/DateTime/DateTimeRange.cs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -64,9 +64,9 @@ public DateTimeRange(DateTime earliestDate, DateTime latestDate)
6464
}
6565

6666
/// <summary>
67-
/// Gets random data for type <see cref="T"/>
67+
/// Gets random data for type <see cref="DateTime"/>
6868
/// </summary>
69-
/// <returns>Random data for type <see cref="T"/></returns>
69+
/// <returns>Random data for type <see cref="DateTime"/></returns>
7070
public DateTime GetValue()
7171
{
7272
var timeSpan = this.latestDate.Subtract(this.earliestDate);
@@ -77,9 +77,9 @@ public DateTime GetValue()
7777
}
7878

7979
/// <summary>
80-
/// Gets random data for type <see cref="T"/>
80+
/// Gets random data for type <see cref="Nullable{DateTime}"/>
8181
/// </summary>
82-
/// <returns>Random data for type <see cref="T"/></returns>
82+
/// <returns>Random data for type <see cref="Nullable{DateTime}"/></returns>
8383
DateTime? IRandomizerPlugin<DateTime?>.GetValue()
8484
{
8585
return this.GetValue();

Tynamix.ObjectFiller/Plugins/Double/DoubleRange.cs

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -58,39 +58,39 @@ public DoubleRange()
5858
}
5959

6060
/// <summary>
61-
/// Gets random data for type <see cref="T"/>
61+
/// Gets random data for type <see cref="double"/>
6262
/// </summary>
63-
/// <returns>Random data for type <see cref="T"/></returns>
63+
/// <returns>Random data for type <see cref="double"/></returns>
6464
public double GetValue()
6565
{
6666
return Random.NextDouble() * Math.Abs(this.maxValue - this.minValue) + this.minValue;
6767
}
6868

6969
/// <summary>
70-
/// Gets random data for type <see cref="T"/>
70+
/// Gets random data for type <see cref="Nullable{Double}"/>
7171
/// </summary>
72-
/// <returns>Random data for type <see cref="T"/></returns>
72+
/// <returns>Random data for type <see cref="Nullable{Double}"/></returns>
7373
double? IRandomizerPlugin<double?>.GetValue()
7474
{
7575
return this.GetValue();
7676
}
7777

7878
/// <summary>
79-
/// Gets random data for type <see cref="T"/>
79+
/// Gets random data for type <see cref="decimal"/>
8080
/// </summary>
81-
/// <returns>Random data for type <see cref="T"/></returns>
81+
/// <returns>Random data for type <see cref="decimal"/></returns>
8282
decimal IRandomizerPlugin<decimal>.GetValue()
8383
{
84-
return (decimal)GetValue();
84+
return (decimal)this.GetValue();
8585
}
8686

8787
/// <summary>
88-
/// Gets random data for type <see cref="T"/>
88+
/// Gets random data for type <see cref="Nullable{Decimal}"/>
8989
/// </summary>
90-
/// <returns>Random data for type <see cref="T"/></returns>
90+
/// <returns>Random data for type <see cref="Nullable{Decimal}"/></returns>
9191
decimal? IRandomizerPlugin<decimal?>.GetValue()
9292
{
93-
return (decimal)GetValue();
93+
return (decimal)this.GetValue();
9494
}
9595
}
9696
}

Tynamix.ObjectFiller/Plugins/Double/FloatRange.cs

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@ namespace Tynamix.ObjectFiller
22
{
33
using System;
44

5+
/// <summary>
6+
/// Randomizer for type <see cref="float"/>
7+
/// </summary>
58
public class FloatRange : IRandomizerPlugin<float>, IRandomizerPlugin<float?>
69
{
710
private readonly float _minValue;
@@ -37,13 +40,21 @@ public FloatRange()
3740

3841
}
3942

43+
/// <summary>
44+
/// Gets random data for type <see cref="float"/>
45+
/// </summary>
46+
/// <returns>Random data for type <see cref="float"/></returns>
4047
public float GetValue()
4148
{
4249
var value = Random.NextDouble();
4350

4451
return Convert.ToSingle(value) * (this._maxValue - this._minValue) + this._minValue;
4552
}
4653

54+
/// <summary>
55+
/// Gets random data for type <see cref="Nullable{Float}"/>
56+
/// </summary>
57+
/// <returns>Random data for type <see cref="Nullable{Float}"/></returns>
4758
float? IRandomizerPlugin<float?>.GetValue()
4859
{
4960
return this.GetValue();

Tynamix.ObjectFiller/Plugins/EnumeratorPlugin.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,9 @@ public EnumeratorPlugin(IEnumerable<T> enumerable)
4040
}
4141

4242
/// <summary>
43-
/// Gets random data for type <see cref="T"/>
43+
/// Gets random data for type <typeparamref name="T"/>
4444
/// </summary>
45-
/// <returns>Random data for type <see cref="T"/></returns>
45+
/// <returns>Random data for type <typeparamref name="T"/></returns>
4646
public T GetValue()
4747
{
4848
// First time?

Tynamix.ObjectFiller/Plugins/IRandomizerPlugin.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,15 @@
1010
namespace Tynamix.ObjectFiller
1111
{
1212
/// <summary>
13-
/// Implement this interface to create a custom randomizer of type <see cref="T"/>
13+
/// Implement this interface to create a custom randomizer of type <typeparamref name="T"/>
1414
/// </summary>
1515
/// <typeparam name="T">Type for which the randomizer will generate data</typeparam>
1616
public interface IRandomizerPlugin<out T>
1717
{
1818
/// <summary>
19-
/// Gets random data for type <see cref="T"/>
19+
/// Gets random data for type <typeparamref name="T"/>
2020
/// </summary>
21-
/// <returns>Random data for type <see cref="T"/></returns>
21+
/// <returns>Random data for type <typeparamref name="T"/></returns>
2222
T GetValue();
2323
}
2424
}

Tynamix.ObjectFiller/Plugins/Integer/IntRange.cs

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -52,21 +52,22 @@ public IntRange()
5252
}
5353

5454
/// <summary>
55-
/// Gets random data for type <see cref="T"/>
55+
/// Gets random data for type <see cref="int"/>
5656
/// </summary>
57-
/// <returns>Random data for type <see cref="T"/></returns>
57+
/// <returns>Random data for type <see cref="int"/></returns>
5858
public int GetValue()
5959
{
6060
return Random.Next(this.min, this.max);
6161
}
6262

63+
6364
/// <summary>
64-
/// Gets random data for type <see cref="T"/>
65+
/// Gets random data for type <see cref="Nullable{Int32}"/>
6566
/// </summary>
66-
/// <returns>Random data for type <see cref="T"/></returns>
67+
/// <returns>Random data for type <see cref="Nullable{Int32}"/></returns>
6768
int? IRandomizerPlugin<int?>.GetValue()
6869
{
69-
return GetValue();
70+
return this.GetValue();
7071
}
7172
}
7273
}

Tynamix.ObjectFiller/Plugins/List/Collectionizer.cs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -95,9 +95,9 @@ public Collectionizer(TRandomizer randomizerToUse, uint minCount, uint maxCount)
9595

9696

9797
/// <summary>
98-
/// Gets random data for type <see cref="T"/>
98+
/// Gets random data for type <typeparamref name="T"/>
9999
/// </summary>
100-
/// <returns>Random data for type <see cref="T"/></returns>
100+
/// <returns>Random data for type <typeparamref name="T"/></returns>
101101
public List<T> GetValue()
102102
{
103103
var count = Randomizer<int>.Create(new IntRange(this.minCount, this.maxCount));
@@ -112,19 +112,19 @@ public List<T> GetValue()
112112
}
113113

114114
/// <summary>
115-
/// Gets random data for type <see cref="T"/>
115+
/// Gets random data for type <typeparamref name="T"/>
116116
/// </summary>
117-
/// <returns>Random data for type <see cref="T"/></returns>
117+
/// <returns>Random data for type <typeparamref name="T"/></returns>
118118
T[] IRandomizerPlugin<T[]>.GetValue()
119119
{
120120
return this.GetValue().ToArray();
121121
}
122122

123123
#if !NETSTANDARD1_0
124124
/// <summary>
125-
/// Gets random data for type <see cref="T"/>
125+
/// Gets random data for type <typeparamref name="T"/>
126126
/// </summary>
127-
/// <returns>Random data for type <see cref="T"/></returns>
127+
/// <returns>Random data for type <typeparamref name="T"/></returns>
128128
ArrayList IRandomizerPlugin<ArrayList>.GetValue()
129129
{
130130
ArrayList arrayList = new ArrayList();

0 commit comments

Comments
 (0)