Merge pull request #1 from BlazorExpress/features/xml-documentation-updates

Features/xml documentation updates

Author: gvreddy04

BlazorExpress.Core/BlazorExpress.Core.csproj

@@ -2,8 +2,8 @@
 
   <PropertyGroup>
     <PackageId>BlazorExpress.Core</PackageId>
-    <Version>0.0.4</Version>
-    <PackageVersion>0.0.4</PackageVersion>
+    <Version>0.1.0</Version>
+    <PackageVersion>0.1.0</PackageVersion>
 
     <!--<PackageIconUrl></PackageIconUrl>-->
     <PackageLicenseExpression>Apache-2.0</PackageLicenseExpression>

BlazorExpress.Core/Components/BlazorExpressComponentCore.cs

@@ -133,17 +133,27 @@ protected virtual ValueTask DisposeAsyncCore(bool disposing)
 
     #region Properties, Indexers
 
-    [Parameter(CaptureUnmatchedValues = true)] public Dictionary<string, object> AdditionalAttributes { get; set; } = default!;
+    /// <summary>
+    /// Gets or sets additional attributes that will be applied to the component.
+    /// <para>
+    /// Default value is <see langword="null" />.
+    /// </para>
+    /// </summary>
+    [AddedVersion("1.0.0")]
+    [DefaultValue(null)]
+    [Description("Gets or sets additional attributes that will be applied to the component.")]
+    [Parameter(CaptureUnmatchedValues = true)]
+    public Dictionary<string, object> AdditionalAttributes { get; set; } = default!;
 
     /// <summary>
-    /// Gets or sets the CSS class.
+    /// Gets or sets the CSS class name(s) to apply to the component.
     /// <para>
     /// Default value is <see langword="null" />.
     /// </para>
     /// </summary>
     [AddedVersion("1.0.0")]
     [DefaultValue(null)]
-    [Description("Gets or sets the CSS class.")]
+    [Description("Gets or sets the CSS class name(s) to apply to the component.")]
     [Parameter]
     public string? Class { get; set; }
 
@@ -175,14 +185,14 @@ protected virtual ValueTask DisposeAsyncCore(bool disposing)
     [Inject] protected IJSRuntime JSRuntime { get; set; } = default!;
 
     /// <summary>
-    /// Gets or sets the CSS style.
+    /// Gets or sets the CSS style string that defines the inline styles for the component.
     /// <para>
     /// Default value is <see langword="null" />.
     /// </para>
     /// </summary>
     [AddedVersion("1.0.0")]
     [DefaultValue(null)]
-    [Description("Gets or sets the CSS style.")]
+    [Description("Gets or sets the CSS style string that defines the inline styles for the component.")]
     [Parameter]
     public string? Style { get; set; }
 

BlazorExpress.Core/Components/BlazorExpressLayoutComponentCore.cs

@@ -133,17 +133,27 @@ protected virtual ValueTask DisposeAsyncCore(bool disposing)
 
     #region Properties, Indexers
 
-    [Parameter(CaptureUnmatchedValues = true)] public Dictionary<string, object> AdditionalAttributes { get; set; } = default!;
+    /// <summary>
+    /// Gets or sets additional attributes that will be applied to the component.
+    /// <para>
+    /// Default value is <see langword="null" />.
+    /// </para>
+    /// </summary>
+    [AddedVersion("1.0.0")]
+    [DefaultValue(null)]
+    [Description("Gets or sets additional attributes that will be applied to the component.")]
+    [Parameter(CaptureUnmatchedValues = true)]
+    public Dictionary<string, object> AdditionalAttributes { get; set; } = default!;
 
     /// <summary>
-    /// Gets or sets the CSS class.
+    /// Gets or sets the CSS class name(s) to apply to the component.
     /// <para>
     /// Default value is <see langword="null" />.
     /// </para>
     /// </summary>
     [AddedVersion("1.0.0")]
     [DefaultValue(null)]
-    [Description("Gets or sets the CSS class.")]
+    [Description("Gets or sets the CSS class name(s) to apply to the component.")]
     [Parameter]
     public string? Class { get; set; }
 
@@ -172,17 +182,18 @@ protected virtual ValueTask DisposeAsyncCore(bool disposing)
 
     protected bool IsFirstRenderComplete { get; private set; }
 
-    [Inject] protected IJSRuntime JSRuntime { get; set; } = default!;
+    [Inject] 
+    protected IJSRuntime JSRuntime { get; set; } = default!;
 
     /// <summary>
-    /// Gets or sets the CSS style.
+    /// Gets or sets the CSS style string that defines the inline styles for the component.
     /// <para>
     /// Default value is <see langword="null" />.
     /// </para>
     /// </summary>
     [AddedVersion("1.0.0")]
     [DefaultValue(null)]
-    [Description("Gets or sets the CSS style.")]
+    [Description("Gets or sets the CSS style string that defines the inline styles for the component.")]
     [Parameter]
     public string? Style { get; set; }