Skip to content

Commit

Permalink
Address review comments
Browse files Browse the repository at this point in the history
- Fix many typos in CreateContext XML comments
  • Loading branch information
jonnew committed Sep 4, 2024
1 parent a8a4879 commit 834adef
Showing 1 changed file with 19 additions and 15 deletions.
34 changes: 19 additions & 15 deletions OpenEphys.Onix1/CreateContext.cs
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,19 @@
namespace OpenEphys.Onix1
{
/// <summary>
/// Creates a <see cref="ContextTask"/> to that orchestrates data acquisition for single ONIX.
/// Creates a <see cref="ContextTask"/> that orchestrates data acquisition for an ONIX system.
/// </summary>
/// <remarks>
/// ONIX is built on top of the <see href="https://open-ephys.github.io/ONI/">ONI</see> hardware specification and API.
/// One of ONI's requirements is the creation of a context that holds information that used for communication between the
/// computer and ONI-compliant hardware. The context holds data such as the device driver that will be used to communicate
/// with hardware, what devices (e.g. headstages) are currently attached to the hardware, how often data should be read
/// from hardware, the run state of the system, etc. <see cref="ContextTask"/> creates a ONI context for a single ONIX
/// system. The system is uniquely identified with a host computer by the <see cref="Driver"/> used to communicate with
/// hardware and the <see cref="Index"/>, which is a enumeration that is translated by the driver into a physical location
/// (e.g. a particular PCIe slot) that the hardware uses to communicate with the host computer.
/// ONIX is built on top of the <see href="https://open-ephys.github.io/ONI/">Open Neuro Interface
/// (ONI)</see> hardware specification and API. One of ONI's requirements is the creation of a "context"
/// that holds information needed for communication between a host computer and ONI-compliant hardware.
/// The context holds data such as the device driver that will be used to communicate with hardware, what
/// devices (e.g. headstages and their internal components) are currently connected, how
/// often data should be read by the host computer, etc. <see cref="CreateContext"/> creates this required
/// ONI context for a single ONIX system. The ONIX system that the context serves is uniquely identified
/// within a host computer by the <see cref="Driver"/> used to communicate with hardware and the <see
/// cref="Index"/>, which is a enumeration that is translated by the driver into a physical interface
/// (e.g. a particular PCIe slot) within the host computer.
/// </remarks>
[Description("Creates a ContextTask to orchestrate a single ONI-compliant controller using the specified device driver and host interconnect.")]
[Combinator(MethodName = nameof(Generate))]
Expand All @@ -34,10 +36,12 @@ public class CreateContext
/// Gets or sets the index of the host interconnect between the ONI controller and host computer.
/// </summary>
/// <remarks>
/// For instance, 0 could correspond to a particular PCIe slot or USB port as enumerated by the operating system and translated by an
/// <see href="https://open-ephys.github.io/ONI/api/liboni/driver-translators/index.html#drivers">ONI device driver translator</see>.
/// A value of -1 will attempt to open the default index and is useful if there is only a single ONI controller
/// managed by the specified selected <see cref="Driver"/> in the host computer.
/// For instance, 0 could correspond to a particular PCIe slot or USB port as enumerated by the
/// operating system and translated by an <see
/// href="https://open-ephys.github.io/ONI/api/liboni/driver-translators/index.html#drivers">ONI
/// device driver translator</see>. A value of -1 will attempt to open the default index and is useful
/// if there is only a single ONI controller managed by the specified selected <see cref="Driver"/> in
/// the host computer.
/// </remarks>
[Description("The index of the host interconnect between the ONI controller and host computer.")]
[Category(DeviceFactory.ConfigurationCategory)]
Expand All @@ -47,8 +51,8 @@ public class CreateContext
/// Generates a sequence that creates a new <see cref="ContextTask"/> object.
/// </summary>
/// <returns>
/// A sequence containing a single instance of the <see cref="ContextTask"/> class. Cancelling the sequence
/// will dispose of the created context.
/// A sequence containing a single instance of the <see cref="ContextTask"/> class. Cancelling the
/// sequence will dispose of the created context.
/// </returns>
public IObservable<ContextTask> Generate()
{
Expand Down

0 comments on commit 834adef

Please sign in to comment.