Skip to content

Commit 91b1bec

Browse files
committed
Reduce API surface and edit XML comments
- Mark EquivalentDataSource.BaseType as internal
1 parent 4be8113 commit 91b1bec

File tree

1 file changed

+9
-15
lines changed

1 file changed

+9
-15
lines changed

OpenEphys.Onix1/EquivalentDataSource.cs

Lines changed: 9 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,26 @@
11
using System;
2-
using System.Collections.Generic;
3-
using System.Linq;
4-
using System.Text;
5-
using System.Threading.Tasks;
62

73
namespace OpenEphys.Onix1
84
{
95
/// <summary>
106
/// Specifies a device class as equivalent to another for data production
117
/// </summary>
128
/// <remarks>
13-
/// This attribute must be used on the static classes that specify
14-
/// the device IDs and name converters to mark it as equivalent to
15-
/// another.
16-
///
17-
/// This will be used only for data production and name converters
18-
///
19-
/// The method <see cref="ContextHelper.CheckDeviceType(Type, Type)"/>
20-
/// can be used to check for type or equivalent type matching
9+
/// This attribute can be used on a static class that specifies device constants (e.g. ID, register
10+
/// addresses, etc) to indicate that another device produces equivalent <see
11+
/// cref="oni.Frame">oni.Frames</see> and, therefore, that both devices a common (set of) production
12+
/// operator(s). This attribute is used by <see cref="DeviceNameConverter"/> to identify devices that can
13+
/// make use of a given data production operator.
2114
/// </remarks>
2215
[AttributeUsage(AttributeTargets.Class, AllowMultiple = true, Inherited = false)]
2316
public sealed class EquivalentDataSource : Attribute
2417
{
18+
internal Type BaseType { get; }
19+
2520
/// <summary>
26-
/// The original type the tagged class is equivalent to
21+
/// Initializes a new instance of the <see cref="EquivalentDataSource"/> class.
2722
/// </summary>
28-
public Type BaseType { get; }
29-
23+
/// <param name="baseType">Device type that produces equivalent <see cref="oni.Frame">oni.Frames</see></param>
3024
public EquivalentDataSource(Type baseType)
3125
{
3226
BaseType = baseType;

0 commit comments

Comments
 (0)