Skip to content

Commit fb98a82

Browse files
committed
Fix defaults documentation of ShapeOptions and TextOptions properties
1 parent b58a245 commit fb98a82

2 files changed

Lines changed: 16 additions & 5 deletions

File tree

src/ImageSharp.Drawing/Processing/ShapeOptions.cs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,8 @@ private ShapeOptions(ShapeOptions source)
2525

2626
/// <summary>
2727
/// Gets or sets a value indicating whether antialiasing should be applied.
28-
/// Defaults to true.
28+
/// <para/>
29+
/// Defaults to <see cref="SixLabors.ImageSharp.Drawing.IntersectionRule.OddEven"/>.
2930
/// </summary>
3031
public IntersectionRule IntersectionRule { get; set; } = IntersectionRule.OddEven;
3132

src/ImageSharp.Drawing/Processing/TextOptions.cs

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,12 +40,14 @@ private TextOptions(TextOptions source)
4040

4141
/// <summary>
4242
/// Gets or sets a value indicating whether the text should be drawing with kerning enabled.
43-
/// Defaults to true;
43+
/// <para/>
44+
/// Defaults to true.
4445
/// </summary>
4546
public bool ApplyKerning { get; set; } = true;
4647

4748
/// <summary>
4849
/// Gets or sets a value indicating the number of space widths a tab should lock to.
50+
/// <para/>
4951
/// Defaults to 4.
5052
/// </summary>
5153
public float TabWidth
@@ -61,12 +63,14 @@ public float TabWidth
6163

6264
/// <summary>
6365
/// Gets or sets a value, if greater than 0, indicating the width at which text should wrap.
66+
/// <para/>
6467
/// Defaults to 0.
6568
/// </summary>
6669
public float WrapTextWidth { get; set; }
6770

6871
/// <summary>
6972
/// Gets or sets a value indicating the DPI (Dots Per Inch) to render text along the X axis.
73+
/// <para/>
7074
/// Defaults to 72.
7175
/// </summary>
7276
public float DpiX
@@ -82,6 +86,7 @@ public float DpiX
8286

8387
/// <summary>
8488
/// Gets or sets a value indicating the DPI (Dots Per Inch) to render text along the Y axis.
89+
/// <para/>
8590
/// Defaults to 72.
8691
/// </summary>
8792
public float DpiY
@@ -97,6 +102,7 @@ public float DpiY
97102

98103
/// <summary>
99104
/// Gets or sets the line spacing. Applied as a multiple of the line height.
105+
/// <para/>
100106
/// Defaults to 1.
101107
/// </summary>
102108
public float LineSpacing
@@ -115,24 +121,28 @@ public float LineSpacing
115121
/// If <see cref="WrapTextWidth"/> is greater than zero it will align relative to the space
116122
/// defined by the location and width, if <see cref="WrapTextWidth"/> equals zero, and thus
117123
/// wrapping disabled, then the alignment is relative to the drawing location.
118-
/// Defaults to <see cref="HorizontalAlignment.Left"/>.
124+
/// <para/>
125+
/// Defaults to <see cref="SixLabors.Fonts.HorizontalAlignment.Left"/>.
119126
/// </summary>
120127
public HorizontalAlignment HorizontalAlignment { get; set; } = HorizontalAlignment.Left;
121128

122129
/// <summary>
123130
/// Gets or sets a value indicating how to align the text relative to the rendering space.
124-
/// Defaults to <see cref="VerticalAlignment.Top"/>.
131+
/// <para/>
132+
/// Defaults to <see cref="SixLabors.Fonts.VerticalAlignment.Top"/>.
125133
/// </summary>
126134
public VerticalAlignment VerticalAlignment { get; set; } = VerticalAlignment.Top;
127135

128136
/// <summary>
129137
/// Gets the list of fallback font families to apply to the text drawing operation.
130-
/// Defaults to <see cref="VerticalAlignment.Top"/>.
138+
/// <para/>
139+
/// Defaults to the empty list.
131140
/// </summary>
132141
public List<FontFamily> FallbackFonts { get; } = new List<FontFamily>();
133142

134143
/// <summary>
135144
/// Gets or sets a value indicating whether we should render color(emoji) fonts.
145+
/// <para/>
136146
/// Defaults to true.
137147
/// </summary>
138148
public bool RenderColorFonts { get; set; } = true;

0 commit comments

Comments
 (0)