Add documentation for all non-private functions.

This commit is contained in:
Christian Williams
2009-11-10 17:32:29 -05:00
parent ff8b9d8375
commit 2a5754600a
27 changed files with 5027 additions and 228 deletions

View File

@@ -1,10 +1,20 @@
/* JasmineReporters.reporter
/** JasmineReporters.reporter
* Base object that will get called whenever a Spec, Suite, or Runner is done. It is up to
* descendants of this object to do something with the results (see json_reporter.js)
*
* @deprecated
*/
jasmine.Reporters = {};
/**
* @deprecated
* @param callbacks
*/
jasmine.Reporters.reporter = function(callbacks) {
/**
* @deprecated
* @param callbacks
*/
var that = {
callbacks: callbacks || {},

View File

@@ -177,7 +177,7 @@ jasmine.Spy = function(name) {
*/
this.isSpy = true;
/**
* The acutal function this spy stubs.
* The actual function this spy stubs.
*/
this.plan = function() {
};

View File

@@ -85,7 +85,9 @@ jasmine.FakeTimer.prototype.scheduleFunction = function(timeoutKey, funcToCall,
};
};
/**
* @namespace
*/
jasmine.Clock = {
defaultFakeTimer: new jasmine.FakeTimer(),

View File

@@ -4,13 +4,16 @@
jasmine.util = {};
/**
* Declare that a child class inherite it's prototype from the parent class.
* Declare that a child class inherit it's prototype from the parent class.
*
* @private
* @param {Function} childClass
* @param {Function} parentClass
*/
jasmine.util.inherit = function(childClass, parentClass) {
/**
* @private
*/
var subclass = function() {
};
subclass.prototype = parentClass.prototype;