Skip to content

Commit 19fb9bf

Browse files
committed
Change some @see into @param or @param and add some descriptions
1 parent d587a84 commit 19fb9bf

File tree

6 files changed

+22
-10
lines changed

6 files changed

+22
-10
lines changed

docs/api/MongoDB/Command/CommandCursor.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,23 +44,23 @@ public function getId()
4444
}
4545

4646
/**
47-
* @see Cursor::getServer()
47+
* @return Server Server from which the cursor originated
4848
*/
4949
public function getServer()
5050
{
5151
return $this->server;
5252
}
5353

5454
/**
55-
* @see Cursor::isDead()
55+
* @return boolean Whether the cursor is exhausted and has no more results
5656
*/
5757
public function isDead()
5858
{
5959
// Return whether the cursor is exhausted and has no more results
6060
}
6161

6262
/**
63-
* @see \MongoDB\Cursor::setBatchSize()
63+
* @param integer $batchSize
6464
*/
6565
public function setBatchSize($batchSize)
6666
{

docs/api/MongoDB/Manager.php

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@
2525
final class Manager
2626
{
2727
/**
28+
* Constructs a new Manager
29+
*
2830
* @param string $uri Connection URI
2931
* @param array $options Connection options (e.g. auth, socket timeouts)
3032
* @param array $driverOptions Driver options (e.g. stream contexts)
@@ -35,6 +37,8 @@ public function __construct($uri, array $options = array(), array $driverOptions
3537
}
3638

3739
/**
40+
* Creates new Manager from a list of servers
41+
*
3842
* @param Server[] $servers
3943
* @return Manager
4044
*/
@@ -50,6 +54,8 @@ static public function createFromServers(array $servers)
5054
}
5155

5256
/**
57+
* Execute a command
58+
*
5359
* @param string $db
5460
* @param Command $command
5561
* @param ReadPreference $readPreference
@@ -72,6 +78,8 @@ public function executeCommand($db, Command $command, ReadPreference $readPrefer
7278
}
7379

7480
/**
81+
* Execute a Query
82+
*
7583
* @param string $namespace
7684
* @param Query $query
7785
* @param ReadPreference $readPreference
@@ -92,6 +100,8 @@ public function executeQuery($namespace, Query $query, ReadPreference $readPrefe
92100
}
93101

94102
/**
103+
* Executes a write operation batch (e.g. insert, update, delete)
104+
*
95105
* @param string $namespace
96106
* @param WriteBatch $batch
97107
* @param array $writeOptions Ordering and write concern options (default: {"ordered": true, "w": 1})

docs/api/MongoDB/Query/QueryCursor.php

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@ final class QueryCursor implements Cursor
2222
private $cursorId;
2323

2424
/**
25+
* Construct a new QueryCursor
26+
*
2527
* @param Server $server
2628
* @param CursorId $cursorId
2729
*/
@@ -32,31 +34,31 @@ public function __construct(Server $server, CursorId $cursorId)
3234
}
3335

3436
/**
35-
* @see Cursor::getId()
37+
* @return CursorId
3638
*/
3739
public function getId()
3840
{
3941
return $this->cursorId;
4042
}
4143

4244
/**
43-
* @see Cursor::getServer()
45+
* @return Server Server from which the cursor originated
4446
*/
4547
public function getServer()
4648
{
4749
return $this->server;
4850
}
4951

5052
/**
51-
* @see Cursor::isDead()
53+
* @return boolean Whether the cursor is exhausted and has no more results
5254
*/
5355
public function isDead()
5456
{
5557
// Return whether the cursor is exhausted and has no more results
5658
}
5759

5860
/**
59-
* @see Cursor::setBatchSize()
61+
* @param integer $batchSize
6062
*/
6163
public function setBatchSize($batchSize)
6264
{

docs/api/MongoDB/Write/DeleteBatch.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ final class DeleteBatch implements WriteBatch
1010
private $documents;
1111

1212
/**
13-
* @see WriteBatch::add()
13+
* @param array|object $document Operation/document to add to the batch
1414
*/
1515
public function add($document)
1616
{

docs/api/MongoDB/Write/InsertBatch.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ final class InsertBatch implements WriteBatch
1010
private $documents;
1111

1212
/**
13-
* @see WriteBatch::add()
13+
* @param array|object $document Operation/document to add to the batch
1414
*/
1515
public function add($document)
1616
{

docs/api/MongoDB/Write/UpdateBatch.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ final class UpdateBatch implements WriteBatch
1010
private $documents;
1111

1212
/**
13-
* @see WriteBatch::add()
13+
* @param array|object $document Operation/document to add to the batch
1414
*/
1515
public function add($document)
1616
{

0 commit comments

Comments
 (0)