Skip to content

Commit 8ffa16c

Browse files
bparks13bparks13
committed
Add XML comments to public interface
- Consolidated XML comments, now the summary is inherited from the interface for shared properties of NeuropixelsV2 devices
1 parent 80651e2 commit 8ffa16c

File tree

3 files changed

+32
-30
lines changed

3 files changed

+32
-30
lines changed

‎OpenEphys.Onix1/ConfigureNeuropixelsV2e.cs‎

Lines changed: 5 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,7 @@ public ConfigureNeuropixelsV2e(ConfigureNeuropixelsV2e configureNode)
3737
DeviceAddress = configureNode.DeviceAddress;
3838
}
3939

40-
/// <summary>
41-
/// Gets or sets the device enable state.
42-
/// </summary>
40+
/// <inheritdoc/>
4341
/// <remarks>
4442
/// If set to true, <see cref="NeuropixelsV2eData"/> will produce data. If set to false,
4543
/// <see cref="NeuropixelsV2eData"/> will not produce data.
@@ -48,9 +46,7 @@ public ConfigureNeuropixelsV2e(ConfigureNeuropixelsV2e configureNode)
4846
[Description("Specifies whether the NeuropixelsV2 device is enabled.")]
4947
public bool Enable { get; set; } = true;
5048

51-
/// <summary>
52-
/// Gets or sets the electrode configuration for Probe A.
53-
/// </summary>
49+
/// <inheritdoc/>
5450
/// <remarks>
5551
/// Configuration is accomplished using a GUI to aid in channel selection and relevant configuration properties.
5652
/// To open a probe configuration GUI, select the ellipses next the <see cref="ProbeConfigurationA"/> variable
@@ -62,9 +58,7 @@ public ConfigureNeuropixelsV2e(ConfigureNeuropixelsV2e configureNode)
6258
[Editor("OpenEphys.Onix1.Design.NeuropixelsV2eProbeConfigurationEditor, OpenEphys.Onix1.Design", typeof(UITypeEditor))]
6359
public NeuropixelsV2QuadShankProbeConfiguration ProbeConfigurationA { get; set; } = new(NeuropixelsV2Probe.ProbeA);
6460

65-
/// <summary>
66-
/// Gets or sets the path to the gain calibration file for Probe A.
67-
/// </summary>
61+
/// <inheritdoc/>
6862
/// <remarks>
6963
/// <para>
7064
/// Each probe is linked to a gain calibration file that contains gain adjustments determined by IMEC during
@@ -83,9 +77,7 @@ public ConfigureNeuropixelsV2e(ConfigureNeuropixelsV2e configureNode)
8377
[Editor("Bonsai.Design.OpenFileNameEditor, Bonsai.Design", DesignTypes.UITypeEditor)]
8478
public string GainCalibrationFileA { get; set; }
8579

86-
/// <summary>
87-
/// Gets or sets the electrode configuration for Probe B.
88-
/// </summary>
80+
/// <inheritdoc/>
8981
/// <remarks>
9082
/// Configuration is accomplished using a GUI to aid in channel selection and relevant configuration properties.
9183
/// To open a probe configuration GUI, select the ellipses next the <see cref="ProbeConfigurationB"/> variable
@@ -97,9 +89,7 @@ public ConfigureNeuropixelsV2e(ConfigureNeuropixelsV2e configureNode)
9789
[Editor("OpenEphys.Onix1.Design.NeuropixelsV2eProbeConfigurationEditor, OpenEphys.Onix1.Design", typeof(UITypeEditor))]
9890
public NeuropixelsV2QuadShankProbeConfiguration ProbeConfigurationB { get; set; } = new(NeuropixelsV2Probe.ProbeB);
9991

100-
/// <summary>
101-
/// Gets or sets the path to the gain calibration file for Probe B.
102-
/// </summary>
92+
/// <inheritdoc/>
10393
/// <remarks>
10494
/// <para>
10595
/// Each probe is linked to a gain calibration file that contains gain adjustments determined by IMEC during

‎OpenEphys.Onix1/ConfigureNeuropixelsV2eBeta.cs‎

Lines changed: 5 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -38,9 +38,7 @@ public ConfigureNeuropixelsV2eBeta(ConfigureNeuropixelsV2eBeta configureNode)
3838
DeviceAddress = configureNode.DeviceAddress;
3939
}
4040

