From b0bc6223f19dc166e430b92e38f8adb81a70bda3 Mon Sep 17 00:00:00 2001 From: jonnew Date: Fri, 6 Sep 2024 10:09:48 -0400 Subject: [PATCH] Address review comments - Remove self-referential cref to DataType in XML docs --- OpenEphys.Onix1/BreakoutAnalogOutput.cs | 45 +++++++++++-------- OpenEphys.Onix1/ConfigureBreakoutDigitalIO.cs | 15 ++++--- 2 files changed, 35 insertions(+), 25 deletions(-) diff --git a/OpenEphys.Onix1/BreakoutAnalogOutput.cs b/OpenEphys.Onix1/BreakoutAnalogOutput.cs index 814632d..84b13ad 100644 --- a/OpenEphys.Onix1/BreakoutAnalogOutput.cs +++ b/OpenEphys.Onix1/BreakoutAnalogOutput.cs @@ -29,26 +29,29 @@ public class BreakoutAnalogOutput : Sink /// Gets or sets the data type used to represent analog samples. /// /// - /// If is selected, each DAC value is represented by a signed, twos-complement encoded - /// 16-bit integer. In this case, the output voltage always corresponds to . - /// When is selected, 32-bit floating point voltages between -10 and 10 volts are sent - /// directly to the DACs. + /// If is selected, each DAC value is represented by a + /// signed, twos-complement encoded 16-bit integer. In this case, the output voltage always + /// corresponds to . When is selected, 32-bit floating point voltages between -10 + /// and 10 volts are sent directly to the DACs. /// [Description("The data type used to represent analog samples.")] [Category(DeviceFactory.ConfigurationCategory)] public BreakoutAnalogIODataType DataType { get; set; } = BreakoutAnalogIODataType.S16; /// - /// Send a matrix of samples to analog outputs + /// Send an matrix of samples to all enabled analog outputs. /// /// - /// If a matrix contains multiple samples, they will be written to hardware as quickly as communication allows. - /// The data within each input matrix must have when is set to or - /// when is set to . + /// If a matrix contains multiple samples, they will be written to hardware as quickly as + /// communication allows. The data within each input matrix must have when + /// DataType is set to or + /// when DataType is set to . /// - /// A sequence of 12xN sample matrices containing the analog data to write to channels 0 to 11. - /// A sequence of 12xN sample matrices containing the analog data that were written to channels 0 to 11. + /// A sequence of 12xN sample matrices containing the analog data to write to + /// channels 0 to 11. + /// A sequence of 12xN sample matrices containing the analog data that were written to + /// channels 0 to 11. public override unsafe IObservable Process(IObservable source) { var dataType = DataType; @@ -109,15 +112,17 @@ public override unsafe IObservable Process(IObservable source) } /// - /// Send an 12-element array of values to update all analog outputs. + /// Send an 12-element array of values to update all enabled analog outputs. /// /// - /// This overload should be used when is set to DataType is set to and values should be within -32,768 to 32,767, which /// correspond to -10.0 to 10.0 volts. /// - /// A sequence of 12x1 element arrays each containing the analog data to write to channels 0 to 11. - /// A sequence of 12x1 element arrays each containing the analog data to write to channels 0 to 11. + /// A sequence of 12x1 element arrays each containing the analog data to write + /// to channels 0 to 11. + /// A sequence of 12x1 element arrays each containing the analog data to write to channels 0 + /// to 11. public IObservable Process(IObservable source) { if (DataType != BreakoutAnalogIODataType.S16) @@ -141,14 +146,16 @@ public IObservable Process(IObservable source) } /// - /// Send an 12-element array of values to update all analog outputs. + /// Send an 12-element array of values to update all enabled analog outputs. /// /// - /// This overload should be used when is set to DataType is set to and values should be within -10.0 to 10.0 volts. /// - /// A sequence of 12x1 element arrays each containing the analog data to write to channels 0 to 11. - /// A sequence of 12x1 element arrays each containing the analog data to write to channels 0 to 11. + /// A sequence of 12x1 element arrays each containing the analog data to write + /// to channels 0 to 11. + /// A sequence of 12x1 element arrays each containing the analog data to write to channels 0 + /// to 11. public IObservable Process(IObservable source) { if (DataType != BreakoutAnalogIODataType.Volts) diff --git a/OpenEphys.Onix1/ConfigureBreakoutDigitalIO.cs b/OpenEphys.Onix1/ConfigureBreakoutDigitalIO.cs index 5b22afd..f20e7b6 100644 --- a/OpenEphys.Onix1/ConfigureBreakoutDigitalIO.cs +++ b/OpenEphys.Onix1/ConfigureBreakoutDigitalIO.cs @@ -11,7 +11,7 @@ namespace OpenEphys.Onix1 /// cref="BreakoutDigitalInput"/> and , using a shared /// DeviceName. /// - [Description("onfigures the ONIX breakout board's digital inputs and outputs.")] + [Description("Configures the ONIX breakout board's digital inputs and outputs.")] public class ConfigureBreakoutDigitalIO : SingleDeviceFactory { /// @@ -27,7 +27,8 @@ public ConfigureBreakoutDigitalIO() /// Gets or sets the device enable state. /// /// - /// If set to true, will produce data. If set to false, will not produce data. + /// If set to true, will produce data. If set to false, will not produce data. /// [Category(ConfigurationCategory)] [Description("Specifies whether the digital IO device is enabled.")] @@ -37,12 +38,14 @@ public ConfigureBreakoutDigitalIO() /// Configures the digital input and output device in the ONIX breakout board. /// /// - /// This will schedule digital IO hardware configuration actions that can be applied by a - /// object prior to data collection. + /// This will schedule digital IO hardware configuration actions that can be applied by a object prior to data collection. /// - /// A sequence of instances that hold configuration actions. + /// A sequence of instances that hold configuration + /// actions. /// - /// The original sequence modified by adding additional configuration actions required to configure a digital IO device. + /// The original sequence modified by adding additional configuration actions required to configure a + /// digital IO device. /// public override IObservable Process(IObservable source) {