Docs: ApiDocsGenerator for API documentation from XML comments

.gitignore

@@ -273,3 +273,6 @@ Documentation/Blazorise.Docs.Server/wwwroot/img/blog/.DS_Store
 
 # Source Generation directory
 __SOURCEGENERATED__/
+
+# Fody
+/Source/Blazorise/FodyWeavers.xsd

Blazorise.sln

@@ -157,6 +157,10 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Blazorise.Charts.Zoom", "So
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Blazorise.PdfViewer", "Source\Extensions\Blazorise.PdfViewer\Blazorise.PdfViewer.csproj", "{EAB7EC89-900A-4280-B24A-152B9DD2B503}"
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Blazorise.Weavers", "Source\SourceGenerators\Blazorise.Weavers\Blazorise.Weavers.csproj", "{BF5FFB8C-45AD-4875-BB01-2DA388890419}"
+EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Blazorise.Weavers.Fody", "Source\SourceGenerators\Blazorise.Weavers.Fody\Blazorise.Weavers.Fody.csproj", "{FFC4A285-1A16-4DD4-8B8C-141521E405B0}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -411,6 +415,14 @@ Global
 		{EAB7EC89-900A-4280-B24A-152B9DD2B503}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{EAB7EC89-900A-4280-B24A-152B9DD2B503}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{EAB7EC89-900A-4280-B24A-152B9DD2B503}.Release|Any CPU.Build.0 = Release|Any CPU
+		{BF5FFB8C-45AD-4875-BB01-2DA388890419}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{BF5FFB8C-45AD-4875-BB01-2DA388890419}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{BF5FFB8C-45AD-4875-BB01-2DA388890419}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{BF5FFB8C-45AD-4875-BB01-2DA388890419}.Release|Any CPU.Build.0 = Release|Any CPU
+		{FFC4A285-1A16-4DD4-8B8C-141521E405B0}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{FFC4A285-1A16-4DD4-8B8C-141521E405B0}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{FFC4A285-1A16-4DD4-8B8C-141521E405B0}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{FFC4A285-1A16-4DD4-8B8C-141521E405B0}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -481,6 +493,8 @@ Global
 		{2B4FD79A-42E2-4B81-828B-0799E4744ADA} = {9731051E-0AA7-411E-A76A-987854F034DA}
 		{045536EC-BD97-409D-BDF7-C148B7C5AAFC} = {9731051E-0AA7-411E-A76A-987854F034DA}
 		{EAB7EC89-900A-4280-B24A-152B9DD2B503} = {9731051E-0AA7-411E-A76A-987854F034DA}
+		{BF5FFB8C-45AD-4875-BB01-2DA388890419} = {0538DB67-B4F3-4D00-B969-D3874A52E405}
+		{FFC4A285-1A16-4DD4-8B8C-141521E405B0} = {0538DB67-B4F3-4D00-B969-D3874A52E405}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {205B3EA4-470F-45DA-911E-346AF7D0A9A5}

Documentation/Blazorise.Docs/Blazorise.Docs.csproj

@@ -2,13 +2,18 @@
 
   <Import Project="..\..\Build\Blazorise.Docs.props" />
 
+  <PropertyGroup>
+    <LangVersion>latest</LangVersion>
+  </PropertyGroup>
+
   <ItemGroup>
     <SupportedPlatform Include="browser" />
   </ItemGroup>
 
   <ItemGroup>
     <ProjectReference Include="..\..\Shared\Blazorise.Shared\Blazorise.Shared.csproj" />
-    <ProjectReference Include="..\..\Source\Blazorise\Blazorise.csproj" />
+    <ProjectReference Include="..\..\Source\Blazorise\Blazorise.csproj"
+                      AdditionalProperties="EnableApiDocsGenerator=true"/>
     <ProjectReference Include="..\..\Source\Extensions\Blazorise.Animate\Blazorise.Animate.csproj" />
     <ProjectReference Include="..\..\Source\Extensions\Blazorise.Captcha.ReCaptcha\Blazorise.Captcha.ReCaptcha.csproj" />
     <ProjectReference Include="..\..\Source\Extensions\Blazorise.Captcha\Blazorise.Captcha.csproj" />
