Add inline documentation for TestSpecification.

davglass · Feb 26, 2013 · 32dd26c · 32dd26c
1 parent 33f8e2c
commit 32dd26c
Showing 1 changed file with 13 additions and 1 deletion.
diff --git a/lib/hub/test-specification.js b/lib/hub/test-specification.js
@@ -46,6 +46,13 @@ TestSpecification.empty = function () {
     });
 };
 
+/**
+ * Set and normalize the mountpoint for use in creating URLs
+ * for Test objects.
+ *
+ * @method setMountpoint
+ * @param {String} mountpoint
+ */
 TestSpecification.prototype.setMountpoint = function (mountpoint) {
     if (!mountpoint) {
         mountpoint = "/";
@@ -55,7 +62,6 @@ TestSpecification.prototype.setMountpoint = function (mountpoint) {
     this.mountpoint = mountpoint;
 };
 
-
 /**
  * Get the timeout in milliseconds.
  *
@@ -66,6 +72,12 @@ TestSpecification.prototype.getTimeoutMilliseconds = function () {
     return this.timeout * 1000;
 };
 
+/**
+ * Create a Tests object from this specification.
+ *
+ * @method createTests
+ * @return {Tests} Created Tests.
+ */
 TestSpecification.prototype.createTests = function () {
     return new Tests(this);
 };