Skip to content

Commit

Permalink
chore(docs): fixes found from running the validator (#6669)
Browse files Browse the repository at this point in the history
  • Loading branch information
bshaffer authored Sep 29, 2023
1 parent b359915 commit 9c4d9a4
Show file tree
Hide file tree
Showing 5 changed files with 26 additions and 8 deletions.
11 changes: 9 additions & 2 deletions src/Acl.php
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,8 @@ public function __construct(ConnectionInterface $connection, $type, array $ident
}

/**
* Delete access controls.
*
* Delete access controls on a {@see Bucket} or
* {@see StorageObject} for a specified entity.
*
Expand All @@ -106,6 +108,8 @@ public function delete($entity, array $options = [])
}

/**
* Get access controls.
*
* Get access controls on a {@see Bucket} or
* {@see StorageObject}. By default this will return all available
* access controls. You may optionally specify a single entity to return
Expand Down Expand Up @@ -141,6 +145,8 @@ public function get(array $options = [])
}

/**
* Add access controls.
*
* Add access controls on a {@see Bucket} or
* {@see StorageObject}.
*
Expand Down Expand Up @@ -173,8 +179,9 @@ public function add($entity, $role, array $options = [])
}

/**
* Update access controls on a {@see Bucket} or
* {@see StorageObject}.
* Update access controls.
*
* Update access controls on a {@see Bucket} or {@see StorageObject}.
*
* Example:
* ```
Expand Down
12 changes: 9 additions & 3 deletions src/Bucket.php
Original file line number Diff line number Diff line change
Expand Up @@ -566,7 +566,9 @@ public function getStreamableUploader($data, array $options = [])

/**
* Lazily instantiates an object. There are no network requests made at this
* point. To see the operations that can be performed on an object please
* point.
*
* To see the operations that can be performed on an object please
* see {@see StorageObject}.
*
* Example:
Expand Down Expand Up @@ -787,7 +789,9 @@ public function createNotification($topic, array $options = [])

/**
* Lazily instantiates a notification. There are no network requests made at
* this point. To see the operations that can be performed on a notification
* this point.
*
* To see the operations that can be performed on a notification
* please see {@see Notification}.
*
* Example:
Expand Down Expand Up @@ -1218,7 +1222,9 @@ public static function lifecycle(array $lifecycle = [])

/**
* Retrieves a lifecycle builder preconfigured with the lifecycle rules that
* already exists on the bucket. Use this if you want to make updates to an
* already exists on the bucket.
*
* Use this if you want to make updates to an
* existing configuration without removing existing rules, as would be the
* case when using {@see Bucket::lifecycle()}.
*
Expand Down
2 changes: 2 additions & 0 deletions src/ObjectIterator.php
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@
use Google\Cloud\Core\Iterator\ItemIteratorTrait;

/**
* ObjectIterator
*
* Iterates over a set of {@see StorageObject} items.
*/
class ObjectIterator implements \Iterator
Expand Down
2 changes: 2 additions & 0 deletions src/ObjectPageIterator.php
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@
use Google\Cloud\Core\Iterator\PageIteratorTrait;

/**
* ObjectPageIterator
*
* Iterates over a set of pages containing
* {@see StorageObject} items.
*/
Expand Down
7 changes: 4 additions & 3 deletions src/StorageClient.php
Original file line number Diff line number Diff line change
Expand Up @@ -127,9 +127,10 @@ public function __construct(array $config = [])
}

/**
* Lazily instantiates a bucket. There are no network requests made at this
* point. To see the operations that can be performed on a bucket please
* see {@see Bucket}.
* Lazily instantiates a bucket.
*
* There are no network requests made at this point. To see the operations
* that can be performed on a bucket please see {@see Bucket}.
*
* If `$userProject` is set to true, the current project ID (used to
* instantiate the client) will be billed for all requests. If
Expand Down

0 comments on commit 9c4d9a4

Please sign in to comment.