dwf: more doc commits

src/NestedResults.js

@@ -1,31 +1,59 @@
 /**
- * Holds results; allows for the results array to hold another jasmine.NestedResults
+ * Holds results for a set of Jasmine spec. Allows for the results array to hold another jasmine.NestedResults
  *
  * @constructor
  */
 jasmine.NestedResults = function() {
+  /**
+   * The total count of results
+   */
   this.totalCount = 0;
+  /**
+   * Number of passed results
+   */
   this.passedCount = 0;
+  /**
+   * Number of failed results
+   */
   this.failedCount = 0;
+  /**
+   * Was this suite/spec skipped?
+   */
   this.skipped = false;
+  /**
+   * @ignore
+   */
   this.items_ = [];
 };
 
+/**
+ * Roll up the result counts.
+ *
+ * @param result
+ */
 jasmine.NestedResults.prototype.rollupCounts = function(result) {
   this.totalCount += result.totalCount;
   this.passedCount += result.passedCount;
   this.failedCount += result.failedCount;
 };
 
+/**
+ * Tracks a result's message.
+ * @param message
+ */
 jasmine.NestedResults.prototype.log = function(message) {
   this.items_.push(new jasmine.MessageResult(message));
 };
 
+/**
+ * Getter for the results: message & results.
+ */
 jasmine.NestedResults.prototype.getItems = function() {
   return this.items_;
 };
 
 /**
+ * Adds a result, tracking counts (total, passed, & failed)
  * @param {jasmine.ExpectationResult|jasmine.NestedResults} result
  */
 jasmine.NestedResults.prototype.addResult = function(result) {
@@ -44,6 +72,9 @@ jasmine.NestedResults.prototype.addResult = function(result) {
   this.items_.push(result);
 };
 
+/**
+ * @returns {Boolean} True if <b>everything</b> below passed
+ */
 jasmine.NestedResults.prototype.passed = function() {
   return this.passedCount === this.totalCount;
 };