revi-archive/phorge-phorge
1
0
Fork 0
mirror of https://we.phorge.it/source/phorge.git synced 2024-12-22 05:20:56 +01:00
Code Issues Releases Wiki Activity

Add missing variable names to PHPDoc @param of methods

Browse source 
Summary:
Add variable names (`$varname` in `@param type $varname explanation`) to PHPDoc method headers, for fun and profit.

Closes T15923

Test Plan:
* Read the method signatures and their corresponding PHPDoc headers at your fireplace
* Still run `./bin/diviner generate` without explosions (though it is very lenient anyway?)

Reviewers: O1 Blessed Committers, valerio.bozzolan

Reviewed By: O1 Blessed Committers, valerio.bozzolan

Subscribers: tobiaswiese, valerio.bozzolan, Matthew, Cigaryno

Maniphest Tasks: T15923

Differential Revision: https://we.phorge.it/D25794
This commit is contained in:
Andre Klapper 2024-08-20 18:04:23 +02:00
parent 9f07e5083d
commit b44b566b13
160 changed files with 879 additions and 793 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
src/aphront/AphrontRequest.php
View file

@ -56,8 +56,8 @@ final class AphrontRequest extends Phobject {
* Applications like Paste, Diffusion, and Harbormaster use "$12-14" in the
* URI to allow users to link to particular lines.
*
* @param string URI data key to pull line range information from.
* @param int|null Maximum length of the range.
* @param string $key URI data key to pull line range information from.
* @param int|null $limit Maximum length of the range.
* @return null|pair<int, int> Null, or beginning and end of the range.
*/
public function getURILineRange($key, $limit) {
@ -537,8 +537,8 @@ final class AphrontRequest extends Phobject {
*
* To set a temporary cookie, see @{method:setTemporaryCookie}.
*
* @param string Cookie name.
* @param string Cookie value.
* @param string $name Cookie name.
* @param string $value Cookie value.
* @return this
* @task cookie
*/
@ -553,8 +553,8 @@ final class AphrontRequest extends Phobject {
*
* To set a durable cookie, see @{method:setCookie}.
*
* @param string Cookie name.
* @param string Cookie value.
* @param string $name Cookie name.
* @param string $value Cookie value.
* @return this
* @task cookie
*/
@ -566,9 +566,9 @@ final class AphrontRequest extends Phobject {
/**
* Set a cookie with a given expiration policy.
*
* @param string Cookie name.
* @param string Cookie value.
* @param int Epoch timestamp for cookie expiration.
* @param string $name Cookie name.
* @param string $value Cookie value.
* @param int $expire Epoch timestamp for cookie expiration.
* @return this
* @task cookie
*/
@ -748,7 +748,7 @@ final class AphrontRequest extends Phobject {
* into a list of key-value pairs suitable for submitting via HTTP request
* (with arrays flattened).
*
* @param dict<string, wild> Data to flatten.
* @param dict<string, wild> $data Data to flatten.
* @return dict<string, string> Flat data suitable for inclusion in an HTTP
* request.
*/
@ -778,9 +778,11 @@ final class AphrontRequest extends Phobject {
* and looks up the appropriate value in `$_SERVER` (in this case,
* `"HTTP_ACCEPT_ENCODING"`).
*
* @param string Canonical header name, like `"Accept-Encoding"`.
* @param wild Default value to return if header is not present.
* @param array? Read this instead of `$_SERVER`.
* @param string $name Canonical header name, like
`"Accept-Encoding"`.
* @param wild? $default Default value to return if header is not
present.
* @param array? $data Read this instead of `$_SERVER`.
* @return string|wild Header value if present, or `$default` if not.
*/
public static function getHTTPHeader($name, $default = null, $data = null) {
@ -844,7 +846,7 @@ final class AphrontRequest extends Phobject {
* This is not a general-purpose proxying method; it is a specialized
* method with niche applications and severe security implications.
*
* @param string URI identifying the host we are proxying the request to.
* @param string URI $uri identifying the host we are proxying the request to.
* @return HTTPSFuture New proxy future.
*
* @phutil-external-symbol class PhabricatorStartup

27
src/aphront/configuration/AphrontApplicationConfiguration.php
View file

@ -510,8 +510,8 @@ final class AphrontApplicationConfiguration
* Map a specific path to the corresponding controller. For a description
* of routing, see @{method:buildController}.
*
* @param list<AphrontRoutingMap> List of routing maps.
* @param string Path to route.
* @param list<AphrontRoutingMap> $maps List of routing maps.
* @param string $path Path to route.
* @return pair<AphrontController,dict> Controller and dictionary of request
* parameters.
* @task routing
@ -562,7 +562,7 @@ final class AphrontApplicationConfiguration
/**
* Tests if a response is of a valid type.
*
* @param wild Supposedly valid response.
* @param wild $response Supposedly valid response.
* @return bool True if the object is of a valid type.
* @task response
*/
@ -583,8 +583,9 @@ final class AphrontApplicationConfiguration
* Verifies that the return value from an @{class:AphrontController} is
* of an allowed type.
*
* @param AphrontController Controller which returned the response.
* @param wild Supposedly valid response.
* @param AphrontController $controller Controller which returned the
* response.
* @param wild $response Supposedly valid response.
* @return void
* @task response
*/
@ -612,9 +613,9 @@ final class AphrontApplicationConfiguration
* Verifies that the return value from an
* @{class:AphrontResponseProducerInterface} is of an allowed type.
*
* @param AphrontResponseProducerInterface Object which produced
* @param AphrontResponseProducerInterface $producer Object which produced
* this response.
* @param wild Supposedly valid response.
* @param wild $response Supposedly valid response.
* @return void
* @task response
*/
@ -642,9 +643,9 @@ final class AphrontApplicationConfiguration
* Verifies that the return value from an
* @{class:AphrontRequestExceptionHandler} is of an allowed type.
*
* @param AphrontRequestExceptionHandler Object which produced this
* @param AphrontRequestExceptionHandler $handler Object which produced this
* response.
* @param wild Supposedly valid response.
* @param wild $response Supposedly valid response.
* @return void
* @task response
*/
@ -678,9 +679,9 @@ final class AphrontApplicationConfiguration
* If a controller returns a response producer, invoke it now and produce
* the real response.
*
* @param AphrontRequest Request being handled.
* @param AphrontResponse|AphrontResponseProducerInterface Response, or
* response producer.
* @param AphrontRequest $request Request being handled.
* @param AphrontResponse|AphrontResponseProducerInterface $response
* Response, or response producer.
* @return AphrontResponse Response after any required production.
* @task response
*/
@ -738,7 +739,7 @@ final class AphrontApplicationConfiguration
* This method delegates exception handling to available subclasses of
* @{class:AphrontRequestExceptionHandler}.
*
* @param Throwable Exception which needs to be handled.
* @param Throwable $throwable Exception which needs to be handled.
* @return wild Response or response producer, or null if no available
* handler can produce a response.
* @task exception

30
src/aphront/httpparametertype/AphrontHTTPParameterType.php
View file

@ -31,7 +31,7 @@ abstract class AphrontHTTPParameterType extends Phobject {
* example, a type might lookup usernames or project names. These types need
* to use the current viewer to execute queries.
*
* @param PhabricatorUser Current viewer.
* @param PhabricatorUser $viewer Current viewer.
* @return this
* @task read
*/
@ -58,8 +58,8 @@ abstract class AphrontHTTPParameterType extends Phobject {
/**
* Test if a value is present in a request.
*
* @param AphrontRequest The incoming request.
* @param string The key to examine.
* @param AphrontRequest $request The incoming request.
* @param string $key The key to examine.
* @return bool True if a readable value is present in the request.
* @task read
*/
@ -74,8 +74,8 @@ abstract class AphrontHTTPParameterType extends Phobject {
* If the value is not present, a default value is returned (usually `null`).
* Use @{method:getExists} to test if a value is present.
*
* @param AphrontRequest The incoming request.
* @param string The key to examine.
* @param AphrontRequest $request The incoming request.
* @param string $key The key to examine.
* @return wild Value, or default if value is not present.
* @task read
*/
@ -165,9 +165,9 @@ abstract class AphrontHTTPParameterType extends Phobject {
* existence check that a simpler "list of strings" type has, and can just
* call the simpler type to reuse its behavior.
*
* @param AphrontHTTPParameterType The other type.
* @param AphrontRequest Incoming request.
* @param string Key to examine.
* @param AphrontHTTPParameterType $type The other type.
* @param AphrontRequest $request Incoming request.
* @param string $key Key to examine.
* @return bool True if the parameter exists.
* @task util
*/
@ -189,9 +189,9 @@ abstract class AphrontHTTPParameterType extends Phobject {
* type. For example, a "list of users" type may start by running the same
* basic parsing that a simpler "list of strings" type does.
*
* @param AphrontHTTPParameterType The other type.
* @param AphrontRequest Incoming request.
* @param string Key to examine.
* @param AphrontHTTPParameterType $type The other type.
* @param AphrontRequest $request Incoming request.
* @param string $key Key to examine.
* @return wild Parsed value.
* @task util
*/
@ -233,8 +233,8 @@ abstract class AphrontHTTPParameterType extends Phobject {
* To call another type's behavior in order to perform this check, use
* @{method:getExistsWithType}.
*
* @param AphrontRequest The incoming request.
* @param string The key to examine.
* @param AphrontRequest $request The incoming request.
* @param string $key The key to examine.
* @return bool True if a readable value is present in the request.
* @task impl
*/
@ -253,8 +253,8 @@ abstract class AphrontHTTPParameterType extends Phobject {
* To call another type's behavior in order to parse a value, use
* @{method:getValueWithType}.
*
* @param AphrontRequest The incoming request.
* @param string The key to examine.
* @param AphrontRequest $request The incoming request.
* @param string $key The key to examine.
* @return wild Parsed value.
* @task impl
*/

2
src/aphront/response/AphrontFileResponse.php
View file

@ -30,7 +30,7 @@ final class AphrontFileResponse extends AphrontResponse {
/**
* Set a download filename
*
* @param $download string
* @param string $download
* @return self
*/
public function setDownload($download) {

5
src/aphront/response/AphrontRedirectResponse.php
View file

@ -117,8 +117,9 @@ class AphrontRedirectResponse extends AphrontResponse {
* ambiguity. For example, Chrome interprets "Location: /\evil.com" to mean
* "perform a protocol-relative redirect to evil.com".
*
* @param string URI to redirect to.
* @param bool True if this URI identifies a remote resource.
* @param string $uri URI to redirect to.
* @param bool $is_external True if this URI identifies a remote
* resource.
* @return string URI for use in a "Location:" header.
*/
public static function getURIForRedirect($uri, $is_external) {

9
src/aphront/sink/AphrontHTTPSink.php
View file

@ -28,7 +28,8 @@ abstract class AphrontHTTPSink extends Phobject {
/**
* Write an HTTP status code to the output.
*
* @param int Numeric HTTP status code.
* @param int $code Numeric HTTP status code.
* @param string? $message
* @return void
*/
final public function writeHTTPStatus($code, $message = '') {
@ -44,7 +45,7 @@ abstract class AphrontHTTPSink extends Phobject {
/**
* Write HTTP headers to the output.
*
* @param list<pair> List of <name, value> pairs.
* @param list<pair> $headers List of <name, value> pairs.
* @return void
*/
final public function writeHeaders(array $headers) {
@ -89,7 +90,7 @@ abstract class AphrontHTTPSink extends Phobject {
/**
* Write HTTP body data to the output.
*
* @param string Body data.
* @param string $data Body data.
* @return void
*/
final public function writeData($data) {
@ -100,7 +101,7 @@ abstract class AphrontHTTPSink extends Phobject {
/**
* Write an entire @{class:AphrontResponse} to the output.
*
* @param AphrontResponse The response object to write.
* @param AphrontResponse $response The response object to write.
* @return void
*/
final public function writeResponse(AphrontResponse $response) {

8
src/aphront/site/AphrontRoutingMap.php
View file

@ -50,7 +50,7 @@ final class AphrontRoutingMap extends Phobject {
/**
* Find the route matching a path, if one exists.
*
* @param string Path to route.
* @param string $path Path to route.
* @return AphrontRoutingResult|null Routing result, if path matches map.
* @task routing
*/
@ -84,9 +84,9 @@ final class AphrontRoutingMap extends Phobject {
/**
* Test a sub-map to see if any routes match a path.
*
* @param string Path to route.
* @param string Pattern from the map.
* @param string Value from the map.
* @param string $route Pattern from the map.
* @param string $value Value from the map.
* @param string $path Path to route.
* @return dict<string, wild>|null Match details, if path matches sub-map.
* @task routing
*/

2
src/aphront/writeguard/AphrontWriteGuard.php
View file

@ -57,7 +57,7 @@ final class AphrontWriteGuard extends Phobject {
* the request, or abort the request (e.g., by throwing an exception) if a
* valid token isn't present.
*
* @param callable CSRF callback.
* @param $callback Callable CSRF callback.
* @return this
* @task manage
*/

2
src/applications/auth/constants/PhabricatorCommonPasswords.php
View file

@ -16,7 +16,7 @@ final class PhabricatorCommonPasswords extends Phobject {
/**
* Check if a password is extremely common.
*
* @param string Password to test.
* @param string $password Password to test.
* @return bool True if the password is pathologically weak.
*
* @task common

14
src/applications/auth/constants/PhabricatorCookies.php
View file

@ -77,7 +77,7 @@ final class PhabricatorCookies extends Phobject {
* Set the client ID cookie. This is a random cookie used like a CSRF value
* during authentication workflows.
*
* @param AphrontRequest Request to modify.
* @param AphrontRequest $request Request to modify.
* @return void
* @task clientid
*/
@ -105,10 +105,10 @@ final class PhabricatorCookies extends Phobject {
* written, to avoid writing over a real URI with a bunch of "humans.txt"
* stuff. See T3793 for discussion.
*
* @param AphrontRequest Request to write to.
* @param string URI to write.
* @param bool Write this cookie even if we have a fresh
* cookie already.
* @param AphrontRequest $request Request to write to.
* @param string $next_uri URI to write.
* @param bool? $force Write this cookie even if we have a
* fresh cookie already.
* @return void
*
* @task next
@ -139,7 +139,7 @@ final class PhabricatorCookies extends Phobject {
/**
* Read the URI out of the Next URI cookie.
*
* @param AphrontRequest Request to examine.
* @param AphrontRequest $request Request to examine.
* @return string|null Next URI cookie's URI value.
*
* @task next
@ -155,7 +155,7 @@ final class PhabricatorCookies extends Phobject {
/**
* Parse a Next URI cookie into its components.
*
* @param string Raw cookie value.
* @param string $cookie Raw cookie value.
* @return list<string> List of timestamp and URI.
*
* @task next

5
src/applications/auth/controller/PhabricatorAuthController.php
View file

@ -44,8 +44,9 @@ abstract class PhabricatorAuthController extends PhabricatorController {
* the user's cookies are set. However, event listeners can intercept this
* event and do something else if they prefer.
*
* @param PhabricatorUser User to log the viewer in as.
* @param bool True to issue a full session immediately, bypassing MFA.
* @param PhabricatorUser $user User to log the viewer in as.
* @param bool? $force_full_session True to issue a full session immediately,
* bypassing MFA.
* @return AphrontResponse Response which continues the login process.
*/
protected function loginUser(

89
src/applications/auth/engine/PhabricatorAuthSessionEngine.php
View file

@ -75,7 +75,7 @@ final class PhabricatorAuthSessionEngine extends Phobject {
* Get the session kind (e.g., anonymous, user, external account) from a
* session token. Returns a `KIND_` constant.
*
* @param string Session token.
* @param string $session_token Session token.
* @return const Session kind constant.
*/
public static function getSessionKindFromToken($session_token) {
@ -109,8 +109,8 @@ final class PhabricatorAuthSessionEngine extends Phobject {
* loading context. This prevents use of a Conduit sesssion as a Web
* session, for example.
*
* @param const The type of session to load.
* @param string The session token.
* @param const $session_type The type of session to load.
* @param string $session_token The session token.
* @return PhabricatorUser|null
* @task use
*/
@ -250,11 +250,12 @@ final class PhabricatorAuthSessionEngine extends Phobject {
* You can configure the maximum number of concurrent sessions for various
* session types in the Phabricator configuration.
*
* @param const Session type constant (see
* @param const $session_type Session type constant (see
* @{class:PhabricatorAuthSession}).
* @param phid|null Identity to establish a session for, usually a user
* PHID. With `null`, generates an anonymous session.
* @param bool True to issue a partial session.
* @param phid|null $identity_phid Identity to establish a session for,
* usually a user PHID. With `null`, generates an
* anonymous session.
* @param bool $partial True to issue a partial session.
* @return string Newly generated session key.
*/
public function establishSession($session_type, $identity_phid, $partial) {
@ -325,9 +326,9 @@ final class PhabricatorAuthSessionEngine extends Phobject {
* This is used when users change passwords, linked accounts, or add
* multifactor authentication.
*
* @param PhabricatorUser User whose sessions should be terminated.
* @param string|null Optionally, one session to keep. Normally, the current
* login session.
* @param PhabricatorUser $user User whose sessions should be terminated.
* @param string|null? $except_session Optionally, one session to keep.
* Normally, the current login session.
*
* @return void
*/
@ -388,9 +389,11 @@ final class PhabricatorAuthSessionEngine extends Phobject {
* does not upgrade the user's session as a side effect. This method is
* appropriate for one-time checks.
*
* @param PhabricatorUser User whose session needs to be in high security.
* @param AphrontRequest Current request.
* @param string URI to return the user to if they cancel.
* @param PhabricatorUser $viewer User whose session needs to be in high
* security.
* @param AphrontRequest $request Current request.
* @param string $cancel_uri URI to return the user to if they
* cancel.
* @return PhabricatorAuthHighSecurityToken Security token.
* @task hisec
*/
@ -420,12 +423,14 @@ final class PhabricatorAuthSessionEngine extends Phobject {
* take multiple high security actions. To perform a one-time check instead,
* use @{method:requireHighSecurityToken}.
*
* @param PhabricatorUser User whose session needs to be in high security.
* @param AphrontRequest Current request.
* @param string URI to return the user to if they cancel.
* @param bool True to jump partial sessions directly into high
* security instead of just upgrading them to full
* sessions.
* @param PhabricatorUser $viewer User whose session needs to be in high
* security.
* @param AphrontRequest $request Current request.
* @param string $cancel_uri URI to return the user to if they
* cancel.
* @param bool? $jump_into_hisec True to jump partial sessions
* directly into high security instead of just
* upgrading them to full sessions.
* @return PhabricatorAuthHighSecurityToken Security token.
* @task hisec
*/
@ -736,8 +741,8 @@ final class PhabricatorAuthSessionEngine extends Phobject {
/**
* Issue a high security token for a session, if authorized.
*
* @param PhabricatorAuthSession Session to issue a token for.
* @param bool Force token issue.
* @param PhabricatorAuthSession $session Session to issue a token for.
* @param bool? $force Force token issue.
* @return PhabricatorAuthHighSecurityToken|null Token, if authorized.
* @task hisec
*/
@ -756,8 +761,10 @@ final class PhabricatorAuthSessionEngine extends Phobject {
/**
* Render a form for providing relevant multi-factor credentials.
*
* @param PhabricatorUser Viewing user.
* @param AphrontRequest Current request.
* @param array $factors
* @param array $validation_results
* @param PhabricatorUser $viewer Viewing user.
* @param AphrontRequest $request Current request.
* @return AphrontFormView Renderable form.
* @task hisec
*/
@ -810,8 +817,9 @@ final class PhabricatorAuthSessionEngine extends Phobject {
*
* Kicks a session out of high security and logs the exit.
*
* @param PhabricatorUser Acting user.
* @param PhabricatorAuthSession Session to return to normal security.
* @param PhabricatorUser $viewer Acting user.
* @param PhabricatorAuthSession $session Session to return to normal
* security.
* @return void
* @task hisec
*/
@ -843,7 +851,7 @@ final class PhabricatorAuthSessionEngine extends Phobject {
/**
* Upgrade a partial session to a full session.
*
* @param PhabricatorAuthSession Session to upgrade.
* @param PhabricatorUser $viewer Viewer whose session should upgrade.
* @return void
* @task partial
*/
@ -885,8 +893,8 @@ final class PhabricatorAuthSessionEngine extends Phobject {
/**
* Upgrade a session to have all legalpad documents signed.
*
* @param PhabricatorUser User whose session should upgrade.
* @param array LegalpadDocument objects
* @param PhabricatorUser $viewer User whose session should upgrade.
* @param array $docs LegalpadDocument objects
* @return void
* @task partial
*/
@ -934,13 +942,14 @@ final class PhabricatorAuthSessionEngine extends Phobject {
* These URIs are used for password recovery and to regain access to accounts
* which users have been locked out of.
*
* @param PhabricatorUser User to generate a URI for.
* @param PhabricatorUserEmail Optionally, email to verify when
* @param PhabricatorUser $user User to generate a URI for.
* @param PhabricatorUserEmail? $email Optionally, email to verify when
* link is used.
* @param string Optional context string for the URI. This is purely cosmetic
* and used only to customize workflow and error messages.
* @param bool True to generate a URI which forces an immediate upgrade to
* a full session, bypassing MFA and other login checks.
* @param string? $type Optional context string for the URI. This is purely
* cosmetic and used only to customize workflow and error messages.
* @param bool? $force_full_session True to generate a URI which forces an
* immediate upgrade to a full session, bypassing MFA and other login
* checks.
* @return string Login URI.
* @task onetime
*/
@ -984,10 +993,10 @@ final class PhabricatorAuthSessionEngine extends Phobject {
/**
* Load the temporary token associated with a given one-time login key.
*
* @param PhabricatorUser User to load the token for.
* @param PhabricatorUserEmail Optionally, email to verify when
* @param PhabricatorUser $user User to load the token for.
* @param PhabricatorUserEmail? $email Optionally, email to verify when
* link is used.
* @param string Key user is presenting as a valid one-time login key.
* @param string? $key Key user is presenting as a valid one-time login key.
* @return PhabricatorAuthTemporaryToken|null Token, if one exists.
* @task onetime
*/
@ -1012,10 +1021,10 @@ final class PhabricatorAuthSessionEngine extends Phobject {
/**
* Hash a one-time login key for storage as a temporary token.
*
* @param PhabricatorUser User this key is for.
* @param PhabricatorUserEmail Optionally, email to verify when
* @param PhabricatorUser $user User this key is for.
* @param PhabricatorUserEmail? $email Optionally, email to verify when
* link is used.
* @param string The one time login key.
* @param string? $key The one time login key.
* @return string Hash of the key.
* task onetime
*/

4
src/applications/auth/password/PhabricatorAuthPasswordHashInterface.php
View file

@ -14,8 +14,8 @@ interface PhabricatorAuthPasswordHashInterface {
* as their password or picking other passwords which are trivially similar
* to an account or object identifier.
*
* @param PhabricatorUser The user selecting the password.
* @param PhabricatorAuthPasswordEngine The password engine updating a
* @param PhabricatorUser $viewer The user selecting the password.
* @param PhabricatorAuthPasswordEngine $engine The password engine updating a
* password.
* @return list<string> Blocklist of nonsecret identifiers which the password
* should not be similar to.

6
src/applications/auth/provider/PhabricatorAuthProvider.php
View file

@ -460,9 +460,9 @@ abstract class PhabricatorAuthProvider extends Phobject {
* - `uri`: URI the button should take the user to when clicked.
* - `method`: Optional HTTP method the button should use, defaults to GET.
*
* @param AphrontRequest HTTP request.
* @param string Request mode string.
* @param map Additional parameters, see above.
* @param AphrontRequest $request HTTP request.
* @param string $mode Request mode string.
* @param map? $attributes Additional parameters, see above.
* @return wild Log in button.
*/
protected function renderStandardLoginButton(

14
src/applications/base/PhabricatorApplication.php
View file

@ -141,7 +141,7 @@ abstract class PhabricatorApplication
*
* Users who have not yet set preferences see a default list of applications.
*
* @param PhabricatorUser User viewing the pinned application list.
* @param PhabricatorUser $viewer User viewing the pinned application list.
* @return bool True if this application should be pinned by default.
*/
public function isPinnedByDefault(PhabricatorUser $viewer) {
@ -330,9 +330,9 @@ abstract class PhabricatorApplication
/**
* Build items for the main menu.
*
* @param PhabricatorUser The viewing user.
* @param AphrontController The current controller. May be null for special
* pages like 404, exception handlers, etc.
* @param PhabricatorUser $user The viewing user.
* @param AphrontController? $controller The current controller. May be null
* for special pages like 404, exception handlers, etc.
* @return list<PHUIListItemView> List of menu items.
* @task ui
*/
@ -409,7 +409,7 @@ abstract class PhabricatorApplication
* To check if an application is installed //and// available to a particular
* viewer, user @{method:isClassInstalledForViewer}.
*
* @param string Application class name.
* @param string $class Application class name.
* @return bool True if the class is installed.
* @task meta
*/
@ -425,8 +425,8 @@ abstract class PhabricatorApplication
* To check if an application is installed at all, use
* @{method:isClassInstalled}.
*
* @param string Application class name.
* @param PhabricatorUser Viewing user.
* @param string $class Application class name.
* @param PhabricatorUser $viewer Viewing user.
* @return bool True if the class is installed for the viewer.
* @task meta
*/

4
src/applications/cache/PhabricatorCaches.php vendored
View file

@ -416,7 +416,7 @@ final class PhabricatorCaches extends Phobject {
*
* Data can later be inflated with @{method:inflateData}.
*
* @param string String to attempt to deflate.
* @param string $value String to attempt to deflate.
* @return string|null Deflated string, or null if it was not deflated.
* @task compress
*/
@ -447,7 +447,7 @@ final class PhabricatorCaches extends Phobject {
/**
* Inflate data previously deflated by @{method:maybeDeflateData}.
*
* @param string Deflated data, from @{method:maybeDeflateData}.
* @param string $value Deflated data, from @{method:maybeDeflateData}.
* @return string Original, uncompressed data.
* @task compress
*/

12
src/applications/celerity/CelerityResourceMap.php
View file

@ -160,7 +160,7 @@ final class CelerityResourceMap extends Phobject {
/**
* Get the epoch timestamp of the last modification time of a symbol.
*
* @param string Resource symbol to lookup.
* @param string $name Resource symbol to lookup.
* @return int Epoch timestamp of last resource modification.
*/
public function getModifiedTimeForName($name) {
@ -186,7 +186,7 @@ final class CelerityResourceMap extends Phobject {
* Return the absolute URI for the resource associated with a symbol. This
* method is fairly low-level and ignores packaging.
*
* @param string Resource symbol to lookup.
* @param string $symbol Resource symbol to lookup.
* @return string|null Resource URI, or null if the symbol is unknown.
*/
public function getURIForSymbol($symbol) {
@ -199,7 +199,7 @@ final class CelerityResourceMap extends Phobject {
* Return the absolute URI for the resource associated with a resource name.
* This method is fairly low-level and ignores packaging.
*
* @param string Resource name to lookup.
* @param string $name Resource name to lookup.
* @return string|null Resource URI, or null if the name is unknown.
*/
public function getURIForName($name) {
@ -217,7 +217,7 @@ final class CelerityResourceMap extends Phobject {
* Return the absolute URI for a resource, identified by hash.
* This method is fairly low-level and ignores packaging.
*
* @param string Resource hash to lookup.
* @param string $hash Resource hash to lookup.
* @return string|null Resource URI, or null if the hash is unknown.
*/
private function getURIForHash($hash) {
@ -231,7 +231,7 @@ final class CelerityResourceMap extends Phobject {
/**
* Return the resource symbols required by a named resource.
*
* @param string Resource name to lookup.
* @param string $name Resource name to lookup.
* @return list<string>|null List of required symbols, or null if the name
* is unknown.
*/
@ -247,7 +247,7 @@ final class CelerityResourceMap extends Phobject {
/**
* Return the resource name for a given symbol.
*
* @param string Resource symbol to lookup.
* @param string $symbol Resource symbol to lookup.
* @return string|null Resource name, or null if the symbol is unknown.
*/
public function getResourceNameForSymbol($symbol) {

23
src/applications/celerity/CelerityResourceMapGenerator.php
View file

@ -146,7 +146,8 @@ EOFILE;
* Find binary resources (like PNG and SWF) and return information about
* them.
*
* @param CelerityPhysicalResources Resource map to find binary resources for.
* @param CelerityPhysicalResources $resources Resource map to find binary
* resources for.
* @return map<string, map<string, string>> Resource information map.
*/
private function rebuildBinaryResources(
@ -170,8 +171,10 @@ EOFILE;
/**
* Find text resources (like JS and CSS) and return information about them.
*
* @param CelerityPhysicalResources Resource map to find text resources for.
* @param CelerityResourceTransformer Configured resource transformer.
* @param CelerityPhysicalResources $resources Resource map to find text
* resources for.
* @param CelerityResourceTransformer $xformer Configured resource
* transformer.
* @return map<string, map<string, string>> Resource information map.
*/
private function rebuildTextResources(
@ -211,8 +214,8 @@ EOFILE;
* Parse the `@provides` and `@requires` symbols out of a text resource, like
* JS or CSS.
*
* @param string Resource name.
* @param string Resource data.
* @param string $name Resource name.
* @param string $data Resource data.
* @return pair<string|null, list<string>|null> The `@provides` symbol and
* the list of `@requires` symbols. If the resource is not part of the
* dependency graph, both are null.
@ -254,8 +257,8 @@ EOFILE;
* Check for dependency cycles in the resource graph. Raises an exception if
* a cycle is detected.
*
* @param map<string, list<string>> Map of `@provides` symbols to their
* `@requires` symbols.
* @param map<string, list<string>> $nodes Map of `@provides` symbols to
* their `@requires` symbols.
* @return void
*/
private function detectGraphCycles(array $nodes) {
@ -278,9 +281,9 @@ EOFILE;
/**
* Build package specifications for a given resource source.
*
* @param CelerityPhysicalResources Resource source to rebuild.
* @param map<string, string> Map of `@provides` to hashes.
* @param map<string, string> Map of hashes to resource names.
* @param CelerityPhysicalResources $resources Resource source to rebuild.
* @param map<string, string> $symbol_map Map of `@provides` to hashes.
* @param map<string, string> $reverse_map Map of hashes to resource names.
* @return map<string, map<string, string>> Package information maps.
*/
private function rebuildPackages(

3
src/applications/celerity/CelerityResourceTransformer.php
View file

@ -228,7 +228,8 @@ final class CelerityResourceTransformer extends Phobject {
* small enough. Otherwise, this method will return `null` and we'll end up
* using a normal URI instead.
*
* @param string Resource name to attempt to generate a data URI for.
* @param string $resource_name Resource name to attempt to generate a data
* URI for.
* @return string|null Data URI, or null if we declined to generate one.
*/
private function generateDataURI($resource_name) {

8
src/applications/celerity/api.php
View file

@ -9,8 +9,9 @@
*
* For more information, see @{article:Adding New CSS and JS}.
*
* @param string Name of the celerity module to include. This is whatever you
* annotated as "@provides" in the file.
* @param string $symbol Name of the celerity module to include. This is
* whatever you annotated as "@provides" in the file.
* @param string? $source_name
* @return void
*/
function require_celerity_resource($symbol, $source_name = 'phabricator') {
@ -40,7 +41,8 @@ function celerity_generate_unique_node_id() {
/**
* Get the versioned URI for a raw resource, like an image.
*
* @param string Path to the raw image.
* @param string $resource Path to the raw image.
* @param string? $source
* @return string Versioned path to the image, if one is available.
*/
function celerity_get_resource_uri($resource, $source = 'phabricator') {

2
src/applications/celerity/controller/CelerityResourceController.php
View file

@ -194,7 +194,7 @@ abstract class CelerityResourceController extends PhabricatorController {
* are cached, while other types of resources (which are large, and cheap
* to process) are not.
*
* @param string Resource type.
* @param string $type Resource type.
* @return bool True to enable caching.
*/
private function isLocallyCacheableResourceType($type) {

2
src/applications/celerity/management/CelerityManagementMapWorkflow.php
View file

@ -32,7 +32,7 @@ final class CelerityManagementMapWorkflow
/**
* Rebuild the resource map for a resource source.
*
* @param CelerityPhysicalResources Resource source to rebuild.
* @param $resources CelerityPhysicalResources Resource source to rebuild.
* @return void
*/
private function rebuildResources(CelerityPhysicalResources $resources) {

5
src/applications/conduit/controller/PhabricatorConduitAPIController.php
View file

@ -159,8 +159,9 @@ final class PhabricatorConduitAPIController
/**
* Authenticate the client making the request to a Phabricator user account.
*
* @param ConduitAPIRequest Request being executed.
* @param dict Request metadata.
* @param ConduitAPIRequest $api_request Request being executed.
* @param dict $metadata Request metadata.
* @param wild $method
* @return null|pair Null to indicate successful authentication, or
* an error code and error message pair.
*/

2
src/applications/conduit/protocol/exception/ConduitException.php
View file

@ -12,7 +12,7 @@ class ConduitException extends Exception {
* will be used instead. This is useful to provide specific information about
* an exception (e.g., which values were wrong in an invalid request).
*
* @param string Detailed error description.
* @param string $error_description Detailed error description.
* @return this
*/
final public function setErrorDescription($error_description) {

2
src/applications/config/custom/PhabricatorCustomLogoConfigType.php
View file

@ -15,7 +15,7 @@ final class PhabricatorCustomLogoConfigType
/**
* Return the full URI of the Phorge logo
* @param PhabricatorUser Current viewer
* @param PhabricatorUser $viewer Current viewer
* @return string Full URI of the Phorge logo
*/
public static function getLogoURI(PhabricatorUser $viewer) {

4
src/applications/config/issue/PhabricatorSetupIssue.php
View file

@ -145,8 +145,8 @@ final class PhabricatorSetupIssue extends Phobject {
* we alter `memory_limit` during startup, so if the original value is not
* provided it will look like it is always set to `-1`.
*
* @param string PHP configuration option to provide a value for.
* @param string Explicit value to show in the UI.
* @param string $php_config PHP configuration option to provide a value for.
* @param string $value Explicit value to show in the UI.
* @return this
*/
public function addPHPConfigOriginalValue($php_config, $value) {

3
src/applications/config/json/PhabricatorConfigJSON.php
View file

@ -4,7 +4,8 @@ final class PhabricatorConfigJSON extends Phobject {
/**
* Properly format a JSON value.
*
* @param wild Any value, but should be a raw value, not a string of JSON.
* @param wild $value Any value, but should be a raw value, not a string of
* JSON.
* @return string
*/
public static function prettyPrintJSON($value) {

4
src/applications/config/option/PhabricatorApplicationConfigOptions.php
View file

@ -65,8 +65,8 @@ abstract class PhabricatorApplicationConfigOptions extends Phobject {
* or other context. For example, this is used to show workspace IDs when
* configuring `asana.workspace-id`.
*
* @param PhabricatorConfigOption Option being rendered.
* @param AphrontRequest Active request.
* @param PhabricatorConfigOption $option Option being rendered.
* @param AphrontRequest $request Active request.
* @return wild Additional contextual description
* information.
*/

2
src/applications/dashboard/engine/PhabricatorDashboardPanelRenderingEngine.php
View file

@ -427,7 +427,7 @@ final class PhabricatorDashboardPanelRenderingEngine extends Phobject {
* panel. Generally, all of this stuff is ridiculous and we just want to
* shut it down.
*
* @param PhabricatorDashboardPanel Panel being rendered.
* @param PhabricatorDashboardPanel $panel Panel being rendered.
* @return void
*/
private function detectRenderingCycle(PhabricatorDashboardPanel $panel) {

2
src/applications/differential/constants/DifferentialReviewerStatus.php
View file

@ -19,7 +19,7 @@ final class DifferentialReviewerStatus extends Phobject {
* will attempt to update you to both "commented" and "accepted". We want
* "accepted" to win, because it's the stronger of the two.
*
* @param const Reviewer status constant.
* @param const $constant Reviewer status constant.
* @return int Relative strength (higher is stronger).
*/
public static function getStatusStrength($constant) {

23
src/applications/differential/parser/DifferentialChangesetParser.php
View file

@ -240,12 +240,12 @@ final class DifferentialChangesetParser extends Phobject {
* the left and right halves of the displayed diff to be correctly mapped to
* storage changesets.
*
* @param id The Differential Changeset ID that comments added to the right
* side of the visible diff should be attached to.
* @param bool If true, attach new comments to the right side of the storage
* changeset. Note that this may be false, if the left side of
* some storage changeset is being shown as the right side of
* a display diff.
* @param id $id The Differential Changeset ID that comments added to the
* right side of the visible diff should be attached to.
* @param bool $is_new If true, attach new comments to the right side of the
* storage changeset. Note that this may be false, if the left
* side of some storage changeset is being shown as the right
* side of a display diff.
* @return this
*/
public function setRightSideCommentMapping($id, $is_new) {
@ -295,7 +295,8 @@ final class DifferentialChangesetParser extends Phobject {
* By default, there is no render cache key and parsers do not use the cache.
* This is appropriate for rarely-viewed changesets.
*
* @param string Key for identifying this changeset in the render cache.
* @param string $key Key for identifying this changeset in the render
* cache.
* @return this
*/
public function setRenderCacheKey($key) {
@ -1238,7 +1239,7 @@ final class DifferentialChangesetParser extends Phobject {
* taking into consideration which halves of which changesets will actually
* be shown.
*
* @param PhabricatorInlineComment Comment to test for visibility.
* @param PhabricatorInlineComment $comment Comment to test for visibility.
* @return bool True if the comment is visible on the rendered diff.
*/
private function isCommentVisibleOnRenderedDiff(
@ -1266,7 +1267,7 @@ final class DifferentialChangesetParser extends Phobject {
* Note that the comment must appear somewhere on the rendered changeset, as
* per isCommentVisibleOnRenderedDiff().
*
* @param PhabricatorInlineComment Comment to test for display
* @param PhabricatorInlineComment $comment Comment to test for display
* location.
* @return bool True for right, false for left.
*/
@ -1298,8 +1299,8 @@ final class DifferentialChangesetParser extends Phobject {
* list($start, $end, $mask) = $parsed;
* $parser->render($start, $end, $mask);
*
* @param string Range specification, indicating the range of the diff that
* should be rendered.
* @param string $spec Range specification, indicating the range of the diff
* that should be rendered.
* @return tuple List of <start, end, mask> suitable for passing to
* @{method:render}.
*/

4
src/applications/differential/parser/DifferentialLineAdjustmentMap.php
View file

@ -58,8 +58,8 @@ final class DifferentialLineAdjustmentMap extends Phobject {
/**
* Map a line across a change, or a series of changes.
*
* @param int Line to map
* @param bool True to map it as the end of a range.
* @param int $line Line to map
* @param bool $is_end True to map it as the end of a range.
* @return wild Spooky magic.
*/
public function mapLine($line, $is_end) {

30
src/applications/differential/query/DifferentialRevisionQuery.php
View file

@ -45,7 +45,7 @@ final class DifferentialRevisionQuery
/**
* Find revisions affecting one or more items in a list of paths.
*
* @param list<string> List of file paths.
* @param list<string> $paths List of file paths.
* @return this
* @task config
*/
@ -59,7 +59,7 @@ final class DifferentialRevisionQuery
* this function will clear anything set by previous calls to
* @{method:withAuthors}.
*
* @param array List of PHIDs of authors
* @param array $author_phids List of PHIDs of authors
* @return this
* @task config
*/
@ -72,7 +72,7 @@ final class DifferentialRevisionQuery
* Filter results to revisions which CC one of the listed people. Calling this
* function will clear anything set by previous calls to @{method:withCCs}.
*
* @param array List of PHIDs of subscribers.
* @param array $cc_phids List of PHIDs of subscribers.
* @return this
* @task config
*/
@ -86,7 +86,7 @@ final class DifferentialRevisionQuery
* reviewers. Calling this function will clear anything set by previous calls
* to @{method:withReviewers}.
*
* @param array List of PHIDs of reviewers
* @param array $reviewer_phids List of PHIDs of reviewers
* @return this
* @task config
*/
@ -124,7 +124,7 @@ final class DifferentialRevisionQuery
* Calling this function will clear anything set by previous calls to
* @{method:withCommitHashes}.
*
* @param array List of pairs <Class
* @param array $commit_hashes List of pairs <Class
* ArcanistDifferentialRevisionHash::HASH_$type constant,
* hash>
* @return this
@ -149,7 +149,7 @@ final class DifferentialRevisionQuery
/**
* Filter results to revisions on given branches.
*
* @param list List of branch names.
* @param list $branches List of branch names.
* @return this
* @task config
*/
@ -162,7 +162,7 @@ final class DifferentialRevisionQuery
/**
* Filter results to only return revisions whose ids are in the given set.
*
* @param array List of revision ids
* @param array $ids List of revision ids
* @return this
* @task config
*/
@ -175,7 +175,7 @@ final class DifferentialRevisionQuery
/**
* Filter results to only return revisions whose PHIDs are in the given set.
*
* @param array List of revision PHIDs
* @param array $phids List of revision PHIDs
* @return this
* @task config
*/
@ -189,7 +189,7 @@ final class DifferentialRevisionQuery
* Given a set of users, filter results to return only revisions they are
* responsible for (i.e., they are either authors or reviewers).
*
* @param array List of user PHIDs.
* @param array $responsible_phids List of user PHIDs.
* @return this
* @task config
*/
@ -221,7 +221,7 @@ final class DifferentialRevisionQuery
* Set whether or not the query should load the active diff for each
* revision.
*
* @param bool True to load and attach diffs.
* @param bool $need_active_diffs True to load and attach diffs.
* @return this
* @task config
*/
@ -235,7 +235,7 @@ final class DifferentialRevisionQuery
* Set whether or not the query should load the associated commit PHIDs for
* each revision.
*
* @param bool True to load and attach diffs.
* @param bool $need_commit_phids True to load and attach diffs.
* @return this
* @task config
*/
@ -249,7 +249,7 @@ final class DifferentialRevisionQuery
* Set whether or not the query should load associated diff IDs for each
* revision.
*
* @param bool True to load and attach diff IDs.
* @param bool $need_diff_ids True to load and attach diff IDs.
* @return this
* @task config
*/
@ -263,7 +263,7 @@ final class DifferentialRevisionQuery
* Set whether or not the query should load associated commit hashes for each
* revision.
*
* @param bool True to load and attach commit hashes.
* @param bool $need_hashes True to load and attach commit hashes.
* @return this
* @task config
*/
@ -276,7 +276,7 @@ final class DifferentialRevisionQuery
/**
* Set whether or not the query should load associated reviewers.
*
* @param bool True to load and attach reviewers.
* @param bool $need_reviewers True to load and attach reviewers.
* @return this
* @task config
*/
@ -291,7 +291,7 @@ final class DifferentialRevisionQuery
* reviewer. In particular, they have authority to act on behalf of projects
* they are a member of.
*
* @param bool True to load and attach authority.
* @param bool $need_reviewer_authority True to load and attach authority.
* @return this
* @task config
*/

13
src/applications/differential/render/DifferentialChangesetHTMLRenderer.php
View file

@ -491,9 +491,10 @@ abstract class DifferentialChangesetHTMLRenderer
/**
* Build links which users can click to show more context in a changeset.
*
* @param int Beginning of the line range to build links for.
* @param int Length of the line range to build links for.
* @param int Total number of lines in the changeset.
* @param int $top Beginning of the line range to build links for.
* @param int $len Length of the line range to build links for.
* @param int $changeset_length Total number of lines in the changeset.
* @param bool? $is_blocks
* @return markup Rendered links.
*/
protected function renderShowContextLinks(
@ -580,9 +581,9 @@ abstract class DifferentialChangesetHTMLRenderer
*
* See @{method:renderShowContextLinks}.
*
* @param bool Does this link show all context when clicked?
* @param string Range specification for lines to show.
* @param string Text of the link.
* @param bool $is_all Does this link show all context when clicked?
* @param string $range Range specification for lines to show.
* @param string $text Text of the link.
* @return markup Rendered link.
*/
private function renderShowContextLink($is_all, $range, $text) {

4
src/applications/differential/render/DifferentialChangesetRenderer.php
View file

@ -442,8 +442,8 @@ abstract class DifferentialChangesetRenderer extends Phobject {
* when a file is not changed.
* - `"none"`: Don't show the link (e.g., text not available).
*
* @param string Message explaining why the diff is hidden.
* @param string|null Force mode, see above.
* @param string $message Message explaining why the diff is hidden.
* @param string|null $force Force mode, see above.
* @return string Shield markup.
*/
abstract public function renderShield($message, $force = 'default');

2
src/applications/differential/storage/DifferentialChangeset.php
View file

@ -213,7 +213,7 @@ final class DifferentialChangeset
* Test if this changeset and some other changeset put the affected file in
* the same state.
*
* @param DifferentialChangeset Changeset to compare against.
* @param DifferentialChangeset $other Changeset to compare against.
* @return bool True if the two changesets have the same effect.
*/
public function hasSameEffectAs(DifferentialChangeset $other) {

2
src/applications/diffusion/data/DiffusionBrowseResultSet.php
View file

@ -123,7 +123,7 @@ final class DiffusionBrowseResultSet extends Phobject {
* When a directory contains several README files, this function scores them
* so the caller can select a preferred file. See @{method:getReadmePath}.
*
* @param string Local README path, like "README.txt".
* @param string $path Local README path, like "README.txt".
* @return int Priority score, with higher being more preferred.
*/
public static function getReadmePriority($path) {

5
src/applications/diffusion/data/DiffusionGitBranch.php
View file

@ -19,8 +19,9 @@ final class DiffusionGitBranch extends Phobject {
* 'master' => '99a9c082f9a1b68c7264e26b9e552484a5ae5f25',
* );
*
* @param string stdout of git branch command.
* @param string Filter branches to those on a specific remote.
* @param string $stdout stdout of git branch command.
* @param string? $only_this_remote Filter branches to those on a specific
* remote.
* @return map Map of 'branch' or 'remote/branch' to hash at HEAD.
*/
public static function parseRemoteBranchOutput(

2
src/applications/diffusion/protocol/DiffusionMercurialCommandEngine.php
View file

@ -58,7 +58,7 @@ final class DiffusionMercurialCommandEngine
* Sanitize output of an `hg` command invoked with the `--debug` flag to make
* it usable.
*
* @param string Output from `hg --debug ...`
* @param string $stdout Output from `hg --debug ...`
* @return string Usable output.
*/
public static function filterMercurialDebugOutput($stdout) {

6
src/applications/diffusion/query/pathid/DiffusionPathIDQuery.php
View file

@ -42,7 +42,7 @@ final class DiffusionPathIDQuery extends Phobject {
/**
* Convert a path to the canonical, absolute representation used by Diffusion.
*
* @param string Some repository path.
* @param string $path Some repository path.
* @return string Canonicalized Diffusion path.
* @task pathutil
*/
@ -62,7 +62,7 @@ final class DiffusionPathIDQuery extends Phobject {
* Return the canonical parent directory for a path. Note, returns "/" when
* passed "/".
*
* @param string Some repository path.
* @param string $path Some repository path.
* @return string That path's canonical parent directory.
* @task pathutil
*/
@ -80,7 +80,7 @@ final class DiffusionPathIDQuery extends Phobject {
* Generate a list of parents for a repository path. The path itself is
* included.
*
* @param string Some repository path.
* @param string $path Some repository path.
* @return list List of canonical paths between the path and the root.
* @task pathutil
*/

19
src/applications/diffusion/request/DiffusionRequest.php
View file

@ -56,7 +56,7 @@ abstract class DiffusionRequest extends Phobject {
* - `commit` Optional, commit identifier.
* - `line` Optional, line range.
*
* @param map See documentation.
* @param map $data See documentation.
* @return DiffusionRequest New request object.
* @task new
*/
@ -133,8 +133,9 @@ abstract class DiffusionRequest extends Phobject {
/**
* Internal. Use @{method:newFromDictionary}, not this method.
*
* @param string Repository identifier.
* @param PhabricatorUser Viewing user.
* @param string $identifier Repository identifier.
* @param PhabricatorUser $viewer Viewing user.
* @param bool? $need_edit
* @return DiffusionRequest New request object.
* @task new
*/
@ -170,7 +171,7 @@ abstract class DiffusionRequest extends Phobject {
/**
* Internal. Use @{method:newFromDictionary}, not this method.
*
* @param PhabricatorRepository Repository object.
* @param PhabricatorRepository $repository Repository object.
* @return DiffusionRequest New request object.
* @task new
*/
@ -201,7 +202,7 @@ abstract class DiffusionRequest extends Phobject {
/**
* Internal. Use @{method:newFromDictionary}, not this method.
*
* @param map Map of parsed data.
* @param map $data Map of parsed data.
* @return void
* @task new
*/
@ -294,7 +295,7 @@ abstract class DiffusionRequest extends Phobject {
/**
* Modify the request to move the symbolic commit elsewhere.
*
* @param string New symbolic commit.
* @param string $symbol New symbolic commit.
* @return this
*/
public function updateSymbolicCommit($symbol) {
@ -464,8 +465,8 @@ abstract class DiffusionRequest extends Phobject {
*
* Parse the request URI into components.
*
* @param string URI blob.
* @param bool True if this VCS supports branches.
* @param string $blob URI blob.
* @param bool $supports_branches True if this VCS supports branches.
* @return map Parsed URI.
*
* @task uri
@ -535,7 +536,7 @@ abstract class DiffusionRequest extends Phobject {
/**
* Check that the working copy of the repository is present and readable.
*
* @param string Path to the working copy.
* @param string $path Path to the working copy.
*/
protected function validateWorkingCopy($path) {
if (!is_readable(dirname($path))) {

2
src/applications/diffusion/view/DiffusionReadmeView.php
View file

@ -26,7 +26,7 @@ final class DiffusionReadmeView extends DiffusionView {
/**
* Get the markup language a README should be interpreted as.
*
* @param string Local README path, like "README.txt".
* @param string $path Local README path, like "README.txt".
* @return string Best markup interpreter (like "remarkup") for this file.
*/
private function getReadmeLanguage($path) {

18
src/applications/diviner/query/DivinerAtomQuery.php
View file

@ -93,7 +93,7 @@ final class DivinerAtomQuery extends PhabricatorCursorPagedPolicyAwareQuery {
* have been generated incorrectly by accident. In these cases, we can
* restore the original data.
*
* @param bool
* @param bool $ghosts
* @return this
*/
public function withGhosts($ghosts) {
@ -437,9 +437,10 @@ final class DivinerAtomQuery extends PhabricatorCursorPagedPolicyAwareQuery {
* children. When recursing, also walk up the tree and collect children of
* atoms they extend.
*
* @param list<DivinerLiveSymbol> List of symbols to collect child hashes of.
* @param bool True to collect children of extended atoms,
* as well.
* @param list<DivinerLiveSymbol> $symbols List of symbols to collect child
* hashes of.
* @param bool $recurse_up True to collect children of
* extended atoms, as well.
* @return map<string, string> Hashes of atoms' children.
*/
private function getAllChildHashes(array $symbols, $recurse_up) {
@ -469,9 +470,12 @@ final class DivinerAtomQuery extends PhabricatorCursorPagedPolicyAwareQuery {
* Attach child atoms to existing atoms. In recursive mode, also attach child
* atoms to atoms that these atoms extend.
*
* @param list<DivinerLiveSymbol> List of symbols to attach children to.
* @param map<string, DivinerLiveSymbol> Map of symbols, keyed by node hash.
* @param bool True to attach children to extended atoms, as well.
* @param list<DivinerLiveSymbol> $symbols List of symbols to attach children
* to.
* @param map<string, DivinerLiveSymbol> $children Map of symbols, keyed by
* node hash.
* @param bool $recurse_up True to attach children to extended atoms, as
* well.
* @return void
*/
private function attachAllChildren(

3
src/applications/doorkeeper/engine/DoorkeeperFeedStoryPublisher.php
View file

@ -31,7 +31,8 @@ abstract class DoorkeeperFeedStoryPublisher extends Phobject {
* JIRA issues which can have several linked revisions), it's generally
* more useful not to assume context.
*
* @param bool True to assume object context when rendering.
* @param bool $render_with_implied_context True to assume object context
* when rendering.
* @return this
* @task config
*/

68
src/applications/drydock/blueprint/DrydockBlueprintImplementation.php
View file

@ -63,9 +63,10 @@ abstract class DrydockBlueprintImplementation extends Phobject {
* This method should not acquire locks or expect anything to be locked. This
* is a coarse compatibility check between a lease and a resource.
*
* @param DrydockBlueprint Concrete blueprint to allocate for.
* @param DrydockResource Candidate resource to allocate the lease on.
* @param DrydockLease Pending lease that wants to allocate here.
* @param DrydockBlueprint $blueprint Concrete blueprint to allocate for.
* @param DrydockResource $resource Candidate resource to allocate the lease
* on.
* @param DrydockLease $lease Pending lease that wants to allocate here.
* @return bool True if the resource and lease are compatible.
* @task lease
*/
@ -81,9 +82,9 @@ abstract class DrydockBlueprintImplementation extends Phobject {
*
* If acquisition fails, throw an exception.
*
* @param DrydockBlueprint Blueprint which built the resource.
* @param DrydockResource Resource to acquire a lease on.
* @param DrydockLease Requested lease.
* @param DrydockBlueprint $blueprint Blueprint which built the resource.
* @param DrydockResource $resource Resource to acquire a lease on.
* @param DrydockLease $lease Requested lease.
* @return void
* @task lease
*/
@ -111,9 +112,9 @@ abstract class DrydockBlueprintImplementation extends Phobject {
* This callback is primarily useful for automatically releasing resources
* once all leases are released.
*
* @param DrydockBlueprint Blueprint which built the resource.
* @param DrydockResource Resource a lease was released on.
* @param DrydockLease Recently released lease.
* @param DrydockBlueprint $blueprint Blueprint which built the resource.
* @param DrydockResource $resource Resource a lease was released on.
* @param DrydockLease $lease Recently released lease.
* @return void
* @task lease
*/
@ -128,9 +129,9 @@ abstract class DrydockBlueprintImplementation extends Phobject {
*
* If a lease creates temporary state while held, destroy it here.
*
* @param DrydockBlueprint Blueprint which built the resource.
* @param DrydockResource Resource the lease is acquired on.
* @param DrydockLease The lease being destroyed.
* @param DrydockBlueprint $blueprint Blueprint which built the resource.
* @param DrydockResource $resource Resource the lease is acquired on.
* @param DrydockLease $lease The lease being destroyed.
* @return void
* @task lease
*/
@ -156,11 +157,11 @@ abstract class DrydockBlueprintImplementation extends Phobject {
* has a flexible pool of expensive resources and you want to pack leases
* onto them as tightly as possible.
*
* @param DrydockBlueprint The blueprint for an existing resource being
* acquired.
* @param DrydockResource The resource being acquired, which we may want to
* build a supplemental resource for.
* @param DrydockLease The current lease performing acquisition.
* @param DrydockBlueprint $blueprint The blueprint for an existing resource
* being acquired.
* @param DrydockResource $resource The resource being acquired, which we may
* want to build a supplemental resource for.
* @param DrydockLease $lease The current lease performing acquisition.
* @return bool True to prefer allocating a supplemental resource.
*
* @task lease
@ -190,7 +191,7 @@ abstract class DrydockBlueprintImplementation extends Phobject {
* really exists, only if some blueprint may conceivably exist which could
* plausibly be able to build a suitable resource.
*
* @param DrydockLease Requested lease.
* @param DrydockLease $lease Requested lease.
* @return bool True if some concrete blueprint of this implementation's
* type might ever be able to build a resource for the lease.
* @task resource
@ -211,9 +212,9 @@ abstract class DrydockBlueprintImplementation extends Phobject {
* if the blueprint as configured may, at some time, be able to build a
* suitable resource.
*
* @param DrydockBlueprint Blueprint which may be asked to allocate a
* resource.
* @param DrydockLease Requested lease.
* @param DrydockBlueprint $blueprint Blueprint which may be asked to
* allocate a resource.
* @param DrydockLease $lease Requested lease.
* @return bool True if this blueprint can eventually build a suitable
* resource for the lease, as currently configured.
* @task resource
@ -240,9 +241,9 @@ abstract class DrydockBlueprintImplementation extends Phobject {
* eaten up free capacity by the time it actually tries to build a resource.
* This is normal and the allocator will recover from it.
*
* @param DrydockBlueprint The blueprint which may be asked to allocate a
* resource.
* @param DrydockLease Requested lease.
* @param DrydockBlueprint $blueprint The blueprint which may be asked to
* allocate a resource.
* @param DrydockLease $lease Requested lease.
* @return bool True if this blueprint appears likely to be able to allocate
* a suitable resource.
* @task resource
@ -260,8 +261,9 @@ abstract class DrydockBlueprintImplementation extends Phobject {
* called. Blueprints are entirely responsible for any lock handling they
* need to perform.
*
* @param DrydockBlueprint The blueprint which should allocate a resource.
* @param DrydockLease Requested lease.
* @param DrydockBlueprint $blueprint The blueprint which should allocate a
* resource.
* @param DrydockLease $lease Requested lease.
* @return DrydockResource Allocated resource.
* @task resource
*/
@ -287,8 +289,8 @@ abstract class DrydockBlueprintImplementation extends Phobject {
* here. For example, you might shut down a virtual host or destroy a working
* copy on disk.
*
* @param DrydockBlueprint Blueprint which built the resource.
* @param DrydockResource Resource being destroyed.
* @param DrydockBlueprint $blueprint Blueprint which built the resource.
* @param DrydockResource $resource Resource being destroyed.
* @return void
* @task resource
*/
@ -300,8 +302,8 @@ abstract class DrydockBlueprintImplementation extends Phobject {
/**
* Get a human readable name for a resource.
*
* @param DrydockBlueprint Blueprint which built the resource.
* @param DrydockResource Resource to get the name of.
* @param DrydockBlueprint $blueprint Blueprint which built the resource.
* @param DrydockResource $resource Resource to get the name of.
* @return string Human-readable resource name.
* @task resource
*/
@ -338,7 +340,7 @@ abstract class DrydockBlueprintImplementation extends Phobject {
* build a resource which can satisfy the lease. They may not be able to
* build that resource right now.
*
* @param DrydockLease Requested lease.
* @param DrydockLease $lease Requested lease.
* @return list<DrydockBlueprintImplementation> List of qualifying blueprint
* implementations.
*/
@ -429,7 +431,7 @@ abstract class DrydockBlueprintImplementation extends Phobject {
/**
* Get the effective concurrent resource limit for this blueprint.
*
* @param DrydockBlueprint Blueprint to get the limit for.
* @param DrydockBlueprint $blueprint Blueprint to get the limit for.
* @return int|null Limit, or `null` for no limit.
*/
protected function getConcurrentResourceLimit(DrydockBlueprint $blueprint) {
@ -500,7 +502,7 @@ abstract class DrydockBlueprintImplementation extends Phobject {
/**
* Apply standard limits on resource allocation rate.
*
* @param DrydockBlueprint The blueprint requesting an allocation.
* @param DrydockBlueprint $blueprint The blueprint requesting an allocation.
* @return bool True if further allocations should be limited.
*/
protected function shouldLimitAllocatingPoolSize(

8
src/applications/drydock/storage/DrydockAuthorization.php
View file

@ -103,10 +103,10 @@ final class DrydockAuthorization extends DrydockDAO
* Apply external authorization effects after a user changes the value of a
* blueprint selector control an object.
*
* @param PhabricatorUser User applying the change.
* @param phid Object PHID change is being applied to.
* @param list<phid> Old blueprint PHIDs.
* @param list<phid> New blueprint PHIDs.
* @param PhabricatorUser $viewer User applying the change.
* @param phid $object_phid Object PHID change is being applied to.
* @param list<phid> $old Old blueprint PHIDs.
* @param list<phid> $new New blueprint PHIDs.
* @return void
*/
public static function applyAuthorizationChanges(

14
src/applications/drydock/storage/DrydockSlotLock.php
View file

@ -43,7 +43,7 @@ final class DrydockSlotLock extends DrydockDAO {
/**
* Load all locks held by a particular owner.
*
* @param phid Owner PHID.
* @param phid $owner_phid Owner PHID.
* @return list<DrydockSlotLock> All held locks.
* @task info
*/
@ -57,7 +57,7 @@ final class DrydockSlotLock extends DrydockDAO {
/**
* Test if a lock is currently free.
*
* @param string Lock key to test.
* @param string $lock Lock key to test.
* @return bool True if the lock is currently free.
* @task info
*/
@ -69,7 +69,7 @@ final class DrydockSlotLock extends DrydockDAO {
/**
* Test if a list of locks are all currently free.
*
* @param list<string> List of lock keys to test.
* @param list<string> $locks List of lock keys to test.
* @return bool True if all locks are currently free.
* @task info
*/
@ -82,7 +82,7 @@ final class DrydockSlotLock extends DrydockDAO {
/**
* Load named locks.
*
* @param list<string> List of lock keys to load.
* @param list<string> $locks List of lock keys to load.
* @return list<DrydockSlotLock> List of held locks.
* @task info
*/
@ -114,8 +114,8 @@ final class DrydockSlotLock extends DrydockDAO {
* This method either acquires all the locks or throws an exception (usually
* because one or more locks are held).
*
* @param phid Lock owner PHID.
* @param list<string> List of locks to acquire.
* @param phid $owner_phid Lock owner PHID.
* @param list<string> $locks List of locks to acquire.
* @return void
* @task locks
*/
@ -158,7 +158,7 @@ final class DrydockSlotLock extends DrydockDAO {
/**
* Release all locks held by an owner.
*
* @param phid Lock owner PHID.
* @param phid $owner_phid Lock owner PHID.
* @return void
* @task locks
*/

50
src/applications/drydock/worker/DrydockLeaseUpdateWorker.php
View file

@ -168,7 +168,7 @@ final class DrydockLeaseUpdateWorker extends DrydockWorker {
* Find or build a resource which can satisfy a given lease request, then
* acquire the lease.
*
* @param DrydockLease Requested lease.
* @param DrydockLease $lease Requested lease.
* @return void
* @task allocator
*/
@ -573,7 +573,7 @@ final class DrydockLeaseUpdateWorker extends DrydockWorker {
* Get all the concrete @{class:DrydockBlueprint}s which can possibly
* build a resource to satisfy a lease.
*
* @param DrydockLease Requested lease.
* @param DrydockLease $lease Requested lease.
* @return list<DrydockBlueprint> List of qualifying blueprints.
* @task allocator
*/
@ -645,9 +645,9 @@ final class DrydockLeaseUpdateWorker extends DrydockWorker {
* Load a list of all resources which a given lease can possibly be
* allocated against.
*
* @param list<DrydockBlueprint> Blueprints which may produce suitable
* resources.
* @param DrydockLease Requested lease.
* @param list<DrydockBlueprint> $blueprints Blueprints which may produce
* suitable resources.
* @param DrydockLease $lease Requested lease.
* @return list<DrydockResource> Resources which may be able to allocate
* the lease.
* @task allocator
@ -675,8 +675,8 @@ final class DrydockLeaseUpdateWorker extends DrydockWorker {
/**
* Remove resources which can not be acquired by a given lease from a list.
*
* @param list<DrydockResource> Candidate resources.
* @param DrydockLease Acquiring lease.
* @param list<DrydockResource> $resources Candidate resources.
* @param DrydockLease $lease Acquiring lease.
* @return list<DrydockResource> Resources which the lease may be able to
* acquire.
* @task allocator
@ -703,9 +703,9 @@ final class DrydockLeaseUpdateWorker extends DrydockWorker {
* Remove blueprints which are too heavily allocated to build a resource for
* a lease from a list of blueprints.
*
* @param list<DrydockBlueprint> List of blueprints.
* @return list<DrydockBlueprint> List with blueprints that can not allocate
* a resource for the lease right now removed.
* @param list<DrydockBlueprint> $blueprints List of blueprints.
* @return list<DrydockBlueprint> $lease List with blueprints that can not
* allocate a resource for the lease right now removed.
* @task allocator
*/
private function removeOverallocatedBlueprints(
@ -731,8 +731,8 @@ final class DrydockLeaseUpdateWorker extends DrydockWorker {
* Rank blueprints by suitability for building a new resource for a
* particular lease.
*
* @param list<DrydockBlueprint> List of blueprints.
* @param DrydockLease Requested lease.
* @param list<DrydockBlueprint> $blueprints List of blueprints.
* @param DrydockLease $lease Requested lease.
* @return list<DrydockBlueprint> Ranked list of blueprints.
* @task allocator
*/
@ -750,8 +750,8 @@ final class DrydockLeaseUpdateWorker extends DrydockWorker {
/**
* Rank resources by suitability for allocating a particular lease.
*
* @param list<DrydockResource> List of resources.
* @param DrydockLease Requested lease.
* @param list<DrydockResource> $resources List of resources.
* @param DrydockLease $lease Requested lease.
* @return list<DrydockResource> Ranked list of resources.
* @task allocator
*/
@ -769,8 +769,9 @@ final class DrydockLeaseUpdateWorker extends DrydockWorker {
/**
* Perform an actual resource allocation with a particular blueprint.
*
* @param DrydockBlueprint The blueprint to allocate a resource from.
* @param DrydockLease Requested lease.
* @param DrydockBlueprint $blueprint The blueprint to allocate a resource
* from.
* @param DrydockLease $lease Requested lease.
* @return DrydockResource Allocated resource.
* @task allocator
*/
@ -815,9 +816,10 @@ final class DrydockLeaseUpdateWorker extends DrydockWorker {
* Check that the resource a blueprint allocated is roughly the sort of
* object we expect.
*
* @param DrydockBlueprint Blueprint which built the resource.
* @param wild Thing which the blueprint claims is a valid resource.
* @param DrydockLease Lease the resource was allocated for.
* @param DrydockBlueprint $blueprint Blueprint which built the resource.
* @param wild $resource Thing which the blueprint claims is a valid
* resource.
* @param DrydockLease $lease Lease the resource was allocated for.
* @return void
* @task allocator
*/
@ -899,8 +901,8 @@ final class DrydockLeaseUpdateWorker extends DrydockWorker {
/**
* Perform an actual lease acquisition on a particular resource.
*
* @param DrydockResource Resource to acquire a lease on.
* @param DrydockLease Lease to acquire.
* @param DrydockResource $resource Resource to acquire a lease on.
* @param DrydockLease $lease Lease to acquire.
* @return void
* @task acquire
*/
@ -931,9 +933,9 @@ final class DrydockLeaseUpdateWorker extends DrydockWorker {
/**
* Make sure that a lease was really acquired properly.
*
* @param DrydockBlueprint Blueprint which created the resource.
* @param DrydockResource Resource which was acquired.
* @param DrydockLease The lease which was supposedly acquired.
* @param DrydockBlueprint $blueprint Blueprint which created the resource.
* @param DrydockResource $resource Resource which was acquired.
* @param DrydockLease $lease The lease which was supposedly acquired.
* @return void
* @task acquire
*/

8
src/applications/drydock/worker/DrydockResourceUpdateWorker.php
View file

@ -38,7 +38,7 @@ final class DrydockResourceUpdateWorker extends DrydockWorker {
/**
* Update a resource, handling exceptions thrown during the update.
*
* @param DrydockReosource Resource to update.
* @param DrydockResource $resource Resource to update.
* @return void
* @task update
*/
@ -58,7 +58,7 @@ final class DrydockResourceUpdateWorker extends DrydockWorker {
/**
* Update a resource.
*
* @param DrydockResource Resource to update.
* @param DrydockResource $resource Resource to update.
* @return void
* @task update
*/
@ -89,8 +89,8 @@ final class DrydockResourceUpdateWorker extends DrydockWorker {
/**
* Convert a temporary exception into a yield.
*
* @param DrydockResource Resource to yield.
* @param Exception Temporary exception worker encountered.
* @param DrydockResource $resource Resource to yield.
* @param Exception $ex Temporary exception worker encountered.
* @task update
*/
private function yieldResource(DrydockResource $resource, Exception $ex) {

2
src/applications/feed/PhabricatorFeedStoryPublisher.php
View file

@ -214,7 +214,7 @@ final class PhabricatorFeedStoryPublisher extends Phobject {
/**
* Remove PHIDs who should not receive notifications from a subscriber list.
*
* @param list<phid> List of potential subscribers.
* @param list<phid> $phids List of potential subscribers.
* @return list<phid> List of actual subscribers.
*/
private function filterSubscribedPHIDs(array $phids) {

5
src/applications/feed/story/PhabricatorFeedStory.php
View file

@ -32,8 +32,9 @@ abstract class PhabricatorFeedStory
* construct appropriate @{class:PhabricatorFeedStory} wrappers for each
* data row.
*
* @param list<dict> List of @{class:PhabricatorFeedStoryData} rows from the
* database.
* @param list<dict> $rows List of @{class:PhabricatorFeedStoryData} rows
* from the database.
* @param PhabricatorUser $viewer
* @return list<PhabricatorFeedStory> List of @{class:PhabricatorFeedStory}
* objects.
* @task load

10
src/applications/files/PhabricatorImageTransformer.php
View file

@ -20,8 +20,8 @@ final class PhabricatorImageTransformer extends Phobject {
* Phabricator can not encode images in the given format (based on available
* extensions), but can save images in another format.
*
* @param resource GD image resource.
* @param string? Optionally, preferred mime type.
* @param resource $data GD image resource.
* @param string? $preferred_mime Optionally, preferred mime type.
* @return string Bytes of an image file.
* @task save
*/
@ -62,7 +62,7 @@ final class PhabricatorImageTransformer extends Phobject {
/**
* Save an image in PNG format, returning the file data as a string.
*
* @param resource GD image resource.
* @param resource $image GD image resource.
* @return string|null PNG file as a string, or null on failure.
* @task save
*/
@ -90,7 +90,7 @@ final class PhabricatorImageTransformer extends Phobject {
/**
* Save an image in GIF format, returning the file data as a string.
*
* @param resource GD image resource.
* @param resource $image GD image resource.
* @return string|null GIF file as a string, or null on failure.
* @task save
*/
@ -114,7 +114,7 @@ final class PhabricatorImageTransformer extends Phobject {
/**
* Save an image in JPG format, returning the file data as a string.
*
* @param resource GD image resource.
* @param resource $image GD image resource.
* @return string|null JPG file as a string, or null on failure.
* @task save
*/

4
src/applications/files/engine/PhabricatorChunkedFileStorageEngine.php
View file

@ -87,8 +87,8 @@ final class PhabricatorChunkedFileStorageEngine
* Ideally, we'd like to be able to verify hashes, but this is complicated
* and time consuming and gives us a fairly small benefit.
*
* @param PhabricatorUser Viewing user.
* @param string Claimed file hash.
* @param PhabricatorUser $viewer Viewing user.
* @param string $hash Claimed file hash.
* @return string Rehashed file hash.
*/
public static function getChunkedHash(PhabricatorUser $viewer, $hash) {

14
src/applications/files/engine/PhabricatorFileStorageEngine.php
View file

@ -160,8 +160,8 @@ abstract class PhabricatorFileStorageEngine extends Phobject {
* throw an exception. If there are other satisfactory but less-preferred
* storage engines available, they will be tried.
*
* @param string The file data to write.
* @param array File metadata (name, author), if available.
* @param string $data The file data to write.
* @param array $params File metadata (name, author), if available.
* @return string Unique string which identifies the stored file, max length
* 255.
* @task file
@ -172,8 +172,8 @@ abstract class PhabricatorFileStorageEngine extends Phobject {
/**
* Read the contents of a file previously written by @{method:writeFile}.
*
* @param string The handle returned from @{method:writeFile} when the
* file was written.
* @param string $handle The handle returned from @{method:writeFile}
* when the file was written.
* @return string File contents.
* @task file
*/
@ -183,8 +183,8 @@ abstract class PhabricatorFileStorageEngine extends Phobject {
/**
* Delete the data for a file previously written by @{method:writeFile}.
*
* @param string The handle returned from @{method:writeFile} when the
* file was written.
* @param string $handle The handle returned from @{method:writeFile}
* when the file was written.
* @return void
* @task file
*/
@ -200,7 +200,7 @@ abstract class PhabricatorFileStorageEngine extends Phobject {
* select the MySQL and Local Disk storage engines if they are configured
* to allow a given file.
*
* @param int File size in bytes.
* @param int $length File size in bytes.
* @task load
*/
public static function loadStorageEngines($length) {

2
src/applications/files/engine/PhabricatorLocalDiskFileStorageEngine.php
View file

@ -116,7 +116,7 @@ final class PhabricatorLocalDiskFileStorageEngine
/**
* Convert a handle into an absolute local disk path.
*
* @param string File data handle.
* @param string $handle File data handle.
* @return string Absolute path to the corresponding file.
* @task internal
*/

2
src/applications/files/engine/PhabricatorMySQLFileStorageEngine.php
View file

@ -80,7 +80,7 @@ final class PhabricatorMySQLFileStorageEngine
/**
* Load the Lisk object that stores the file data for a handle.
*
* @param string File data handle.
* @param string $handle File data handle.
* @return PhabricatorFileStorageBlob Data DAO.
* @task internal
*/

3
src/applications/files/query/PhabricatorFileQuery.php
View file

@ -96,7 +96,8 @@ final class PhabricatorFileQuery
* `PHID-FILE-aaaa` and all transformations of the file with PHID
* `PHID-FILE-bbbb`.
*
* @param list<dict> List of transform specifications, described above.
* @param list<dict> $specs List of transform specifications, described
* above.
* @return this
*/
public function withTransforms(array $specs) {

23
src/applications/files/storage/PhabricatorFile.php
View file

@ -807,8 +807,8 @@ final class PhabricatorFile extends PhabricatorFileDAO
/**
* Return an iterable which emits file content bytes.
*
* @param int Offset for the start of data.
* @param int Offset for the end of data.
* @param int? $begin Offset for the start of data.
* @param int? $end Offset for the end of data.
* @return Iterable Iterable object which emits requested data.
*/
public function getFileDataIterator($begin = null, $end = null) {
@ -1214,8 +1214,9 @@ final class PhabricatorFile extends PhabricatorFileDAO
* Builtins are located in `resources/builtin/` and identified by their
* name.
*
* @param PhabricatorUser Viewing user.
* @param list<PhabricatorFilesBuiltinFile> List of builtin file specs.
* @param PhabricatorUser $user Viewing user.
* @param list<PhabricatorFilesBuiltinFile> $builtins List of builtin file
* specs.
* @return dict<string, PhabricatorFile> Dictionary of named builtins.
*/
public static function loadBuiltins(PhabricatorUser $user, array $builtins) {
@ -1281,8 +1282,8 @@ final class PhabricatorFile extends PhabricatorFileDAO
/**
* Convenience wrapper for @{method:loadBuiltins}.
*
* @param PhabricatorUser Viewing user.
* @param string Single builtin name to load.
* @param PhabricatorUser $user Viewing user.
* @param string $name Single builtin name to load.
* @return PhabricatorFile Corresponding builtin file.
*/
public static function loadBuiltin(PhabricatorUser $user, $name) {
@ -1473,7 +1474,7 @@ final class PhabricatorFile extends PhabricatorFileDAO
* Write the policy edge between this file and some object.
* This method is successful even if the file is already attached.
*
* @param phid Object PHID to attach to.
* @param phid $phid Object PHID to attach to.
* @return this
*/
public function attachToObject($phid) {
@ -1487,8 +1488,8 @@ final class PhabricatorFile extends PhabricatorFileDAO
* NOTE: Please avoid to use this static method directly.
* Instead, use PhabricatorFile#attachToObject(phid).
*
* @param phid File PHID to attach from.
* @param phid Object PHID to attach to.
* @param phid $file_phid File PHID to attach from.
* @param phid $object_phid Object PHID to attach to.
* @return void
*/
public static function attachFileToObject($file_phid, $object_phid) {
@ -1526,8 +1527,8 @@ final class PhabricatorFile extends PhabricatorFileDAO
* This method is called both when creating a file from fresh data, and
* when creating a new file which reuses existing storage.
*
* @param map<string, wild> Bag of parameters, see @{class:PhabricatorFile}
* for documentation.
* @param map<string, wild> $params Bag of parameters, see
* @{class:PhabricatorFile} for documentation.
* @return this
*/
private function readPropertiesFromParameters(array $params) {

8
src/applications/files/transform/PhabricatorFileImageTransform.php
View file

@ -11,7 +11,7 @@ abstract class PhabricatorFileImageTransform extends PhabricatorFileTransform {
/**
* Get an estimate of the transformed dimensions of a file.
*
* @param PhabricatorFile File to transform.
* @param PhabricatorFile $file File to transform.
* @return list<int, int>|null Width and height, if available.
*/
public function getTransformedDimensions(PhabricatorFile $file) {
@ -132,7 +132,7 @@ abstract class PhabricatorFileImageTransform extends PhabricatorFileTransform {
/**
* Create a new @{class:PhabricatorFile} from raw data.
*
* @param string Raw file data.
* @param string $data Raw file data.
*/
protected function newFileFromData($data) {
if ($this->file) {
@ -159,8 +159,8 @@ abstract class PhabricatorFileImageTransform extends PhabricatorFileTransform {
/**
* Create a new image filled with transparent pixels.
*
* @param int Desired image width.
* @param int Desired image height.
* @param int $w Desired image width.
* @param int $h Desired image height.
* @return resource New image resource.
*/
protected function newEmptyImage($w, $h) {

2
src/applications/harbormaster/constants/HarbormasterBuildStatus.php
View file

@ -96,7 +96,7 @@ final class HarbormasterBuildStatus extends Phobject {
/**
* Get a human readable name for a build status constant.
*
* @param const Build status constant.
* @param const $status Build status constant.
* @return string Human-readable name.
*/
public static function getBuildStatusName($status) {

9
src/applications/harbormaster/engine/HarbormasterBuildEngine.php
View file

@ -322,8 +322,9 @@ final class HarbormasterBuildEngine extends Phobject {
* particularly relevant when a build uses multiple hosts since it returns
* hosts to the pool more quickly.
*
* @param list<HarbormasterBuildTarget> Targets in the build.
* @param list<HarbormasterBuildStep> List of running and waiting steps.
* @param list<HarbormasterBuildTarget> $targets Targets in the build.
* @param list<HarbormasterBuildStep> $steps List of running and waiting
* steps.
* @return void
*/
private function releaseUnusedArtifacts(array $targets, array $steps) {
@ -372,7 +373,7 @@ final class HarbormasterBuildEngine extends Phobject {
* Process messages which were sent to these targets, kicking applicable
* targets out of "Waiting" and into either "Passed" or "Failed".
*
* @param list<HarbormasterBuildTarget> List of targets to process.
* @param list<HarbormasterBuildTarget> $targets List of targets to process.
* @return void
*/
private function updateWaitingTargets(array $targets) {
@ -436,7 +437,7 @@ final class HarbormasterBuildEngine extends Phobject {
* the overall state of the associated buildable. Compute the new aggregate
* state and save it on the buildable.
*
* @param HarbormasterBuild The buildable to update.
* @param HarbormasterBuild $buildable The buildable to update.
* @return void
*/
public function updateBuildable(HarbormasterBuildable $buildable) {

8
src/applications/harbormaster/engine/HarbormasterTargetEngine.php
View file

@ -56,7 +56,7 @@ final class HarbormasterTargetEngine extends Phobject {
*
* This method creates the steps if they do not yet exist.
*
* @param list<string> Autotarget keys, like `"core.arc.lint"`.
* @param list<string> $autotargets Autotarget keys, like `"core.arc.lint"`.
* @return map<string, object> Map of keys to step objects.
*/
private function generateBuildStepMap(array $autotargets) {
@ -127,7 +127,7 @@ final class HarbormasterTargetEngine extends Phobject {
* Get all of the @{class:HarbormasterBuildStepImplementation} objects for
* a list of autotarget keys.
*
* @param list<string> Autotarget keys, like `"core.arc.lint"`.
* @param list<string> $autotargets Autotarget keys, like `"core.arc.lint"`.
* @return map<string, object> Map of keys to implementations.
*/
private function getAutosteps(array $autotargets) {
@ -154,8 +154,8 @@ final class HarbormasterTargetEngine extends Phobject {
*
* If some targets or builds do not exist, they are created.
*
* @param HarbormasterBuildable A buildable.
* @param map<string, object> Map of keys to steps.
* @param HarbormasterBuildable $buildable A buildable.
* @param map<string, object> $step_map Map of keys to steps.
* @return map<string, object> Map of keys to targets.
*/
private function generateBuildTargetMap(

8
src/applications/harbormaster/step/HarbormasterBuildStepImplementation.php
View file

@ -187,9 +187,11 @@ abstract class HarbormasterBuildStepImplementation extends Phobject {
*
* ls 'dir with spaces'
*
* @param string Name of a `vxsprintf` function, like @{function:vcsprintf}.
* @param string User-provided pattern string containing `${variables}`.
* @param dict List of available replacement variables.
* @param string $function Name of a `vxsprintf` function, like
* @{function:vcsprintf}.
* @param string $pattern User-provided pattern string containing
* `${variables}`.
* @param dict $variables List of available replacement variables.
* @return string String with variables replaced safely into it.
*/
protected function mergeVariables($function, $pattern, array $variables) {

6
src/applications/harbormaster/storage/HarbormasterBuildable.php
View file

@ -60,9 +60,9 @@ final class HarbormasterBuildable
/**
* Start builds for a given buildable.
*
* @param phid PHID of the object to build.
* @param phid Container PHID for the buildable.
* @param list<HarbormasterBuildRequest> List of builds to perform.
* @param phid $phid PHID of the object to build.
* @param phid $container_phid Container PHID for the buildable.
* @param list<HarbormasterBuildRequest> $requests List of builds to perform.
* @return void
*/
public static function applyBuildPlans(

3
src/applications/herald/adapter/HeraldAdapter.php
View file

@ -171,7 +171,8 @@ abstract class HeraldAdapter extends Phobject {
* These transactions are set by @{class:PhabricatorApplicationEditor}
* automatically, before it invokes Herald.
*
* @param list<PhabricatorApplicationTransaction> List of transactions.
* @param list<PhabricatorApplicationTransaction> $xactions List of
* transactions.
* @return this
*/
final public function setAppliedTransactions(array $xactions) {

4
src/applications/maniphest/constants/ManiphestTaskPriority.php
View file

@ -137,7 +137,7 @@ final class ManiphestTaskPriority extends ManiphestConstants {
/**
* Retrieve the full name of the priority level provided.
*
* @param int A priority level.
* @param int $priority A priority level.
* @return string The priority name if the level is a valid one.
*/
public static function getTaskPriorityName($priority) {
@ -147,7 +147,7 @@ final class ManiphestTaskPriority extends ManiphestConstants {
/**
* Retrieve the color of the priority level given
*
* @param int A priority level.
* @param int $priority A priority level.
* @return string The color of the priority if the level is valid,
* or black if it is not.
*/

2
src/applications/meta/panel/PhabricatorApplicationConfigurationPanel.php
View file

@ -27,7 +27,7 @@ abstract class PhabricatorApplicationConfigurationPanel
/**
* Get the URI for this application configuration panel.
*
* @param string? Optional path to append.
* @param string? $path Optional path to append.
* @return string Relative URI for the panel.
*/
public function getPanelURI($path = '') {

2
src/applications/metamta/parser/PhabricatorMetaMTAEmailBodyParser.php
View file

@ -26,7 +26,7 @@ final class PhabricatorMetaMTAEmailBodyParser extends Phobject {
* ),
* )
*
* @param string Raw mail text body.
* @param string $body Raw mail text body.
* @return dict Parsed body.
*/
public function parseBody($body) {

6
src/applications/metamta/receiver/PhabricatorObjectMailReceiver.php
View file

@ -19,9 +19,9 @@ abstract class PhabricatorObjectMailReceiver extends PhabricatorMailReceiver {
* Load the object receiving mail, based on an identifying pattern. Normally
* this pattern is some sort of object ID.
*
* @param string A string matched by @{method:getObjectPattern}
* fragment.
* @param PhabricatorUser The viewing user.
* @param string $pattern A string matched by
* @{method:getObjectPattern} fragment.
* @param PhabricatorUser $viewer The viewing user.
* @return object|null The object to receive mail, or null if no such
* object exists.
*/

16
src/applications/metamta/replyhandler/PhabricatorMailReplyHandler.php
View file

@ -199,8 +199,8 @@ abstract class PhabricatorMailReplyHandler extends Phobject {
* Each target should be sent a separate email, and contains the information
* required to generate it with appropriate permissions and configuration.
*
* @param list<phid> List of "To" PHIDs.
* @param list<phid> List of "CC" PHIDs.
* @param list<phid> $raw_to List of "To" PHIDs.
* @param list<phid> $raw_cc List of "CC" PHIDs.
* @return list<PhabricatorMailTarget> List of targets.
*/
final public function getMailTargets(array $raw_to, array $raw_cc) {
@ -274,8 +274,8 @@ abstract class PhabricatorMailReplyHandler extends Phobject {
* This takes any compound recipients (like projects) and looks up all their
* members.
*
* @param list<phid> List of To PHIDs.
* @param list<phid> List of CC PHIDs.
* @param list<phid> $to List of To PHIDs.
* @param list<phid> $cc List of CC PHIDs.
* @return pair<list<phid>, list<phid>> Expanded PHID lists.
*/
private function expandRecipientPHIDs(array $to, array $cc) {
@ -332,8 +332,8 @@ abstract class PhabricatorMailReplyHandler extends Phobject {
*
* Invalid recipients are dropped from the results.
*
* @param list<phid> List of To PHIDs.
* @param list<phid> List of CC PHIDs.
* @param list<phid> $to List of To PHIDs.
* @param list<phid> $cc List of CC PHIDs.
* @return pair<wild, wild> Maps from PHIDs to users.
*/
private function loadRecipientUsers(array $to, array $cc) {
@ -370,8 +370,8 @@ abstract class PhabricatorMailReplyHandler extends Phobject {
/**
* Remove recipients who do not have permission to view the mail receiver.
*
* @param map<string, PhabricatorUser> Map of "To" users.
* @param map<string, PhabricatorUser> Map of "CC" users.
* @param map<string, PhabricatorUser> $to Map of "To" users.
* @param map<string, PhabricatorUser> $cc Map of "CC" users.
* @return pair<wild, wild> Filtered user maps.
*/
private function filterRecipientUsers(array $to, array $cc) {

19
src/applications/metamta/storage/PhabricatorMetaMTAMail.php
View file

@ -88,7 +88,7 @@ final class PhabricatorMetaMTAMail
* These tags are used to allow users to opt out of receiving certain types
* of mail, like updates when a task's projects change.
*
* @param list<const>
* @param list<const> $tags
* @return this
*/
public function setMailTags(array $tags) {
@ -109,7 +109,7 @@ final class PhabricatorMetaMTAMail
* needs to be set whenever an action is triggered by an email message. See
* T251 for more details.
*
* @param string The "Message-ID" of the email which precedes this one.
* @param string $id The "Message-ID" of the email which precedes this one.
* @return this
*/
public function setParentMessageID($id) {
@ -419,7 +419,7 @@ final class PhabricatorMetaMTAMail
* This is primarily intended to let users who don't want any email still
* receive things like password resets.
*
* @param bool True to force delivery despite user preferences.
* @param bool $force True to force delivery despite user preferences.
* @return this
*/
public function setForceDelivery($force) {
@ -437,7 +437,7 @@ final class PhabricatorMetaMTAMail
* "Precedence: bulk" or similar, but is implementation and configuration
* dependent.
*
* @param bool True if the mail is automated bulk mail.
* @param bool $is_bulk True if the mail is automated bulk mail.
* @return this
*/
public function setIsBulk($is_bulk) {
@ -454,9 +454,10 @@ final class PhabricatorMetaMTAMail
* set appropriate headers (Message-ID, In-Reply-To, References and
* Thread-Index) based on the capabilities of the underlying mailer.
*
* @param string Unique identifier, appropriate for use in a Message-ID,
* In-Reply-To or References headers.
* @param bool If true, indicates this is the first message in the thread.
* @param string $thread_id Unique identifier, appropriate for use in a
* Message-ID, In-Reply-To or References headers.
* @param bool? $is_first_message If true, indicates this is the first
* message in the thread.
* @return this
*/
public function setThreadID($thread_id, $is_first_message = false) {
@ -858,8 +859,8 @@ final class PhabricatorMetaMTAMail
* For example, this will expand project PHIDs into a list of the project's
* members.
*
* @param list<phid> List of recipient PHIDs, possibly including aggregate
* recipients.
* @param list<phid> $phids List of recipient PHIDs, possibly including
* aggregate recipients.
* @return list<phid> Deaggregated list of mailable recipients.
*/
public function expandRecipients(array $phids) {

6
src/applications/metamta/util/PhabricatorMailUtil.php
View file

@ -10,7 +10,7 @@ final class PhabricatorMailUtil
* which can make forwarding rules easier to write. This method strips the
* prefix if it is present, and normalizes casing and whitespace.
*
* @param PhutilEmailAddress Email address.
* @param PhutilEmailAddress $address Email address.
* @return PhutilEmailAddress Normalized address.
*/
public static function normalizeAddress(PhutilEmailAddress $address) {
@ -47,8 +47,8 @@ final class PhabricatorMailUtil
* <ALincoln@example.com>
* "Abraham" <phabricator+ALINCOLN@EXAMPLE.COM> # With configured prefix.
*
* @param PhutilEmailAddress Email address.
* @param PhutilEmailAddress Another email address.
* @param PhutilEmailAddress $u Email address.
* @param PhutilEmailAddress $v Another email address.
* @return bool True if addresses are effectively the same address.
*/
public static function matchAddresses(

10
src/applications/metamta/view/PhabricatorMetaMTAMailBody.php
View file

@ -40,7 +40,7 @@ final class PhabricatorMetaMTAMailBody extends Phobject {
/**
* Add a raw block of text to the email. This will be rendered as-is.
*
* @param string Block of text.
* @param string $text Block of text.
* @return this
* @task compose
*/
@ -100,8 +100,8 @@ final class PhabricatorMetaMTAMailBody extends Phobject {
* HEADER
* Text is indented.
*
* @param string Header text.
* @param string Section text.
* @param string $header Header text.
* @param string $section Section text.
* @return this
* @task compose
*/
@ -155,7 +155,7 @@ final class PhabricatorMetaMTAMailBody extends Phobject {
/**
* Add an attachment.
*
* @param PhabricatorMailAttachment Attachment.
* @param PhabricatorMailAttachment $attachment Attachment.
* @return this
* @task compose
*/
@ -198,7 +198,7 @@ final class PhabricatorMetaMTAMailBody extends Phobject {
/**
* Indent a block of text for rendering under a section heading.
*
* @param string Text to indent.
* @param string $text Text to indent.
* @return string Indented text.
* @task render
*/

4
src/applications/notification/query/PhabricatorNotificationQuery.php
View file

@ -31,8 +31,8 @@ final class PhabricatorNotificationQuery
* only unread notifications, while `false` means to return only //read//
* notifications. The default is `null`, which returns both.
*
* @param mixed True or false to filter results by read status. Null to remove
* the filter.
* @param mixed $unread True or false to filter results by read status. Null
* to remove the filter.
* @return this
* @task config
*/

6
src/applications/passphrase/view/PassphraseCredentialControl.php
View file

@ -157,9 +157,9 @@ final class PassphraseCredentialControl extends AphrontFormControl {
* - If you do change the credential, the new credential must be one you
* can use.
*
* @param PhabricatorUser The acting user.
* @param list<PhabricatorApplicationTransaction> List of credential altering
* transactions.
* @param PhabricatorUser $actor The acting user.
* @param list<PhabricatorApplicationTransaction> $xactions List of
* credential altering transactions.
* @return bool True if the transactions are valid.
*/
public static function validateTransactions(

16
src/applications/people/storage/PhabricatorUser.php
View file

@ -429,8 +429,8 @@ final class PhabricatorUser
/**
* Test if a given setting is set to a particular value.
*
* @param const Setting key.
* @param wild Value to compare.
* @param const $key Setting key.
* @param wild $value Value to compare.
* @return bool True if the setting has the specified value.
* @task settings
*/
@ -477,7 +477,7 @@ final class PhabricatorUser
*
* This is primarily useful for unit tests.
*
* @param string New timezone identifier.
* @param string $identifier New timezone identifier.
* @return this
* @task settings
*/
@ -770,8 +770,8 @@ final class PhabricatorUser
/**
* Write to the availability cache.
*
* @param wild Availability cache data.
* @param int|null Cache TTL.
* @param wild $availability Availability cache data.
* @param int|null $ttl Cache TTL.
* @return this
* @task availability
*/
@ -916,7 +916,7 @@ final class PhabricatorUser
* Get a @{class:PhabricatorHandleList} which benefits from this viewer's
* internal handle pool.
*
* @param list<phid> List of PHIDs to load.
* @param list<phid> $phids List of PHIDs to load.
* @return PhabricatorHandleList Handle list object.
* @task handle
*/
@ -935,7 +935,7 @@ final class PhabricatorUser
*
* This benefits from the viewer's internal handle pool.
*
* @param phid PHID to render a handle for.
* @param phid $phid PHID to render a handle for.
* @return PHUIHandleView View of the handle.
* @task handle
*/
@ -949,7 +949,7 @@ final class PhabricatorUser
*
* This benefits from the viewer's internal handle pool.
*
* @param list<phid> List of PHIDs to render.
* @param list<phid> $phids List of PHIDs to render.
* @return PHUIHandleListView View of the handles.
* @task handle
*/

8
src/applications/people/storage/PhabricatorUserEmail.php
View file

@ -180,7 +180,7 @@ final class PhabricatorUserEmail
/**
* Send a verification email from $user to this address.
*
* @param PhabricatorUser The user sending the verification.
* @param PhabricatorUser $user The user sending the verification.
* @return this
* @task email
*/
@ -229,8 +229,8 @@ final class PhabricatorUserEmail
* Send a notification email from $user to this address, informing the
* recipient that this is no longer their account's primary address.
*
* @param PhabricatorUser The user sending the notification.
* @param PhabricatorUserEmail New primary email address.
* @param PhabricatorUser $user The user sending the notification.
* @param PhabricatorUserEmail $new New primary email address.
* @task email
*/
public function sendOldPrimaryEmail(
@ -269,7 +269,7 @@ final class PhabricatorUserEmail
* Send a notification email from $user to this address, informing the
* recipient that this is now their account's new primary email address.
*
* @param PhabricatorUser The user sending the verification.
* @param PhabricatorUser $user The user sending the verification.
* @return this
* @task email
*/

2
src/applications/phid/PhabricatorObjectHandle.php
View file

@ -275,7 +275,7 @@ final class PhabricatorObjectHandle
* Set whether or not the underlying object is complete. See
* @{method:isComplete} for an explanation of what it means to be complete.
*
* @param bool True if the handle represents a complete object.
* @param bool $complete True if the handle represents a complete object.
* @return this
*/
public function setComplete($complete) {

4
src/applications/phid/query/PhabricatorObjectQuery.php
View file

@ -196,8 +196,8 @@ final class PhabricatorObjectQuery
* viewer. This method is generally used to validate that PHIDs affected by
* a transaction are valid.
*
* @param PhabricatorUser Viewer.
* @param list<phid> List of ostensibly valid PHIDs.
* @param PhabricatorUser $viewer Viewer.
* @param list<phid> $phids List of ostensibly valid PHIDs.
* @return list<phid> List of invalid or restricted PHIDs.
*/
public static function loadInvalidPHIDsForViewer(

21
src/applications/phid/type/PhabricatorPHIDType.php
View file

@ -52,8 +52,8 @@ abstract class PhabricatorPHIDType extends Phobject {
* can provide a dummy implementation for this method and overload
* @{method:loadObjects} instead.
*
* @param PhabricatorObjectQuery Query being executed.
* @param list<phid> PHIDs to load.
* @param PhabricatorObjectQuery $query Query being executed.
* @param list<phid> $phids PHIDs to load.
* @return PhabricatorPolicyAwareQuery Query object which loads the
* specified PHIDs when executed.
*/
@ -67,8 +67,8 @@ abstract class PhabricatorPHIDType extends Phobject {
* necessary to implement @{method:buildQueryForObjects} to get object
* loading to work.
*
* @param PhabricatorObjectQuery Query being executed.
* @param list<phid> PHIDs to load.
* @param PhabricatorObjectQuery $query Query being executed.
* @param list<phid> $phids PHIDs to load.
* @return list<wild> Corresponding objects.
*/
public function loadObjects(
@ -113,10 +113,11 @@ abstract class PhabricatorPHIDType extends Phobject {
* each handle at a minimum. See @{class:PhabricatorObjectHandle} for other
* handle properties.
*
* @param PhabricatorHandleQuery Issuing query object.
* @param list<PhabricatorObjectHandle> Handles to populate with data.
* @param list<Object> Objects for these PHIDs loaded by
* @{method:buildQueryForObjects()}.
* @param PhabricatorHandleQuery $query Issuing query object.
* @param list<PhabricatorObjectHandle> $handles Handles to populate with
* data.
* @param list<Object> $objects Objects for these PHIDs
* loaded by @{method:buildQueryForObjects()}.
* @return void
*/
abstract public function loadHandles(
@ -165,7 +166,7 @@ abstract class PhabricatorPHIDType extends Phobject {
/**
* Get all PHID types of applications installed for a given viewer.
*
* @param PhabricatorUser Viewing user.
* @param PhabricatorUser $viewer Viewing user.
* @return dict<string, PhabricatorPHIDType> Map of constants to installed
* types.
*/
@ -209,7 +210,7 @@ abstract class PhabricatorPHIDType extends Phobject {
/**
* Get all PHID types of an application.
*
* @param string Class name of an application
* @param string $application Class name of an application
* @return dict<string, PhabricatorPHIDType> Map of constants of application
*/
public static function getAllTypesForApplication(

4
src/applications/phid/utils.php
View file

@ -4,7 +4,7 @@
* Look up the type of a PHID. Returns
* PhabricatorPHIDConstants::PHID_TYPE_UNKNOWN if it fails to look up the type
*
* @param phid Anything.
* @param phid $phid Anything.
* @return string A value from PhabricatorPHIDConstants (ideally)
*/
function phid_get_type($phid) {
@ -18,7 +18,7 @@ function phid_get_type($phid) {
/**
* Group a list of phids by type.
*
* @param phids array of phids
* @param $phids Array of phids
* @return map of phid type => list of phids
*/
function phid_group_by_type($phids) {

3
src/applications/phrequent/storage/PhrequentTimeBlock.php
View file

@ -254,7 +254,8 @@ final class PhrequentTimeBlock extends Phobject {
* This is used to avoid double-counting time on objects which had timers
* started multiple times.
*
* @param list<pair<int, int>> List of possibly overlapping time ranges.
* @param list<pair<int, int>> $ranges List of possibly overlapping time
* ranges.
* @return list<pair<int, int>> Nonoverlapping time ranges.
*/
public static function mergeTimeRanges(array $ranges) {

12
src/applications/policy/filter/PhabricatorPolicyFilter.php
View file

@ -52,11 +52,13 @@ final class PhabricatorPolicyFilter extends Phobject {
* ...will throw a @{class:PhabricatorPolicyException} if the new policy would
* remove the user's ability to edit the object.
*
* @param PhabricatorUser The viewer to perform a policy check for.
* @param PhabricatorPolicyInterface The object to perform a policy check on.
* @param string Capability to test.
* @param string Perform the test as though the object has this
* policy instead of the policy it actually has.
* @param PhabricatorUser $viewer The viewer to perform a policy check for.
* @param PhabricatorPolicyInterface $object The object to perform a policy
* check on.
* @param string $capability Capability to test.
* @param string $forced_policy Perform the test as though the
* object has this policy instead of the policy it
* actually has.
* @return void
*/
public static function requireCapabilityWithForcedPolicy(

4
src/applications/policy/interface/PhabricatorExtendedPolicyInterface.php
View file

@ -62,8 +62,8 @@ interface PhabricatorExtendedPolicyInterface {
* // ...
* );
*
* @param const Capability being tested.
* @param PhabricatorUser Viewer whose capabilities are being tested.
* @param const $capability Capability being tested.
* @param PhabricatorUser $viewer Viewer whose capabilities are being tested.
* @return list<pair<wild, wild>> List of extended policies.
*/
public function getExtendedPolicy($capability, PhabricatorUser $viewer);

6
src/applications/policy/rule/PhabricatorPolicyRule.php
View file

@ -120,9 +120,9 @@ abstract class PhabricatorPolicyRule extends Phobject {
* rendering a verdict about whether the user will be able to see the object
* or not after applying the policy change.
*
* @param PhabricatorPolicyInterface Object to pass a hint about.
* @param PhabricatorPolicyRule Rule to pass hint to.
* @param wild Hint.
* @param PhabricatorPolicyInterface $object Object to pass a hint about.
* @param PhabricatorPolicyRule $rule Rule to pass hint to.
* @param wild $hint Hint.
* @return void
*/
public static function passTransactionHintToRule(

4
src/applications/policy/storage/PhabricatorPolicy.php
View file

@ -348,7 +348,7 @@ final class PhabricatorPolicy
* policy. This is used to bulk load data (like project memberships) in order
* to apply policy filters efficiently.
*
* @param string Policy rule classname.
* @param string $rule_class Policy rule classname.
* @return list<wild> List of values used in this policy.
*/
public function getCustomRuleValues($rule_class) {
@ -402,7 +402,7 @@ final class PhabricatorPolicy
* set of unique users. In this case, neither is strictly stronger than
* the other.
*
* @param PhabricatorPolicy Other policy.
* @param PhabricatorPolicy $other Other policy.
* @return bool `true` if this policy is more restrictive than the other
* policy.
*/

4
src/applications/repository/daemon/PhabricatorRepositoryPullLocalDaemon.php
View file

@ -341,8 +341,8 @@ final class PhabricatorRepositoryPullLocalDaemon
* With the `$consume` flag, an internal cursor will also be incremented so
* that these messages are not returned by subsequent calls.
*
* @param bool Pass `true` to consume these messages, so the process will
* not see them again.
* @param bool? $consume Pass `true` to consume these messages, so the
* process will not see them again.
* @return list<wild> Pending update messages.
*
* @task pull

2
src/applications/repository/engine/PhabricatorRepositoryDiscoveryEngine.php
View file

@ -538,7 +538,7 @@ final class PhabricatorRepositoryDiscoveryEngine
*
* @task internal
*
* @param list<DiffusionRepositoryRef> List of refs.
* @param list<DiffusionRepositoryRef> $refs List of refs.
* @return list<DiffusionRepositoryRef> Sorted list of refs.
*/
private function sortRefs(array $refs) {

2
src/applications/repository/engine/PhabricatorRepositoryPullEngine.php
View file

@ -740,7 +740,7 @@ final class PhabricatorRepositoryPullEngine
* error message. To prevent this, censor response bodies out of error
* messages.
*
* @param string Uncensored Mercurial command output.
* @param string $message Uncensored Mercurial command output.
* @return string Censored Mercurial command output.
*/
private function censorMercurialErrorMessage($message) {

2
src/applications/repository/engine/PhabricatorRepositoryRefEngine.php
View file

@ -233,7 +233,7 @@ final class PhabricatorRepositoryRefEngine
* point at commits which no longer exist. This can make commands issued later
* fail. See T5839 for discussion.
*
* @param list<string> List of commit identifiers.
* @param list<string> $identifiers List of commit identifiers.
* @return list<string> List with nonexistent identifiers removed.
*/
private function removeMissingCommits(array $identifiers) {

25
src/applications/repository/graphcache/PhabricatorRepositoryGraphCache.php
View file

@ -64,10 +64,10 @@ final class PhabricatorRepositoryGraphCache extends Phobject {
/**
* Search the graph cache for the most modification to a path.
*
* @param int The commit ID to search ancestors of.
* @param int The path ID to search for changes to.
* @param float Maximum number of seconds to spend trying to satisfy this
* query using the graph cache. By default, `0.5` (500ms).
* @param int $commit_id The commit ID to search ancestors of.
* @param int $path_id The path ID to search for changes to.
* @param float $time Maximum number of seconds to spend trying to satisfy
* this query using the graph cache. By default `0.5` (500ms).
* @return mixed Commit ID, or `null` if no ancestors exist, or `false` if
* the graph cache was unable to determine the answer.
* @task query
@ -189,7 +189,7 @@ final class PhabricatorRepositoryGraphCache extends Phobject {
/**
* Get the bucket key for a given commit ID.
*
* @param int Commit ID.
* @param int $commit_id Commit ID.
* @return int Bucket key.
* @task cache
*/
@ -201,7 +201,7 @@ final class PhabricatorRepositoryGraphCache extends Phobject {
/**
* Get the cache key for a given bucket key (from @{method:getBucketKey}).
*
* @param int Bucket key.
* @param int $bucket_key Bucket key.
* @return string Cache key.
* @task cache
*/
@ -235,9 +235,10 @@ final class PhabricatorRepositoryGraphCache extends Phobject {
* Normally, this operates as a readthrough cache call. It can also be used
* to force a cache update by passing the existing data to `$rebuild_data`.
*
* @param int Bucket key, from @{method:getBucketKey}.
* @param mixed Current data, to force a cache rebuild of this bucket.
* @return array Data from the cache.
* @param int $bucket_key Bucket key, from @{method:getBucketKey}.
* @param mixed? $rebuild_data Current data, to force a cache rebuild of
* this bucket.
* @return array Data from the cache.
* @task cache
*/
private function getBucketData($bucket_key, $rebuild_data = null) {
@ -287,9 +288,9 @@ final class PhabricatorRepositoryGraphCache extends Phobject {
/**
* Rebuild a cache bucket, amending existing data if available.
*
* @param int Bucket key, from @{method:getBucketKey}.
* @param array Existing bucket data.
* @return array Rebuilt bucket data.
* @param int $bucket_key Bucket key, from @{method:getBucketKey}.
* @param array $current_data Existing bucket data.
* @return array Rebuilt bucket data.
* @task cache
*/
private function rebuildBucket($bucket_key, array $current_data) {

12
src/applications/repository/storage/PhabricatorRepository.php
View file

@ -1288,7 +1288,7 @@ final class PhabricatorRepository extends PhabricatorRepositoryDAO
/**
* Determine if a protocol is SSH or SSH-like.
*
* @param string A protocol string, like "http" or "ssh".
* @param string $protocol A protocol string, like "http" or "ssh".
* @return bool True if the protocol is SSH-like.
* @task uri
*/
@ -1701,7 +1701,7 @@ final class PhabricatorRepository extends PhabricatorRepositoryDAO
* 2037). We adjust the pull frequency based on when the most recent commit
* occurred.
*
* @param int The minimum update interval to use, in seconds.
* @param int? $minimum The minimum update interval to use, in seconds.
* @return int Repository update interval, in seconds.
*/
public function loadUpdateInterval($minimum = 15) {
@ -1836,8 +1836,8 @@ final class PhabricatorRepository extends PhabricatorRepositoryDAO
* with repository services. This method provides lower-level resolution of
* services, returning raw URIs.
*
* @param PhabricatorUser Viewing user.
* @param map<string, wild> Constraints on selectable services.
* @param PhabricatorUser $viewer Viewing user.
* @param map<string, wild> $options Constraints on selectable services.
* @return string|null URI, or `null` for local repositories.
*/
public function getAlmanacServiceURI(
@ -2168,8 +2168,8 @@ final class PhabricatorRepository extends PhabricatorRepositoryDAO
*
* For lower-level service resolution, see @{method:getAlmanacServiceURI}.
*
* @param PhabricatorUser Viewing user.
* @param bool `true` to throw if a client would be returned.
* @param PhabricatorUser $viewer Viewing user.
* @param bool? $never_proxy `true` to throw if a client would be returned.
* @return ConduitClient|null Client, or `null` for local repositories.
*/
public function newConduitClient(

33
src/applications/search/engine/PhabricatorApplicationSearchEngine.php
View file

@ -126,7 +126,7 @@ abstract class PhabricatorApplicationSearchEngine extends Phobject {
/**
* Create a saved query object from the request.
*
* @param AphrontRequest The search request.
* @param AphrontRequest $request The search request.
* @return PhabricatorSavedQuery
*/
public function buildSavedQueryFromRequest(AphrontRequest $request) {
@ -147,7 +147,7 @@ abstract class PhabricatorApplicationSearchEngine extends Phobject {
/**
* Executes the saved query.
*
* @param PhabricatorSavedQuery The saved query to operate on.
* @param PhabricatorSavedQuery $original The saved query to operate on.
* @return PhabricatorQuery The result of the query.
*/
public function buildQueryFromSavedQuery(PhabricatorSavedQuery $original) {
@ -201,7 +201,7 @@ abstract class PhabricatorApplicationSearchEngine extends Phobject {
* hook to keep old queries working the way users expect, by reading,
* adjusting, and overwriting parameters.
*
* @param PhabricatorSavedQuery Saved query which will be executed.
* @param PhabricatorSavedQuery $saved Saved query which will be executed.
* @return void
*/
protected function willUseSavedQuery(PhabricatorSavedQuery $saved) {
@ -215,8 +215,8 @@ abstract class PhabricatorApplicationSearchEngine extends Phobject {
/**
* Builds the search form using the request.
*
* @param AphrontFormView Form to populate.
* @param PhabricatorSavedQuery The query from which to build the form.
* @param AphrontFormView $form Form to populate.
* @param PhabricatorSavedQuery $saved Query from which to build the form.
* @return void
*/
public function buildSearchForm(
@ -400,7 +400,7 @@ abstract class PhabricatorApplicationSearchEngine extends Phobject {
* Return an application URI corresponding to the results page of a query.
* Normally, this is something like `/application/query/QUERYKEY/`.
*
* @param string The query key to build a URI for.
* @param string $query_key The query key to build a URI for.
* @return string URI where the query can be executed.
* @task uri
*/
@ -730,9 +730,9 @@ abstract class PhabricatorApplicationSearchEngine extends Phobject {
* links to pages (like "alincoln's open revisions") without needing to make
* API calls.
*
* @param AphrontRequest Request to read user PHIDs from.
* @param string Key to read in the request.
* @param list<const> Other permitted PHID types.
* @param AphrontRequest $request Request to read user PHIDs from.
* @param string $key Key to read in the request.
* @param list<const>? $allow_types Other permitted PHID types.
* @return list<phid> List of user PHIDs and selector functions.
* @task read
*/
@ -782,8 +782,8 @@ abstract class PhabricatorApplicationSearchEngine extends Phobject {
/**
* Read a list of subscribers from a request in a flexible way.
*
* @param AphrontRequest Request to read PHIDs from.
* @param string Key to read in the request.
* @param AphrontRequest $request Request to read PHIDs from.
* @param string $key Key to read in the request.
* @return list<phid> List of object PHIDs.
* @task read
*/
@ -805,9 +805,10 @@ abstract class PhabricatorApplicationSearchEngine extends Phobject {
* comma-delimited forms. Objects can be specified either by PHID or by
* object name.
*
* @param AphrontRequest Request to read PHIDs from.
* @param string Key to read in the request.
* @param list<const> Optional, list of permitted PHID types.
* @param AphrontRequest $request Request to read PHIDs from.
* @param string $key Key to read in the request.
* @param list<const>? $allow_types Optional, list of permitted PHID
* types.
* @return list<phid> List of object PHIDs.
*
* @task read
@ -853,8 +854,8 @@ abstract class PhabricatorApplicationSearchEngine extends Phobject {
* This provides flexibility when constructing URIs, especially from external
* sources.
*
* @param AphrontRequest Request to read strings from.
* @param string Key to read in the request.
* @param AphrontRequest $request Request to read strings from.
* @param string $key Key to read in the request.
* @return list<string> List of values.
*/
protected function readListFromRequest(

18
src/applications/search/field/PhabricatorSearchField.php
View file

@ -33,7 +33,7 @@ abstract class PhabricatorSearchField extends Phobject {
* The key should be a short, unique (within a search engine) string which
* does not contain any special characters.
*
* @param string Unique key which identifies the field.
* @param string $key Unique key which identifies the field.
* @return this
* @task config
*/
@ -59,7 +59,7 @@ abstract class PhabricatorSearchField extends Phobject {
*
* This should be a short text string, like "Reviewers" or "Colors".
*
* @param string Short, human-readable field label.
* @param string $label Short, human-readable field label.
* @return this
* task config
*/
@ -86,7 +86,7 @@ abstract class PhabricatorSearchField extends Phobject {
* Engines do not need to do this explicitly; it will be done on their
* behalf by the caller.
*
* @param PhabricatorUser Viewer.
* @param PhabricatorUser $viewer Viewer.
* @return this
* @task config
*/
@ -115,7 +115,7 @@ abstract class PhabricatorSearchField extends Phobject {
* an alias like `authors` to let users write `&authors=alincoln` instead of
* `&authorPHIDs=alincoln`. This is a little easier to use.
*
* @param list<string> List of aliases for this field.
* @param list<string> $aliases List of aliases for this field.
* @return this
* @task config
*/
@ -142,7 +142,7 @@ abstract class PhabricatorSearchField extends Phobject {
* This can allow you to choose a more usable key for API endpoints.
* If no key is provided, the main key is used.
*
* @param string Alternate key for Conduit.
* @param string $conduit_key Alternate key for Conduit.
* @return this
* @task config
*/
@ -170,7 +170,7 @@ abstract class PhabricatorSearchField extends Phobject {
/**
* Set a human-readable description for this field.
*
* @param string Human-readable description.
* @param string $description Human-readable description.
* @return this
* @task config
*/
@ -194,7 +194,7 @@ abstract class PhabricatorSearchField extends Phobject {
/**
* Hide this field from the web UI.
*
* @param bool True to hide the field from the web UI.
* @param bool $is_hidden True to hide the field from the web UI.
* @return this
* @task config
*/
@ -400,8 +400,8 @@ abstract class PhabricatorSearchField extends Phobject {
* This provides flexibility when constructing URIs, especially from external
* sources.
*
* @param AphrontRequest Request to read strings from.
* @param string Key to read in the request.
* @param AphrontRequest $request Request to read strings from.
* @param string $key Key to read in the request.
* @return list<string> List of values.
* @task utility
*/

4
src/applications/search/fulltextstorage/PhabricatorFulltextStorageEngine.php
View file

@ -47,7 +47,7 @@ abstract class PhabricatorFulltextStorageEngine extends Phobject {
/**
* Update the index for an abstract document.
*
* @param PhabricatorSearchAbstractDocument Document to update.
* @param PhabricatorSearchAbstractDocument $document Document to update.
* @return void
*/
abstract public function reindexAbstractDocument(
@ -56,7 +56,7 @@ abstract class PhabricatorFulltextStorageEngine extends Phobject {
/**
* Execute a search query.
*
* @param PhabricatorSavedQuery A query to execute.
* @param PhabricatorSavedQuery $query A query to execute.
* @return list A list of matching PHIDs.
*/
abstract public function executeSearch(PhabricatorSavedQuery $query);

4
src/applications/settings/panel/PhabricatorSettingsPanel.php
View file

@ -222,7 +222,7 @@ abstract class PhabricatorSettingsPanel extends Phobject {
* Generally, render your settings panel by returning a form, then return
* a redirect when the user saves settings.
*
* @param AphrontRequest Incoming request.
* @param AphrontRequest $request Incoming request.
* @return wild Response to request, either as an
* @{class:AphrontResponse} or something which can
* be composed into a @{class:AphrontView}.
@ -234,7 +234,7 @@ abstract class PhabricatorSettingsPanel extends Phobject {
/**
* Get the URI for this panel.
*
* @param string? Optional path to append.
* @param string? $path Optional path to append.
* @return string Relative URI for the panel.
* @task panel
*/

3
src/applications/settings/query/PhabricatorUserPreferencesQuery.php
View file

@ -49,7 +49,8 @@ final class PhabricatorUserPreferencesQuery
* If no settings exist for a user, a new empty settings object with
* appropriate defaults is returned.
*
* @param bool True to generate synthetic preferences for missing users.
* @param bool $synthetic True to generate synthetic preferences for missing
* users.
*/
public function needSyntheticPreferences($synthetic) {
$this->synthetic = $synthetic;

4
src/applications/settings/storage/PhabricatorUserPreferences.php
View file

@ -119,7 +119,7 @@ final class PhabricatorUserPreferences
/**
* Load or create a preferences object for the given user.
*
* @param PhabricatorUser User to load or create preferences for.
* @param PhabricatorUser $user User to load or create preferences for.
*/
public static function loadUserPreferences(PhabricatorUser $user) {
return id(new PhabricatorUserPreferencesQuery())
@ -134,7 +134,7 @@ final class PhabricatorUserPreferences
*
* If no global preferences exist, an empty preferences object is returned.
*
* @param PhabricatorUser Viewing user.
* @param PhabricatorUser $viewer Viewing user.
*/
public static function loadGlobalPreferences(PhabricatorUser $viewer) {
$global = id(new PhabricatorUserPreferencesQuery())

2
src/applications/spaces/query/PhabricatorSpacesNamespaceQuery.php
View file

@ -212,7 +212,7 @@ final class PhabricatorSpacesNamespaceQuery
* This is intended to simplify performing a bunch of redundant checks; you
* can intentionally pass any value in (including `null`).
*
* @param wild
* @param wild $object
* @return phid|null
*/
public static function getObjectSpacePHID($object) {

6
src/applications/subscriptions/editor/PhabricatorSubscriptionsEditor.php
View file

@ -18,7 +18,7 @@ final class PhabricatorSubscriptionsEditor extends PhabricatorEditor {
* (or been subscribed) to the object, and will be added even if they
* had previously unsubscribed.
*
* @param list<phid> List of PHIDs to explicitly subscribe.
* @param list<phid> $phids List of PHIDs to explicitly subscribe.
* @return this
*/
public function subscribeExplicit(array $phids) {
@ -32,7 +32,7 @@ final class PhabricatorSubscriptionsEditor extends PhabricatorEditor {
* implicitly subscribes them (e.g., adding a comment) but it will be
* suppressed if they've previously unsubscribed from the object.
*
* @param list<phid> List of PHIDs to implicitly subscribe.
* @param list<phid> $phids List of PHIDs to implicitly subscribe.
* @return this
*/
public function subscribeImplicit(array $phids) {
@ -45,7 +45,7 @@ final class PhabricatorSubscriptionsEditor extends PhabricatorEditor {
* Unsubscribe PHIDs and mark them as unsubscribed, so implicit subscriptions
* will not resubscribe them.
*
* @param list<phid> List of PHIDs to unsubscribe.
* @param list<phid> $phids List of PHIDs to unsubscribe.
* @return this
*/
public function unsubscribe(array $phids) {

Some files were not shown because too many files have changed in this diff Show more