Skip to content

Commit

Permalink
chore(Storage): fix see tags in phpdoc (#6624)
Browse files Browse the repository at this point in the history
  • Loading branch information
bshaffer authored Sep 13, 2023
1 parent dc3fbf1 commit eb45a0a
Show file tree
Hide file tree
Showing 10 changed files with 38 additions and 38 deletions.
16 changes: 8 additions & 8 deletions src/Acl.php
Original file line number Diff line number Diff line change
Expand Up @@ -78,8 +78,8 @@ public function __construct(ConnectionInterface $connection, $type, array $ident
}

/**
* Delete access controls on a {@see Google\Cloud\Storage\Bucket} or
* {@see Google\Cloud\Storage\StorageObject} for a specified entity.
* Delete access controls on a {@see Bucket} or
* {@see StorageObject} for a specified entity.
*
* Example:
* ```
Expand All @@ -104,8 +104,8 @@ public function delete($entity, array $options = [])
}

/**
* Get access controls on a {@see Google\Cloud\Storage\Bucket} or
* {@see Google\Cloud\Storage\StorageObject}. By default this will return all available
* 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
* details for as well.
*
Expand Down Expand Up @@ -139,8 +139,8 @@ public function get(array $options = [])
}

/**
* Add access controls on a {@see Google\Cloud\Storage\Bucket} or
* {@see Google\Cloud\Storage\StorageObject}.
* Add access controls on a {@see Bucket} or
* {@see StorageObject}.
*
* Example:
* ```
Expand Down Expand Up @@ -171,8 +171,8 @@ public function add($entity, $role, array $options = [])
}

/**
* Update access controls on a {@see Google\Cloud\Storage\Bucket} or
* {@see Google\Cloud\Storage\StorageObject}.
* Update access controls on a {@see Bucket} or
* {@see StorageObject}.
*
* Example:
* ```
Expand Down
20 changes: 10 additions & 10 deletions src/Bucket.php
Original file line number Diff line number Diff line change
Expand Up @@ -565,7 +565,7 @@ 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
* see {@see Google\Cloud\Storage\StorageObject}.
* see {@see StorageObject}.
*
* Example:
* ```
Expand Down Expand Up @@ -786,7 +786,7 @@ 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
* please see {@see Google\Cloud\Storage\Notification}.
* please see {@see Notification}.
*
* Example:
* ```
Expand Down Expand Up @@ -973,7 +973,7 @@ public function delete(array $options = [])
* occurs, signified by the hold's release.
* @type array $retentionPolicy Defines the retention policy for a
* bucket. In order to lock a retention policy, please see
* {@see Google\Cloud\Storage\Bucket::lockRetentionPolicy()}.
* {@see Bucket::lockRetentionPolicy()}.
* @type int $retentionPolicy.retentionPeriod Specifies the duration
* that objects need to be retained, in seconds. Retention
* duration must be greater than zero and less than 100 years.
Expand Down Expand Up @@ -1185,8 +1185,8 @@ public function name()
* replace the configuration with the rules provided by this builder.
*
* This builder is intended to be used in tandem with
* {@see Google\Cloud\Storage\StorageClient::createBucket()} and
* {@see Google\Cloud\Storage\Bucket::update()}.
* {@see StorageClient::createBucket()} and
* {@see Bucket::update()}.
*
* Example:
* ```
Expand Down Expand Up @@ -1218,11 +1218,11 @@ 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
* existing configuration without removing existing rules, as would be the
* case when using {@see Google\Cloud\Storage\Bucket::lifecycle()}.
* case when using {@see Bucket::lifecycle()}.
*
* This builder is intended to be used in tandem with
* {@see Google\Cloud\Storage\StorageClient::createBucket()} and
* {@see Google\Cloud\Storage\Bucket::update()}.
* {@see StorageClient::createBucket()} and
* {@see Bucket::update()}.
*
* Please note, this method may trigger a network request in order to fetch
* the existing lifecycle rules from the server.
Expand Down Expand Up @@ -1344,8 +1344,8 @@ public function iam()
* metageneration value will need to be available. It can either be supplied
* explicitly through the `ifMetagenerationMatch` option or detected for you
* by ensuring a value is cached locally (by calling
* {@see Google\Cloud\Storage\Bucket::reload()} or
* {@see Google\Cloud\Storage\Bucket::info()}, for example).
* {@see Bucket::reload()} or
* {@see Bucket::info()}, for example).
*
* Example:
* ```
Expand Down
2 changes: 1 addition & 1 deletion src/HmacKey.php
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ public function update($state, array $options = [])
* Delete the HMAC Key.
*
* Key state must be set to `INACTIVE` prior to deletion. See
* {@see Google\Cloud\Storage\HmacKey::update()} for details.
* {@see HmacKey::update()} for details.
*
* Example:
* ```
Expand Down
4 changes: 2 additions & 2 deletions src/Lifecycle.php
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@
*
* This builder does not execute any network requests and is intended to be used
* in combination with either
* {@see Google\Cloud\Storage\StorageClient::createBucket()}
* or {@see Google\Cloud\Storage\Bucket::update()}.
* {@see StorageClient::createBucket()}
* or {@see Bucket::update()}.
*
* Example:
* ```
Expand Down
2 changes: 1 addition & 1 deletion src/Notification.php
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
* and the object that changed.
*
* To utilize this class and see more examples, please see the relevant
* notifications based methods exposed on {@see Google\Cloud\Storage\Bucket}.
* notifications based methods exposed on {@see Bucket}.
*
* Example:
* ```
Expand Down
2 changes: 1 addition & 1 deletion src/ObjectIterator.php
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
use Google\Cloud\Core\Iterator\ItemIteratorTrait;

/**
* Iterates over a set of {@see Google\Cloud\Storage\StorageObject} items.
* Iterates over a set of {@see StorageObject} items.
*/
class ObjectIterator implements \Iterator
{
Expand Down
2 changes: 1 addition & 1 deletion src/ObjectPageIterator.php
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@

/**
* Iterates over a set of pages containing
* {@see Google\Cloud\Storage\StorageObject} items.
* {@see StorageObject} items.
*/
class ObjectPageIterator implements \Iterator
{
Expand Down
8 changes: 4 additions & 4 deletions src/SigningHelper.php
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ public static function getHelper()
* leading slash.
* @param int|null $generation The resource generation.
* @param array $options Configuration options. See
* {@see Google\Cloud\Storage\StorageObject::signedUrl()} for
* {@see StorageObject::signedUrl()} for
* details.
* @return string
* @throws \InvalidArgumentException
Expand Down Expand Up @@ -117,7 +117,7 @@ public function sign(ConnectionInterface $connection, $expires, $resource, $gene
* leading slash.
* @param int|null $generation The resource generation.
* @param array $options Configuration options. See
* {@see Google\Cloud\Storage\StorageObject::signedUrl()} for
* {@see StorageObject::signedUrl()} for
* details.
* @return string
* @throws \InvalidArgumentException
Expand Down Expand Up @@ -213,7 +213,7 @@ public function v2Sign(ConnectionInterface $connection, $expires, $resource, $ge
* leading slash.
* @param int|null $generation The resource generation.
* @param array $options Configuration options. See
* {@see Google\Cloud\Storage\StorageObject::signedUrl()} for
* {@see StorageObject::signedUrl()} for
* details.
* @return string
* @throws \InvalidArgumentException
Expand Down Expand Up @@ -367,7 +367,7 @@ public function v4Sign(ConnectionInterface $connection, $expires, $resource, $ge
* @param string $resource The URI to the storage resource, preceded by a
* leading slash.
* @param array $options Configuration options. See
* {@see Google\Cloud\Storage\Bucket::generateSignedPostPolicyV4()} for details.
* {@see Bucket::generateSignedPostPolicyV4()} for details.
* @return array An associative array, containing (string) `uri` and
* (array) `fields` keys.
*/
Expand Down
4 changes: 2 additions & 2 deletions src/StorageClient.php
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ 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 Google\Cloud\Storage\Bucket}.
* 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 Expand Up @@ -335,7 +335,7 @@ function (array $bucket) use ($userProject) {
* occurs, signified by the hold's release.
* @type array $retentionPolicy Defines the retention policy for a
* bucket. In order to lock a retention policy, please see
* {@see Google\Cloud\Storage\Bucket::lockRetentionPolicy()}.
* {@see Bucket::lockRetentionPolicy()}.
* @type int $retentionPolicy.retentionPeriod Specifies the retention
* period for objects in seconds. During the retention period an
* object cannot be overwritten or deleted. Retention period must
Expand Down
16 changes: 8 additions & 8 deletions src/StorageObject.php
Original file line number Diff line number Diff line change
Expand Up @@ -546,7 +546,7 @@ public function rename($name, array $options = [])
* Download an object as a string.
*
* For an example of setting the range header to download a subrange of the
* object please see {@see Google\Cloud\Storage\StorageObject::downloadAsStream()}.
* object please see {@see StorageObject::downloadAsStream()}.
*
* Example:
* ```
Expand Down Expand Up @@ -580,7 +580,7 @@ public function downloadAsString(array $options = [])
* Download an object to a specified location.
*
* For an example of setting the range header to download a subrange of the
* object please see {@see Google\Cloud\Storage\StorageObject::downloadAsStream()}.
* object please see {@see StorageObject::downloadAsStream()}.
*
* Example:
* ```
Expand Down Expand Up @@ -684,7 +684,7 @@ public function downloadAsStream(array $options = [])
* Asynchronously download an object as a stream.
*
* For an example of setting the range header to download a subrange of the
* object please see {@see Google\Cloud\Storage\StorageObject::downloadAsStream()}.
* object please see {@see StorageObject::downloadAsStream()}.
*
* Example:
* ```
Expand Down Expand Up @@ -763,10 +763,10 @@ public function downloadAsStreamAsync(array $options = [])
* Token Creator" IAM role.
*
* Additionally, signing using IAM requires different scopes. When creating
* an instance of {@see Google\Cloud\Storage\StorageClient}, provide the
* an instance of {@see StorageClient}, provide the
* `https://www.googleapis.com/auth/cloud-platform` scopein `$options.scopes`.
* This scope may be used entirely in place of the scopes provided in
* {@see Google\Cloud\Storage\StorageClient}.
* {@see StorageClient}.
*
* App Engine and Compute Engine will attempt to sign URLs using IAM.
*
Expand Down Expand Up @@ -904,7 +904,7 @@ public function signedUrl($expires, array $options = [])
/**
* Create a Signed Upload URL for this object.
*
* This method differs from {@see Google\Cloud\Storage\StorageObject::signedUrl()}
* This method differs from {@see StorageObject::signedUrl()}
* in that it allows you to initiate a new resumable upload session. This
* can be used to allow non-authenticated users to insert an object into a
* bucket.
Expand All @@ -915,7 +915,7 @@ public function signedUrl($expires, array $options = [])
* more information.
*
* If you prefer to skip this initial step, you may find
* {@see Google\Cloud\Storage\StorageObject::beginSignedUploadSession()} to
* {@see StorageObject::beginSignedUploadSession()} to
* fit your needs. Note that `beginSignedUploadSession()` cannot be used
* with Google Cloud PHP's Signed URL Uploader, and does not support a
* configurable expiration date.
Expand Down Expand Up @@ -1014,7 +1014,7 @@ public function signedUploadUrl($expires, array $options = [])
* Create a signed URL upload session.
*
* The returned URL differs from the return value of
* {@see Google\Cloud\Storage\StorageObject::signedUploadUrl()} in that it
* {@see StorageObject::signedUploadUrl()} in that it
* is ready to accept upload data immediately via an HTTP PUT request.
*
* Because an upload session is created by the client, the expiration date
Expand Down

0 comments on commit eb45a0a

Please sign in to comment.