BeatKeeper explanation of what BeatKeeper is and/or does

Inherits from: Object

More detailed prose description of BeatKeeper.

See also: Object [some other help files]

Some Important Issues Regarding BeatKeeper (optional)

Explanation of the issues. For more information see Nil and [some other help files].

Creation / Class Methods

*new (now)

Short prose description of method.

now - Explanation of now. Default value is nil. Other information.

// inline example

g = BeatKeeper.new;

g.doSomething; // explanation

g.cleanUpMethod;

Accessing Instance and Class Variables

now

Explanation including the type of now and a link to its help file.

Default value is nil.

Doing Some Task (optional)

A short bit of prose explaining something about the task.

wait (waittime, beatDur, tolerance, base)

Short prose description of method.

waittime - Explanation of waittime. Default value is nil. Other information.

beatDur - Explanation of beatDur. Default value is 0.25. Other information.

tolerance - Explanation of tolerance. Default value is 0.0001. Other information.

base - Explanation of base. Default value is 0.25. Other information.

// inline example

g = BeatKeeper.wait;

g.doSomething; // explanation

g.cleanUpMethod;

roundNow (tolerance, base)

Short prose description of method.

tolerance - Explanation of tolerance. Default value is 0.0001. Other information.

base - Explanation of base. Default value is 0.25. Other information.

// inline example

g = BeatKeeper.roundNow;

g.doSomething; // explanation

g.cleanUpMethod;

now_ (newNow, tolerance, base)

Short prose description of method.

newNow - Explanation of newNow. Default value is nil. Other information.

tolerance - Explanation of tolerance. Default value is 0.0001. Other information.

base - Explanation of base. Default value is 0.25. Other information.

// inline example

g = BeatKeeper.now_;

g.doSomething; // explanation

g.cleanUpMethod;

Examples

// what this example does

e = BeatKeeper.new;

e.instanceMethod(someObject);

e.cleanUp;

...