Small update to comments and property names

Author: bparks13

OpenEphys.Onix1.Design/ChannelConfigurationDialog.cs

@@ -18,9 +18,6 @@ public abstract partial class ChannelConfigurationDialog : Form
     {
         internal event EventHandler OnResizeZedGraph;
 
-        /// <summary>
-        /// Local variable that holds the channel configuration in memory until the user presses Okay
-        /// </summary>
         internal ProbeGroup ChannelConfiguration;
 
         internal readonly List<int> ReferenceContacts = new();

OpenEphys.Onix1.Design/ContactTag.cs

@@ -18,7 +18,7 @@ public class ContactTag
         /// <summary>
         /// Gets the contact index of this contact.
         /// </summary>
-        public int ContactIndex;
+        public int ContactIndex { get; }
 
         /// <summary>
         /// Gets the string defining the probe and contact index for this contact.

OpenEphys.Onix1.Design/NeuropixelsV2eBno055Dialog.cs

@@ -21,7 +21,7 @@ public ConfigureNeuropixelsV2eBno055 ConfigureNode
         /// Initializes a new instance of <see cref="NeuropixelsV2eBno055Dialog"/> with the given
         /// <see cref="ConfigureNeuropixelsV2eBno055"/> object.
         /// </summary>
-        /// <param name="configureNode">A <see cref="ConfigureNeuropixelsV2eBno055"/> object that contains configuration settings</param>
+        /// <param name="configureNode">A <see cref="ConfigureNeuropixelsV2eBno055"/> object that contains configuration settings.</param>
         public NeuropixelsV2eBno055Dialog(ConfigureNeuropixelsV2eBno055 configureNode)
         {
             InitializeComponent();

OpenEphys.Onix1.Design/NeuropixelsV2eChannelConfigurationDialog.cs

@@ -9,7 +9,7 @@
 namespace OpenEphys.Onix1.Design
 {
     /// <summary>
-    /// Partial class to create a GUI for <see cref="ConfigureNeuropixelsV2e"/>.
+    /// Partial class to create a channel configuration GUI for <see cref="ConfigureNeuropixelsV2e"/>.
     /// </summary>
     public partial class NeuropixelsV2eChannelConfigurationDialog : ChannelConfigurationDialog
     {
@@ -20,11 +20,6 @@ public partial class NeuropixelsV2eChannelConfigurationDialog : ChannelConfigura
         /// Public <see cref="NeuropixelsV2QuadShankProbeConfiguration"/> object that is manipulated by
         /// <see cref="NeuropixelsV2eChannelConfigurationDialog"/>.
         /// </summary>
-        /// <remarks>
-        /// When a <see cref="NeuropixelsV2QuadShankProbeConfiguration"/> is passed to 
-        /// <see cref="NeuropixelsV2eChannelConfigurationDialog"/>, it is copied and stored in this
-        /// variable so that any modifications made to configuration settings can be easily reversed.
-        /// </remarks>
         public NeuropixelsV2QuadShankProbeConfiguration ProbeConfiguration;
 
         /// <summary>

OpenEphys.Onix1.Design/NeuropixelsV2eDialog.cs

@@ -17,11 +17,6 @@ public partial class NeuropixelsV2eDialog : Form
         /// Public <see cref="ConfigureNeuropixelsV2e"/> object that is manipulated by
         /// <see cref="NeuropixelsV2eDialog"/>.
         /// </summary>
-        /// <remarks>
-        /// When a <see cref="ConfigureNeuropixelsV2e"/> is passed to 
-        /// <see cref="NeuropixelsV2eDialog"/>, it is copied and stored in this
-        /// variable so that any modifications made to configuration settings can be easily reversed.
-        /// </remarks>
         public ConfigureNeuropixelsV2e ConfigureNode { get; set; }
 
         /// <summary>

OpenEphys.Onix1.Design/NeuropixelsV2eHeadstageDialog.cs

@@ -15,7 +15,7 @@ public partial class NeuropixelsV2eHeadstageDialog : Form
         /// <summary>
         /// A <see cref="NeuropixelsV2eBno055Dialog"/> that configures a <see cref="ConfigureNeuropixelsV2eBno055"/>.
         /// </summary>
-        public readonly NeuropixelsV2eBno055Dialog ConfigureBno055;
+        public readonly NeuropixelsV2eBno055Dialog DialogBno055;
 
         /// <summary>
         /// Initializes a new instance of a <see cref="NeuropixelsV2eHeadstageDialog"/>.
@@ -38,17 +38,17 @@ public NeuropixelsV2eHeadstageDialog(ConfigureNeuropixelsV2e configureNeuropixel
             this.AddMenuItemsFromDialogToFileOption(DialogNeuropixelsV2e, "NeuropixelsV2e");
             DialogNeuropixelsV2e.Show();
 
-            ConfigureBno055 = new(configureBno055)
+            DialogBno055 = new(configureBno055)
             {
                 TopLevel = false,
                 FormBorderStyle = FormBorderStyle.None,
                 Dock = DockStyle.Fill,
                 Parent = this
             };
 
-            panelBno055.Controls.Add(ConfigureBno055);
-            ConfigureBno055.Show();
-            ConfigureBno055.Invalidate();
+            panelBno055.Controls.Add(DialogBno055);
+            DialogBno055.Show();
+            DialogBno055.Invalidate();
         }
 
         private void ButtonClick(object sender, System.EventArgs e)

OpenEphys.Onix1.Design/NeuropixelsV2eHeadstageEditor.cs

@@ -22,7 +22,7 @@ public override bool EditComponent(ITypeDescriptorContext context, object compon
 
                     if (editorDialog.ShowDialog() == DialogResult.OK)
                     {
-                        configureHeadstage.Bno055.Enable = editorDialog.ConfigureBno055.ConfigureNode.Enable;
+                        configureHeadstage.Bno055.Enable = editorDialog.DialogBno055.ConfigureNode.Enable;
 
                         configureHeadstage.NeuropixelsV2e.Enable = editorDialog.DialogNeuropixelsV2e.ConfigureNode.Enable;
                         configureHeadstage.NeuropixelsV2e.ProbeConfigurationA = editorDialog.DialogNeuropixelsV2e.ConfigureNode.ProbeConfigurationA;

OpenEphys.Onix1.Design/NeuropixelsV2eProbeConfigurationDialog.cs

@@ -51,18 +51,13 @@ private enum ChannelPreset
         /// Public <see cref="NeuropixelsV2QuadShankProbeConfiguration"/> object that is manipulated by
         /// <see cref="NeuropixelsV2eProbeConfigurationDialog"/>.
         /// </summary>
-        /// <remarks>
-        /// When a <see cref="NeuropixelsV2QuadShankProbeConfiguration"/> is passed to 
-        /// <see cref="NeuropixelsV2eProbeConfigurationDialog"/>, it is copied and stored in this
-        /// variable so that any modifications made to configuration settings can be easily reversed.
-        /// </remarks>
         public NeuropixelsV2QuadShankProbeConfiguration ProbeConfiguration { get; set; }
 
         /// <summary>
         /// Initializes a new instance of <see cref="NeuropixelsV2eProbeConfigurationDialog"/>.
         /// </summary>
         /// <param name="configuration">A <see cref="NeuropixelsV2QuadShankProbeConfiguration"/> object holding the current configuration settings.</param>
-        /// <param name="calibrationFile">String containing the path to the gain calibration file for this probe.</param>
+        /// <param name="calibrationFile">String containing the path to the calibration file for this probe.</param>
         public NeuropixelsV2eProbeConfigurationDialog(NeuropixelsV2QuadShankProbeConfiguration configuration, string calibrationFile)
         {
             InitializeComponent();