Merge pull request #261 from open-ephys/issue-209

Remove "a class that" from XML comments

OpenEphys.Onix1/Bno055Data.cs

@@ -7,13 +7,13 @@
 namespace OpenEphys.Onix1
 {
     /// <summary>
-    /// A class that generates a sequence of 3D orientation measurements produced by BNO055 9-axis inertial measurement unit.
+    /// Produces a sequence of 3D orientation measurements produced by Bno055 9-axis inertial measurement unit.
     /// </summary>
     /// <remarks>
-    /// This data stream class must be linked to an appropriate configuration, such as a <see cref="ConfigureBno055"/>,
+    /// This data stream operator must be linked to an appropriate configuration, such as a <see cref="ConfigureBno055"/>,
     /// in order to stream 3D orientation data.
     /// </remarks>
-    [Description("Generates a sequence of 3D orientation measurements produced by a BNO055 9-axis inertial measurement unit.")]
+    [Description("Produces a sequence of 3D orientation measurements produced by a Bno055 9-axis inertial measurement unit.")]
     public class Bno055Data : Source<Bno055DataFrame>
     {
         /// <inheritdoc cref = "SingleDeviceFactory.DeviceName"/>

OpenEphys.Onix1/Bno055DataFrame.cs

@@ -5,14 +5,14 @@
 namespace OpenEphys.Onix1
 {
     /// <summary>
-    /// A class that contains 3D orientation data produced by a Bosch BNO055 9-axis inertial measurement unit (IMU).
+    /// 3D-orientation data produced by a Bosch Bno55 9-axis inertial measurement unit (IMU).
     /// </summary>
     public class Bno055DataFrame : DataFrame
     {
         /// <summary>
         /// Initializes a new instance of the <see cref="Bno055DataFrame"/> class.
         /// </summary>
-        /// <param name="frame">An ONI data frame containing BNO055 data.</param>
+        /// <param name="frame">An ONI data frame containing Bno055 data.</param>
         public unsafe Bno055DataFrame(oni.Frame frame)
             : this(frame.Clock, (Bno055Payload*)frame.Data.ToPointer())
         {

OpenEphys.Onix1/BreakoutDigitalInput.cs

@@ -7,11 +7,11 @@
 namespace OpenEphys.Onix1
 {
     /// <summary>
-    /// A class that produces a sequence of digital input frames from an ONIX breakout board.
+    /// Produces a sequence of digital input data from an ONIX breakout board.
     /// </summary>
     /// <remarks>
-    /// This data stream class must be linked to an appropriate configuration, such as a <see cref="ConfigureBreakoutDigitalIO"/>,
-    /// in order to stream data.
+    /// This data stream operator must be linked to an appropriate configuration, such as a
+    /// <see cref="ConfigureBreakoutDigitalIO"/>, in order to stream data.
     /// </remarks>
     [Description("Produces a sequence of digital input frames from an ONIX breakout board.")]
     public class BreakoutDigitalInput : Source<BreakoutDigitalInputDataFrame>
@@ -23,12 +23,12 @@ public class BreakoutDigitalInput : Source<BreakoutDigitalInputDataFrame>
         public string DeviceName { get; set; }
 
         /// <summary>
-        /// Generates a sequence of <see cref="BreakoutDigitalInputDataFrame"/> objects, which contains information about breakout
-        /// board's digital input state.
+        /// Generates a sequence of digital input data frames, each of which contains information about
+        /// breakout board's digital input state.
         /// </summary>
         /// <remarks>
-        /// Digital inputs are not regularly sampled. Instead, a new <see cref="BreakoutDigitalInputDataFrame"/> is produced each
-        /// whenever any digital state (i.e. a digital input pin, button, or switch state) changes.
+        /// Digital inputs are sampled at 4 MHz but a <see cref="BreakoutDigitalInputDataFrame"/> is produced
+        /// only when a button, switch, or digital input pin is toggled.
         /// </remarks>
         /// <returns>A sequence of <see cref="BreakoutDigitalInputDataFrame"/> objects.</returns>
         public unsafe override IObservable<BreakoutDigitalInputDataFrame> Generate()

OpenEphys.Onix1/BreakoutDigitalInputDataFrame.cs

@@ -3,7 +3,7 @@
 namespace OpenEphys.Onix1
 {
     /// <summary>
-    /// A class that contains information about a digital event on the ONIX breakout board.
+    /// A digital event produced by the ONIX breakout board.
     /// </summary>
     public class BreakoutDigitalInputDataFrame : DataFrame
     {

OpenEphys.Onix1/ConfigureBno055.cs

@@ -4,12 +4,13 @@
 namespace OpenEphys.Onix1
 {
     /// <summary>
-    /// A class for configuring a Bosch BNO055 9-axis inertial measurement unit (IMU).
-    /// </summary>
+    /// Configures a Bosch Bno055 9-axis inertial measurement unit (IMU).
+    /// </summary>C
     /// <remarks>
-    /// This configuration class can be linked to a <see cref="Bno055Data"/> instance to stream orientation data from the IMU.
+    /// This configuration operator can be linked to a <see cref="Bno055Data"/> instance to stream
+    /// orientation data from the IMU.
     /// </remarks>
-    [Description("Configures a Bosch BNO055 9-axis IMU device.")]
+    [Description("Configures a Bosch Bno055 9-axis inertial measurement unit.")]
     [Editor("OpenEphys.Onix1.Design.Bno055Editor, OpenEphys.Onix1.Design", typeof(ComponentEditor))]
     public class ConfigureBno055 : SingleDeviceFactory
     {
@@ -41,18 +42,18 @@ public ConfigureBno055(ConfigureBno055 configureBno055)
         /// it will not produce data.
         /// </remarks>
         [Category(ConfigurationCategory)]
-        [Description("Specifies whether the BNO055 device is enabled.")]
+        [Description("Specifies whether the Bno055 device is enabled.")]
         public bool Enable { get; set; } = true;
 
         /// <summary>
-        /// Configures a Bosch BNO055 9-axis IMU device.
+        /// Configures a Bosch Bno055 9-axis IMU device.
         /// </summary>
         /// <remarks>
         /// This will schedule configuration actions to be applied by a <see cref="StartAcquisition"/> instance
         /// prior to data acquisition.
         /// </remarks>
         /// <param name="source">A sequence of <see cref="ContextTask"/> instances that holds configuration actions.</param>
-        /// <returns>The original sequence modified by adding additional configuration actions required to configure a BNO055 device.</returns>
+        /// <returns>The original sequence modified by adding additional configuration actions required to configure a Bno055 device.</returns>
         public override IObservable<ContextTask> Process(IObservable<ContextTask> source)
         {
             var deviceName = DeviceName;

OpenEphys.Onix1/ConfigureBreakoutAnalogIO.cs

@@ -5,14 +5,14 @@
 namespace OpenEphys.Onix1
 {
     /// <summary>
-    /// A class for configuring the ONIX breakout board's analog inputs and outputs.
+    /// Configures the ONIX breakout board's analog inputs and outputs.
     /// </summary>
     [TypeConverter(typeof(SortedPropertyConverter))]
-    [Description("Configures the analog input and output device in the ONIX breakout board.")]
+    [Description("Configures the ONIX breakout board's analog inputs and outputs.")]
     public class ConfigureBreakoutAnalogIO : SingleDeviceFactory
     {
         /// <summary>
-        /// Initialize a new instance of ConfigureAnalogIO.
+        /// Initialize a new instance of <see cref="ConfigureBreakoutAnalogIO"/> class.
         /// </summary>
         public ConfigureBreakoutAnalogIO()
             : base(typeof(BreakoutAnalogIO))

OpenEphys.Onix1/ConfigureBreakoutBoard.cs

@@ -4,7 +4,7 @@
 namespace OpenEphys.Onix1
 {
     /// <summary>
-    /// A class that configures an ONIX breakout board.
+    /// Configures an ONIX breakout board.
     /// </summary>
     [Description("Configures an ONIX breakout board.")]
     public class ConfigureBreakoutBoard : MultiDeviceFactory

OpenEphys.Onix1/ConfigureBreakoutDigitalIO.cs

@@ -4,13 +4,13 @@
 namespace OpenEphys.Onix1
 {
     /// <summary>
-    /// A class for configuring the ONIX breakout board's digital inputs and outputs.
+    /// Configures the ONIX breakout board's digital inputs and outputs.
     /// </summary>
-    [Description("Configures the digital input and output device in the ONIX breakout board.")]
+    [Description("onfigures the ONIX breakout board's digital inputs and outputs.")]
     public class ConfigureBreakoutDigitalIO : SingleDeviceFactory
     {
         /// <summary>
-        /// Initialize a new instance of <see cref="ConfigureBreakoutDigitalIO"/>.
+        /// Initialize a new instance of the <see cref="ConfigureBreakoutDigitalIO"/> class.
         /// </summary>
         public ConfigureBreakoutDigitalIO()
             : base(typeof(BreakoutDigitalIO))

OpenEphys.Onix1/ConfigureHarpSyncInput.cs

@@ -4,7 +4,8 @@
 namespace OpenEphys.Onix1
 {
     /// <summary>
-    /// A class for configuring the ONIX breakout board Harp sync input device.
+    /// Configures the ONIX breakout board's <see href="https://harp-tech.org/">Harp</see>
+    /// sync input.
     /// </summary>
     /// <remarks>
     /// <para>
@@ -26,7 +27,7 @@ namespace OpenEphys.Onix1
     /// <see href="https://harp-tech.org/"/>.
     /// </para>
     /// </remarks>
-    [Description("Configures a ONIX breakout board Harp sync input device.")]
+    [Description("Configures a ONIX breakout board Harp sync input.")]
     public class ConfigureHarpSyncInput : SingleDeviceFactory
     {
         /// <summary>

OpenEphys.Onix1/ConfigureHeadstage64.cs

@@ -5,7 +5,7 @@
 namespace OpenEphys.Onix1
 {
     /// <summary>
-    /// A class that configures an ONIX headstage-64 on the specified port.
+    /// Configures an ONIX headstage-64 on the specified port.
     /// </summary>
     [Description("Configures an ONIX headstage-64 in the specified port.")]
     public class ConfigureHeadstage64 : MultiDeviceFactory
@@ -22,7 +22,7 @@ public class ConfigureHeadstage64 : MultiDeviceFactory
         /// 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>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>

OpenEphys.Onix1/ConfigureHeadstage64ElectricalStimulator.cs

@@ -4,10 +4,10 @@
 namespace OpenEphys.Onix1
 {
     /// <summary>
-    /// A class that configures a headstage-64 onboard electrical stimulator.
+    /// Configures a headstage-64 onboard electrical stimulator.
     /// </summary>
     /// <remarks>
-    /// This configuration class can be linked to a <see cref="Headstage64ElectricalStimulatorTrigger"/> instance to deliver
+    /// This configuration operator can be linked to a <see cref="Headstage64ElectricalStimulatorTrigger"/> instance to deliver
     /// current controlled electrical micro-stimulation through a contact on the probe connector on the bottom of the headstage
     /// or the corresponding contact on a compatible electrode interface board.
     /// </remarks>

OpenEphys.Onix1/ConfigureHeadstage64OpticalStimulator.cs

@@ -4,10 +4,10 @@
 namespace OpenEphys.Onix1
 {
     /// <summary>
-    /// A class that configures a headstage-64 dual-channel optical stimulator.
+    /// Configures a headstage-64 dual-channel optical stimulator.
     /// </summary>
     /// <remarks>
-    /// This configuration class can be linked to a <see cref="Headstage64OpticalStimulatorTrigger"/> instance to drive current
+    /// This configuration operator can be linked to a <see cref="Headstage64OpticalStimulatorTrigger"/> instance to drive current
     /// through laser diodes or LEDs connected to two contacts on the probe connector on the bottom of the headstage
     /// or the corresponding contacts on a compatible electrode interface board.
     /// </remarks>

OpenEphys.Onix1/ConfigureHeartbeat.cs

@@ -7,9 +7,9 @@
 namespace OpenEphys.Onix1
 {
     /// <summary>
-    /// A class for configuring a heartbeat device.
+    /// Configures a heartbeat device.
     /// <remarks>
-    /// This configuration class can be linked to a <see cref="HeartbeatData"/> instance to stream
+    /// This configuration operator can be linked to a <see cref="HeartbeatData"/> instance to stream
     /// heartbeats from the acquisition system.
     /// </remarks>
     /// </summary>
@@ -19,7 +19,7 @@ public class ConfigureHeartbeat : SingleDeviceFactory
         readonly BehaviorSubject<uint> beatsPerSecond = new(10);
 
         /// <summary>
-        /// Initializes and new instance of the <see cref="ConfigureHeartbeat"/> class.
+        /// Initializes a new instance of the <see cref="ConfigureHeartbeat"/> class.
         /// </summary>
         public ConfigureHeartbeat()
             : base(typeof(Heartbeat))

OpenEphys.Onix1/ConfigureLoadTester.cs

@@ -8,7 +8,7 @@
 namespace OpenEphys.Onix1
 {
     /// <summary>
-    /// A class for configuring a load testing device.
+    /// Configures a load tester device.
     /// </summary>
     /// <remarks>
     /// The load tester device can be configured to produce data at user-settable size and rate

OpenEphys.Onix1/ConfigureMemoryMonitor.cs

@@ -5,26 +5,30 @@
 namespace OpenEphys.Onix1
 {
     /// <summary>
-    /// A class for configuring a hardware memory monitor device.
+    /// Configures a hardware memory monitor.
     /// </summary>
     /// <remarks>
     /// The memory monitor produces periodic snapshots of the system's first in, first out (FIFO) data buffer.
     /// This can be useful for:
     /// <list type="bullet">
-    /// <item><description>Ensuring that data is being read by the host PC quickly enough to prevent real-time delays or overflows.
-    /// In the case that the PC is not keeping up with data collection, FIFO memory use will increase monotonically.</description></item>
-    /// <item><description>Tuning the value of <see cref="StartAcquisition.ReadSize"/> to optimize real-time performance.
+    /// <item>
+    /// <description>Ensuring that data is being read by the host PC quickly enough to prevent real-time delays or overflows.
+    /// In the case that the PC is not keeping up with data collection, FIFO memory use will increase monotonically.</description>
+    /// </item>
+    /// <item>
+    /// <description>Tuning the value of <see cref="StartAcquisition.ReadSize"/> to optimize real-time performance.
     /// For optimal real-time performance, <see cref="StartAcquisition.ReadSize"/> should be as small as possible and the FIFO should be bypassed
     /// (memory usage should remain at 0). However, these requirements are in conflict. The memory monitor provides a way to find the minimal value of
     /// value of <see cref="StartAcquisition.ReadSize"/> that does not result in excessive FIFO data buffering. This tradeoff will depend on the
-    /// bandwidth of data being acquired, the performance of the host PC, and downstream real-time processing.</description></item>
+    /// bandwidth of data being acquired, the performance of the host PC, and downstream real-time processing.</description>
+    /// </item>
     /// </list>
     /// </remarks>
-    [Description("Configures a hardware memory monitor device.")]
+    [Description("Configures a hardware memory monitor.")]
     public class ConfigureMemoryMonitor : SingleDeviceFactory
     {
         /// <summary>
-        /// Initialize a new instance of <see cref="ConfigureMemoryMonitor"/>.
+        /// Initializes a new instance of the <see cref="ConfigureMemoryMonitor"/> class.
         /// </summary>
         public ConfigureMemoryMonitor()
             : base(typeof(MemoryMonitor))
@@ -58,7 +62,7 @@ public ConfigureMemoryMonitor()
         /// prior to data acquisition.
         /// </remarks>
         /// <param name="source">A sequence of <see cref="ContextTask"/> instances that holds configuration actions.</param>
-        /// <returns>The original sequence modified by adding additional configuration actions required to configure a memory monitor device./></returns>
+        /// <returns>The original sequence modified by adding additional configuration actions required to configure a memory monitor device.</returns>
         public override IObservable<ContextTask> Process(IObservable<ContextTask> source)
         {
             var enable = Enable;

OpenEphys.Onix1/ConfigureNeuropixelsV1e.cs

@@ -7,14 +7,14 @@
 namespace OpenEphys.Onix1
 {
     /// <summary>
-    /// A class that configures a NeuropixelsV1e device.
+    /// Configures a NeuropixelsV1e device.
     /// </summary>
     [Description("Configures a NeuropixelsV1e device.")]
     [Editor("OpenEphys.Onix1.Design.NeuropixelsV1eEditor, OpenEphys.Onix1.Design", typeof(ComponentEditor))]
     public class ConfigureNeuropixelsV1e : SingleDeviceFactory
     {
         /// <summary>
-        /// Initialize a new instance of a <see cref="ConfigureNeuropixelsV1e"/> class.
+        /// Initializes a new instance of the <see cref="ConfigureNeuropixelsV1e"/> class.
         /// </summary>
         public ConfigureNeuropixelsV1e()
             : base(typeof(NeuropixelsV1e))

OpenEphys.Onix1/ConfigureNeuropixelsV1eBno055.cs

@@ -4,14 +4,14 @@
 namespace OpenEphys.Onix1
 {
     /// <summary>
-    /// A class that configures a NeuropixelsV1eBno055 device.
+    /// Configures a NeuropixelsV1eBno055 device.
     /// </summary>
     [Description("Configures a NeuropixelsV1eBno055 device.")]
     [Editor("OpenEphys.Onix1.Design.NeuropixelsV1eBno055Editor, OpenEphys.Onix1.Design", typeof(ComponentEditor))]
     public class ConfigureNeuropixelsV1eBno055 : SingleDeviceFactory
     {
         /// <summary>
-        /// Initialize a new instance of a <see cref="ConfigureNeuropixelsV1eBno055"/> class.
+        /// Initializes a new instance of the <see cref="ConfigureNeuropixelsV1eBno055"/> class.
         /// </summary>
         public ConfigureNeuropixelsV1eBno055()
             : base(typeof(NeuropixelsV1eBno055))
@@ -37,7 +37,7 @@ public ConfigureNeuropixelsV1eBno055(ConfigureNeuropixelsV1eBno055 configureBno0
         /// <see cref="NeuropixelsV1eBno055Data"/> will not produce data.
         /// </remarks>
         [Category(ConfigurationCategory)]
-        [Description("Specifies whether the BNO055 device is enabled.")]
+        [Description("Specifies whether the Bno055 device is enabled.")]
         public bool Enable { get; set; } = true;
 
         /// <summary>
@@ -79,7 +79,7 @@ static void ConfigureDeserializer(DeviceContext device)
 
         static void ConfigureBno055(DeviceContext device)
         {
-            // setup BNO055 device
+            // setup Bno055 device
             var i2c = new I2CRegisterContext(device, NeuropixelsV1eBno055.BNO055Address);
             i2c.WriteByte(0x3E, 0x00); // Power mode normal
             i2c.WriteByte(0x07, 0x00); // Page ID address 0

OpenEphys.Onix1/ConfigureNeuropixelsV1eHeadstage.cs

@@ -5,17 +5,17 @@
 namespace OpenEphys.Onix1
 {
     /// <summary>
-    /// A class that configures a NeuropixelsV1e headstage on the specified port.
+    /// Configures a NeuropixelsV1e headstage on the specified port.
     /// </summary>
-    [Description("Configures a NeuropixelsV1e headstage.")]
+    [Description("Configures a NeuropixelsV1e headstage on the specified port.")]
     [Editor("OpenEphys.Onix1.Design.NeuropixelsV1eHeadstageEditor, OpenEphys.Onix1.Design", typeof(ComponentEditor))]
     public class ConfigureNeuropixelsV1eHeadstage : MultiDeviceFactory
     {
         PortName port;
         readonly ConfigureNeuropixelsV1ePortController PortControl = new();
 
         /// <summary>
-        /// Initialize a new instance of a <see cref="ConfigureNeuropixelsV1eHeadstage"/> class.
+        /// Initializes a new instance of the <see cref="ConfigureNeuropixelsV1eHeadstage"/> class.
         /// </summary>
         public ConfigureNeuropixelsV1eHeadstage()
         {

OpenEphys.Onix1/ConfigureNeuropixelsV2e.cs

@@ -7,14 +7,14 @@
 namespace OpenEphys.Onix1
 {
     /// <summary>
-    /// A class that configures a NeuropixelsV2e device.
+    /// Configures a NeuropixelsV2e device.
     /// </summary>
     [Editor("OpenEphys.Onix1.Design.NeuropixelsV2eEditor, OpenEphys.Onix1.Design", typeof(ComponentEditor))]
     [Description("Configures a NeuropixelsV2e device.")]
     public class ConfigureNeuropixelsV2e : SingleDeviceFactory, IConfigureNeuropixelsV2
     {
         /// <summary>
-        /// Initialize a new instance of a <see cref="ConfigureNeuropixelsV2e"/> class.
+        /// Initializes a new instance of the <see cref="ConfigureNeuropixelsV2e"/> class.
         /// </summary>
         public ConfigureNeuropixelsV2e()
             : base(typeof(NeuropixelsV2e))