[dev-v5] Refactoring the generator of API documentation

[dvoituron]

[dev-v5] Refactoring the generator of API documentation

The current project FluentUI.Demo.Generators.csproj is an Analyzer project which had to be compiled to netstandard2.0.

The documentation file generated by Visual Studio is an XML file containing some tags like <inheritdoc /> to automatically read the comment from the parent element. To manage these flows, we need to use a library LoxSmoke.DocXml and to load the Microsoft.FluentUI.AspNetCore.Components library developed with .NET9. These different .NET versions are not compatible.

So, we created a new project FluentUI.Demo.DocApiGen to generate a JSON file api-comments.json that is read read by the Demo app to populate the API tables.
This DocApiGen is a console app that is already configured for the developer using the launchSettings.json file

Usage: DocApiGen --xml <xml_file>
                 --dll <dll_file>
                 --output <generated_file>
                 --format <csharp|json>

Developer usage

Without actions, the demo application will launch without errors, but the API tables will be empty (only the Description column).

To populate this column, the developer must run the DocApiGen project (right click -> Debug -> Start without debugging) and the JSON file will be saved in the FluentUI.Demo.Client/wwwroot folder.

Build pipeline and publication

This command must be included in the YML file to generate the JSON file in the wwwroot folder.

[vnbaaij]

👏

[github-actions]

✅ All tests passed successfully

Details on your Workflow / Core Tests page.

[github-actions]

Summary - Unit Tests Code Coverage

Summary

Generated on:	02/09/2025 - 12:49:40
Coverage date:	02/09/2025 - 12:49:29
Parser:	Cobertura
Assemblies:	1
Classes:	67
Files:	77
Line coverage:	99.1% (1454 of 1467)
Covered lines:	1454
Uncovered lines:	13
Coverable lines:	1467
Total lines:	6258
Branch coverage:	92% (896 of 973)
Covered branches:	896
Total branches:	973
Method coverage:	Feature is only available for sponsors
Tag:	2581_13225812521

Coverage

Microsoft.FluentUI.AspNetCore.Components - 99.1%

