Skip to content

Commit 2c9a3eb

Browse files
committed
Fixed spacing, and updated namespace to match solution
1 parent 4110ce0 commit 2c9a3eb

9 files changed

+15
-24
lines changed

OpenEphys.ProbeInterface.NET/Contact.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
namespace OpenEphys.ProbeInterface
1+
namespace OpenEphys.ProbeInterface.NET
22
{
33
/// <summary>
44
/// Struct that extends the Probeinterface specification by encapsulating all values for a single contact.

OpenEphys.ProbeInterface.NET/ContactAnnotations.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
using Newtonsoft.Json;
22

3-
namespace OpenEphys.ProbeInterface
3+
namespace OpenEphys.ProbeInterface.NET
44
{
55
/// <summary>
66
/// Class holding all of the annotations for each contact.

OpenEphys.ProbeInterface.NET/ContactShape.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
using Newtonsoft.Json;
33
using Newtonsoft.Json.Converters;
44

5-
namespace OpenEphys.ProbeInterface
5+
namespace OpenEphys.ProbeInterface.NET
66
{
77
/// <summary>
88
/// Shape of the contact.

OpenEphys.ProbeInterface.NET/ContactShapeParam.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
using Newtonsoft.Json;
22

3-
namespace OpenEphys.ProbeInterface
3+
namespace OpenEphys.ProbeInterface.NET
44
{
55
/// <summary>
66
/// Class holding parameters used to draw the contact.

OpenEphys.ProbeInterface.NET/Probe.cs

+7-12
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,13 @@
11
using System.Xml.Serialization;
2-
using System.CodeDom.Compiler;
32
using Newtonsoft.Json;
43

5-
namespace OpenEphys.ProbeInterface
4+
namespace OpenEphys.ProbeInterface.NET
65
{
76
/// <summary>
87
/// Class that implements the Probe Interface specification for a Probe.
98
/// </summary>
109
public class Probe
1110
{
12-
1311
/// <summary>
1412
/// Gets the <see cref="ProbeNdim"/> to use while plotting the <see cref="Probe"/>.
1513
/// </summary>
@@ -35,7 +33,7 @@ public class Probe
3533
public ProbeAnnotations Annotations { get; protected set; }
3634

3735
/// <summary>
38-
/// Gets the <see cref="ProbeInterface.ContactAnnotations"/> for the <see cref="Probe"/>.
36+
/// Gets the <see cref="ContactAnnotations.ContactAnnotations"/> for the <see cref="Probe"/>.
3937
/// </summary>
4038
/// <remarks>
4139
/// This field can be used for noting things like where it physically is within a specimen, or if it
@@ -63,7 +61,6 @@ public class Probe
6361
[JsonProperty("contact_plane_axes")]
6462
public float[][][] ContactPlaneAxes { get; protected set; }
6563

66-
6764
/// <summary>
6865
/// Gets the <see cref="ContactShape"/> for each contact.
6966
/// </summary>
@@ -84,7 +81,6 @@ public class Probe
8481
[JsonProperty("contact_shape_params", Required = Required.Always)]
8582
public ContactShapeParam[] ContactShapeParams { get; protected set; }
8683

87-
8884
/// <summary>
8985
/// Gets the outline of the probe that represents the physical shape.
9086
/// </summary>
@@ -114,7 +110,6 @@ public class Probe
114110
[JsonProperty("shank_ids")]
115111
public string[] ShankIds { get; internal set; }
116112

117-
118113
/// <summary>
119114
/// Public constructor, defined as the default Json constructor.
120115
/// </summary>
@@ -264,11 +259,11 @@ public static ContactShapeParam[] DefaultRectParams(int numberOfContacts, float
264259
}
265260

266261
/// <summary>
267-
/// Returns a default array of sequential <see cref="Probe.DeviceChannelIndices"/>.
262+
/// Returns a default array of sequential <see cref="DeviceChannelIndices"/>.
268263
/// </summary>
269264
/// <param name="numberOfContacts">Number of contacts in a single <see cref="Probe"/>.</param>
270-
/// <param name="offset">The first value of the <see cref="Probe.DeviceChannelIndices"/>.</param>
271-
/// <returns>A serially increasing array of <see cref="Probe.DeviceChannelIndices"/>.</returns>
265+
/// <param name="offset">The first value of the <see cref="DeviceChannelIndices"/>.</param>
266+
/// <returns>A serially increasing array of <see cref="DeviceChannelIndices"/>.</returns>
272267
public static int[] DefaultDeviceChannelIndices(int numberOfContacts, int offset)
273268
{
274269
int[] deviceChannelIndices = new int[numberOfContacts];
@@ -282,10 +277,10 @@ public static int[] DefaultDeviceChannelIndices(int numberOfContacts, int offset
282277
}
283278

284279
/// <summary>
285-
/// Returns a sequential array of <see cref="Probe.ContactIds"/>.
280+
/// Returns a sequential array of <see cref="ContactIds"/>.
286281
/// </summary>
287282
/// <param name="numberOfContacts">Number of contacts in a single <see cref="Probe"/>.</param>
288-
/// <returns>Array of strings defining the <see cref="Probe.ContactIds"/>.</returns>
283+
/// <returns>Array of strings defining the <see cref="ContactIds"/>.</returns>
289284
public static string[] DefaultContactIds(int numberOfContacts)
290285
{
291286
string[] contactIds = new string[numberOfContacts];

OpenEphys.ProbeInterface.NET/ProbeAnnotations.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
using Newtonsoft.Json;
22

3-
namespace OpenEphys.ProbeInterface
3+
namespace OpenEphys.ProbeInterface.NET
44
{
55
/// <summary>
66
/// Class holding the <see cref="Probe"/> annotations.

OpenEphys.ProbeInterface.NET/ProbeGroup.cs

+1-5
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,13 @@
44
using Newtonsoft.Json;
55
using System;
66

7-
namespace OpenEphys.ProbeInterface
7+
namespace OpenEphys.ProbeInterface.NET
88
{
99
/// <summary>
1010
/// Abstract class that implements the Probeinterface specification in C# for .NET.
1111
/// </summary>
1212
public abstract class ProbeGroup
1313
{
14-
//private IEnumerable<Probe> Probes;
15-
1614
/// <summary>
1715
/// Gets the string defining the specification of the file.
1816
/// </summary>
@@ -42,7 +40,6 @@ public abstract class ProbeGroup
4240
[JsonProperty("probes", Required = Required.Always)]
4341
public IEnumerable<Probe> Probes { get; protected set; }
4442

45-
4643
/// <summary>
4744
/// Initializes a new instance of the <see cref="ProbeGroup"/> class.
4845
/// </summary>
@@ -80,7 +77,6 @@ protected ProbeGroup(ProbeGroup probeGroup)
8077
/// </summary>
8178
public int NumberOfContacts => Probes.Aggregate(0, (total, next) => total + next.NumberOfContacts);
8279

83-
8480
/// <summary>
8581
/// Returns the <see cref="Probe.ContactIds"/>'s of all contacts in all probes.
8682
/// </summary>

OpenEphys.ProbeInterface.NET/ProbeNdim.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
using System.Runtime.Serialization;
22

3-
namespace OpenEphys.ProbeInterface
3+
namespace OpenEphys.ProbeInterface.NET
44
{
55
/// <summary>
66
/// Number of dimensions to use while plotting a <see cref="Probe"/>.

OpenEphys.ProbeInterface.NET/ProbeSiUnits.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
using Newtonsoft.Json;
33
using Newtonsoft.Json.Converters;
44

5-
namespace OpenEphys.ProbeInterface
5+
namespace OpenEphys.ProbeInterface.NET
66
{
77
/// <summary>
88
/// SI units for all values relating to location and position.

0 commit comments

Comments
 (0)