PHPLIB-70: Add class-level docs to model iterators

Author: jmikola

src/Model/CollectionInfoCommandIterator.php

@@ -4,6 +4,17 @@
 
 use IteratorIterator;
 
+/**
+ * CollectionInfoIterator for listCollections command results.
+ *
+ * This iterator may be used to wrap a Cursor returned by the listCollections
+ * command.
+ *
+ * @internal
+ * @see MongoDB\Database::listCollections()
+ * @see https://github.com/mongodb/specifications/blob/master/source/enumerate-collections.rst
+ * @see http://docs.mongodb.org/manual/reference/command/listCollections/
+ */
 class CollectionInfoCommandIterator extends IteratorIterator implements CollectionInfoIterator
 {
     /**

src/Model/CollectionInfoIterator.php

@@ -4,6 +4,14 @@
 
 use Iterator;
 
+/**
+ * CollectionInfoIterator interface.
+ *
+ * This iterator is used for enumerating collections in a database.
+ *
+ * @api
+ * @see MongoDB\Database::listCollections()
+ */
 interface CollectionInfoIterator extends Iterator
 {
     /**

src/Model/CollectionInfoLegacyIterator.php

@@ -7,6 +7,20 @@
 use IteratorIterator;
 use Traversable;
 
+/**
+ * CollectionInfoIterator for legacy "system.namespaces" query results.
+ *
+ * This iterator may be used to wrap a Cursor returned for queries on the
+ * "system.namespaces" collection. It includes logic to filter out internal
+ * collections and modify the collection name to be consistent with results from
+ * the listCollections command.
+ *
+ * @internal
+ * @see MongoDB\Database::listCollections()
+ * @see https://github.com/mongodb/specifications/blob/master/source/enumerate-collections.rst
+ * @see http://docs.mongodb.org/manual/reference/command/listCollections/
+ * @see http://docs.mongodb.org/manual/reference/system-collections/
+ */
 class CollectionInfoLegacyIterator extends FilterIterator implements CollectionInfoIterator
 {
     /**

src/Model/DatabaseInfoIterator.php

@@ -4,6 +4,14 @@
 
 use Iterator;
 
+/**
+ * DatabaseInfoIterator interface.
+ *
+ * This iterator is used for enumerating databases on a server.
+ *
+ * @api
+ * @see MongoDB\Client::listDatabases()
+ */
 interface DatabaseInfoIterator extends Iterator
 {
     /**

src/Model/DatabaseInfoLegacyIterator.php

@@ -2,6 +2,16 @@
 
 namespace MongoDB\Model;
 
+/**
+ * DatabaseInfoIterator for inline listDatabases command results.
+ *
+ * This iterator may be used to wrap the array returned within the listDatabases
+ * command's single-document result.
+ *
+ * @internal
+ * @see MongoDB\Client::listDatabases()
+ * @see http://docs.mongodb.org/manual/reference/command/listDatabases/
+ */
 class DatabaseInfoLegacyIterator implements DatabaseInfoIterator
 {
     private $databases;