@@ -25,7 +30,8 @@
     <ProjectReference Include="..\..\Source\Extensions\Blazorise.QRCode\Blazorise.QRCode.csproj" />
     <ProjectReference Include="..\..\Source\Extensions\Blazorise.RichTextEdit\Blazorise.RichTextEdit.csproj" />
     <ProjectReference Include="..\..\Source\Extensions\Blazorise.Sidebar\Blazorise.Sidebar.csproj" />
-    <ProjectReference Include="..\..\Source\Extensions\Blazorise.Snackbar\Blazorise.Snackbar.csproj" />
+    <ProjectReference Include="..\..\Source\Extensions\Blazorise.Snackbar\Blazorise.Snackbar.csproj"
+                      AdditionalProperties="EnableApiDocsGenerator=true"/>
     <ProjectReference Include="..\..\Source\Extensions\Blazorise.SpinKit\Blazorise.SpinKit.csproj" />
     <ProjectReference Include="..\..\Source\Extensions\Blazorise.LoadingIndicator\Blazorise.LoadingIndicator.csproj" />
     <ProjectReference Include="..\..\Source\Extensions\Blazorise.TreeView\Blazorise.TreeView.csproj" />
@@ -40,6 +46,7 @@
     <PackageReference Include="Microsoft.Extensions.Http" Version="9.0.*" />
     <PackageReference Include="MimeKit" Version="4.8.0" />
     <PackageReference Include="Blazored.LocalStorage" Version="4.5.0" />
+    <ProjectReference Include="..\..\Source\SourceGenerators\Blazorise.Generator.Features\Blazorise.Generator.Features.csproj" />
   </ItemGroup>
 
   <!--Binary path for the code generator-->
@@ -50,8 +57,8 @@
   <!--Project path for code generator-->
   <PropertyGroup>
     <ProjectDocsCompiler>dotnet run --configuration release --project "..\..\Documentation/Blazorise.Docs.Compiler/Blazorise.Docs.Compiler.csproj"</ProjectDocsCompiler>
-  </PropertyGroup>
-
+  </PropertyGroup> 
+  
   <!--Execute the code generator-->
   <Target Name="CompileDocs" BeforeTargets="BeforeBuild">
     <!--Command-line for the code generator-->

Documentation/Blazorise.Docs/Components/ComponentApiDocs.razor

@@ -0,0 +1,48 @@
+@using Blazorise.Generator.Features.ApiDocsDtos
+<DocsPageSubtitle>
+    API
+</DocsPageSubtitle>
+
+@{
+    IReadOnlyList<ApiDocsForComponent> apiDocsForComponents = ComponentTypes.Select(x => ComponentsApiDocsSource.Instance.Components.GetValueOrDefault(x)).Where(x => x is not null).ToList();
+    var hasComponentTypes = ComponentTypes.Any();
+    var multipleComponentTypes = ComponentTypes.Count > 1;
+    var hasMethods = apiDocsForComponents.Any(x => x.Methods.Any());
+}
+
+@if (hasComponentTypes)
+{
+    <ComponentApiDocsProperty ApiDocsForComponents="apiDocsForComponents"
+                              MultipleComponentTypes="multipleComponentTypes"
+                              PropertyType="ComponentApiDocsProperty.PropertyTypes.Parameters"/>
+
+
+    <ComponentApiDocsProperty ApiDocsForComponents="apiDocsForComponents"
+                              MultipleComponentTypes="multipleComponentTypes"
+                              PropertyType="ComponentApiDocsProperty.PropertyTypes.Events"/>
+}
+
+@if (hasMethods)
+{
+    <Heading Margin="Margin.Is2.FromTop.Is3.FromBottom" Size="HeadingSize.Is3">
+        Methods
+    </Heading>
+
+    @foreach(var apiDocsForComponent in apiDocsForComponents.Where(x => x?.Methods?.Count > 0))
+    {
+        <DocsMethods Name="Method" Title="@(multipleComponentTypes ? apiDocsForComponent.TypeName : null)">
+            @foreach(ApiDocsForComponentMethod method in apiDocsForComponent.Methods)
+            {
+                <DocsMethodsItem Name="@method.Name" ReturnType="@method.ReturnTypeName"
+                                 Parameters="@(string.Join(", ", method.Parameters.Select(x => $"{x.TypeName} {x.Name}")))">
+                    @((MarkupString)method.Summary)
+                    <ComponentApiDocsRemarks Value="@method.Remarks"/>
+                </DocsMethodsItem>
+            }
+        </DocsMethods>
+    }
+}
+
+@code {
+    [Parameter, EditorRequired] public List<Type> ComponentTypes { get; set; } = [];
+}

