From a83c7708a6fc1fd1ec3959fec11758dddd816efe Mon Sep 17 00:00:00 2001
From: bparks13 <bap@open-ephys.org>
Date: Wed, 14 Aug 2024 15:52:55 -0400
Subject: [PATCH] Added missing parameter comments

---
 OpenEphys.ProbeInterface.NET/Contact.cs       | 24 ++++++++--------
 .../ContactAnnotations.cs                     |  2 +-
 .../ContactShapeParam.cs                      |  2 +-
 OpenEphys.ProbeInterface.NET/Probe.cs         | 28 +++++++++----------
 .../ProbeAnnotations.cs                       |  6 ++--
 5 files changed, 31 insertions(+), 31 deletions(-)

diff --git a/OpenEphys.ProbeInterface.NET/Contact.cs b/OpenEphys.ProbeInterface.NET/Contact.cs
index 6e3af5c..b25f9bc 100644
--- a/OpenEphys.ProbeInterface.NET/Contact.cs
+++ b/OpenEphys.ProbeInterface.NET/Contact.cs
@@ -48,24 +48,24 @@ public readonly struct Contact
         /// <summary>
         /// Initializes a new instance of the <see cref="Contact"/> struct.
         /// </summary>
-        /// <param name="posX"></param>
-        /// <param name="posY"></param>
-        /// <param name="shape"></param>
-        /// <param name="shapeParam"></param>
-        /// <param name="device_id"></param>
-        /// <param name="contact_id"></param>
-        /// <param name="shank_id"></param>
-        /// <param name="index"></param>
+        /// <param name="posX">Center value of the contact on the X-axis.</param>
+        /// <param name="posY">Center value of the contact on the Y-axis.</param>
+        /// <param name="shape">The <see cref="ContactShape"/> of the contact.</param>
+        /// <param name="shapeParam"><see cref="ContactShapeParam"/>'s relevant to the <see cref="ContactShape"/> of the contact.</param>
+        /// <param name="deviceId">The device channel index (<see cref="Probe.DeviceChannelIndices"/>) of this contact.</param>
+        /// <param name="contactId">The contact ID (<see cref="Probe.ContactIds"/>) of this contact.</param>
+        /// <param name="shankId">The shank ID (<see cref="Probe.ShankIds"/>) of this contact.</param>
+        /// <param name="index">The index of the contact within the context of the <see cref="Probe"/>.</param>
         public Contact(float posX, float posY, ContactShape shape, ContactShapeParam shapeParam,
-            int device_id, string contact_id, string shank_id, int index)
+            int deviceId, string contactId, string shankId, int index)
         {
             PosX = posX;
             PosY = posY;
             Shape = shape;
             ShapeParams = shapeParam;
-            DeviceId = device_id;
-            ContactId = contact_id;
-            ShankId = shank_id;
+            DeviceId = deviceId;
+            ContactId = contactId;
+            ShankId = shankId;
             Index = index;
         }
     }
diff --git a/OpenEphys.ProbeInterface.NET/ContactAnnotations.cs b/OpenEphys.ProbeInterface.NET/ContactAnnotations.cs
index 8e46223..73b241e 100644
--- a/OpenEphys.ProbeInterface.NET/ContactAnnotations.cs
+++ b/OpenEphys.ProbeInterface.NET/ContactAnnotations.cs
@@ -15,7 +15,7 @@ public class ContactAnnotations
         /// <summary>
         /// Initializes a new instance of the <see cref="ContactAnnotations"/> class.
         /// </summary>
