Improved the documentation.

Bishop92 · Bishop92 · commit 652c3e935065 · 2014-04-23T22:42:33.000+02:00
diff --git a/Aggregate/Aggregate.js b/Aggregate/Aggregate.js
@@ -7,7 +7,7 @@ function Aggregate() {
 }
 
 /**
- * Return the iterator relative to the aggregate.
+ * Returns the iterator relative to the aggregate.
  * @abstract
  * @return {Iterator} The iterator.
  */
diff --git a/Aggregate/Iterator.js b/Aggregate/Iterator.js
@@ -2,12 +2,17 @@
  * Created by Stefano on 04/04/2014.
  */
 
+/**
+ * Interface for managing an iterator for an aggregate.
+ * @constructor
+ * @interface
+ */
 function Iterator() {
 
 }
 
 /**
- * Move the iterator to the first position of the aggregate.
+ * Moves the iterator to the first position of the aggregate.
  * @abstract
  * @return {void}
  */
@@ -16,7 +21,7 @@ Iterator.prototype.first = function () {
 };
 
 /**
- * Move the iterator to the next item.
+ * Moves the iterator to the next item.
  * @abstract
  * @return {void}
  */
@@ -25,7 +30,7 @@ Iterator.prototype.next = function () {
 };
 
 /**
- * Move the iterator to the last position of the aggregate.
+ * Moves the iterator to the last position of the aggregate.
  * @abstract
  * @return {void}
  */
@@ -34,7 +39,7 @@ Iterator.prototype.last = function () {
 };
 
 /**
- * Move the iterator to the previous item.
+ * Moves the iterator to the previous item.
  * @abstract
  * @return {void}
  */
@@ -43,7 +48,7 @@ Iterator.prototype.previous = function () {
 };
 
 /**
- * Check if the iterator is out of the bounds of the aggregate.
+ * Checks if the iterator is out of the bounds of the aggregate.
  * @abstract
  * @return {boolean} It return true if the iterator is out of the bounds of the aggregate, otherwise false.
  */
@@ -52,9 +57,9 @@ Iterator.prototype.isDone = function () {
 };
 
 /**
- * Return the item stored at the position pointed by the iterator.
+ * Returns the item stored at the position pointed by the iterator.
  * @abstract
- * @return {Object|undefined} The item stored or undefined if it's out of the bounds.
+ * @return {*} The item stored or undefined if it's out of the bounds.
  */
 Iterator.prototype.getItem = function () {
 
diff --git a/BSTree/BSTree.js b/BSTree/BSTree.js
@@ -39,6 +39,10 @@ function BSNode(key, item) {
 BSTree.prototype = new Aggregate();
 BSTree.prototype.constructor = BSTree;
 
+/**
+ * Class for managing a binary search tree.
+ * @constructor
+ */
 function BSTree() {
 	/**
 	 * The root of the tree.
diff --git a/DataStructures.js b/DataStructures.js

Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@ function Aggregate() {`
`7`	`7`	`}`
`8`	`8`
`9`	`9`	`/**`
`10`		`- * Return the iterator relative to the aggregate.`
	`10`	`+ * Returns the iterator relative to the aggregate.`
`11`	`11`	`* @abstract`
`12`	`12`	`* @return {Iterator} The iterator.`
`13`	`13`	`*/`