Documentation/Blazorise.Docs/Components/ComponentApiDocsProperty.razor

@@ -0,0 +1,60 @@
+@using Blazorise.Generator.Features.ApiDocsDtos
+
+@if (filteredApiDocsForComponents.Any())
+{
+    <Heading Margin="Margin.Is2.FromTop.Is3.FromBottom" Size="HeadingSize.Is3">
+        @(PropertyType ==PropertyTypes.Events
+             ? "Events"
+            : "Parameters" )
+    </Heading>
+}
+
+@foreach(var apiDocsForComponent in filteredApiDocsForComponents)
+{
+    <DocsAttributes ShowDefaults="@(PropertyType != PropertyTypes.Events)"
+        Name="@(PropertyType == PropertyTypes.Events ? "Event": "Parameter")"
+        Title="@(MultipleComponentTypes ? apiDocsForComponent.TypeName : null)">
+        @foreach(var property in (PropertyType == PropertyTypes.Events? apiDocsForComponent.Events:apiDocsForComponent.Parameters).OrderBy(x => x.Name))
+        {
+            <DocsAttributesItem @key="@property.Name" Name="@property.Name" Type="@property.TypeName"
+                                Default="@property.DefaultValueString">
+                <Paragraph Margin="@(property.IsBlazoriseEnum ? null : Margin.Is0.FromBottom)">
+                    @((MarkupString)property.Summary)
+                </Paragraph>
+
+                @if (property.IsBlazoriseEnum)
+                {
+                    var enumNames = Enum.GetNames(property.Type);
+
+                    <Paragraph Margin="Margin.Is0.FromBottom">
+                        <Text>Possible values:</Text>
+                        @for (int i = 0; i < enumNames.Length; i++)
+                        {
+                            int i1 = i;
+
+                            <Code>@enumNames[i1]</Code>
+                            @(i < @enumNames.Length - 1 ? ", " : "")
+                        }
+                    </Paragraph>
+                }
+                <ComponentApiDocsRemarks Value="@property.Remarks"/>
+            </DocsAttributesItem>
+        }
+    </DocsAttributes>
+}
+
+@code {
+    [Parameter, EditorRequired] public IEnumerable<ApiDocsForComponent> ApiDocsForComponents { get; set; } = [];
+    [Parameter, EditorRequired] public bool MultipleComponentTypes { get; set; }
+    [Parameter, EditorRequired] public PropertyTypes PropertyType { get; set; }
+
+    IEnumerable<ApiDocsForComponent> filteredApiDocsForComponents = [];
+
+    protected override void OnInitialized()
+    {
+        filteredApiDocsForComponents = ApiDocsForComponents.Where(x => (PropertyType == PropertyTypes.Events? x.Events:x.Parameters).Count > 0);
+    }
+
+    public enum PropertyTypes { Parameters, Events }
+}
+

Documentation/Blazorise.Docs/Components/ComponentApiDocsRemarks.razor

@@ -0,0 +1,12 @@
+@if (!string.IsNullOrEmpty(Value))
+{
+    <details>
+        <summary style="list-style: none; display: inline; cursor: pointer;">
+            <Badge Color="Color.Info">Remarks</Badge>
+        </summary>
+        <Paragraph> @((MarkupString)Value)</Paragraph>
+    </details>
+}
+@code {
+    [Parameter] public string Value { get; set; } = "";
+}