-        /// <param name="contactAnnotations"></param>
+        /// <param name="contactAnnotations">Array of strings containing annotations for each contact. Size of the array should match the number of contacts, but they can be empty strings.</param>
         [JsonConstructor]
         public ContactAnnotations(string[] contactAnnotations)
         {
diff --git a/OpenEphys.ProbeInterface.NET/ContactShapeParam.cs b/OpenEphys.ProbeInterface.NET/ContactShapeParam.cs
index 51cab51..943046b 100644
--- a/OpenEphys.ProbeInterface.NET/ContactShapeParam.cs
+++ b/OpenEphys.ProbeInterface.NET/ContactShapeParam.cs
@@ -52,7 +52,7 @@ public ContactShapeParam(float? radius = null, float? width = null, float? heigh
         /// <summary>
         /// Copy constructor given an existing <see cref="ContactShapeParam"/> object.
         /// </summary>
-        /// <param name="shape"></param>
+        /// <param name="shape">Existing <see cref="ContactShapeParam"/> object to be copied.</param>
         protected ContactShapeParam(ContactShapeParam shape)
         {
             Radius = shape.Radius;
diff --git a/OpenEphys.ProbeInterface.NET/Probe.cs b/OpenEphys.ProbeInterface.NET/Probe.cs
index 7944663..b7a84ad 100644
--- a/OpenEphys.ProbeInterface.NET/Probe.cs
+++ b/OpenEphys.ProbeInterface.NET/Probe.cs
@@ -113,18 +113,18 @@ public class Probe
         /// <summary>
         /// Public constructor, defined as the default Json constructor.
         /// </summary>
-        /// <param name="ndim"></param>
-        /// <param name="si_units"></param>
-        /// <param name="annotations"></param>
-        /// <param name="contact_annotations"></param>
-        /// <param name="contact_positions"></param>
-        /// <param name="contact_plane_axes"></param>
-        /// <param name="contact_shapes"></param>
-        /// <param name="contact_shape_params"></param>
-        /// <param name="probe_planar_contour"></param>
-        /// <param name="device_channel_indices"></param>
-        /// <param name="contact_ids"></param>
-        /// <param name="shank_ids"></param>
+        /// <param name="ndim">Number of dimensions to use while plotting the contacts [<see cref="ProbeNdim.Two"/> or <see cref="ProbeNdim.Three"/>].</param>
+        /// <param name="si_units">Real-world units to use while plotting the contacts [<see cref="ProbeSiUnits.mm"/> or <see cref="ProbeSiUnits.um"/>].</param>
+        /// <param name="annotations">Annotations for the probe.</param>
+        /// <param name="contact_annotations">Annotations for each contact as an array of strings.</param>
+        /// <param name="contact_positions">Center position of each contact in a two-dimensional array of floats. For more info, see <see cref="ContactPositions"/>.</param>
+        /// <param name="contact_plane_axes">Plane axes of each contact in a three-dimensional array of floats. For more info, see <see cref="ContactPlaneAxes"/>.</param>
+        /// <param name="contact_shapes">Array of shapes for each contact.</param>
+        /// <param name="contact_shape_params">Array of shape parameters for the each contact.</param>
+        /// <param name="probe_planar_contour">Two-dimensional array of floats (X and Y positions) defining a closed shape for a probe contour.</param>
+        /// <param name="device_channel_indices">Array of integers containing the device channel indices for each contact. For more info, see <see cref="DeviceChannelIndices"/>.</param>
+        /// <param name="contact_ids">Array of strings containing the contact ID for each contact. For more info, see <see cref="ContactIds"/>.</param>
+        /// <param name="shank_ids">Array of strings containing the shank ID for each contact. For more info, see <see cref="ShankIds"/>.</param>
         [JsonConstructor]
         public Probe(ProbeNdim ndim, ProbeSiUnits si_units, ProbeAnnotations annotations, ContactAnnotations contact_annotations,
             float[][] contact_positions, float[][][] contact_plane_axes, ContactShape[] contact_shapes,
@@ -148,7 +148,7 @@ public Probe(ProbeNdim ndim, ProbeSiUnits si_units, ProbeAnnotations annotations
         /// <summary>
         /// Copy constructor given an existing <see cref="Probe"/> object.
         /// </summary>
-        /// <param name="probe"></param>
+        /// <param name="probe">Existing <see cref="Probe"/> object to be copied.</param>
         protected Probe(Probe probe)
         {
             NumDimensions = probe.NumDimensions;
@@ -252,7 +252,7 @@ public static ContactShapeParam[] DefaultRectParams(int numberOfContacts, float
 
             for (int i = 0; i < numberOfContacts; i++)
             {
-                contactShapeParams[i] = new ContactShapeParam(height: height);
+                contactShapeParams[i] = new ContactShapeParam(width: width, height: height);
             }
 
             return contactShapeParams;
diff --git a/OpenEphys.ProbeInterface.NET/ProbeAnnotations.cs b/OpenEphys.ProbeInterface.NET/ProbeAnnotations.cs
index e7e59ed..72f9011 100644
--- a/OpenEphys.ProbeInterface.NET/ProbeAnnotations.cs
+++ b/OpenEphys.ProbeInterface.NET/ProbeAnnotations.cs
@@ -22,8 +22,8 @@ public class ProbeAnnotations
         /// <summary>
         /// Initializes a new instance of the <see cref="ProbeAnnotations"/> class.
         /// </summary>
-        /// <param name="name"></param>
-        /// <param name="manufacturer"></param>
+        /// <param name="name">String defining the name of the probe.</param>
+        /// <param name="manufacturer">String defining the manufacturer of the probe.</param>
         [JsonConstructor]
         public ProbeAnnotations(string name, string manufacturer)
         {
@@ -34,7 +34,7 @@ public ProbeAnnotations(string name, string manufacturer)
         /// <summary>
         /// Copy constructor that copies data from an existing <see cref="ProbeAnnotations"/> object.
         /// </summary>
-        /// <param name="probeAnnotations"></param>
+        /// <param name="probeAnnotations">Existing <see cref="ProbeAnnotations"/> object, containing a <see cref="Name"/> and a <see cref="Manufacturer"/>.</param>
         protected ProbeAnnotations(ProbeAnnotations probeAnnotations)
         {
             Name = probeAnnotations.Name;