Skip to content

Commit 5ed0c9e

Browse files
committed
Finish missing XML comments for neuropixels gain files
- I only updated the description for one of the files in both the Neuropixles2.0e and 2.0ebeta configuration operators
1 parent 13f7262 commit 5ed0c9e

File tree

2 files changed

+20
-10
lines changed

2 files changed

+20
-10
lines changed

OpenEphys.Onix1/ConfigureNeuropixelsV2e.cs

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -41,11 +41,16 @@ public ConfigureNeuropixelsV2e()
4141
/// Gets or sets the path to the gain calibration file for Probe A.
4242
/// </summary>
4343
/// <remarks>
44-
/// Each probe is linked to a gain calibration file that contains a gain adjustments determined by IMEC during
44+
/// <para>
45+
/// Each probe is linked to a gain calibration file that contains gain adjustments determined by IMEC during
4546
/// factory testing. Electrode voltages are scaled using these values to ensure they can be accurately compared
4647
/// across probes. Therefore, using the correct gain calibration file is mandatory to create standardized recordings.
47-
/// If you have lost track of the gain calibration file for your probe, you can email IMEC at [email protected]
48-
/// with the probe serial number to retrieve a new copy.
48+
/// </para>
49+
/// <para>
50+
/// Calibration files are probe-specific and not interchangeable across probes. Calibration files must contain the
51+
/// serial number of the corresponding probe on their first line of text. If you have lost track of a calibration
52+
/// file for your probe, email IMEC at [email protected] with the probe serial number to retrieve a new copy.
53+
/// </para>
4954
/// </remarks>
5055
[FileNameFilter("Gain calibration files (*_gainCalValues.csv)|*_gainCalValues.csv")]
5156
[Description("Path to the gain calibration file for probe A.")]
@@ -69,8 +74,8 @@ public ConfigureNeuropixelsV2e()
6974
/// across probes. Therefore, using the correct gain calibration file is mandatory to create standardized recordings.
7075
/// </para>
7176
/// <para>
72-
/// Calibration files are probe-specific and not interchangeable across probes. Calibration files must contain the
73-
/// serial number of the corresponding probe on their first line of text. If you have lost track of a calibration
77+
/// Calibration files are probe-specific and not interchangeable across probes. Calibration files must contain the
78+
/// serial number of the corresponding probe on their first line of text. If you have lost track of a calibration
7479
/// file for your probe, email IMEC at [email protected] with the probe serial number to retrieve a new copy.
7580
/// </para>
7681
/// </remarks>

OpenEphys.Onix1/ConfigureNeuropixelsV2eBeta.cs

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -57,8 +57,8 @@ public ConfigureNeuropixelsV2eBeta()
5757
/// across probes. Therefore, using the correct gain calibration file is mandatory to create standardized recordings.
5858
/// </para>
5959
/// <para>
60-
/// Calibration files are probe-specific and not interchangeable across probes. Calibration files must contain the
61-
/// serial number of the corresponding probe on their first line of text. If you have lost track of a calibration
60+
/// Calibration files are probe-specific and not interchangeable across probes. Calibration files must contain the
61+
/// serial number of the corresponding probe on their first line of text. If you have lost track of a calibration
6262
/// file for your probe, email IMEC at [email protected] with the probe serial number to retrieve a new copy.
6363
/// </para>
6464
/// </remarks>
@@ -78,11 +78,16 @@ public ConfigureNeuropixelsV2eBeta()
7878
/// Gets or sets the path to the gain calibration file for Probe B.
7979
/// </summary>
8080
/// <remarks>
81-
/// Each probe is linked to a gain calibration file that contains a gain adjustments determined by IMEC during
81+
/// <para>
82+
/// Each probe is linked to a gain calibration file that contains gain adjustments determined by IMEC during
8283
/// factory testing. Electrode voltages are scaled using these values to ensure they can be accurately compared
8384
/// across probes. Therefore, using the correct gain calibration file is mandatory to create standardized recordings.
84-
/// If you have lost track of the gain calibration file for your probe, you can email IMEC at [email protected]
85-
/// with the probe serial number to retrieve a new copy.
85+
/// </para>
86+
/// <para>
87+
/// Calibration files are probe-specific and not interchangeable across probes. Calibration files must contain the
88+
/// serial number of the corresponding probe on their first line of text. If you have lost track of a calibration
89+
/// file for your probe, email IMEC at [email protected] with the probe serial number to retrieve a new copy.
90+
/// </para>
8691
/// </remarks>
8792
[FileNameFilter("Gain calibration files (*_gainCalValues.csv)|*_gainCalValues.csv")]
8893
[Description("Path to the gain calibration file for probe B.")]

0 commit comments

Comments
 (0)