GeezerVison is showing github.com — Fixed some incorrect and missing comments. · gregkrsak/ArduinoProtoThread@bfb4ef4
File tree
Expand file treeCollapse file tree
Open diff view settings
Expand file treeCollapse file tree
Open diff view settings
Collapse file
Copy file name to clipboardExpand all lines: ArduinoProtoThread.cpp +5-1Lines changed: 5 additions & 1 deletion | Original file line number | Diff line number | Diff line change |
|---|
|
35 | 35 | // Member Function: setEecutionIntervalTo |
36 | 36 | // Purpose: Sets the protothread execution interval. |
37 | 37 | // Parameters: |
38 | | -// newInterval: Try to run this protothread every X number of milliseconds. |
| 38 | +// newIntervalInMs: Try to run this protothread every X number of milliseconds. |
39 | 39 | // Returns: void |
40 | 40 | // |
41 | 41 | void ArduinoProtoThread::setExecutionIntervalTo(unsigned long newIntervalInMs) |
@@ -59,6 +59,8 @@ unsigned long ArduinoProtoThread::executionInterval() |
59 | 59 | // |
60 | 60 | // Member Function: changeStateTo |
61 | 61 | // Purpose: Changes the state of the protothread's state machine. |
| 62 | +// Parameters: |
| 63 | +// newState: The new state for the protothread. See ArduinoProtoThreadStateMachine.hpp for details. |
62 | 64 | // Returns: void |
63 | 65 | // |
64 | 66 | void ArduinoProtoThread::changeStateTo(ArduinoProtoThreadState newState) |
@@ -83,6 +85,8 @@ ArduinoProtoThreadState ArduinoProtoThread::currentState() |
83 | 85 | // |
84 | 86 | // Member Function: delegateCallbacksTo |
85 | 87 | // Purpose: Sets the protothread's delegate. |
| 88 | +// Parameters: |
| 89 | +// *object: The protothread's delegate. See ArduinoProtoThreadDelegate.hpp for details. |
86 | 90 | // Returns: void |
87 | 91 | // |
88 | 92 | void ArduinoProtoThread::delegateCallbacksTo(ArduinoProtoThreadDelegate *object) |
|
Collapse file
Copy file name to clipboardExpand all lines: ArduinoProtoThreadDelegate.hpp +1-1Lines changed: 1 addition & 1 deletion | Original file line number | Diff line number | Diff line change |
|---|
|
1 | 1 | // ArduinoProtoThread |
2 | 2 | // ArduinoProtoThreadDelegate.hpp |
3 | 3 | // |
4 | | -// Abstract class that defines a delegate object for ArduinoProtoThread state transitionss. |
| 4 | +// Abstract class that defines a delegate object for ArduinoProtoThread state transitions. |
5 | 5 | // |
6 | 6 | // https://github.com/gregkrsak/ArduinoProtoThread |
7 | 7 | // |
|