Skip to content
Snippets Groups Projects
Commit d5bd9b11 authored by Josh Brooks's avatar Josh Brooks
Browse files

Clean up documentation

parent fa79a577
No related branches found
No related tags found
2 merge requests!510Release,!329Hotfix/dummy message bindings
...@@ -32,9 +32,9 @@ type DummyTraffic struct { ...@@ -32,9 +32,9 @@ type DummyTraffic struct {
// each sending cycle. // each sending cycle.
// - avgSendDeltaMS - the average duration, in milliseconds, to wait // - avgSendDeltaMS - the average duration, in milliseconds, to wait
// between sends. // between sends.
// - randomRangeMS - the upper bound of the interval between sending cycles. // - randomRangeMS - the upper bound of the interval between sending cycles,
// Sends occur every avgSendDeltaMS +/- a random duration with an // in milliseconds. Sends occur every avgSendDeltaMS +/- a random duration
// upper bound of randomRangeMS // with an upper bound of randomRangeMS.
func NewDummyTrafficManager(e2eID, maxNumMessages, avgSendDeltaMS, func NewDummyTrafficManager(e2eID, maxNumMessages, avgSendDeltaMS,
randomRangeMS int) (*DummyTraffic, error) { randomRangeMS int) (*DummyTraffic, error) {
...@@ -62,7 +62,7 @@ func NewDummyTrafficManager(e2eID, maxNumMessages, avgSendDeltaMS, ...@@ -62,7 +62,7 @@ func NewDummyTrafficManager(e2eID, maxNumMessages, avgSendDeltaMS,
// //
// Params: // Params:
// - boolean - True: Sending thread is sending dummy messages. // - boolean - True: Sending thread is sending dummy messages.
// False: Sending thread is paused/stopped and is not sending dummy messages // False: Sending thread is paused/stopped and is not sending dummy messages.
// Returns: // Returns:
// - error - if the DummyTraffic.SetStatus is called too frequently, causing the // - error - if the DummyTraffic.SetStatus is called too frequently, causing the
// internal status channel to fill. // internal status channel to fill.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment