Fixed spacing, and updated namespace to match solution

open-ephys · Aug 14, 2024 · 2c9a3eb · 2c9a3eb
1 parent 4110ce0
commit 2c9a3eb
Show file tree

Hide file tree

Showing 9 changed files with 15 additions and 24 deletions.
diff --git a/OpenEphys.ProbeInterface.NET/Contact.cs b/OpenEphys.ProbeInterface.NET/Contact.cs
@@ -1,4 +1,4 @@
-namespace OpenEphys.ProbeInterface
+namespace OpenEphys.ProbeInterface.NET
 {
     /// <summary>
     /// Struct that extends the Probeinterface specification by encapsulating all values for a single contact.

diff --git a/OpenEphys.ProbeInterface.NET/ContactAnnotations.cs b/OpenEphys.ProbeInterface.NET/ContactAnnotations.cs
@@ -1,6 +1,6 @@
 using Newtonsoft.Json;
 
-namespace OpenEphys.ProbeInterface
+namespace OpenEphys.ProbeInterface.NET
 {
     /// <summary>
     /// Class holding all of the annotations for each contact.

diff --git a/OpenEphys.ProbeInterface.NET/ContactShape.cs b/OpenEphys.ProbeInterface.NET/ContactShape.cs
@@ -2,7 +2,7 @@
 using Newtonsoft.Json;
 using Newtonsoft.Json.Converters;
 
-namespace OpenEphys.ProbeInterface
+namespace OpenEphys.ProbeInterface.NET
 {
     /// <summary>
     /// Shape of the contact.

diff --git a/OpenEphys.ProbeInterface.NET/ContactShapeParam.cs b/OpenEphys.ProbeInterface.NET/ContactShapeParam.cs
@@ -1,6 +1,6 @@
 using Newtonsoft.Json;
 
-namespace OpenEphys.ProbeInterface
+namespace OpenEphys.ProbeInterface.NET
 {
     /// <summary>
     /// Class holding parameters used to draw the contact.

diff --git a/OpenEphys.ProbeInterface.NET/Probe.cs b/OpenEphys.ProbeInterface.NET/Probe.cs
@@ -1,15 +1,13 @@
 using System.Xml.Serialization;
-using System.CodeDom.Compiler;
 using Newtonsoft.Json;
 
-namespace OpenEphys.ProbeInterface
+namespace OpenEphys.ProbeInterface.NET
 {
     /// <summary>
     /// Class that implements the Probe Interface specification for a Probe.
     /// </summary>
     public class Probe
     {
-
         /// <summary>
         /// Gets the <see cref="ProbeNdim"/> to use while plotting the <see cref="Probe"/>.
         /// </summary>
@@ -35,7 +33,7 @@ public class Probe
         public ProbeAnnotations Annotations { get; protected set; }
 
         /// <summary>
-        /// Gets the <see cref="ProbeInterface.ContactAnnotations"/> for the <see cref="Probe"/>.
+        /// Gets the <see cref="ContactAnnotations.ContactAnnotations"/> for the <see cref="Probe"/>.
         /// </summary>
         /// <remarks>
         /// 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
         [JsonProperty("contact_plane_axes")]
         public float[][][] ContactPlaneAxes { get; protected set; }
 
-
         /// <summary>
         /// Gets the <see cref="ContactShape"/> for each contact.
         /// </summary>
@@ -84,7 +81,6 @@ public class Probe
         [JsonProperty("contact_shape_params", Required = Required.Always)]
         public ContactShapeParam[] ContactShapeParams { get; protected set; }
 
-
         /// <summary>
         /// Gets the outline of the probe that represents the physical shape.
         /// </summary>
@@ -114,7 +110,6 @@ public class Probe
         [JsonProperty("shank_ids")]
         public string[] ShankIds { get; internal set; }
 
-
         /// <summary>
         /// Public constructor, defined as the default Json constructor.
         /// </summary>
@@ -264,11 +259,11 @@ public static ContactShapeParam[] DefaultRectParams(int numberOfContacts, float
         }
 
         /// <summary>
-        /// Returns a default array of sequential <see cref="Probe.DeviceChannelIndices"/>.
+        /// Returns a default array of sequential <see cref="DeviceChannelIndices"/>.
         /// </summary>
         /// <param name="numberOfContacts">Number of contacts in a single <see cref="Probe"/>.</param>
-        /// <param name="offset">The first value of the <see cref="Probe.DeviceChannelIndices"/>.</param>
-        /// <returns>A serially increasing array of <see cref="Probe.DeviceChannelIndices"/>.</returns>
+        /// <param name="offset">The first value of the <see cref="DeviceChannelIndices"/>.</param>
+        /// <returns>A serially increasing array of <see cref="DeviceChannelIndices"/>.</returns>
         public static int[] DefaultDeviceChannelIndices(int numberOfContacts, int offset)
         {
             int[] deviceChannelIndices = new int[numberOfContacts];
@@ -282,10 +277,10 @@ public static int[] DefaultDeviceChannelIndices(int numberOfContacts, int offset
         }
 
         /// <summary>
-        /// Returns a sequential array of <see cref="Probe.ContactIds"/>.
+        /// Returns a sequential array of <see cref="ContactIds"/>.
         /// </summary>
         /// <param name="numberOfContacts">Number of contacts in a single <see cref="Probe"/>.</param>
-        /// <returns>Array of strings defining the <see cref="Probe.ContactIds"/>.</returns>
+        /// <returns>Array of strings defining the <see cref="ContactIds"/>.</returns>
         public static string[] DefaultContactIds(int numberOfContacts)
         {
             string[] contactIds = new string[numberOfContacts];

diff --git a/OpenEphys.ProbeInterface.NET/ProbeAnnotations.cs b/OpenEphys.ProbeInterface.NET/ProbeAnnotations.cs
@@ -1,6 +1,6 @@
 using Newtonsoft.Json;
 
-namespace OpenEphys.ProbeInterface
+namespace OpenEphys.ProbeInterface.NET
 {
     /// <summary>
     /// Class holding the <see cref="Probe"/> annotations.

diff --git a/OpenEphys.ProbeInterface.NET/ProbeGroup.cs b/OpenEphys.ProbeInterface.NET/ProbeGroup.cs
@@ -4,15 +4,13 @@
 using Newtonsoft.Json;
 using System;
 
-namespace OpenEphys.ProbeInterface
+namespace OpenEphys.ProbeInterface.NET
 {
     /// <summary>
     /// Abstract class that implements the Probeinterface specification in C# for .NET.
     /// </summary>
     public abstract class ProbeGroup
     {
-        //private IEnumerable<Probe> Probes;
-
         /// <summary>
         /// Gets the string defining the specification of the file.
         /// </summary>
@@ -42,7 +40,6 @@ public abstract class ProbeGroup
         [JsonProperty("probes", Required = Required.Always)]
         public IEnumerable<Probe> Probes { get; protected set; }
 
-
         /// <summary>
         /// Initializes a new instance of the <see cref="ProbeGroup"/> class.
         /// </summary>
@@ -80,7 +77,6 @@ protected ProbeGroup(ProbeGroup probeGroup)
         /// </summary>
         public int NumberOfContacts => Probes.Aggregate(0, (total, next) => total + next.NumberOfContacts);
 
-
         /// <summary>
         /// Returns the <see cref="Probe.ContactIds"/>'s of all contacts in all probes.
         /// </summary>

diff --git a/OpenEphys.ProbeInterface.NET/ProbeNdim.cs b/OpenEphys.ProbeInterface.NET/ProbeNdim.cs
@@ -1,6 +1,6 @@
 using System.Runtime.Serialization;
 
-namespace OpenEphys.ProbeInterface
+namespace OpenEphys.ProbeInterface.NET
 {
     /// <summary>
     /// Number of dimensions to use while plotting a <see cref="Probe"/>.

diff --git a/OpenEphys.ProbeInterface.NET/ProbeSiUnits.cs b/OpenEphys.ProbeInterface.NET/ProbeSiUnits.cs
@@ -2,7 +2,7 @@
 using Newtonsoft.Json;
 using Newtonsoft.Json.Converters;
 
-namespace OpenEphys.ProbeInterface
+namespace OpenEphys.ProbeInterface.NET
 {
     /// <summary>
     /// SI units for all values relating to location and position.