Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Resolve issues in discussion of #189 #194

Merged
merged 3 commits into from
Aug 6, 2024
Merged

Resolve issues in discussion of #189 #194

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
de8af86
Resolve issues in discussion of #189
jonnew Aug 4, 2024
e2b7f72
Address review in #194
jonnew Aug 6, 2024
ee8a775
Minor wording review
glopesdev Aug 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion OpenEphys.Onix1/DeviceFactory.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ public abstract class DeviceFactory : Sink<ContextTask>

/// <summary>
/// Provides an abstract base class for configuration operators responsible for
/// registering a single device in the context device table.
/// registering a single device within an internal device manager.
jonnew marked this conversation as resolved.
Show resolved Hide resolved
/// </summary>
/// <remarks>
/// ONI devices usually require a specific sequence of configuration and parameterization
Expand Down
12 changes: 8 additions & 4 deletions OpenEphys.Onix1/MultiDeviceFactory.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ namespace OpenEphys.Onix1
{
/// <summary>
/// Provides an abstract base class for configuration operators responsible for
/// registering logical groups of <see cref="oni.Device"/>s.
/// registering all devices within a logical group within an internal device manager.
jonnew marked this conversation as resolved.
Show resolved Hide resolved
/// </summary>
/// <remarks>
/// <para>
Expand All @@ -16,11 +16,12 @@ namespace OpenEphys.Onix1
/// and usually require a specific sequence of configuration steps prior to acquisition.
/// </para>
/// <para>
/// This class allows configuration of logical device groups of <see cref="oni.Device"/>s across ONI-defined
/// This class allows configuration of logical groups of devices within or across ONI-defined
/// hubs. For instance, the group of devices within a headstage (a single hub) can be combined with a device
/// from another hub that is used to control its port voltage and communication status
/// (e.g. <see cref="ConfigureHeadstage64"/>). Alternatively, diagnostic devices that are present within
/// an ONI hub can be omitted from a device group to aid its useability (e.g. <see cref="ConfigureBreakoutBoard"/>).
/// an ONI hub can be omitted from a device group to aid its usability (e.g. <see cref="ConfigureBreakoutBoard"/>).
/// Of course, all devices within to a single hub can also be grouped without modification.
jonnew marked this conversation as resolved.
Show resolved Hide resolved
/// </para>
/// <para>
/// These device groups are the most common starting point for configuration
Expand All @@ -43,7 +44,10 @@ internal MultiDeviceFactory()
/// <summary>
/// Gets or sets a unique device group name.
/// </summary>
/// <inheritdoc cref = "SingleDeviceFactory.DeviceName"/>
/// <remarks>
/// A human-readable identifier that is used as a prefix for
/// the <see cref="SingleDeviceFactory.DeviceName"/> of each device in the the group.
/// </remarks>
[Description("The unique device group name.")]
public string Name
{
Expand Down