Remove camel/pascal case and make it more like plain language

cjsha · cjsha · commit 34748ed35140 · 2025-02-21T15:22:09.000-05:00
Change ushort to short for analoginputdata
diff --git a/OpenEphys.Onix1/AnalogInputDataFrame.cs b/OpenEphys.Onix1/AnalogInputDataFrame.cs
@@ -28,12 +28,12 @@ public AnalogInputDataFrame(ulong[] clock, ulong[] hubClock, Mat analogData)
         /// samples acquired at 100 kHz. Each column corresponds to an ADC sample whose time is
         /// indicated by the corresponding elements in <see cref="DataFrame.Clock"/> and <see
         /// cref="DataFrame.HubClock"/>. When <c>DataType</c> in <see
-        /// cref="OpenEphys.Onix1.AnalogInput"/> is set to <c>Volts</c>, pre-converted voltage
-        /// values are encoded as a <see cref="float"/>. When <c>DataType</c> is set to <c>S16</c>,
-        /// raw 16-bit ADC samples are encoded as a <see cref="ushort"/>. In this case, the following
-        /// equation can be used to convert it to volts:
+        /// cref="OpenEphys.Onix1.AnalogInput"/> is set to <c>Volts</c>, each pre-converted voltage
+        /// value is encoded as a <see cref="float"/>. When <c>DataType</c> is set to <c>S16</c>,
+        /// each raw 16-bit ADC samples is encoded as a <see cref="short"/>. In this case, the
+        /// following equation can be used to convert it to volts:
         /// <code> 
-        /// V_analogInput (V) = VoltageRange / 2^16 × AdcSample 
+        /// Analog Voltage (V) = Voltage Range / 2^16 × ADC Sample 
         /// </code> 
         /// where voltage range can be 5, 10, or 20 depending on how the analog input voltage range
         /// is configured (±2.5, ±5, or ±10 volts) in <see
