Skip to content

Commit 7d9ead7

Browse files
authored
Update Image props docs and add metadata attributes (#1233)
Updated XML docs for Alt, Src, IsResponsive, and IsThumbnail properties in the Image component to use <para> for default values. Added [AddedVersion], [DefaultValue], and [Description] attributes to each property. Clarified IsThumbnail description regarding border appearance.
1 parent 41f82fd commit 7d9ead7

File tree

1 file changed

+24
-12
lines changed

1 file changed

+24
-12
lines changed

blazorbootstrap/Components/Image/Image.razor.cs

Lines changed: 24 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -11,37 +11,49 @@ public partial class Image: BlazorBootstrapComponentBase
1111

1212
/// <summary>
1313
/// Gets or sets the alternate text for the image.
14+
/// <para>
15+
/// Default value is <see langword="null"/>.
16+
/// </para>
1417
/// </summary>
15-
/// <remarks>
16-
/// Default value is null.
17-
/// </remarks>
18+
[AddedVersion("3.0.0")]
19+
[DefaultValue(null)]
20+
[Description("Gets or sets the alternate text for the image.")]
1821
[Parameter]
1922
public string? Alt { get; set; }
2023

2124
/// <summary>
2225
/// Gets or sets the source of the image.
26+
/// <para>
27+
/// Default value is <see langword="null"/>.
28+
/// </para>
2329
/// </summary>
24-
/// <remarks>
25-
/// Default value is null.
26-
/// </remarks>
30+
[AddedVersion("3.0.0")]
31+
[DefaultValue(null)]
32+
[Description("Gets or sets the source of the image.")]
2733
[Parameter]
2834
public string? Src { get; set; }
2935

3036
/// <summary>
3137
/// Gets or sets a value indicating whether the image is responsive.
32-
/// </summary>
33-
/// <remarks>
38+
/// <para>
3439
/// Default value is <see langword="true"/>.
35-
/// </remarks>
40+
/// </para>
41+
/// </summary>
42+
[AddedVersion("3.0.0")]
43+
[DefaultValue(true)]
44+
[Description("Gets or sets a value indicating whether the image is responsive.")]
3645
[Parameter]
3746
public bool IsResponsive { get; set; } = true;
3847

3948
/// <summary>
4049
/// Makes the image have a rounded 1px border appearance if set to <see langword="true"/>.
41-
/// </summary>
42-
/// <remarks>
50+
/// <para>
4351
/// Default value is <see langword="false"/>.
44-
/// </remarks>
52+
/// </para>
53+
/// </summary>
54+
[AddedVersion("3.0.0")]
55+
[DefaultValue(false)]
56+
[Description("Makes the image have a rounded 1px border appearance if set to <b>true</b>.")]
4557
[Parameter]
4658
public bool IsThumbnail { get; set; }
4759

0 commit comments

Comments
 (0)