Merge pull request #3 from bjori/docblocks

Improve docblocks

Author: bjori

docs/api/MongoDB/Command/CommandCursor.php

@@ -4,6 +4,7 @@
 
 use MongoDB\Cursor;
 use MongoDB\CursorId;
+use Mongodb\Server;
 
 /**
  * Cursor implementation that may be constructed from values found in a
@@ -34,37 +35,42 @@ public function __construct(Server $server, CursorId $cursorId, array $firstBatc
         $this->firstBatch = $firstBatch;
     }
 
-    // Iterator methods...
-
     /**
-     * @return Cursor::getId()
+     * @return CursorId
      */
     public function getId()
     {
         return $this->cursorId;
     }
 
     /**
-     * @see Cursor::getServer()
+     * @return Server Server from which the cursor originated
      */
     public function getServer()
     {
         return $this->server;
     }
 
     /**
-     * @see Cursor::isDead()
+     * @return boolean Whether the cursor is exhausted and has no more results
      */
     public function isDead()
     {
         // Return whether the cursor is exhausted and has no more results
     }
 
     /**
-     * @see \MongoDB\Cursor::setBatchSize()
+     * @param integer $batchSize
      */
     public function setBatchSize($batchSize)
     {
         $this->batchSize = (integer) $batchSize;
     }
+
+    /* Cursor is an iterator */
+    public function current() {}
+    public function next() {}
+    public function key() {}
+    public function valid() {}
+    public function rewind() {}
 }

docs/api/MongoDB/CursorId.php

@@ -13,7 +13,7 @@ final class CursorId
     // $id is an internal uint64_t value instead of a class property
 
     /**
-     * @param integer|string $id
+     * @param string $id
      */
     public function __construct($id)
     {

docs/api/MongoDB/Manager.php

@@ -25,6 +25,8 @@
 final class Manager
 {
     /**
+     * Constructs a new Manager
+     *
      * @param string $uri           Connection URI
      * @param array  $options       Connection options (e.g. auth, socket timeouts)
      * @param array  $driverOptions Driver options (e.g. stream contexts)
@@ -35,6 +37,8 @@ public function __construct($uri, array $options = array(), array $driverOptions
     }
 
     /**
+     * Creates new Manager from a list of servers
+     *
      * @param Server[] $servers
      * @return Manager
      */
@@ -50,6 +54,8 @@ static public function createFromServers(array $servers)
     }
 
     /**
+     * Execute a command
+     *
      * @param string         $db
      * @param Command        $command
      * @param ReadPreference $readPreference
@@ -72,6 +78,8 @@ public function executeCommand($db, Command $command, ReadPreference $readPrefer
     }
 
     /**
+     * Execute a Query
+     *
      * @param string         $namespace
      * @param Query          $query
      * @param ReadPreference $readPreference
@@ -92,6 +100,8 @@ public function executeQuery($namespace, Query $query, ReadPreference $readPrefe
     }
 
     /**
+     * Executes a write operation batch (e.g. insert, update, delete)
+     *
      * @param string     $namespace
      * @param WriteBatch $batch
      * @param array      $writeOptions Ordering and write concern options (default: {"ordered": true, "w": 1})

docs/api/MongoDB/Query/Query.php

@@ -31,8 +31,8 @@ final class Query
      * @param array|object $query    Query document
      * @param array|object $selector Selector document
      * @param integer      $flags    Query flags
-     * @param integer      $limit    Limit
      * @param integer      $skip     Skip
+     * @param integer      $limit    Limit
      */
     public function __construct($query, $selector, $flags, $skip, $limit)
     {

docs/api/MongoDB/Query/QueryCursor.php

@@ -4,6 +4,7 @@
 
 use MongoDB\Cursor;
 use MongoDB\CursorId;
+use Mongodb\Server;
 
 /**
  * Cursor implementation that is returned after executing a Query.
@@ -21,6 +22,8 @@ final class QueryCursor implements Cursor
     private $cursorId;
 
     /**
+     * Construct a new QueryCursor
+     *
      * @param Server   $server
      * @param CursorId $cursorId
      */
@@ -30,37 +33,42 @@ public function __construct(Server $server, CursorId $cursorId)
         $this->cursorId = $cursorId;
     }
 
-    // Iterator methods...
-
     /**
-     * @see Cursor::getId()
+     * @return CursorId
      */
     public function getId()
     {
         return $this->cursorId;
     }
 
     /**
-     * @see Cursor::getServer()
+     * @return Server Server from which the cursor originated
      */
     public function getServer()
     {
         return $this->server;
     }
 
     /**
-     * @see Cursor::isDead()
+     * @return boolean Whether the cursor is exhausted and has no more results
      */
     public function isDead()
     {
         // Return whether the cursor is exhausted and has no more results
     }
 
     /**
-     * @see Cursor::setBatchSize()
+     * @param integer $batchSize
      */
     public function setBatchSize($batchSize)
     {
         $this->batchSize = (integer) $batchSize;
     }
+
+    /* Cursor is an iterator */
+    public function current() {}
+    public function next() {}
+    public function key() {}
+    public function valid() {}
+    public function rewind() {}
 }

docs/api/MongoDB/Write/DeleteBatch.php

@@ -10,7 +10,7 @@ final class DeleteBatch implements WriteBatch
     private $documents;
 
     /**
-     * @see WriteBatch::add()
+     * @param array|object $document Operation/document to add to the batch
      */
     public function add($document)
     {

docs/api/MongoDB/Write/InsertBatch.php

@@ -10,7 +10,7 @@ final class InsertBatch implements WriteBatch
     private $documents;
 
     /**
-     * @see WriteBatch::add()
+     * @param array|object $document Operation/document to add to the batch
      */
     public function add($document)
     {

docs/api/MongoDB/Write/UpdateBatch.php

@@ -10,7 +10,7 @@ final class UpdateBatch implements WriteBatch
     private $documents;
 
     /**
-     * @see WriteBatch::add()
+     * @param array|object $document Operation/document to add to the batch
      */
     public function add($document)
     {

docs/bootstrap.php

@@ -0,0 +1,22 @@
+<?php
+include "api/MongoDB/Cursor.php";
+include "api/MongoDB/CursorId.php";
+include "api/MongoDB/Manager.php";
+include "api/MongoDB/ReadPreference.php";
+include "api/MongoDB/Server.php";
+include "api/MongoDB/Query/Query.php";
+include "api/MongoDB/Query/QueryCursor.php";
+include "api/MongoDB/Command/Command.php";
+include "api/MongoDB/Command/CommandCursor.php";
+include "api/MongoDB/Command/CommandResult.php";
+include "api/MongoDB/Write/WriteBatch.php";
+include "api/MongoDB/Write/WriteResult.php";
+include "api/MongoDB/Write/DeleteBatch.php";
+include "api/MongoDB/Write/DeleteResult.php";
+include "api/MongoDB/Write/GeneratedId.php";
+include "api/MongoDB/Write/InsertBatch.php";
+include "api/MongoDB/Write/InsertResult.php";
+include "api/MongoDB/Write/UpdateBatch.php";
+include "api/MongoDB/Write/UpdateResult.php";
+include "api/MongoDB/Write/WriteConcernError.php";
+include "api/MongoDB/Write/WriteError.php";