Skip to content

Commit

Permalink
Updated xml comments
Browse files Browse the repository at this point in the history
  • Loading branch information
ncguilbeault committed May 23, 2024
1 parent 1e59d13 commit 4b51df3
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions src/Bonsai.ML.Visualizers/TimeSeriesOxyPlotBase.cs
Original file line number Diff line number Diff line change
Expand Up @@ -22,24 +22,27 @@ internal class TimeSeriesOxyPlotBase : UserControl
private StatusStrip statusStrip;

/// <summary>
/// DateTime value that determines the starting time of the data values.
/// Gets or sets the datetime value that determines the starting time of the data values.
/// </summary>
public DateTime StartTime { get; set; }

/// <summary>
/// Integer value that determines how many data points should be shown along the x axis.
/// Gets or sets the integer value that determines how many data points should be shown along the x axis.
/// </summary>
public int Capacity { get; set; }

/// <summary>
/// Gets the status strip control.
/// </summary>
public StatusStrip StatusStrip => statusStrip;

/// <summary>
/// Buffer the data beyond the capacity.
/// Gets or sets a boolean value that determines whether to buffer the data beyond the capacity.
/// </summary>
public bool BufferData { get; set; }

/// <summary>
/// Constructor of the TimeSeriesOxyPlotBase class.
/// Initializes a new instance of the <see cref="TimeSeriesOxyPlotBase"/> class
/// </summary>
public TimeSeriesOxyPlotBase()
{
Expand Down

0 comments on commit 4b51df3

Please sign in to comment.