Name	Line	Branch
Microsoft.FluentUI.AspNetCore.Components	99.1%	92%
Microsoft.FluentUI.AspNetCore.Components.DefaultStyles	100%
Microsoft.FluentUI.AspNetCore.Components.Dialog.MessageBox.FluentMessageBox	100%	100%
Microsoft.FluentUI.AspNetCore.Components.DialogEventArgs	100%	92.8%
Microsoft.FluentUI.AspNetCore.Components.DialogInstance	100%	100%
Microsoft.FluentUI.AspNetCore.Components.DialogOptions	100%
Microsoft.FluentUI.AspNetCore.Components.DialogOptionsFooter	100%	100%
Microsoft.FluentUI.AspNetCore.Components.DialogOptionsFooterAction	100%	100%
Microsoft.FluentUI.AspNetCore.Components.DialogOptionsHeader	100%
Microsoft.FluentUI.AspNetCore.Components.DialogResult	100%	100%
Microsoft.FluentUI.AspNetCore.Components.DialogResult`1	100%
Microsoft.FluentUI.AspNetCore.Components.DialogService	98.9%	81.4%
Microsoft.FluentUI.AspNetCore.Components.DialogToggleEventArgs	100%
Microsoft.FluentUI.AspNetCore.Components.Extensions.EnumExtensions	100%	100%
Microsoft.FluentUI.AspNetCore.Components.Extensions.FluentInputExtensions	100%	100%
Microsoft.FluentUI.AspNetCore.Components.FluentButton	100%	89.5%
Microsoft.FluentUI.AspNetCore.Components.FluentComponentBase	100%	100%
Microsoft.FluentUI.AspNetCore.Components.FluentDialog	97.4%	89.7%
Microsoft.FluentUI.AspNetCore.Components.FluentDialogBody	100%	91.6%
Microsoft.FluentUI.AspNetCore.Components.FluentDialogInstance	100%	100%
Microsoft.FluentUI.AspNetCore.Components.FluentDialogProvider	100%	79.1%
Microsoft.FluentUI.AspNetCore.Components.FluentField	100%	96.4%
Microsoft.FluentUI.AspNetCore.Components.FluentFieldCondition	100%	100%
Microsoft.FluentUI.AspNetCore.Components.FluentFieldConditionItem	100%
Microsoft.FluentUI.AspNetCore.Components.FluentFieldConditionOptions	100%
Microsoft.FluentUI.AspNetCore.Components.FluentFieldExtensions	100%
Microsoft.FluentUI.AspNetCore.Components.FluentFieldParameterSelector	100%	98.7%
Microsoft.FluentUI.AspNetCore.Components.FluentGrid	100%	90%
Microsoft.FluentUI.AspNetCore.Components.FluentGridItem	100%	100%
Microsoft.FluentUI.AspNetCore.Components.FluentIcon`1	100%	95.8%
Microsoft.FluentUI.AspNetCore.Components.FluentInputBase`1	93.3%	25%
Microsoft.FluentUI.AspNetCore.Components.FluentInputImmediateBase`1	100%	100%
Microsoft.FluentUI.AspNetCore.Components.FluentJSModule	100%	100%
Microsoft.FluentUI.AspNetCore.Components.FluentLabel	100%
Microsoft.FluentUI.AspNetCore.Components.FluentLayout	100%	71.4%
Microsoft.FluentUI.AspNetCore.Components.FluentLayoutHamburger	100%	100%
Microsoft.FluentUI.AspNetCore.Components.FluentLayoutItem	100%	89.2%
Microsoft.FluentUI.AspNetCore.Components.FluentListBase`1	93.7%	94.7%
Microsoft.FluentUI.AspNetCore.Components.FluentLocalizerExtensions	100%
Microsoft.FluentUI.AspNetCore.Components.FluentLocalizerInternal	100%
Microsoft.FluentUI.AspNetCore.Components.FluentOption	91.6%	100%
Microsoft.FluentUI.AspNetCore.Components.FluentSelect`1	100%
Microsoft.FluentUI.AspNetCore.Components.FluentServiceBase`1	100%
Microsoft.FluentUI.AspNetCore.Components.FluentServiceProviderException`1	100%
Microsoft.FluentUI.AspNetCore.Components.FluentStack	100%	100%
Microsoft.FluentUI.AspNetCore.Components.FluentStatus	100%
Microsoft.FluentUI.AspNetCore.Components.FluentText	100%	100%
Microsoft.FluentUI.AspNetCore.Components.FluentTextInput	100%	78.5%
Microsoft.FluentUI.AspNetCore.Components.Icon	100%	91.1%
Microsoft.FluentUI.AspNetCore.Components.IconFromImage	100%
Microsoft.FluentUI.AspNetCore.Components.IconInfo	100%
Microsoft.FluentUI.AspNetCore.Components.IFluentLocalizer	100%	100%
Microsoft.FluentUI.AspNetCore.Components.InternalListContext`1	60%
Microsoft.FluentUI.AspNetCore.Components.Localization.LanguageResource	100%	100%
Microsoft.FluentUI.AspNetCore.Components.MessageBoxOptions	100%
Microsoft.FluentUI.AspNetCore.Components.Migration.AppearanceExtensions	100%	100%
Microsoft.FluentUI.AspNetCore.Components.Migration.FluentInputAppearanceExt ensions	100%	100%
Microsoft.FluentUI.AspNetCore.Components.ServiceProviderExtensions	100%
Microsoft.FluentUI.AspNetCore.Components.SpacingExtensions	100%	97.2%
Microsoft.FluentUI.AspNetCore.Components.Utilities.AddTag	100%	100%
Microsoft.FluentUI.AspNetCore.Components.Utilities.CssBuilder	100%	100%
Microsoft.FluentUI.AspNetCore.Components.Utilities.Debounce	100%	83.3%
Microsoft.FluentUI.AspNetCore.Components.Utilities.Identifier	100%	100%
Microsoft.FluentUI.AspNetCore.Components.Utilities.IdentifierContext	100%	75%
Microsoft.FluentUI.AspNetCore.Components.Utilities.InlineStyleBuilder	100%	92.8%
Microsoft.FluentUI.AspNetCore.Components.Utilities.InternalDebounce.Dispatc herTimerExtensions	95.7%	75%
Microsoft.FluentUI.AspNetCore.Components.Utilities.StyleBuilder	100%	100%
Microsoft.FluentUI.AspNetCore.Components.ZIndex	100%