Documentation/Blazorise.Docs/Components/DocsAttributes.razor

@@ -4,15 +4,15 @@
 
 @if ( Title != null )
 {
-    <Heading Class="b-docs-page-attributes-title" Size="HeadingSize.Is4">
+    <Heading Class="b-docs-page-attributes-title" Size="HeadingSize.Is4" Margin="Margin.Is3.FromBottom">
         @Title
     </Heading>
 }
 
 <Table Class="b-docs-attributes" Responsive Margin="Margin.Is4.FromBottom">
     <TableHeader ThemeContrast="@ThemeContrast">
         <TableRow>
-            <TableHeaderCell>Name</TableHeaderCell>
+            <TableHeaderCell>@Name</TableHeaderCell>
             <TableHeaderCell>Description</TableHeaderCell>
             <TableHeaderCell>Type</TableHeaderCell>
             @if ( ShowDefaults )

Documentation/Blazorise.Docs/Components/DocsAttributes.razor.cs

@@ -63,6 +63,8 @@ void OnThemeChanged( object sender, string theme )
 
     [Parameter] public RenderFragment ChildContent { get; set; }
 
+    [Parameter] public string Name { get; set; } = "Name";
+
     public List<DocsAttributesItem> DocsAttributesItems { get; set; } = new();
 
     #endregion

Documentation/Blazorise.Docs/Components/DocsMethods.razor

@@ -12,7 +12,7 @@
 <Table Class="b-docs-methods" Responsive Margin="Margin.Is4.FromBottom">
     <TableHeader ThemeContrast="@ThemeContrast">
         <TableRow>
