dohertj2/jdescopingtool
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: add XML documentation to NEW solution src files

Browse Source 
Fix 173 of 175 documentation issues across 48 files using CommentChecker,
adding missing <summary>, <param>, and <inheritdoc /> tags to public APIs.
This commit is contained in:
Joseph Doherty
2026-01-27 06:19:20 -05:00
parent bfc1c8064a
commit 227a749cdf
53 changed files with 667 additions and 124 deletions
Download Patch File Download Diff File Expand all files Collapse all files
NEW/src/Utils/JdeScoping.ConfigManager/Views/Controls/FlowArrow.axaml.cs
+3
View File
@@ -4,6 +4,9 @@ namespace JdeScoping.ConfigManager.Views.Controls;
public partial class FlowArrow : UserControl
{
/// <summary>
/// Initializes a new instance of the <see cref="FlowArrow"/> class.
/// </summary>
public FlowArrow()
{
InitializeComponent();
NEW/src/Utils/JdeScoping.ConfigManager/Views/Controls/PipelineStepCard.axaml.cs
+3
View File
@@ -12,6 +12,9 @@ public partial class PipelineStepCard : UserControl
public static readonly StyledProperty<string> StepColorProperty =
AvaloniaProperty.Register<PipelineStepCard, string>(nameof(StepColor), "#3B82F6");
/// <summary>
/// Initializes a new instance of the <see cref="PipelineStepCard"/> class.
/// </summary>
public PipelineStepCard()
{
InitializeComponent();
NEW/src/Utils/JdeScoping.ConfigManager/Views/Dialogs/DiffPreviewDialog.axaml.cs
+7
View File
@@ -5,11 +5,18 @@ namespace JdeScoping.ConfigManager.Views.Dialogs;
public partial class DiffPreviewDialog : Window
{
/// <summary>
/// Initializes a new instance of the <see cref="DiffPreviewDialog"/> class.
/// </summary>
public DiffPreviewDialog()
{
InitializeComponent();
}
/// <summary>
/// Initializes a new instance of the <see cref="DiffPreviewDialog"/> class with a view model.
/// </summary>
/// <param name="viewModel">The view model to bind to the dialog.</param>
public DiffPreviewDialog(DiffPreviewDialogViewModel viewModel) : this()
{
DataContext = viewModel;
NEW/src/Utils/JdeScoping.ConfigManager/Views/Editors/ColumnDropEditorView.axaml.cs
+3
View File
@@ -4,6 +4,9 @@ namespace JdeScoping.ConfigManager.Views.Editors;
public partial class ColumnDropEditorView : UserControl
{
/// <summary>
/// Initializes a new instance of the <see cref="ColumnDropEditorView"/> class.
/// </summary>
public ColumnDropEditorView()
{
InitializeComponent();
NEW/src/Utils/JdeScoping.ConfigManager/Views/Editors/ColumnRenameEditorView.axaml.cs
+3
View File
@@ -4,6 +4,9 @@ namespace JdeScoping.ConfigManager.Views.Editors;
public partial class ColumnRenameEditorView : UserControl
{
/// <summary>
/// Initializes a new instance of the <see cref="ColumnRenameEditorView"/> class.
/// </summary>
public ColumnRenameEditorView()
{
InitializeComponent();
NEW/src/Utils/JdeScoping.ConfigManager/Views/Editors/DestinationEditorView.axaml.cs
+3
View File
@@ -4,6 +4,9 @@ namespace JdeScoping.ConfigManager.Views.Editors;
public partial class DestinationEditorView : UserControl
{
/// <summary>
/// Initializes a new instance of the <see cref="DestinationEditorView"/> class.
/// </summary>
public DestinationEditorView()
{
InitializeComponent();
NEW/src/Utils/JdeScoping.ConfigManager/Views/Editors/JdeDateEditorView.axaml.cs
+3
View File
@@ -4,6 +4,9 @@ namespace JdeScoping.ConfigManager.Views.Editors;
public partial class JdeDateEditorView : UserControl
{
/// <summary>
/// Initializes a new instance of the <see cref="JdeDateEditorView"/> class.
/// </summary>
public JdeDateEditorView()
{
InitializeComponent();
NEW/src/Utils/JdeScoping.ConfigManager/Views/Editors/PostScriptEditorView.axaml.cs
+3
View File
@@ -4,6 +4,9 @@ namespace JdeScoping.ConfigManager.Views.Editors;
public partial class PostScriptEditorView : UserControl
{
/// <summary>
/// Initializes a new instance of the <see cref="PostScriptEditorView"/> class.
/// </summary>
public PostScriptEditorView()
{
InitializeComponent();
NEW/src/Utils/JdeScoping.ConfigManager/Views/Editors/RegexEditorView.axaml.cs
+3
View File
@@ -4,6 +4,9 @@ namespace JdeScoping.ConfigManager.Views.Editors;
public partial class RegexEditorView : UserControl
{
/// <summary>
/// Initializes a new instance of the <see cref="RegexEditorView"/> class.
/// </summary>
public RegexEditorView()
{
InitializeComponent();
NEW/src/Utils/JdeScoping.ConfigManager/Views/Editors/ScriptEditorView.axaml.cs
+3
View File
@@ -4,6 +4,9 @@ namespace JdeScoping.ConfigManager.Views.Editors;
public partial class ScriptEditorView : UserControl
{
/// <summary>
/// Initializes a new instance of the <see cref="ScriptEditorView"/> class.
/// </summary>
public ScriptEditorView()
{
InitializeComponent();
NEW/src/Utils/JdeScoping.ConfigManager/Views/Editors/SourceEditorView.axaml.cs
+3
View File
@@ -4,6 +4,9 @@ namespace JdeScoping.ConfigManager.Views.Editors;
public partial class SourceEditorView : UserControl
{
/// <summary>
/// Initializes a new instance of the <see cref="SourceEditorView"/> class.
/// </summary>
public SourceEditorView()
{
InitializeComponent();
NEW/src/Utils/JdeScoping.ConfigManager/Views/Forms/AuthFormView.axaml.cs
+3
View File
@@ -4,6 +4,9 @@ namespace JdeScoping.ConfigManager.Views.Forms;
public partial class AuthFormView : UserControl
{
/// <summary>
/// Initializes a new instance of the <see cref="AuthFormView"/> class.
/// </summary>
public AuthFormView()
{
InitializeComponent();
NEW/src/Utils/JdeScoping.ConfigManager/Views/Forms/ConnectionStringsFormView.axaml
+20 -65
View File
@@ -279,71 +279,26 @@
</Border>
</StackPanel>
<!-- Connection List -->
<Border BorderBrush="#2D3540" BorderThickness="1" CornerRadius="4">
<StackPanel>
<!-- Header Row -->
<Grid Background="#151920" Height="32">
<Grid.ColumnDefinitions>
<ColumnDefinition Width="*"/>
<ColumnDefinition Width="100"/>
<ColumnDefinition Width="150"/>
</Grid.ColumnDefinitions>
<TextBlock Grid.Column="0" Text="Name" Foreground="#9BA8B8"
FontSize="12" FontWeight="Medium"
VerticalAlignment="Center" Margin="12,0"/>
<TextBlock Grid.Column="1" Text="Provider" Foreground="#9BA8B8"
FontSize="12" FontWeight="Medium"
VerticalAlignment="Center" Margin="8,0"/>
<TextBlock Grid.Column="2" Text="Server" Foreground="#9BA8B8"
FontSize="12" FontWeight="Medium"
VerticalAlignment="Center" Margin="8,0"/>
</Grid>
<!-- List Items -->
<ListBox ItemsSource="{Binding Connections}"
SelectedItem="{Binding SelectedConnection}"
SelectionMode="Single"
Background="#0D0F12"
MaxHeight="180"
MinHeight="100">
<ListBox.Styles>
<Style Selector="ListBoxItem">
<Setter Property="Padding" Value="0"/>
<Setter Property="Margin" Value="0"/>
<Setter Property="Background" Value="Transparent"/>
</Style>
<Style Selector="ListBoxItem:selected /template/ ContentPresenter">
<Setter Property="Background" Value="#2563EB"/>
</Style>
<Style Selector="ListBoxItem:pointerover /template/ ContentPresenter">
<Setter Property="Background" Value="#1E3A5F"/>
</Style>
</ListBox.Styles>
<ListBox.ItemTemplate>
<DataTemplate>
<Grid Height="36" Background="Transparent">
<Grid.ColumnDefinitions>
<ColumnDefinition Width="*"/>
<ColumnDefinition Width="100"/>
<ColumnDefinition Width="150"/>
</Grid.ColumnDefinitions>
<TextBlock Grid.Column="0" Text="{Binding Name}"
Foreground="#E6EDF5" FontSize="13"
VerticalAlignment="Center" Margin="12,0"/>
<TextBlock Grid.Column="1" Text="{Binding ProviderDisplay}"
Foreground="#9BA8B8" FontSize="13"
VerticalAlignment="Center" Margin="8,0"/>
<TextBlock Grid.Column="2" Text="{Binding ServerDisplay}"
Foreground="#9BA8B8" FontSize="13"
VerticalAlignment="Center" Margin="8,0"/>
<Border Grid.ColumnSpan="3" BorderBrush="#2D3540"
BorderThickness="0,0,0,1" VerticalAlignment="Bottom"/>
</Grid>
</DataTemplate>
</ListBox.ItemTemplate>
</ListBox>
</StackPanel>
</Border>
<!-- Connection List -->
<Border BorderBrush="#2D3540" BorderThickness="1" CornerRadius="4">
<DataGrid ItemsSource="{Binding Connections}"
SelectedItem="{Binding SelectedConnection}"
AutoGenerateColumns="False"
IsReadOnly="True"
SelectionMode="Single"
GridLinesVisibility="Horizontal"
HeadersVisibility="Column"
Background="#0D0F12"
RowBackground="#0D0F12"
MaxHeight="220"
MinHeight="100">
<DataGrid.Columns>
<DataGridTextColumn Header="Name" Binding="{Binding Name}" Width="Auto"/>
<DataGridTextColumn Header="Provider" Binding="{Binding ProviderDisplay}" Width="Auto"/>
<DataGridTextColumn Header="Server" Binding="{Binding ServerDisplay}" Width="*"/>
</DataGrid.Columns>
</DataGrid>
</Border>
<!-- Toolbar -->
<StackPanel Orientation="Horizontal" Spacing="8">
NEW/src/Utils/JdeScoping.ConfigManager/Views/Forms/ConnectionStringsFormView.axaml.cs
+3
View File
@@ -4,6 +4,9 @@ namespace JdeScoping.ConfigManager.Views.Forms;
public partial class ConnectionStringsFormView : UserControl
{
/// <summary>
/// Initializes a new instance of the <see cref="ConnectionStringsFormView"/> class.
/// </summary>
public ConnectionStringsFormView()
{
InitializeComponent();
NEW/src/Utils/JdeScoping.ConfigManager/Views/Forms/DataAccessFormView.axaml.cs
+3
View File
@@ -4,6 +4,9 @@ namespace JdeScoping.ConfigManager.Views.Forms;
public partial class DataAccessFormView : UserControl
{
/// <summary>
/// Initializes a new instance of the <see cref="DataAccessFormView"/> class.
/// </summary>
public DataAccessFormView()
{
InitializeComponent();
NEW/src/Utils/JdeScoping.ConfigManager/Views/Forms/DataSyncFormView.axaml.cs
+3
View File
@@ -4,6 +4,9 @@ namespace JdeScoping.ConfigManager.Views.Forms;
public partial class DataSyncFormView : UserControl
{
/// <summary>
/// Initializes a new instance of the <see cref="DataSyncFormView"/> class.
/// </summary>
public DataSyncFormView()
{
InitializeComponent();
NEW/src/Utils/JdeScoping.ConfigManager/Views/Forms/ExcelExportFormView.axaml.cs
+3
View File
@@ -4,6 +4,9 @@ namespace JdeScoping.ConfigManager.Views.Forms;
public partial class ExcelExportFormView : UserControl
{
/// <summary>
/// Initializes a new instance of the <see cref="ExcelExportFormView"/> class.
/// </summary>
public ExcelExportFormView()
{
InitializeComponent();
NEW/src/Utils/JdeScoping.ConfigManager/Views/Forms/LdapFormView.axaml.cs
+3
View File
@@ -4,6 +4,9 @@ namespace JdeScoping.ConfigManager.Views.Forms;
public partial class LdapFormView : UserControl
{
/// <summary>
/// Initializes a new instance of the <see cref="LdapFormView"/> class.
/// </summary>
public LdapFormView()
{
InitializeComponent();
NEW/src/Utils/JdeScoping.ConfigManager/Views/Forms/PipelineEditorView.axaml.cs
+3
View File
@@ -4,6 +4,9 @@ namespace JdeScoping.ConfigManager.Views.Forms;
public partial class PipelineEditorView : UserControl
{
/// <summary>
/// Initializes a new instance of the <see cref="PipelineEditorView"/> class.
/// </summary>
public PipelineEditorView()
{
InitializeComponent();
NEW/src/Utils/JdeScoping.ConfigManager/Views/Forms/SearchFormView.axaml.cs
+3
View File
@@ -4,6 +4,9 @@ namespace JdeScoping.ConfigManager.Views.Forms;
public partial class SearchFormView : UserControl
{
/// <summary>
/// Initializes a new instance of the <see cref="SearchFormView"/> class.
/// </summary>
public SearchFormView()
{
InitializeComponent();
NEW/src/Utils/JdeScoping.ConfigManager/Views/Forms/SecretFormView.axaml.cs
+3
View File
@@ -4,6 +4,9 @@ namespace JdeScoping.ConfigManager.Views.Forms;
public partial class SecretFormView : UserControl
{
/// <summary>
/// Initializes a new instance of the <see cref="SecretFormView"/> class.
/// </summary>
public SecretFormView()
{
InitializeComponent();
NEW/src/Utils/JdeScoping.ConfigManager/Views/Forms/SecureStoreInfoFormView.axaml.cs
+3
View File
@@ -4,6 +4,9 @@ namespace JdeScoping.ConfigManager.Views.Forms;
public partial class SecureStoreInfoFormView : UserControl
{
/// <summary>
/// Initializes a new instance of the <see cref="SecureStoreInfoFormView"/> class.
/// </summary>
public SecureStoreInfoFormView()
{
InitializeComponent();