Skip to content

Commit

Permalink
[Docs] Improved help on ITimedObject.Time and ILengthedObject.Length
Browse files Browse the repository at this point in the history
  • Loading branch information
melanchall committed Feb 3, 2024
1 parent 1c47c70 commit 95f8b92
Show file tree
Hide file tree
Showing 6 changed files with 48 additions and 0 deletions.
10 changes: 10 additions & 0 deletions DryWetMidi/Interaction/Chords/Chord.cs
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,11 @@ public Chord(IEnumerable<Note> notes, long time)
/// <summary>
/// Gets or sets absolute time of the chord in units defined by the time division of a MIDI file.
/// </summary>
/// <remarks>
/// Note that the returned value will be in ticks (not seconds, not milliseconds and so on).
/// Please read <see href="xref:a_time_length">Time and length</see> article to learn how you can
/// get the time in different representations.
/// </remarks>
/// <exception cref="ArgumentOutOfRangeException"><paramref name="value"/> is negative.</exception>
public long Time
{
Expand All @@ -126,6 +131,11 @@ public long Time
/// <summary>
/// Gets or sets the length of the chord in units defined by the time division of a MIDI file.
/// </summary>
/// <remarks>
/// Note that the returned value will be in ticks (not seconds, not milliseconds and so on).
/// Please read <see href="xref:a_time_length">Time and length</see> article to learn how you can
/// get the length in different representations.
/// </remarks>
/// <exception cref="ArgumentOutOfRangeException"><paramref name="value"/> is negative.</exception>
public long Length
{
Expand Down
12 changes: 12 additions & 0 deletions DryWetMidi/Interaction/GetObjects/Rest.cs
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,12 @@ internal Rest(long time, long length, FourBitNumber? channel, SevenBitNumber? no
/// <summary>
/// Gets start time of an object.
/// </summary>
/// <remarks>
/// Note that the returned value will be in ticks (not seconds, not milliseconds and so on).
/// Please read <see href="xref:a_time_length">Time and length</see> article to learn how you can
/// get the time in different representations.
/// </remarks>
/// <exception cref="ArgumentOutOfRangeException"><paramref name="value"/> is negative.</exception>
public long Time
{
get { return _time; }
Expand All @@ -67,6 +73,12 @@ public long Time
/// <summary>
/// Gets length of an object.
/// </summary>
/// <remarks>
/// Note that the returned value will be in ticks (not seconds, not milliseconds and so on).
/// Please read <see href="xref:a_time_length">Time and length</see> article to learn how you can
/// get the length in different representations.
/// </remarks>
/// <exception cref="ArgumentOutOfRangeException"><paramref name="value"/> is negative.</exception>
public long Length
{
get { return _length; }
Expand Down
10 changes: 10 additions & 0 deletions DryWetMidi/Interaction/Notes/Note.cs
Original file line number Diff line number Diff line change
Expand Up @@ -201,6 +201,11 @@ internal Note(TimedEvent timedNoteOnEvent, TimedEvent timedNoteOffEvent, bool ch
/// <summary>
/// Gets or sets absolute time of the note in units defined by the time division of a MIDI file.
/// </summary>
/// <remarks>
/// Note that the returned value will be in ticks (not seconds, not milliseconds and so on).
/// Please read <see href="xref:a_time_length">Time and length</see> article to learn how you can
/// get the time in different representations.
/// </remarks>
/// <exception cref="ArgumentOutOfRangeException"><paramref name="value"/> is negative.</exception>
public long Time
{
Expand All @@ -223,6 +228,11 @@ public long Time
/// <summary>
/// Gets or sets the length of the note in units defined by the time division of a MIDI file.
/// </summary>
/// <remarks>
/// Note that the returned value will be in ticks (not seconds, not milliseconds and so on).
/// Please read <see href="xref:a_time_length">Time and length</see> article to learn how you can
/// get the length in different representations.
/// </remarks>
/// <exception cref="ArgumentOutOfRangeException"><paramref name="value"/> is negative.</exception>
public long Length
{
Expand Down
5 changes: 5 additions & 0 deletions DryWetMidi/Interaction/Parameters/Parameter.cs
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,11 @@ public ParameterValueType ValueType
/// <summary>
/// Gets or sets absolute time of the parameter data in units defined by the time division of a MIDI file.
/// </summary>
/// <remarks>
/// Note that the returned value will be in ticks (not seconds, not milliseconds and so on).
/// Please read <see href="xref:a_time_length">Time and length</see> article to learn how you can
/// get the time in different representations.
/// </remarks>
/// <exception cref="ArgumentOutOfRangeException"><paramref name="value"/> is negative.</exception>
public long Time
{
Expand Down
5 changes: 5 additions & 0 deletions DryWetMidi/Interaction/TimedEvents/TimedEvent.cs
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,11 @@ public TimedEvent(MidiEvent midiEvent, long time)
/// <summary>
/// Gets or sets absolute time of the event in units defined by the time division of a MIDI file.
/// </summary>
/// <remarks>
/// Note that the returned value will be in ticks (not seconds, not milliseconds and so on).
/// Please read <see href="xref:a_time_length">Time and length</see> article to learn how you can
/// get the time in different representations.
/// </remarks>
/// <exception cref="ArgumentOutOfRangeException"><paramref name="value"/> is negative.</exception>
public long Time
{
Expand Down
6 changes: 6 additions & 0 deletions DryWetMidi/Interaction/ValueLine/ValueChange.cs
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,12 @@ internal ValueChange(long time, TValue value)
/// <summary>
/// Gets the MIDI time when value is changed.
/// </summary>
/// <remarks>
/// Note that the returned value will be in ticks (not seconds, not milliseconds and so on).
/// Please read <see href="xref:a_time_length">Time and length</see> article to learn how you can
/// get the time in different representations.
/// </remarks>
/// <exception cref="InvalidOperationException">Setting time of value change object is not allowed.</exception>
public long Time
{
get { return _time; }
Expand Down

0 comments on commit 95f8b92

Please sign in to comment.