PR review

- Updated headstage descriptions for consistency and simplicity while reviewing

Author: jonnew

OpenEphys.Onix1/ConfigureHeadstage64.cs

@@ -5,14 +5,14 @@
 namespace OpenEphys.Onix1
 {
     /// <summary>
-    /// Configures an ONIX headstage-64 on the specified port.
+    /// Configures an ONIX multifunction 64-channel headstage on the specified port.
     /// </summary>
     /// <remarks>
     /// Headstage-64 is a 1.5g serialized, multifunction headstage designed to function with passive
     /// probes such as tetrode microdrives, silicon arrays, EEG/ECOG arrays, etc. It provides the
     /// following features:
     /// <list type="bullet">
-    /// <item><description>64 analog ephys channels and 3 auxiliary channels sampled at 30 kHz per
+    /// <item><description>64 electrophysiology channels and 3 auxiliary channels sampled at 30 kHz per
     /// channel.</description></item>
     /// <item><description>A BNO055 9-axis IMU for real-time, 3D orientation tracking.</description></item>
     /// <item><description>Three TS4231 light to digital converters for real-time, 3D position tracking with
@@ -22,7 +22,7 @@ namespace OpenEphys.Onix1
     /// <item><description>Two optical stimulators (800 mA peak current per channel).</description></item>
     /// </list>
     /// </remarks>
-    [Description("Configures an ONIX headstage-64 in the specified port.")]
+    [Description("Configures an ONIX multifunction 64-channel headstage.")]
     public class ConfigureHeadstage64 : MultiDeviceFactory
     {
         PortName port;
@@ -31,19 +31,6 @@ public class ConfigureHeadstage64 : MultiDeviceFactory
         /// <summary>
         /// Initializes a new instance of the <see cref="ConfigureHeadstage64"/> class.
         /// </summary>
-        /// <remarks>
-        /// Headstage-64 is a 1.5g serialized, multifunction headstage designed to function with
-        /// tetrode microdrives. Alternatively it can be used with other passive probes (e.g.
-        /// silicon arrays, EEG/ECOG arrays, etc.). It provides the following features on the
-        /// headstage:
-        /// <list type="bullet">
-        /// <item><description>64 analog ephys channels and 3 auxiliary channels sampled at 30 kHz per channel.</description></item>
-        /// <item><description>A Bno055 9-axis IMU for real-time, 3D orientation tracking.</description></item>
-        /// <item><description>Three TS4231 light to digital converters for real-time, 3D position tracking with HTC Vive base stations.</description></item>
-        /// <item><description>A single electrical stimulator (current controlled, +/-15V compliance, automatic electrode discharge).</description></item>
-        /// <item><description>Two optical stimulators (800 mA peak current per channel).</description></item>
-        /// </list>
-        /// </remarks>
         public ConfigureHeadstage64()
         {
             // WONTFIX: The issue with this headstage is that its locking voltage is far, far lower than the

OpenEphys.Onix1/ConfigureHeadstageNeuropixelsV1e.cs

@@ -22,8 +22,8 @@ namespace OpenEphys.Onix1
     /// <item><description>A BNO055 9-axis IMU for real-time, 3D orientation tracking.</description></item>
     /// </list>
     /// </remarks>
-    [Description("Configures a NeuropixelsV1e headstage.")]
     [Editor("OpenEphys.Onix1.Design.NeuropixelsV1eHeadstageEditor, OpenEphys.Onix1.Design", typeof(ComponentEditor))]
+    [Description("Configures a NeuropixelsV1e headstage.")]
     public class ConfigureHeadstageNeuropixelsV1e : MultiDeviceFactory
     {
         PortName port;

OpenEphys.Onix1/ConfigureHeadstageNeuropixelsV2e.cs

@@ -22,7 +22,7 @@ namespace OpenEphys.Onix1
     /// </list>
     /// </remarks>
     [Editor("OpenEphys.Onix1.Design.NeuropixelsV2eHeadstageEditor, OpenEphys.Onix1.Design", typeof(ComponentEditor))]
-    [Description("Configures a NeuropixelsV2e headstage on the specified port.")]
+    [Description("Configures a NeuropixelsV2e headstage.")]
     public class ConfigureHeadstageNeuropixelsV2e : MultiDeviceFactory
     {
         PortName port;

OpenEphys.Onix1/ConfigureHeadstageNeuropixelsV2eBeta.cs

@@ -21,8 +21,8 @@ namespace OpenEphys.Onix1
     /// <item><description>A BNO055 9-axis IMU for real-time, 3D orientation tracking.</description></item>
     /// </list>
     /// </remarks>
-    [Description("Configures a NeuropixelsV2eBeta headstage.")]
     [Editor("OpenEphys.Onix1.Design.NeuropixelsV2eHeadstageEditor, OpenEphys.Onix1.Design", typeof(ComponentEditor))]
+    [Description("Configures a NeuropixelsV2eBeta headstage.")]
     public class ConfigureHeadstageNeuropixelsV2eBeta : MultiDeviceFactory
     {
         PortName port;

OpenEphys.Onix1/ConfigureHeadstageNric1384.cs

@@ -23,7 +23,7 @@ namespace OpenEphys.Onix1
     /// electrode discharge).</description></item>
     /// </list>
     /// </remarks>
-    [Description("Configures a Nric1384 Headstage headstage.")]
+    [Description("Configures a Nric1384 headstage.")]
     public class ConfigureHeadstageNric1384 : MultiDeviceFactory
     {
         PortName port;

OpenEphys.Onix1/ConfigureHeadstageRhs2116.cs

@@ -13,17 +13,17 @@ namespace OpenEphys.Onix1
     /// stimuli. The Rhs2116 Headstage can be used with passive probes (e.g. silicon arrays,
     /// EEG/ECOG arrays, etc) using a 36-Channel Omnetics EIB. It provides the following features:
     /// <list type="bullet">
-    /// <item><description>Two, synchronized Rhs2116 ICs for a combined 32 bidirectional ephys channels.</description></item>
+    /// <item><description>Two, synchronized Rhs2116 ICs for a combined 32 bidirectional ephys channels
+    /// sampled at 30.1932367 kHz per channel.</description></item>
     /// <item><description>Real-time control of stimulation sequences.</description></item>
-    /// <item><description>Real-time control of filter settings and artifact recovery parameters.</description></item>
-    /// <item><description>~1 millisecond active stimulus artifact recovery.</description></item>
+    /// <item><description>Real-time control of filter settings.</description></item>
+    /// <item><description>Active post-stimulus electrode discharge and filtering allowing ~1 ms artifact recovery.</description></item>
     /// <item><description>Max stimulator current: 2.55mA @ +/-7V compliance.</description></item>
-    /// <item><description>Sample rate: 30193.2367 Hz.</description></item>
     /// <item><description>Stimulus active and stimulus trigger pins.</description></item>
-    /// <item><description>On-board Lattice Crosslink FPGA for real-time data arbitration.</description></item>
     /// </list>
     /// </remarks>
     [Editor("OpenEphys.Onix1.Design.HeadstageRhs2116Editor, OpenEphys.Onix1.Design", typeof(ComponentEditor))]
+    [Description("Configures an ONIX Rhs2116 headstage.")]
     public class ConfigureHeadstageRhs2116 : MultiDeviceFactory
     {
         PortName port;