diff --git a/OpenEphys.Onix1/NeuropixelsV1DataFrame.cs b/OpenEphys.Onix1/NeuropixelsV1DataFrame.cs
@@ -44,7 +44,7 @@ public NeuropixelsV1DataFrame(ulong[] clock, ulong[] hubClock, int[] frameCount,
         /// encoded as a <see cref="ushort"/>. The following equation can be used to convert it to
         /// microvolts:
         /// <code> 
-        /// V_electrode (µV) = 1,171.875 / ApGain × (AdcSample – 512) 
+        /// Electrode Voltage (µV) = 1,171.875 / AP Gain × (ADC Sample – 512) 
         /// </code>
         /// where AP gain can be 50, 125, 250, 500, 1,000, 1,500, 2,000, or 3,000 depending on how
         /// it's configured in the <see
@@ -62,7 +62,7 @@ public NeuropixelsV1DataFrame(ulong[] clock, ulong[] hubClock, int[] frameCount,
         /// cref="DataFrame.HubClock"/>. Each ADC sample is a 10-bit offset, binary value encoded as
         /// a <see cref="ushort"/>. The following equation can be used to convert it to microvolts:
         /// <code> 
-        /// V_electrode (µV) = 1,171.875 / LfpGain × (AdcSample – 512) 
+        /// Electrode Voltage (µV) = 1,171.875 / LFP Gain × (ADC Sample – 512) 
         /// </code>
         /// where LFP gain can be 50, 125, 250, 500, 1,000, 1,500, 2,000, or 3,000 depending on how
         /// it's configured in the <see
diff --git a/OpenEphys.Onix1/NeuropixelsV2eBetaDataFrame.cs b/OpenEphys.Onix1/NeuropixelsV2eBetaDataFrame.cs
@@ -32,7 +32,7 @@ public NeuropixelsV2eBetaDataFrame(ulong[] clock, ulong[] hubClock, Mat amplifie
         /// cref="DataFrame.HubClock"/>. Each ADC sample is a 14-bit, offset binary value encoded
         /// as a <see cref="ushort"/>. The following equation can be used to convert it to microvolts:
         /// <code>
-        /// V_electrode (µV) = 0.76294 × (AdcSample – 8192)
+        /// Electrode Voltage (µV) = 0.76294 × (ADC Sample – 8192)
         /// </code>
         /// </remarks>
         public Mat AmplifierData { get; }
diff --git a/OpenEphys.Onix1/NeuropixelsV2eDataFrame.cs b/OpenEphys.Onix1/NeuropixelsV2eDataFrame.cs
@@ -30,7 +30,7 @@ public NeuropixelsV2eDataFrame(ulong[] clock, ulong[] hubClock, Mat amplifierDat
         /// cref="DataFrame.HubClock"/>. Each ADC sample is a 12-bit, offset binary value encoded
         /// as a <see cref="ushort"/>. The following equation can be used to convert it to microvolts:
         /// <code>
-        /// V_electrode (µV) = 3.05176 × (AdcSample – 2048)
+        /// Electrode Voltage (µV) = 3.05176 × (ADC Sample – 2048)
         /// </code>
         /// </remarks>
         public Mat AmplifierData { get; }
diff --git a/OpenEphys.Onix1/Nric1384DataFrame.cs b/OpenEphys.Onix1/Nric1384DataFrame.cs
@@ -46,7 +46,7 @@ public Nric1384DataFrame(ulong[] clock, ulong[] hubClock, int[] frameCount, Mat
         /// encoded as a <see cref="ushort"/>. The following equation can be used to convert it to
         /// microvolts:
         /// <code> 
-        /// V_electrode (µV) = 1,171.875 / ApGain × (AdcSample – 512) 
+        /// Electrode Voltage (µV) = 1,171.875 / AP Gain × (ADC Sample – 512) 
         /// </code>
         /// where AP gain can be 50, 125, 250, 500, 1,000, 1,500, 2,000, or 3,000 depending on how
         /// it's configured in <see cref="OpenEphys.Onix1.ConfigureNric1384"/> .
@@ -64,7 +64,7 @@ public Nric1384DataFrame(ulong[] clock, ulong[] hubClock, int[] frameCount, Mat
         /// cref="DataFrame.HubClock"/>. Each ADC sample is an 10-bit, offset binary value encoded
         /// as a <see cref="ushort"/>. The following equation can be used to convert it to microvolts:
         /// <code> 
-        /// V_electrode (µV) = 1,171.875 / LfpGain × (AdcSample – 512) 
+        /// Electrode Voltage (µV) = 1,171.875 / LFP Gain × (ADC Sample – 512) 
         /// </code>
         /// where LFP gain can be 50, 125, 250, 500, 1,000, 1,500, 2,000, or 3,000 depending on how
         /// it's configured in <see cref="OpenEphys.Onix1.ConfigureNric1384"/>.
diff --git a/OpenEphys.Onix1/Rhd2164DataFrame.cs b/OpenEphys.Onix1/Rhd2164DataFrame.cs
@@ -32,7 +32,7 @@ public Rhd2164DataFrame(ulong[] clock, ulong[] hubClock, Mat amplifierData, Mat
         /// cref="DataFrame.HubClock"/>. Each ADC sample is a 16-bit, offset binary value encoded
         /// as a <see cref="ushort"/>. TThe following equation can be used to convert it to microvolts:
         /// <code>
-        /// V_electrode (µV) = 0.195 × (AdcSample – 32768)
+        /// Electrode Voltage (µV) = 0.195 × (ADC Sample – 32768)
         /// </code>
         /// </remarks>
         public Mat AmplifierData { get; }
@@ -47,7 +47,7 @@ public Rhd2164DataFrame(ulong[] clock, ulong[] hubClock, Mat amplifierData, Mat
         /// cref="DataFrame.HubClock"/>. Each ADC sample is a 16-bit, offset binary value encoded
         /// as a <see cref="ushort"/>. The following equation can be used to convert it to microvolts:
         /// <code>
-        /// V_electrode (µV) = 0.195 × (AdcSample – 32768)
+        /// Electrode Voltage (µV) = 0.195 × (ADC Sample – 32768)
         /// </code>
         /// </remarks>
         public Mat AuxData { get; }
diff --git a/OpenEphys.Onix1/Rhs2116DataFrame.cs b/OpenEphys.Onix1/Rhs2116DataFrame.cs
@@ -32,7 +32,7 @@ public Rhs2116DataFrame(ulong[] clock, ulong[] hubClock, Mat amplifierData, Mat
         /// cref="DataFrame.HubClock"/>. Each ADC sample is an 16-bit, offset binary value encoded
         /// as a <see cref="ushort"/>. The following equation can be used to convert it to microvolts:
         /// <code>
-        /// V_electrode (µV) = 0.195 × (AdcSample – 32768)
+        /// Electrode Voltage (µV) = 0.195 × (ADC Sample – 32768)
         /// </code>
         /// </remarks>
         public Mat AmplifierData { get; }
@@ -47,7 +47,7 @@ public Rhs2116DataFrame(ulong[] clock, ulong[] hubClock, Mat amplifierData, Mat
         /// cref="DataFrame.HubClock"/>. Each ADC sample is a 16-bit, offset binary value encoded
         /// as a <see cref="ushort"/>. The following equation can be used to convert it to microvolts:
         /// <code>
-        /// V_electrode (mV) = -19.23 × (AdcSample – 512)
+        /// Electrode Voltage (mV) = -19.23 × (ADC Sample – 512)
         /// </code>
         /// </remarks>
         public Mat DCData { get; }