41-
/// <summary>
42-
/// Gets or sets the device enable state.
43-
/// </summary>
41+
/// <inheritdoc/>
4442
/// <remarks>
4543
/// If set to true, <see cref="NeuropixelsV2eBetaData"/> will produce data. If set to false,
4644
/// <see cref="NeuropixelsV2eBetaData"/> will not produce data.
@@ -59,9 +57,7 @@ public ConfigureNeuropixelsV2eBeta(ConfigureNeuropixelsV2eBeta configureNode)
5957
[Description("If true, the headstage LED will turn on during data acquisition. If false, the LED will not turn on.")]
6058
public bool EnableLed { get; set; } = true;
6159

62-
/// <summary>
63-
/// Gets or sets the electrode configuration for Probe A.
64-
/// </summary>
60+
/// <inheritdoc/>
6561
/// <remarks>
6662
/// Configuration is accomplished using a GUI to aid in channel selection and relevant configuration properties.
6763
/// To open a probe configuration GUI, select the ellipses next the <see cref="ProbeConfigurationA"/> variable
@@ -73,9 +69,7 @@ public ConfigureNeuropixelsV2eBeta(ConfigureNeuropixelsV2eBeta configureNode)
7369
[Editor("OpenEphys.Onix1.Design.NeuropixelsV2eProbeConfigurationEditor, OpenEphys.Onix1.Design", typeof(UITypeEditor))]
7470
public NeuropixelsV2QuadShankProbeConfiguration ProbeConfigurationA { get; set; } = new(NeuropixelsV2Probe.ProbeA);
7571

76-
/// <summary>
77-
/// Gets or sets the path to the gain calibration file for Probe A.
78-
/// </summary>
72+
/// <inheritdoc/>
7973
/// <remarks>
8074
/// <para>
8175
/// Each probe is linked to a gain calibration file that contains gain adjustments determined by IMEC during
@@ -94,9 +88,7 @@ public ConfigureNeuropixelsV2eBeta(ConfigureNeuropixelsV2eBeta configureNode)
9488
[Editor("Bonsai.Design.OpenFileNameEditor, Bonsai.Design", DesignTypes.UITypeEditor)]
9589
public string GainCalibrationFileA { get; set; }
9690

97-
/// <summary>
98-
/// Gets or sets the electrode configuration for Probe B.
99-
/// </summary>
91+
/// <inheritdoc/>
10092
/// <remarks>
10193
/// Configuration is accomplished using a GUI to aid in channel selection and relevant configuration properties.
10294
/// To open a probe configuration GUI, select the ellipses next the <see cref="ProbeConfigurationB"/> variable
@@ -108,9 +100,7 @@ public ConfigureNeuropixelsV2eBeta(ConfigureNeuropixelsV2eBeta configureNode)
108100
[Editor("OpenEphys.Onix1.Design.NeuropixelsV2eProbeConfigurationEditor, OpenEphys.Onix1.Design", typeof(UITypeEditor))]
109101
public NeuropixelsV2QuadShankProbeConfiguration ProbeConfigurationB { get; set; } = new(NeuropixelsV2Probe.ProbeB);
110102

111-
/// <summary>
112-
/// Gets or sets the path to the gain calibration file for Probe B.
113-
/// </summary>
103+
/// <inheritdoc/>
114104
/// <remarks>
115105
/// <para>
116106
/// Each probe is linked to a gain calibration file that contains gain adjustments determined by IMEC during

‎OpenEphys.Onix1/IConfigureNeuropixelsV2.cs‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,33 @@
11
namespace OpenEphys.Onix1
22
{
3+
/// <summary>
4+
/// Public interface that defines common properties in NeuropixelsV2 devices.
5+
/// </summary>
36
public interface IConfigureNeuropixelsV2
47
{
8+
/// <summary>
9+
/// Gets or sets the device enable state.
10+
/// </summary>
511
public bool Enable { get; set; }
12+
13+
/// <summary>
14+
/// Gets or sets the electrode configuration for Probe A.
15+
/// </summary>
616
public NeuropixelsV2QuadShankProbeConfiguration ProbeConfigurationA { get; set; }
17+
18+
/// <summary>
19+
/// Gets or sets the path to the gain calibration file for Probe A.
20+
/// </summary>
721
public string GainCalibrationFileA { get; set; }
22+
23+
/// <summary>
24+
/// Gets or sets the electrode configuration for Probe B.
25+
/// </summary>
826
public NeuropixelsV2QuadShankProbeConfiguration ProbeConfigurationB { get; set; }
27+
28+
/// <summary>
29+
/// Gets or sets the path to the gain calibration file for Probe B.
30+
/// </summary>
931
public string GainCalibrationFileB { get; set; }
1032
}
1133
}

0 commit comments

Comments
 (0)