Skip to content

Commit 6650473

Browse files
committed
updated README
1 parent 380d3bd commit 6650473

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,7 @@ Documentation:
8686
#### void AddTimeGraph( String title, int pointsDisplayed, String label1, Variable1Type variable1 )
8787

8888
*Add a 1-variable graph vs. time*
89+
##### Arguments
8990
- title: String with title of graph
9091
- pointsDisplayed: number of points to be shown at a given time. Used to control time-scaling
9192
- label1: String with label of the plotted variable
@@ -94,6 +95,7 @@ Documentation:
9495
#### void AddTimeGraph( String title, int pointsDisplayed, String label1, Variable1Type variable1, String label2, Variable2Type variable2, ... )
9596

9697
*Add a multi-variable graph vs. time*
98+
##### Arguments
9799
- title: String with title of graph
98100
- pointsDisplayed: number of points to be shown at a given time. Used to control time-scaling
99101
- label1: String with label of the plotted variable
@@ -105,20 +107,23 @@ Documentation:
105107
#### void AddXYGraph( String title, int pointsDisplayed, String labelX, VariableTypeX variableX, String labelY, VariableTypeY variableY )
106108

107109
*Add an X vs Y graph*
110+
##### Arguments
108111
- title: String with title of graph
109112
- pointsDisplayed: number of points to be shown at a given time. Used to control time-scaling
110113
- labelX: String with label of variable to be plotted along X-axis
111114
- variableX: global X-variable that will be updated throughout program
112115
- labelY: String with label of variable to be plotted along Y-axis
113116
- variableY: global Y-variable that will be updated throughout program
114117

115-
### void Plot()
118+
#### void Plot()
116119

117120
*Send most recent values for all plotted variables to the listener application*
118121

119-
### bool Remove( int index )
122+
#### bool Remove( int index )
120123

121124
*Removes the graph at the specified position with zero-indexing. (ie passing 0 would remove the first graph added)
125+
##### Arguments
122126
- index: position of graph to remove
123-
Returns:
127+
128+
##### Returns
124129
- bool: true if successful

0 commit comments

Comments
 (0)