-            <TableHeaderCell>Name</TableHeaderCell>
+            <TableHeaderCell>@Name</TableHeaderCell>
             <TableHeaderCell>Description</TableHeaderCell>
             @if ( ShowReturnType )
             {
@@ -46,7 +46,7 @@
                 @if ( ShowParameters )
                 {
                     <TableRowCell Class="@docsMethodsItem.DefaultClassNames">
-                        @if ( @docsMethodsItem.Parameters != null )
+                        @if ( !string.IsNullOrWhiteSpace( docsMethodsItem.Parameters ) )
                         {
                             <Code>@docsMethodsItem.Parameters</Code>
                         }

Documentation/Blazorise.Docs/Components/DocsMethods.razor.cs

@@ -64,6 +64,8 @@ void OnThemeChanged( object sender, string theme )
     [Parameter] public bool ShowParameters { get; set; } = true;
 
     [Parameter] public RenderFragment ChildContent { get; set; }
+
+    [Parameter] public string Name { get; set; } = "Name";
 
     public List<DocsMethodsItem> DocsMethodsItems { get; set; } = new();
 

Documentation/Blazorise.Docs/Pages/Docs/Components/Accordions/AccordionPage.razor

@@ -94,52 +94,4 @@
     </Alert>
 </Paragraph>
 
-<DocsPageSubtitle>
-    API
-</DocsPageSubtitle>
-
-<Heading Size="HeadingSize.Is3">
-    Attributes
-</Heading>
-
-<DocsAttributes Title="Accordion">
-    <DocsAttributesItem Name="ChildContent" Type="RenderFragment" Default="null">
-        Specifies the content to be rendered insidethe accordion.
-    </DocsAttributesItem>
-</DocsAttributes>
-
-<DocsAttributes Title="AccordionToggle">
-    <DocsAttributesItem Name="Clicked" Type="EventCallback<MouseEventArgs>" Default="null">
-        Occurs when the toggle button is clicked.
-    </DocsAttributesItem>
-    <DocsAttributesItem Name="ChildContent" Type="RenderFragment" Default="null">
-        Specifies the content to be rendered insidethe accordion toggle.
-    </DocsAttributesItem>
-</DocsAttributes>
-
-<DocsAttributes Title="AccordionItem">
-    <DocsAttributesItem Name="Visible" Type="bool" Default="false">
-        Defines the collapse state of the accordion item.
-    </DocsAttributesItem>
-    <DocsAttributesItem Name="VisibleChanged" Type="EventCallback<bool>">
-        Occurs when the accordion item visibility state changes.
-    </DocsAttributesItem>
-    <DocsAttributesItem Name="ChildContent" Type="RenderFragment" Default="null">
-        Specifies the content to be rendered inside the accordion item.
-    </DocsAttributesItem>
-</DocsAttributes>
-
-<DocsAttributes Title="AccordionHeader">
-    <DocsAttributesItem Name="Clicked" Type="EventCallback<MouseEventArgs>">
-        Occurs when the accordion header is clicked.
-    </DocsAttributesItem>
-    <DocsAttributesItem Name="ChildContent" Type="RenderFragment" Default="null">
-        Specifies the content to be rendered inside the accordion body.
-    </DocsAttributesItem>
-</DocsAttributes>
-
-<DocsAttributes Title="AccordionBody">
-    <DocsAttributesItem Name="ChildContent" Type="RenderFragment" Default="null">
-        Specifies the content to be rendered inside the accordion body.
-    </DocsAttributesItem>
-</DocsAttributes>
+<ComponentApiDocs ComponentTypes="[typeof(Accordion), typeof(AccordionToggle), typeof(AccordionItem), typeof(AccordionHeader), typeof(AccordionBody)]" />

Documentation/Blazorise.Docs/Pages/Docs/Components/Addons/AddonPage.razor

@@ -129,22 +129,4 @@
     <DocsPageSectionSource Code="AddonWithValidationExample" />
 </DocsPageSection>
 
-<DocsPageSubtitle>
-    API
-</DocsPageSubtitle>
-
-<Heading Size="HeadingSize.Is3">
-    Attributes
-</Heading>
-
-<DocsAttributes Title="Addons">
-    <DocsAttributesItem Name="Size" Type="Size" Default="Default">
-        Addons size variations.
-    </DocsAttributesItem>
-</DocsAttributes>
-
-<DocsAttributes Title="Addon">
-    <DocsAttributesItem Name="AddonType" Type="AddonType" Default="Body">
-        Defines the location and behavior of addon container.
-    </DocsAttributesItem>
-</DocsAttributes>
+<ComponentApiDocs ComponentTypes="[typeof(Addons), typeof(Addon)]" />

Documentation/Blazorise.Docs/Pages/Docs/Components/Alerts/AlertPage.razor

@@ -112,41 +112,4 @@
     <DocsPageSectionSource Code="AlertUseProgrammaticallyExample" />
 </DocsPageSection>
 
-<DocsPageSubtitle>
-    API
-</DocsPageSubtitle>
-
-<Heading Size="HeadingSize.Is3">
-    Methods
-</Heading>
-
-<DocsMethods>
-    <DocsMethodsItem Name="Show()" ReturnType="Task">
-        Makes the alert visible.
-    </DocsMethodsItem>
-    <DocsMethodsItem Name="Hide()" ReturnType="Task">
-        Hides the alert.
-    </DocsMethodsItem>
-    <DocsMethodsItem Name="Toggle()" ReturnType="Task">
-        Switches the alert visibility.
-    </DocsMethodsItem>
-</DocsMethods>
-
-<Heading Size="HeadingSize.Is3">
-    Attributes
-</Heading>
-
-<DocsAttributes>
-    <DocsAttributesItem Name="Dismisable" Type="bool" Default="false">
-        Enables the alert to be closed by placing the padding for close button.
-    </DocsAttributesItem>
-    <DocsAttributesItem Name="Visible" Type="bool" Default="false">
-        Defines the alert visibility.
-    </DocsAttributesItem>
-    <DocsAttributesItem Name="VisibleChanged" Type="EventCallback<bool>">
-        Occurs when the alert visibility changes.
-    </DocsAttributesItem>
-    <DocsAttributesItem Name="Color" Type="Color" Default="Default">
-        Component visual or contextual style variants.
-    </DocsAttributesItem>
-</DocsAttributes>
+<ComponentApiDocs ComponentTypes="[typeof(Alert)]" />