+16 -14

src/aphront/AphrontRequest.php

reviewed

··· 56 56 * Applications like Paste, Diffusion, and Harbormaster use "$12-14" in the 57 57 * URI to allow users to link to particular lines. 58 58 * 59 59 - * @param string URI data key to pull line range information from. 60 60 - * @param int|null Maximum length of the range. 59 59 + * @param string $key URI data key to pull line range information from. 60 60 + * @param int|null $limit Maximum length of the range. 61 61 * @return null|pair<int, int> Null, or beginning and end of the range. 62 62 */ 63 63 public function getURILineRange($key, $limit) { ··· 537 537 * 538 538 * To set a temporary cookie, see @{method:setTemporaryCookie}. 539 539 * 540 540 - * @param string Cookie name. 541 541 - * @param string Cookie value. 540 540 + * @param string $name Cookie name. 541 541 + * @param string $value Cookie value. 542 542 * @return this 543 543 * @task cookie 544 544 */ ··· 553 553 * 554 554 * To set a durable cookie, see @{method:setCookie}. 555 555 * 556 556 - * @param string Cookie name. 557 557 - * @param string Cookie value. 556 556 + * @param string $name Cookie name. 557 557 + * @param string $value Cookie value. 558 558 * @return this 559 559 * @task cookie 560 560 */ ··· 566 566 /** 567 567 * Set a cookie with a given expiration policy. 568 568 * 569 569 - * @param string Cookie name. 570 570 - * @param string Cookie value. 571 571 - * @param int Epoch timestamp for cookie expiration. 569 569 + * @param string $name Cookie name. 570 570 + * @param string $value Cookie value. 571 571 + * @param int $expire Epoch timestamp for cookie expiration. 572 572 * @return this 573 573 * @task cookie 574 574 */ ··· 748 748 * into a list of key-value pairs suitable for submitting via HTTP request 749 749 * (with arrays flattened). 750 750 * 751 751 - * @param dict<string, wild> Data to flatten. 751 751 + * @param dict<string, wild> $data Data to flatten. 752 752 * @return dict<string, string> Flat data suitable for inclusion in an HTTP 753 753 * request. 754 754 */ ··· 778 778 * and looks up the appropriate value in `$_SERVER` (in this case, 779 779 * `"HTTP_ACCEPT_ENCODING"`). 780 780 * 781 781 - * @param string Canonical header name, like `"Accept-Encoding"`. 782 782 - * @param wild Default value to return if header is not present. 783 783 - * @param array? Read this instead of `$_SERVER`. 781 781 + * @param string $name Canonical header name, like 782 782 + `"Accept-Encoding"`. 783 783 + * @param wild? $default Default value to return if header is not 784 784 + present. 785 785 + * @param array? $data Read this instead of `$_SERVER`. 784 786 * @return string|wild Header value if present, or `$default` if not. 785 787 */ 786 788 public static function getHTTPHeader($name, $default = null, $data = null) { ··· 844 846 * This is not a general-purpose proxying method; it is a specialized 845 847 * method with niche applications and severe security implications. 846 848 * 847 847 - * @param string URI identifying the host we are proxying the request to. 849 849 + * @param string URI $uri identifying the host we are proxying the request to. 848 850 * @return HTTPSFuture New proxy future. 849 851 * 850 852 * @phutil-external-symbol class PhabricatorStartup

+14 -13

src/aphront/configuration/AphrontApplicationConfiguration.php

reviewed

··· 510 510 * Map a specific path to the corresponding controller. For a description 511 511 * of routing, see @{method:buildController}. 512 512 * 513 513 - * @param list<AphrontRoutingMap> List of routing maps. 514 514 - * @param string Path to route. 513 513 + * @param list<AphrontRoutingMap> $maps List of routing maps. 514 514 + * @param string $path Path to route. 515 515 * @return pair<AphrontController,dict> Controller and dictionary of request 516 516 * parameters. 517 517 * @task routing ··· 562 562 /** 563 563 * Tests if a response is of a valid type. 564 564 * 565 565 - * @param wild Supposedly valid response. 565 565 + * @param wild $response Supposedly valid response. 566 566 * @return bool True if the object is of a valid type. 567 567 * @task response 568 568 */ ··· 583 583 * Verifies that the return value from an @{class:AphrontController} is 584 584 * of an allowed type. 585 585 * 586 586 - * @param AphrontController Controller which returned the response. 587 587 - * @param wild Supposedly valid response. 586 586 + * @param AphrontController $controller Controller which returned the 587 587 + * response. 588 588 + * @param wild $response Supposedly valid response. 588 589 * @return void 589 590 * @task response 590 591 */ ··· 612 613 * Verifies that the return value from an 613 614 * @{class:AphrontResponseProducerInterface} is of an allowed type. 614 615 * 615 615 - * @param AphrontResponseProducerInterface Object which produced 616 616 + * @param AphrontResponseProducerInterface $producer Object which produced 616 617 * this response. 617 617 - * @param wild Supposedly valid response. 618 618 + * @param wild $response Supposedly valid response. 618 619 * @return void 619 620 * @task response 620 621 */ ··· 642 643 * Verifies that the return value from an 643 644 * @{class:AphrontRequestExceptionHandler} is of an allowed type. 644 645 * 645 645 - * @param AphrontRequestExceptionHandler Object which produced this 646 646 + * @param AphrontRequestExceptionHandler $handler Object which produced this 646 647 * response. 647 647 - * @param wild Supposedly valid response. 648 648 + * @param wild $response Supposedly valid response. 648 649 * @return void 649 650 * @task response 650 651 */ ··· 678 679 * If a controller returns a response producer, invoke it now and produce 679 680 * the real response. 680 681 * 681 681 - * @param AphrontRequest Request being handled. 682 682 - * @param AphrontResponse|AphrontResponseProducerInterface Response, or 683 683 - * response producer. 682 682 + * @param AphrontRequest $request Request being handled. 683 683 + * @param AphrontResponse|AphrontResponseProducerInterface $response 684 684 + * Response, or response producer. 684 685 * @return AphrontResponse Response after any required production. 685 686 * @task response 686 687 */ ··· 738 739 * This method delegates exception handling to available subclasses of 739 740 * @{class:AphrontRequestExceptionHandler}. 740 741 * 741 741 - * @param Throwable Exception which needs to be handled. 742 742 + * @param Throwable $throwable Exception which needs to be handled. 742 743 * @return wild Response or response producer, or null if no available 743 744 * handler can produce a response. 744 745 * @task exception

+15 -15

src/aphront/httpparametertype/AphrontHTTPParameterType.php

reviewed

··· 31 31 * example, a type might lookup usernames or project names. These types need 32 32 * to use the current viewer to execute queries. 33 33 * 34 34 - * @param PhabricatorUser Current viewer. 34 34 + * @param PhabricatorUser $viewer Current viewer. 35 35 * @return this 36 36 * @task read 37 37 */ ··· 58 58 /** 59 59 * Test if a value is present in a request. 60 60 * 61 61 - * @param AphrontRequest The incoming request. 62 62 - * @param string The key to examine. 61 61 + * @param AphrontRequest $request The incoming request. 62 62 + * @param string $key The key to examine. 63 63 * @return bool True if a readable value is present in the request. 64 64 * @task read 65 65 */ ··· 74 74 * If the value is not present, a default value is returned (usually `null`). 75 75 * Use @{method:getExists} to test if a value is present. 76 76 * 77 77 - * @param AphrontRequest The incoming request. 78 78 - * @param string The key to examine. 77 77 + * @param AphrontRequest $request The incoming request. 78 78 + * @param string $key The key to examine. 79 79 * @return wild Value, or default if value is not present. 80 80 * @task read 81 81 */ ··· 165 165 * existence check that a simpler "list of strings" type has, and can just 166 166 * call the simpler type to reuse its behavior. 167 167 * 168 168 - * @param AphrontHTTPParameterType The other type. 169 169 - * @param AphrontRequest Incoming request. 170 170 - * @param string Key to examine. 168 168 + * @param AphrontHTTPParameterType $type The other type. 169 169 + * @param AphrontRequest $request Incoming request. 170 170 + * @param string $key Key to examine. 171 171 * @return bool True if the parameter exists. 172 172 * @task util 173 173 */ ··· 189 189 * type. For example, a "list of users" type may start by running the same 190 190 * basic parsing that a simpler "list of strings" type does. 191 191 * 192 192 - * @param AphrontHTTPParameterType The other type. 193 193 - * @param AphrontRequest Incoming request. 194 194 - * @param string Key to examine. 192 192 + * @param AphrontHTTPParameterType $type The other type. 193 193 + * @param AphrontRequest $request Incoming request. 194 194 + * @param string $key Key to examine. 195 195 * @return wild Parsed value. 196 196 * @task util 197 197 */ ··· 233 233 * To call another type's behavior in order to perform this check, use 234 234 * @{method:getExistsWithType}. 235 235 * 236 236 - * @param AphrontRequest The incoming request. 237 237 - * @param string The key to examine. 236 236 + * @param AphrontRequest $request The incoming request. 237 237 + * @param string $key The key to examine. 238 238 * @return bool True if a readable value is present in the request. 239 239 * @task impl 240 240 */ ··· 253 253 * To call another type's behavior in order to parse a value, use 254 254 * @{method:getValueWithType}. 255 255 * 256 256 - * @param AphrontRequest The incoming request. 257 257 - * @param string The key to examine. 256 256 + * @param AphrontRequest $request The incoming request. 257 257 + * @param string $key The key to examine. 258 258 * @return wild Parsed value. 259 259 * @task impl 260 260 */

+1 -1

src/aphront/response/AphrontFileResponse.php

reviewed

··· 30 30 /** 31 31 * Set a download filename 32 32 * 33 33 - * @param $download string 33 33 + * @param string $download 34 34 * @return self 35 35 */ 36 36 public function setDownload($download) {

+3 -2

src/aphront/response/AphrontRedirectResponse.php

reviewed

··· 117 117 * ambiguity. For example, Chrome interprets "Location: /\evil.com" to mean 118 118 * "perform a protocol-relative redirect to evil.com". 119 119 * 120 120 - * @param string URI to redirect to. 121 121 - * @param bool True if this URI identifies a remote resource. 120 120 + * @param string $uri URI to redirect to. 121 121 + * @param bool $is_external True if this URI identifies a remote 122 122 + * resource. 122 123 * @return string URI for use in a "Location:" header. 123 124 */ 124 125 public static function getURIForRedirect($uri, $is_external) {

+5 -4

src/aphront/sink/AphrontHTTPSink.php

reviewed

··· 28 28 /** 29 29 * Write an HTTP status code to the output. 30 30 * 31 31 - * @param int Numeric HTTP status code. 31 31 + * @param int $code Numeric HTTP status code. 32 32 + * @param string? $message 32 33 * @return void 33 34 */ 34 35 final public function writeHTTPStatus($code, $message = '') { ··· 44 45 /** 45 46 * Write HTTP headers to the output. 46 47 * 47 47 - * @param list<pair> List of <name, value> pairs. 48 48 + * @param list<pair> $headers List of <name, value> pairs. 48 49 * @return void 49 50 */ 50 51 final public function writeHeaders(array $headers) { ··· 89 90 /** 90 91 * Write HTTP body data to the output. 91 92 * 92 92 - * @param string Body data. 93 93 + * @param string $data Body data. 93 94 * @return void 94 95 */ 95 96 final public function writeData($data) { ··· 100 101 /** 101 102 * Write an entire @{class:AphrontResponse} to the output. 102 103 * 103 103 - * @param AphrontResponse The response object to write. 104 104 + * @param AphrontResponse $response The response object to write. 104 105 * @return void 105 106 */ 106 107 final public function writeResponse(AphrontResponse $response) {

+4 -4

src/aphront/site/AphrontRoutingMap.php

reviewed

··· 50 50 /** 51 51 * Find the route matching a path, if one exists. 52 52 * 53 53 - * @param string Path to route. 53 53 + * @param string $path Path to route. 54 54 * @return AphrontRoutingResult|null Routing result, if path matches map. 55 55 * @task routing 56 56 */ ··· 84 84 /** 85 85 * Test a sub-map to see if any routes match a path. 86 86 * 87 87 - * @param string Path to route. 88 88 - * @param string Pattern from the map. 89 89 - * @param string Value from the map. 87 87 + * @param string $route Pattern from the map. 88 88 + * @param string $value Value from the map. 89 89 + * @param string $path Path to route. 90 90 * @return dict<string, wild>|null Match details, if path matches sub-map. 91 91 * @task routing 92 92 */

+1 -1

src/aphront/writeguard/AphrontWriteGuard.php

reviewed

··· 57 57 * the request, or abort the request (e.g., by throwing an exception) if a 58 58 * valid token isn't present. 59 59 * 60 60 - * @param callable CSRF callback. 60 60 + * @param $callback Callable CSRF callback. 61 61 * @return this 62 62 * @task manage 63 63 */

+1 -1

src/applications/auth/constants/PhabricatorCommonPasswords.php

reviewed

··· 16 16 /** 17 17 * Check if a password is extremely common. 18 18 * 19 19 - * @param string Password to test. 19 19 + * @param string $password Password to test. 20 20 * @return bool True if the password is pathologically weak. 21 21 * 22 22 * @task common

+7 -7

src/applications/auth/constants/PhabricatorCookies.php

reviewed

··· 77 77 * Set the client ID cookie. This is a random cookie used like a CSRF value 78 78 * during authentication workflows. 79 79 * 80 80 - * @param AphrontRequest Request to modify. 80 80 + * @param AphrontRequest $request Request to modify. 81 81 * @return void 82 82 * @task clientid 83 83 */ ··· 105 105 * written, to avoid writing over a real URI with a bunch of "humans.txt" 106 106 * stuff. See T3793 for discussion. 107 107 * 108 108 - * @param AphrontRequest Request to write to. 109 109 - * @param string URI to write. 110 110 - * @param bool Write this cookie even if we have a fresh 111 111 - * cookie already. 108 108 + * @param AphrontRequest $request Request to write to. 109 109 + * @param string $next_uri URI to write. 110 110 + * @param bool? $force Write this cookie even if we have a 111 111 + * fresh cookie already. 112 112 * @return void 113 113 * 114 114 * @task next ··· 139 139 /** 140 140 * Read the URI out of the Next URI cookie. 141 141 * 142 142 - * @param AphrontRequest Request to examine. 142 142 + * @param AphrontRequest $request Request to examine. 143 143 * @return string|null Next URI cookie's URI value. 144 144 * 145 145 * @task next ··· 155 155 /** 156 156 * Parse a Next URI cookie into its components. 157 157 * 158 158 - * @param string Raw cookie value. 158 158 + * @param string $cookie Raw cookie value. 159 159 * @return list<string> List of timestamp and URI. 160 160 * 161 161 * @task next

+3 -2

src/applications/auth/controller/PhabricatorAuthController.php

reviewed

··· 44 44 * the user's cookies are set. However, event listeners can intercept this 45 45 * event and do something else if they prefer. 46 46 * 47 47 - * @param PhabricatorUser User to log the viewer in as. 48 48 - * @param bool True to issue a full session immediately, bypassing MFA. 47 47 + * @param PhabricatorUser $user User to log the viewer in as. 48 48 + * @param bool? $force_full_session True to issue a full session immediately, 49 49 + * bypassing MFA. 49 50 * @return AphrontResponse Response which continues the login process. 50 51 */ 51 52 protected function loginUser(

+49 -40

src/applications/auth/engine/PhabricatorAuthSessionEngine.php

reviewed

··· 75 75 * Get the session kind (e.g., anonymous, user, external account) from a 76 76 * session token. Returns a `KIND_` constant. 77 77 * 78 78 - * @param string Session token. 78 78 + * @param string $session_token Session token. 79 79 * @return const Session kind constant. 80 80 */ 81 81 public static function getSessionKindFromToken($session_token) { ··· 109 109 * loading context. This prevents use of a Conduit sesssion as a Web 110 110 * session, for example. 111 111 * 112 112 - * @param const The type of session to load. 113 113 - * @param string The session token. 112 112 + * @param const $session_type The type of session to load. 113 113 + * @param string $session_token The session token. 114 114 * @return PhabricatorUser|null 115 115 * @task use 116 116 */ ··· 250 250 * You can configure the maximum number of concurrent sessions for various 251 251 * session types in the Phabricator configuration. 252 252 * 253 253 - * @param const Session type constant (see 253 253 + * @param const $session_type Session type constant (see 254 254 * @{class:PhabricatorAuthSession}). 255 255 - * @param phid|null Identity to establish a session for, usually a user 256 256 - * PHID. With `null`, generates an anonymous session. 257 257 - * @param bool True to issue a partial session. 255 255 + * @param phid|null $identity_phid Identity to establish a session for, 256 256 + * usually a user PHID. With `null`, generates an 257 257 + * anonymous session. 258 258 + * @param bool $partial True to issue a partial session. 258 259 * @return string Newly generated session key. 259 260 */ 260 261 public function establishSession($session_type, $identity_phid, $partial) { ··· 325 326 * This is used when users change passwords, linked accounts, or add 326 327 * multifactor authentication. 327 328 * 328 328 - * @param PhabricatorUser User whose sessions should be terminated. 329 329 - * @param string|null Optionally, one session to keep. Normally, the current 330 330 - * login session. 329 329 + * @param PhabricatorUser $user User whose sessions should be terminated. 330 330 + * @param string|null? $except_session Optionally, one session to keep. 331 331 + * Normally, the current login session. 331 332 * 332 333 * @return void 333 334 */ ··· 388 389 * does not upgrade the user's session as a side effect. This method is 389 390 * appropriate for one-time checks. 390 391 * 391 391 - * @param PhabricatorUser User whose session needs to be in high security. 392 392 - * @param AphrontRequest Current request. 393 393 - * @param string URI to return the user to if they cancel. 392 392 + * @param PhabricatorUser $viewer User whose session needs to be in high 393 393 + * security. 394 394 + * @param AphrontRequest $request Current request. 395 395 + * @param string $cancel_uri URI to return the user to if they 396 396 + * cancel. 394 397 * @return PhabricatorAuthHighSecurityToken Security token. 395 398 * @task hisec 396 399 */ ··· 420 423 * take multiple high security actions. To perform a one-time check instead, 421 424 * use @{method:requireHighSecurityToken}. 422 425 * 423 423 - * @param PhabricatorUser User whose session needs to be in high security. 424 424 - * @param AphrontRequest Current request. 425 425 - * @param string URI to return the user to if they cancel. 426 426 - * @param bool True to jump partial sessions directly into high 427 427 - * security instead of just upgrading them to full 428 428 - * sessions. 426 426 + * @param PhabricatorUser $viewer User whose session needs to be in high 427 427 + * security. 428 428 + * @param AphrontRequest $request Current request. 429 429 + * @param string $cancel_uri URI to return the user to if they 430 430 + * cancel. 431 431 + * @param bool? $jump_into_hisec True to jump partial sessions 432 432 + * directly into high security instead of just 433 433 + * upgrading them to full sessions. 429 434 * @return PhabricatorAuthHighSecurityToken Security token. 430 435 * @task hisec 431 436 */ ··· 736 741 /** 737 742 * Issue a high security token for a session, if authorized. 738 743 * 739 739 - * @param PhabricatorAuthSession Session to issue a token for. 740 740 - * @param bool Force token issue. 744 744 + * @param PhabricatorAuthSession $session Session to issue a token for. 745 745 + * @param bool? $force Force token issue. 741 746 * @return PhabricatorAuthHighSecurityToken|null Token, if authorized. 742 747 * @task hisec 743 748 */ ··· 756 761 /** 757 762 * Render a form for providing relevant multi-factor credentials. 758 763 * 759 759 - * @param PhabricatorUser Viewing user. 760 760 - * @param AphrontRequest Current request. 764 764 + * @param array $factors 765 765 + * @param array $validation_results 766 766 + * @param PhabricatorUser $viewer Viewing user. 767 767 + * @param AphrontRequest $request Current request. 761 768 * @return AphrontFormView Renderable form. 762 769 * @task hisec 763 770 */ ··· 810 817 * 811 818 * Kicks a session out of high security and logs the exit. 812 819 * 813 813 - * @param PhabricatorUser Acting user. 814 814 - * @param PhabricatorAuthSession Session to return to normal security. 820 820 + * @param PhabricatorUser $viewer Acting user. 821 821 + * @param PhabricatorAuthSession $session Session to return to normal 822 822 + * security. 815 823 * @return void 816 824 * @task hisec 817 825 */ ··· 843 851 /** 844 852 * Upgrade a partial session to a full session. 845 853 * 846 846 - * @param PhabricatorAuthSession Session to upgrade. 854 854 + * @param PhabricatorUser $viewer Viewer whose session should upgrade. 847 855 * @return void 848 856 * @task partial 849 857 */ ··· 885 893 /** 886 894 * Upgrade a session to have all legalpad documents signed. 887 895 * 888 888 - * @param PhabricatorUser User whose session should upgrade. 889 889 - * @param array LegalpadDocument objects 896 896 + * @param PhabricatorUser $viewer User whose session should upgrade. 897 897 + * @param array $docs LegalpadDocument objects 890 898 * @return void 891 899 * @task partial 892 900 */ ··· 934 942 * These URIs are used for password recovery and to regain access to accounts 935 943 * which users have been locked out of. 936 944 * 937 937 - * @param PhabricatorUser User to generate a URI for. 938 938 - * @param PhabricatorUserEmail Optionally, email to verify when 945 945 + * @param PhabricatorUser $user User to generate a URI for. 946 946 + * @param PhabricatorUserEmail? $email Optionally, email to verify when 939 947 * link is used. 940 940 - * @param string Optional context string for the URI. This is purely cosmetic 941 941 - * and used only to customize workflow and error messages. 942 942 - * @param bool True to generate a URI which forces an immediate upgrade to 943 943 - * a full session, bypassing MFA and other login checks. 948 948 + * @param string? $type Optional context string for the URI. This is purely 949 949 + * cosmetic and used only to customize workflow and error messages. 950 950 + * @param bool? $force_full_session True to generate a URI which forces an 951 951 + * immediate upgrade to a full session, bypassing MFA and other login 952 952 + * checks. 944 953 * @return string Login URI. 945 954 * @task onetime 946 955 */ ··· 984 993 /** 985 994 * Load the temporary token associated with a given one-time login key. 986 995 * 987 987 - * @param PhabricatorUser User to load the token for. 988 988 - * @param PhabricatorUserEmail Optionally, email to verify when 996 996 + * @param PhabricatorUser $user User to load the token for. 997 997 + * @param PhabricatorUserEmail? $email Optionally, email to verify when 989 998 * link is used. 990 990 - * @param string Key user is presenting as a valid one-time login key. 999 999 + * @param string? $key Key user is presenting as a valid one-time login key. 991 1000 * @return PhabricatorAuthTemporaryToken|null Token, if one exists. 992 1001 * @task onetime 993 1002 */ ··· 1012 1021 /** 1013 1022 * Hash a one-time login key for storage as a temporary token. 1014 1023 * 1015 1015 - * @param PhabricatorUser User this key is for. 1016 1016 - * @param PhabricatorUserEmail Optionally, email to verify when 1024 1024 + * @param PhabricatorUser $user User this key is for. 1025 1025 + * @param PhabricatorUserEmail? $email Optionally, email to verify when 1017 1026 * link is used. 1018 1018 - * @param string The one time login key. 1027 1027 + * @param string? $key The one time login key. 1019 1028 * @return string Hash of the key. 1020 1029 * task onetime 1021 1030 */

+2 -2

src/applications/auth/password/PhabricatorAuthPasswordHashInterface.php

reviewed

··· 14 14 * as their password or picking other passwords which are trivially similar 15 15 * to an account or object identifier. 16 16 * 17 17 - * @param PhabricatorUser The user selecting the password. 18 18 - * @param PhabricatorAuthPasswordEngine The password engine updating a 17 17 + * @param PhabricatorUser $viewer The user selecting the password. 18 18 + * @param PhabricatorAuthPasswordEngine $engine The password engine updating a 19 19 * password. 20 20 * @return list<string> Blocklist of nonsecret identifiers which the password 21 21 * should not be similar to.

+3 -3

src/applications/auth/provider/PhabricatorAuthProvider.php

reviewed

··· 460 460 * - `uri`: URI the button should take the user to when clicked. 461 461 * - `method`: Optional HTTP method the button should use, defaults to GET. 462 462 * 463 463 - * @param AphrontRequest HTTP request. 464 464 - * @param string Request mode string. 465 465 - * @param map Additional parameters, see above. 463 463 + * @param AphrontRequest $request HTTP request. 464 464 + * @param string $mode Request mode string. 465 465 + * @param map? $attributes Additional parameters, see above. 466 466 * @return wild Log in button. 467 467 */ 468 468 protected function renderStandardLoginButton(

+7 -7

src/applications/base/PhabricatorApplication.php

reviewed

··· 141 141 * 142 142 * Users who have not yet set preferences see a default list of applications. 143 143 * 144 144 - * @param PhabricatorUser User viewing the pinned application list. 144 144 + * @param PhabricatorUser $viewer User viewing the pinned application list. 145 145 * @return bool True if this application should be pinned by default. 146 146 */ 147 147 public function isPinnedByDefault(PhabricatorUser $viewer) { ··· 330 330 /** 331 331 * Build items for the main menu. 332 332 * 333 333 - * @param PhabricatorUser The viewing user. 334 334 - * @param AphrontController The current controller. May be null for special 335 335 - * pages like 404, exception handlers, etc. 333 333 + * @param PhabricatorUser $user The viewing user. 334 334 + * @param AphrontController? $controller The current controller. May be null 335 335 + * for special pages like 404, exception handlers, etc. 336 336 * @return list<PHUIListItemView> List of menu items. 337 337 * @task ui 338 338 */ ··· 409 409 * To check if an application is installed //and// available to a particular 410 410 * viewer, user @{method:isClassInstalledForViewer}. 411 411 * 412 412 - * @param string Application class name. 412 412 + * @param string $class Application class name. 413 413 * @return bool True if the class is installed. 414 414 * @task meta 415 415 */ ··· 425 425 * To check if an application is installed at all, use 426 426 * @{method:isClassInstalled}. 427 427 * 428 428 - * @param string Application class name. 429 429 - * @param PhabricatorUser Viewing user. 428 428 + * @param string $class Application class name. 429 429 + * @param PhabricatorUser $viewer Viewing user. 430 430 * @return bool True if the class is installed for the viewer. 431 431 * @task meta 432 432 */

+2 -2

src/applications/cache/PhabricatorCaches.php

reviewed

··· 416 416 * 417 417 * Data can later be inflated with @{method:inflateData}. 418 418 * 419 419 - * @param string String to attempt to deflate. 419 419 + * @param string $value String to attempt to deflate. 420 420 * @return string|null Deflated string, or null if it was not deflated. 421 421 * @task compress 422 422 */ ··· 447 447 /** 448 448 * Inflate data previously deflated by @{method:maybeDeflateData}. 449 449 * 450 450 - * @param string Deflated data, from @{method:maybeDeflateData}. 450 450 + * @param string $value Deflated data, from @{method:maybeDeflateData}. 451 451 * @return string Original, uncompressed data. 452 452 * @task compress 453 453 */

+6 -6

src/applications/celerity/CelerityResourceMap.php

reviewed

··· 160 160 /** 161 161 * Get the epoch timestamp of the last modification time of a symbol. 162 162 * 163 163 - * @param string Resource symbol to lookup. 163 163 + * @param string $name Resource symbol to lookup. 164 164 * @return int Epoch timestamp of last resource modification. 165 165 */ 166 166 public function getModifiedTimeForName($name) { ··· 186 186 * Return the absolute URI for the resource associated with a symbol. This 187 187 * method is fairly low-level and ignores packaging. 188 188 * 189 189 - * @param string Resource symbol to lookup. 189 189 + * @param string $symbol Resource symbol to lookup. 190 190 * @return string|null Resource URI, or null if the symbol is unknown. 191 191 */ 192 192 public function getURIForSymbol($symbol) { ··· 199 199 * Return the absolute URI for the resource associated with a resource name. 200 200 * This method is fairly low-level and ignores packaging. 201 201 * 202 202 - * @param string Resource name to lookup. 202 202 + * @param string $name Resource name to lookup. 203 203 * @return string|null Resource URI, or null if the name is unknown. 204 204 */ 205 205 public function getURIForName($name) { ··· 217 217 * Return the absolute URI for a resource, identified by hash. 218 218 * This method is fairly low-level and ignores packaging. 219 219 * 220 220 - * @param string Resource hash to lookup. 220 220 + * @param string $hash Resource hash to lookup. 221 221 * @return string|null Resource URI, or null if the hash is unknown. 222 222 */ 223 223 private function getURIForHash($hash) { ··· 231 231 /** 232 232 * Return the resource symbols required by a named resource. 233 233 * 234 234 - * @param string Resource name to lookup. 234 234 + * @param string $name Resource name to lookup. 235 235 * @return list<string>|null List of required symbols, or null if the name 236 236 * is unknown. 237 237 */ ··· 247 247 /** 248 248 * Return the resource name for a given symbol. 249 249 * 250 250 - * @param string Resource symbol to lookup. 250 250 + * @param string $symbol Resource symbol to lookup. 251 251 * @return string|null Resource name, or null if the symbol is unknown. 252 252 */ 253 253 public function getResourceNameForSymbol($symbol) {

+13 -10

src/applications/celerity/CelerityResourceMapGenerator.php

reviewed

··· 146 146 * Find binary resources (like PNG and SWF) and return information about 147 147 * them. 148 148 * 149 149 - * @param CelerityPhysicalResources Resource map to find binary resources for. 149 149 + * @param CelerityPhysicalResources $resources Resource map to find binary 150 150 + * resources for. 150 151 * @return map<string, map<string, string>> Resource information map. 151 152 */ 152 153 private function rebuildBinaryResources( ··· 170 171 /** 171 172 * Find text resources (like JS and CSS) and return information about them. 172 173 * 173 173 - * @param CelerityPhysicalResources Resource map to find text resources for. 174 174 - * @param CelerityResourceTransformer Configured resource transformer. 174 174 + * @param CelerityPhysicalResources $resources Resource map to find text 175 175 + * resources for. 176 176 + * @param CelerityResourceTransformer $xformer Configured resource 177 177 + * transformer. 175 178 * @return map<string, map<string, string>> Resource information map. 176 179 */ 177 180 private function rebuildTextResources( ··· 211 214 * Parse the `@provides` and `@requires` symbols out of a text resource, like 212 215 * JS or CSS. 213 216 * 214 214 - * @param string Resource name. 215 215 - * @param string Resource data. 217 217 + * @param string $name Resource name. 218 218 + * @param string $data Resource data. 216 219 * @return pair<string|null, list<string>|null> The `@provides` symbol and 217 220 * the list of `@requires` symbols. If the resource is not part of the 218 221 * dependency graph, both are null. ··· 254 257 * Check for dependency cycles in the resource graph. Raises an exception if 255 258 * a cycle is detected. 256 259 * 257 257 - * @param map<string, list<string>> Map of `@provides` symbols to their 258 258 - * `@requires` symbols. 260 260 + * @param map<string, list<string>> $nodes Map of `@provides` symbols to 261 261 + * their `@requires` symbols. 259 262 * @return void 260 263 */ 261 264 private function detectGraphCycles(array $nodes) { ··· 278 281 /** 279 282 * Build package specifications for a given resource source. 280 283 * 281 281 - * @param CelerityPhysicalResources Resource source to rebuild. 282 282 - * @param map<string, string> Map of `@provides` to hashes. 283 283 - * @param map<string, string> Map of hashes to resource names. 284 284 + * @param CelerityPhysicalResources $resources Resource source to rebuild. 285 285 + * @param map<string, string> $symbol_map Map of `@provides` to hashes. 286 286 + * @param map<string, string> $reverse_map Map of hashes to resource names. 284 287 * @return map<string, map<string, string>> Package information maps. 285 288 */ 286 289 private function rebuildPackages(

+2 -1

src/applications/celerity/CelerityResourceTransformer.php

reviewed

··· 228 228 * small enough. Otherwise, this method will return `null` and we'll end up 229 229 * using a normal URI instead. 230 230 * 231 231 - * @param string Resource name to attempt to generate a data URI for. 231 231 + * @param string $resource_name Resource name to attempt to generate a data 232 232 + * URI for. 232 233 * @return string|null Data URI, or null if we declined to generate one. 233 234 */ 234 235 private function generateDataURI($resource_name) {

+5 -3

src/applications/celerity/api.php

reviewed

··· 9 9 * 10 10 * For more information, see @{article:Adding New CSS and JS}. 11 11 * 12 12 - * @param string Name of the celerity module to include. This is whatever you 13 13 - * annotated as "@provides" in the file. 12 12 + * @param string $symbol Name of the celerity module to include. This is 13 13 + * whatever you annotated as "@provides" in the file. 14 14 + * @param string? $source_name 14 15 * @return void 15 16 */ 16 17 function require_celerity_resource($symbol, $source_name = 'phabricator') { ··· 40 41 /** 41 42 * Get the versioned URI for a raw resource, like an image. 42 43 * 43 43 - * @param string Path to the raw image. 44 44 + * @param string $resource Path to the raw image. 45 45 + * @param string? $source 44 46 * @return string Versioned path to the image, if one is available. 45 47 */ 46 48 function celerity_get_resource_uri($resource, $source = 'phabricator') {

+1 -1

src/applications/celerity/controller/CelerityResourceController.php

reviewed

··· 194 194 * are cached, while other types of resources (which are large, and cheap 195 195 * to process) are not. 196 196 * 197 197 - * @param string Resource type. 197 197 + * @param string $type Resource type. 198 198 * @return bool True to enable caching. 199 199 */ 200 200 private function isLocallyCacheableResourceType($type) {

+1 -1

src/applications/celerity/management/CelerityManagementMapWorkflow.php

reviewed

··· 32 32 /** 33 33 * Rebuild the resource map for a resource source. 34 34 * 35 35 - * @param CelerityPhysicalResources Resource source to rebuild. 35 35 + * @param $resources CelerityPhysicalResources Resource source to rebuild. 36 36 * @return void 37 37 */ 38 38 private function rebuildResources(CelerityPhysicalResources $resources) {

+3 -2

src/applications/conduit/controller/PhabricatorConduitAPIController.php

reviewed

··· 159 159 /** 160 160 * Authenticate the client making the request to a Phabricator user account. 161 161 * 162 162 - * @param ConduitAPIRequest Request being executed. 163 163 - * @param dict Request metadata. 162 162 + * @param ConduitAPIRequest $api_request Request being executed. 163 163 + * @param dict $metadata Request metadata. 164 164 + * @param wild $method 164 165 * @return null|pair Null to indicate successful authentication, or 165 166 * an error code and error message pair. 166 167 */

+1 -1

src/applications/conduit/protocol/exception/ConduitException.php

reviewed

··· 12 12 * will be used instead. This is useful to provide specific information about 13 13 * an exception (e.g., which values were wrong in an invalid request). 14 14 * 15 15 - * @param string Detailed error description. 15 15 + * @param string $error_description Detailed error description. 16 16 * @return this 17 17 */ 18 18 final public function setErrorDescription($error_description) {

+1 -1

src/applications/config/custom/PhabricatorCustomLogoConfigType.php

reviewed

··· 15 15 16 16 /** 17 17 * Return the full URI of the Phorge logo 18 18 - * @param PhabricatorUser Current viewer 18 18 + * @param PhabricatorUser $viewer Current viewer 19 19 * @return string Full URI of the Phorge logo 20 20 */ 21 21 public static function getLogoURI(PhabricatorUser $viewer) {

+2 -2

src/applications/config/issue/PhabricatorSetupIssue.php

reviewed

··· 145 145 * we alter `memory_limit` during startup, so if the original value is not 146 146 * provided it will look like it is always set to `-1`. 147 147 * 148 148 - * @param string PHP configuration option to provide a value for. 149 149 - * @param string Explicit value to show in the UI. 148 148 + * @param string $php_config PHP configuration option to provide a value for. 149 149 + * @param string $value Explicit value to show in the UI. 150 150 * @return this 151 151 */ 152 152 public function addPHPConfigOriginalValue($php_config, $value) {

+2 -1

src/applications/config/json/PhabricatorConfigJSON.php

reviewed

··· 4 4 /** 5 5 * Properly format a JSON value. 6 6 * 7 7 - * @param wild Any value, but should be a raw value, not a string of JSON. 7 7 + * @param wild $value Any value, but should be a raw value, not a string of 8 8 + * JSON. 8 9 * @return string 9 10 */ 10 11 public static function prettyPrintJSON($value) {

+2 -2

src/applications/config/option/PhabricatorApplicationConfigOptions.php

reviewed

··· 65 65 * or other context. For example, this is used to show workspace IDs when 66 66 * configuring `asana.workspace-id`. 67 67 * 68 68 - * @param PhabricatorConfigOption Option being rendered. 69 69 - * @param AphrontRequest Active request. 68 68 + * @param PhabricatorConfigOption $option Option being rendered. 69 69 + * @param AphrontRequest $request Active request. 70 70 * @return wild Additional contextual description 71 71 * information. 72 72 */

+1 -1

src/applications/dashboard/engine/PhabricatorDashboardPanelRenderingEngine.php

reviewed

··· 427 427 * panel. Generally, all of this stuff is ridiculous and we just want to 428 428 * shut it down. 429 429 * 430 430 - * @param PhabricatorDashboardPanel Panel being rendered. 430 430 + * @param PhabricatorDashboardPanel $panel Panel being rendered. 431 431 * @return void 432 432 */ 433 433 private function detectRenderingCycle(PhabricatorDashboardPanel $panel) {

+1 -1

src/applications/differential/constants/DifferentialReviewerStatus.php

reviewed

··· 19 19 * will attempt to update you to both "commented" and "accepted". We want 20 20 * "accepted" to win, because it's the stronger of the two. 21 21 * 22 22 - * @param const Reviewer status constant. 22 22 + * @param const $constant Reviewer status constant. 23 23 * @return int Relative strength (higher is stronger). 24 24 */ 25 25 public static function getStatusStrength($constant) {

+12 -11

src/applications/differential/parser/DifferentialChangesetParser.php

reviewed

··· 240 240 * the left and right halves of the displayed diff to be correctly mapped to 241 241 * storage changesets. 242 242 * 243 243 - * @param id The Differential Changeset ID that comments added to the right 244 244 - * side of the visible diff should be attached to. 245 245 - * @param bool If true, attach new comments to the right side of the storage 246 246 - * changeset. Note that this may be false, if the left side of 247 247 - * some storage changeset is being shown as the right side of 248 248 - * a display diff. 243 243 + * @param id $id The Differential Changeset ID that comments added to the 244 244 + * right side of the visible diff should be attached to. 245 245 + * @param bool $is_new If true, attach new comments to the right side of the 246 246 + * storage changeset. Note that this may be false, if the left 247 247 + * side of some storage changeset is being shown as the right 248 248 + * side of a display diff. 249 249 * @return this 250 250 */ 251 251 public function setRightSideCommentMapping($id, $is_new) { ··· 295 295 * By default, there is no render cache key and parsers do not use the cache. 296 296 * This is appropriate for rarely-viewed changesets. 297 297 * 298 298 - * @param string Key for identifying this changeset in the render cache. 298 298 + * @param string $key Key for identifying this changeset in the render 299 299 + * cache. 299 300 * @return this 300 301 */ 301 302 public function setRenderCacheKey($key) { ··· 1238 1239 * taking into consideration which halves of which changesets will actually 1239 1240 * be shown. 1240 1241 * 1241 1241 - * @param PhabricatorInlineComment Comment to test for visibility. 1242 1242 + * @param PhabricatorInlineComment $comment Comment to test for visibility. 1242 1243 * @return bool True if the comment is visible on the rendered diff. 1243 1244 */ 1244 1245 private function isCommentVisibleOnRenderedDiff( ··· 1266 1267 * Note that the comment must appear somewhere on the rendered changeset, as 1267 1268 * per isCommentVisibleOnRenderedDiff(). 1268 1269 * 1269 1269 - * @param PhabricatorInlineComment Comment to test for display 1270 1270 + * @param PhabricatorInlineComment $comment Comment to test for display 1270 1271 * location. 1271 1272 * @return bool True for right, false for left. 1272 1273 */ ··· 1298 1299 * list($start, $end, $mask) = $parsed; 1299 1300 * $parser->render($start, $end, $mask); 1300 1301 * 1301 1301 - * @param string Range specification, indicating the range of the diff that 1302 1302 - * should be rendered. 1302 1302 + * @param string $spec Range specification, indicating the range of the diff 1303 1303 + * that should be rendered. 1303 1304 * @return tuple List of <start, end, mask> suitable for passing to 1304 1305 * @{method:render}. 1305 1306 */

+2 -2

src/applications/differential/parser/DifferentialLineAdjustmentMap.php

reviewed

··· 58 58 /** 59 59 * Map a line across a change, or a series of changes. 60 60 * 61 61 - * @param int Line to map 62 62 - * @param bool True to map it as the end of a range. 61 61 + * @param int $line Line to map 62 62 + * @param bool $is_end True to map it as the end of a range. 63 63 * @return wild Spooky magic. 64 64 */ 65 65 public function mapLine($line, $is_end) {

+15 -15

src/applications/differential/query/DifferentialRevisionQuery.php

reviewed

··· 45 45 /** 46 46 * Find revisions affecting one or more items in a list of paths. 47 47 * 48 48 - * @param list<string> List of file paths. 48 48 + * @param list<string> $paths List of file paths. 49 49 * @return this 50 50 * @task config 51 51 */ ··· 59 59 * this function will clear anything set by previous calls to 60 60 * @{method:withAuthors}. 61 61 * 62 62 - * @param array List of PHIDs of authors 62 62 + * @param array $author_phids List of PHIDs of authors 63 63 * @return this 64 64 * @task config 65 65 */ ··· 72 72 * Filter results to revisions which CC one of the listed people. Calling this 73 73 * function will clear anything set by previous calls to @{method:withCCs}. 74 74 * 75 75 - * @param array List of PHIDs of subscribers. 75 75 + * @param array $cc_phids List of PHIDs of subscribers. 76 76 * @return this 77 77 * @task config 78 78 */ ··· 86 86 * reviewers. Calling this function will clear anything set by previous calls 87 87 * to @{method:withReviewers}. 88 88 * 89 89 - * @param array List of PHIDs of reviewers 89 89 + * @param array $reviewer_phids List of PHIDs of reviewers 90 90 * @return this 91 91 * @task config 92 92 */ ··· 124 124 * Calling this function will clear anything set by previous calls to 125 125 * @{method:withCommitHashes}. 126 126 * 127 127 - * @param array List of pairs <Class 127 127 + * @param array $commit_hashes List of pairs <Class 128 128 * ArcanistDifferentialRevisionHash::HASH_$type constant, 129 129 * hash> 130 130 * @return this ··· 149 149 /** 150 150 * Filter results to revisions on given branches. 151 151 * 152 152 - * @param list List of branch names. 152 152 + * @param list $branches List of branch names. 153 153 * @return this 154 154 * @task config 155 155 */ ··· 162 162 /** 163 163 * Filter results to only return revisions whose ids are in the given set. 164 164 * 165 165 - * @param array List of revision ids 165 165 + * @param array $ids List of revision ids 166 166 * @return this 167 167 * @task config 168 168 */ ··· 175 175 /** 176 176 * Filter results to only return revisions whose PHIDs are in the given set. 177 177 * 178 178 - * @param array List of revision PHIDs 178 178 + * @param array $phids List of revision PHIDs 179 179 * @return this 180 180 * @task config 181 181 */ ··· 189 189 * Given a set of users, filter results to return only revisions they are 190 190 * responsible for (i.e., they are either authors or reviewers). 191 191 * 192 192 - * @param array List of user PHIDs. 192 192 + * @param array $responsible_phids List of user PHIDs. 193 193 * @return this 194 194 * @task config 195 195 */ ··· 221 221 * Set whether or not the query should load the active diff for each 222 222 * revision. 223 223 * 224 224 - * @param bool True to load and attach diffs. 224 224 + * @param bool $need_active_diffs True to load and attach diffs. 225 225 * @return this 226 226 * @task config 227 227 */ ··· 235 235 * Set whether or not the query should load the associated commit PHIDs for 236 236 * each revision. 237 237 * 238 238 - * @param bool True to load and attach diffs. 238 238 + * @param bool $need_commit_phids True to load and attach diffs. 239 239 * @return this 240 240 * @task config 241 241 */ ··· 249 249 * Set whether or not the query should load associated diff IDs for each 250 250 * revision. 251 251 * 252 252 - * @param bool True to load and attach diff IDs. 252 252 + * @param bool $need_diff_ids True to load and attach diff IDs. 253 253 * @return this 254 254 * @task config 255 255 */ ··· 263 263 * Set whether or not the query should load associated commit hashes for each 264 264 * revision. 265 265 * 266 266 - * @param bool True to load and attach commit hashes. 266 266 + * @param bool $need_hashes True to load and attach commit hashes. 267 267 * @return this 268 268 * @task config 269 269 */ ··· 276 276 /** 277 277 * Set whether or not the query should load associated reviewers. 278 278 * 279 279 - * @param bool True to load and attach reviewers. 279 279 + * @param bool $need_reviewers True to load and attach reviewers. 280 280 * @return this 281 281 * @task config 282 282 */ ··· 291 291 * reviewer. In particular, they have authority to act on behalf of projects 292 292 * they are a member of. 293 293 * 294 294 - * @param bool True to load and attach authority. 294 294 + * @param bool $need_reviewer_authority True to load and attach authority. 295 295 * @return this 296 296 * @task config 297 297 */

+7 -6

src/applications/differential/render/DifferentialChangesetHTMLRenderer.php

reviewed

··· 491 491 /** 492 492 * Build links which users can click to show more context in a changeset. 493 493 * 494 494 - * @param int Beginning of the line range to build links for. 495 495 - * @param int Length of the line range to build links for. 496 496 - * @param int Total number of lines in the changeset. 494 494 + * @param int $top Beginning of the line range to build links for. 495 495 + * @param int $len Length of the line range to build links for. 496 496 + * @param int $changeset_length Total number of lines in the changeset. 497 497 + * @param bool? $is_blocks 497 498 * @return markup Rendered links. 498 499 */ 499 500 protected function renderShowContextLinks( ··· 580 581 * 581 582 * See @{method:renderShowContextLinks}. 582 583 * 583 583 - * @param bool Does this link show all context when clicked? 584 584 - * @param string Range specification for lines to show. 585 585 - * @param string Text of the link. 584 584 + * @param bool $is_all Does this link show all context when clicked? 585 585 + * @param string $range Range specification for lines to show. 586 586 + * @param string $text Text of the link. 586 587 * @return markup Rendered link. 587 588 */ 588 589 private function renderShowContextLink($is_all, $range, $text) {

+2 -2

src/applications/differential/render/DifferentialChangesetRenderer.php

reviewed

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

+1 -1

src/applications/differential/storage/DifferentialChangeset.php

reviewed

··· 213 213 * Test if this changeset and some other changeset put the affected file in 214 214 * the same state. 215 215 * 216 216 - * @param DifferentialChangeset Changeset to compare against. 216 216 + * @param DifferentialChangeset $other Changeset to compare against. 217 217 * @return bool True if the two changesets have the same effect. 218 218 */ 219 219 public function hasSameEffectAs(DifferentialChangeset $other) {

+1 -1

src/applications/diffusion/data/DiffusionBrowseResultSet.php

reviewed

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

+3 -2

src/applications/diffusion/data/DiffusionGitBranch.php

reviewed

··· 19 19 * 'master' => '99a9c082f9a1b68c7264e26b9e552484a5ae5f25', 20 20 * ); 21 21 * 22 22 - * @param string stdout of git branch command. 23 23 - * @param string Filter branches to those on a specific remote. 22 22 + * @param string $stdout stdout of git branch command. 23 23 + * @param string? $only_this_remote Filter branches to those on a specific 24 24 + * remote. 24 25 * @return map Map of 'branch' or 'remote/branch' to hash at HEAD. 25 26 */ 26 27 public static function parseRemoteBranchOutput(

+1 -1

src/applications/diffusion/protocol/DiffusionMercurialCommandEngine.php

reviewed

··· 58 58 * Sanitize output of an `hg` command invoked with the `--debug` flag to make 59 59 * it usable. 60 60 * 61 61 - * @param string Output from `hg --debug ...` 61 61 + * @param string $stdout Output from `hg --debug ...` 62 62 * @return string Usable output. 63 63 */ 64 64 public static function filterMercurialDebugOutput($stdout) {

+3 -3

src/applications/diffusion/query/pathid/DiffusionPathIDQuery.php

reviewed

··· 42 42 /** 43 43 * Convert a path to the canonical, absolute representation used by Diffusion. 44 44 * 45 45 - * @param string Some repository path. 45 45 + * @param string $path Some repository path. 46 46 * @return string Canonicalized Diffusion path. 47 47 * @task pathutil 48 48 */ ··· 62 62 * Return the canonical parent directory for a path. Note, returns "/" when 63 63 * passed "/". 64 64 * 65 65 - * @param string Some repository path. 65 65 + * @param string $path Some repository path. 66 66 * @return string That path's canonical parent directory. 67 67 * @task pathutil 68 68 */ ··· 80 80 * Generate a list of parents for a repository path. The path itself is 81 81 * included. 82 82 * 83 83 - * @param string Some repository path. 83 83 + * @param string $path Some repository path. 84 84 * @return list List of canonical paths between the path and the root. 85 85 * @task pathutil 86 86 */

+10 -9

src/applications/diffusion/request/DiffusionRequest.php

reviewed

··· 56 56 * - `commit` Optional, commit identifier. 57 57 * - `line` Optional, line range. 58 58 * 59 59 - * @param map See documentation. 59 59 + * @param map $data See documentation. 60 60 * @return DiffusionRequest New request object. 61 61 * @task new 62 62 */ ··· 133 133 /** 134 134 * Internal. Use @{method:newFromDictionary}, not this method. 135 135 * 136 136 - * @param string Repository identifier. 137 137 - * @param PhabricatorUser Viewing user. 136 136 + * @param string $identifier Repository identifier. 137 137 + * @param PhabricatorUser $viewer Viewing user. 138 138 + * @param bool? $need_edit 138 139 * @return DiffusionRequest New request object. 139 140 * @task new 140 141 */ ··· 170 171 /** 171 172 * Internal. Use @{method:newFromDictionary}, not this method. 172 173 * 173 173 - * @param PhabricatorRepository Repository object. 174 174 + * @param PhabricatorRepository $repository Repository object. 174 175 * @return DiffusionRequest New request object. 175 176 * @task new 176 177 */ ··· 201 202 /** 202 203 * Internal. Use @{method:newFromDictionary}, not this method. 203 204 * 204 204 - * @param map Map of parsed data. 205 205 + * @param map $data Map of parsed data. 205 206 * @return void 206 207 * @task new 207 208 */ ··· 294 295 /** 295 296 * Modify the request to move the symbolic commit elsewhere. 296 297 * 297 297 - * @param string New symbolic commit. 298 298 + * @param string $symbol New symbolic commit. 298 299 * @return this 299 300 */ 300 301 public function updateSymbolicCommit($symbol) { ··· 464 465 * 465 466 * Parse the request URI into components. 466 467 * 467 467 - * @param string URI blob. 468 468 - * @param bool True if this VCS supports branches. 468 468 + * @param string $blob URI blob. 469 469 + * @param bool $supports_branches True if this VCS supports branches. 469 470 * @return map Parsed URI. 470 471 * 471 472 * @task uri ··· 535 536 /** 536 537 * Check that the working copy of the repository is present and readable. 537 538 * 538 538 - * @param string Path to the working copy. 539 539 + * @param string $path Path to the working copy. 539 540 */ 540 541 protected function validateWorkingCopy($path) { 541 542 if (!is_readable(dirname($path))) {

+1 -1

src/applications/diffusion/view/DiffusionReadmeView.php

reviewed

··· 26 26 /** 27 27 * Get the markup language a README should be interpreted as. 28 28 * 29 29 - * @param string Local README path, like "README.txt". 29 29 + * @param string $path Local README path, like "README.txt". 30 30 * @return string Best markup interpreter (like "remarkup") for this file. 31 31 */ 32 32 private function getReadmeLanguage($path) {

+11 -7

src/applications/diviner/query/DivinerAtomQuery.php

reviewed

··· 93 93 * have been generated incorrectly by accident. In these cases, we can 94 94 * restore the original data. 95 95 * 96 96 - * @param bool 96 96 + * @param bool $ghosts 97 97 * @return this 98 98 */ 99 99 public function withGhosts($ghosts) { ··· 437 437 * children. When recursing, also walk up the tree and collect children of 438 438 * atoms they extend. 439 439 * 440 440 - * @param list<DivinerLiveSymbol> List of symbols to collect child hashes of. 441 441 - * @param bool True to collect children of extended atoms, 442 442 - * as well. 440 440 + * @param list<DivinerLiveSymbol> $symbols List of symbols to collect child 441 441 + * hashes of. 442 442 + * @param bool $recurse_up True to collect children of 443 443 + * extended atoms, as well. 443 444 * @return map<string, string> Hashes of atoms' children. 444 445 */ 445 446 private function getAllChildHashes(array $symbols, $recurse_up) { ··· 469 470 * Attach child atoms to existing atoms. In recursive mode, also attach child 470 471 * atoms to atoms that these atoms extend. 471 472 * 472 472 - * @param list<DivinerLiveSymbol> List of symbols to attach children to. 473 473 - * @param map<string, DivinerLiveSymbol> Map of symbols, keyed by node hash. 474 474 - * @param bool True to attach children to extended atoms, as well. 473 473 + * @param list<DivinerLiveSymbol> $symbols List of symbols to attach children 474 474 + * to. 475 475 + * @param map<string, DivinerLiveSymbol> $children Map of symbols, keyed by 476 476 + * node hash. 477 477 + * @param bool $recurse_up True to attach children to extended atoms, as 478 478 + * well. 475 479 * @return void 476 480 */ 477 481 private function attachAllChildren(

+2 -1

src/applications/doorkeeper/engine/DoorkeeperFeedStoryPublisher.php

reviewed

··· 31 31 * JIRA issues which can have several linked revisions), it's generally 32 32 * more useful not to assume context. 33 33 * 34 34 - * @param bool True to assume object context when rendering. 34 34 + * @param bool $render_with_implied_context True to assume object context 35 35 + * when rendering. 35 36 * @return this 36 37 * @task config 37 38 */

+35 -33

src/applications/drydock/blueprint/DrydockBlueprintImplementation.php

reviewed

··· 63 63 * This method should not acquire locks or expect anything to be locked. This 64 64 * is a coarse compatibility check between a lease and a resource. 65 65 * 66 66 - * @param DrydockBlueprint Concrete blueprint to allocate for. 67 67 - * @param DrydockResource Candidate resource to allocate the lease on. 68 68 - * @param DrydockLease Pending lease that wants to allocate here. 66 66 + * @param DrydockBlueprint $blueprint Concrete blueprint to allocate for. 67 67 + * @param DrydockResource $resource Candidate resource to allocate the lease 68 68 + * on. 69 69 + * @param DrydockLease $lease Pending lease that wants to allocate here. 69 70 * @return bool True if the resource and lease are compatible. 70 71 * @task lease 71 72 */ ··· 81 82 * 82 83 * If acquisition fails, throw an exception. 83 84 * 84 84 - * @param DrydockBlueprint Blueprint which built the resource. 85 85 - * @param DrydockResource Resource to acquire a lease on. 86 86 - * @param DrydockLease Requested lease. 85 85 + * @param DrydockBlueprint $blueprint Blueprint which built the resource. 86 86 + * @param DrydockResource $resource Resource to acquire a lease on. 87 87 + * @param DrydockLease $lease Requested lease. 87 88 * @return void 88 89 * @task lease 89 90 */ ··· 111 112 * This callback is primarily useful for automatically releasing resources 112 113 * once all leases are released. 113 114 * 114 114 - * @param DrydockBlueprint Blueprint which built the resource. 115 115 - * @param DrydockResource Resource a lease was released on. 116 116 - * @param DrydockLease Recently released lease. 115 115 + * @param DrydockBlueprint $blueprint Blueprint which built the resource. 116 116 + * @param DrydockResource $resource Resource a lease was released on. 117 117 + * @param DrydockLease $lease Recently released lease. 117 118 * @return void 118 119 * @task lease 119 120 */ ··· 128 129 * 129 130 * If a lease creates temporary state while held, destroy it here. 130 131 * 131 131 - * @param DrydockBlueprint Blueprint which built the resource. 132 132 - * @param DrydockResource Resource the lease is acquired on. 133 133 - * @param DrydockLease The lease being destroyed. 132 132 + * @param DrydockBlueprint $blueprint Blueprint which built the resource. 133 133 + * @param DrydockResource $resource Resource the lease is acquired on. 134 134 + * @param DrydockLease $lease The lease being destroyed. 134 135 * @return void 135 136 * @task lease 136 137 */ ··· 156 157 * has a flexible pool of expensive resources and you want to pack leases 157 158 * onto them as tightly as possible. 158 159 * 159 159 - * @param DrydockBlueprint The blueprint for an existing resource being 160 160 - * acquired. 161 161 - * @param DrydockResource The resource being acquired, which we may want to 162 162 - * build a supplemental resource for. 163 163 - * @param DrydockLease The current lease performing acquisition. 160 160 + * @param DrydockBlueprint $blueprint The blueprint for an existing resource 161 161 + * being acquired. 162 162 + * @param DrydockResource $resource The resource being acquired, which we may 163 163 + * want to build a supplemental resource for. 164 164 + * @param DrydockLease $lease The current lease performing acquisition. 164 165 * @return bool True to prefer allocating a supplemental resource. 165 166 * 166 167 * @task lease ··· 190 191 * really exists, only if some blueprint may conceivably exist which could 191 192 * plausibly be able to build a suitable resource. 192 193 * 193 193 - * @param DrydockLease Requested lease. 194 194 + * @param DrydockLease $lease Requested lease. 194 195 * @return bool True if some concrete blueprint of this implementation's 195 196 * type might ever be able to build a resource for the lease. 196 197 * @task resource ··· 211 212 * if the blueprint as configured may, at some time, be able to build a 212 213 * suitable resource. 213 214 * 214 214 - * @param DrydockBlueprint Blueprint which may be asked to allocate a 215 215 - * resource. 216 216 - * @param DrydockLease Requested lease. 215 215 + * @param DrydockBlueprint $blueprint Blueprint which may be asked to 216 216 + * allocate a resource. 217 217 + * @param DrydockLease $lease Requested lease. 217 218 * @return bool True if this blueprint can eventually build a suitable 218 219 * resource for the lease, as currently configured. 219 220 * @task resource ··· 240 241 * eaten up free capacity by the time it actually tries to build a resource. 241 242 * This is normal and the allocator will recover from it. 242 243 * 243 243 - * @param DrydockBlueprint The blueprint which may be asked to allocate a 244 244 - * resource. 245 245 - * @param DrydockLease Requested lease. 244 244 + * @param DrydockBlueprint $blueprint The blueprint which may be asked to 245 245 + * allocate a resource. 246 246 + * @param DrydockLease $lease Requested lease. 246 247 * @return bool True if this blueprint appears likely to be able to allocate 247 248 * a suitable resource. 248 249 * @task resource ··· 260 261 * called. Blueprints are entirely responsible for any lock handling they 261 262 * need to perform. 262 263 * 263 263 - * @param DrydockBlueprint The blueprint which should allocate a resource. 264 264 - * @param DrydockLease Requested lease. 264 264 + * @param DrydockBlueprint $blueprint The blueprint which should allocate a 265 265 + * resource. 266 266 + * @param DrydockLease $lease Requested lease. 265 267 * @return DrydockResource Allocated resource. 266 268 * @task resource 267 269 */ ··· 287 289 * here. For example, you might shut down a virtual host or destroy a working 288 290 * copy on disk. 289 291 * 290 290 - * @param DrydockBlueprint Blueprint which built the resource. 291 291 - * @param DrydockResource Resource being destroyed. 292 292 + * @param DrydockBlueprint $blueprint Blueprint which built the resource. 293 293 + * @param DrydockResource $resource Resource being destroyed. 292 294 * @return void 293 295 * @task resource 294 296 */ ··· 300 302 /** 301 303 * Get a human readable name for a resource. 302 304 * 303 303 - * @param DrydockBlueprint Blueprint which built the resource. 304 304 - * @param DrydockResource Resource to get the name of. 305 305 + * @param DrydockBlueprint $blueprint Blueprint which built the resource. 306 306 + * @param DrydockResource $resource Resource to get the name of. 305 307 * @return string Human-readable resource name. 306 308 * @task resource 307 309 */ ··· 338 340 * build a resource which can satisfy the lease. They may not be able to 339 341 * build that resource right now. 340 342 * 341 341 - * @param DrydockLease Requested lease. 343 343 + * @param DrydockLease $lease Requested lease. 342 344 * @return list<DrydockBlueprintImplementation> List of qualifying blueprint 343 345 * implementations. 344 346 */ ··· 429 431 /** 430 432 * Get the effective concurrent resource limit for this blueprint. 431 433 * 432 432 - * @param DrydockBlueprint Blueprint to get the limit for. 434 434 + * @param DrydockBlueprint $blueprint Blueprint to get the limit for. 433 435 * @return int|null Limit, or `null` for no limit. 434 436 */ 435 437 protected function getConcurrentResourceLimit(DrydockBlueprint $blueprint) { ··· 500 502 /** 501 503 * Apply standard limits on resource allocation rate. 502 504 * 503 503 - * @param DrydockBlueprint The blueprint requesting an allocation. 505 505 + * @param DrydockBlueprint $blueprint The blueprint requesting an allocation. 504 506 * @return bool True if further allocations should be limited. 505 507 */ 506 508 protected function shouldLimitAllocatingPoolSize(

+4 -4

src/applications/drydock/storage/DrydockAuthorization.php

reviewed

··· 103 103 * Apply external authorization effects after a user changes the value of a 104 104 * blueprint selector control an object. 105 105 * 106 106 - * @param PhabricatorUser User applying the change. 107 107 - * @param phid Object PHID change is being applied to. 108 108 - * @param list<phid> Old blueprint PHIDs. 109 109 - * @param list<phid> New blueprint PHIDs. 106 106 + * @param PhabricatorUser $viewer User applying the change. 107 107 + * @param phid $object_phid Object PHID change is being applied to. 108 108 + * @param list<phid> $old Old blueprint PHIDs. 109 109 + * @param list<phid> $new New blueprint PHIDs. 110 110 * @return void 111 111 */ 112 112 public static function applyAuthorizationChanges(

+7 -7

src/applications/drydock/storage/DrydockSlotLock.php

reviewed

··· 43 43 /** 44 44 * Load all locks held by a particular owner. 45 45 * 46 46 - * @param phid Owner PHID. 46 46 + * @param phid $owner_phid Owner PHID. 47 47 * @return list<DrydockSlotLock> All held locks. 48 48 * @task info 49 49 */ ··· 57 57 /** 58 58 * Test if a lock is currently free. 59 59 * 60 60 - * @param string Lock key to test. 60 60 + * @param string $lock Lock key to test. 61 61 * @return bool True if the lock is currently free. 62 62 * @task info 63 63 */ ··· 69 69 /** 70 70 * Test if a list of locks are all currently free. 71 71 * 72 72 - * @param list<string> List of lock keys to test. 72 72 + * @param list<string> $locks List of lock keys to test. 73 73 * @return bool True if all locks are currently free. 74 74 * @task info 75 75 */ ··· 82 82 /** 83 83 * Load named locks. 84 84 * 85 85 - * @param list<string> List of lock keys to load. 85 85 + * @param list<string> $locks List of lock keys to load. 86 86 * @return list<DrydockSlotLock> List of held locks. 87 87 * @task info 88 88 */ ··· 114 114 * This method either acquires all the locks or throws an exception (usually 115 115 * because one or more locks are held). 116 116 * 117 117 - * @param phid Lock owner PHID. 118 118 - * @param list<string> List of locks to acquire. 117 117 + * @param phid $owner_phid Lock owner PHID. 118 118 + * @param list<string> $locks List of locks to acquire. 119 119 * @return void 120 120 * @task locks 121 121 */ ··· 158 158 /** 159 159 * Release all locks held by an owner. 160 160 * 161 161 - * @param phid Lock owner PHID. 161 161 + * @param phid $owner_phid Lock owner PHID. 162 162 * @return void 163 163 * @task locks 164 164 */

+26 -24

src/applications/drydock/worker/DrydockLeaseUpdateWorker.php

reviewed

··· 168 168 * Find or build a resource which can satisfy a given lease request, then 169 169 * acquire the lease. 170 170 * 171 171 - * @param DrydockLease Requested lease. 171 171 + * @param DrydockLease $lease Requested lease. 172 172 * @return void 173 173 * @task allocator 174 174 */ ··· 573 573 * Get all the concrete @{class:DrydockBlueprint}s which can possibly 574 574 * build a resource to satisfy a lease. 575 575 * 576 576 - * @param DrydockLease Requested lease. 576 576 + * @param DrydockLease $lease Requested lease. 577 577 * @return list<DrydockBlueprint> List of qualifying blueprints. 578 578 * @task allocator 579 579 */ ··· 645 645 * Load a list of all resources which a given lease can possibly be 646 646 * allocated against. 647 647 * 648 648 - * @param list<DrydockBlueprint> Blueprints which may produce suitable 649 649 - * resources. 650 650 - * @param DrydockLease Requested lease. 648 648 + * @param list<DrydockBlueprint> $blueprints Blueprints which may produce 649 649 + * suitable resources. 650 650 + * @param DrydockLease $lease Requested lease. 651 651 * @return list<DrydockResource> Resources which may be able to allocate 652 652 * the lease. 653 653 * @task allocator ··· 675 675 /** 676 676 * Remove resources which can not be acquired by a given lease from a list. 677 677 * 678 678 - * @param list<DrydockResource> Candidate resources. 679 679 - * @param DrydockLease Acquiring lease. 678 678 + * @param list<DrydockResource> $resources Candidate resources. 679 679 + * @param DrydockLease $lease Acquiring lease. 680 680 * @return list<DrydockResource> Resources which the lease may be able to 681 681 * acquire. 682 682 * @task allocator ··· 703 703 * Remove blueprints which are too heavily allocated to build a resource for 704 704 * a lease from a list of blueprints. 705 705 * 706 706 - * @param list<DrydockBlueprint> List of blueprints. 707 707 - * @return list<DrydockBlueprint> List with blueprints that can not allocate 708 708 - * a resource for the lease right now removed. 706 706 + * @param list<DrydockBlueprint> $blueprints List of blueprints. 707 707 + * @return list<DrydockBlueprint> $lease List with blueprints that can not 708 708 + * allocate a resource for the lease right now removed. 709 709 * @task allocator 710 710 */ 711 711 private function removeOverallocatedBlueprints( ··· 731 731 * Rank blueprints by suitability for building a new resource for a 732 732 * particular lease. 733 733 * 734 734 - * @param list<DrydockBlueprint> List of blueprints. 735 735 - * @param DrydockLease Requested lease. 734 734 + * @param list<DrydockBlueprint> $blueprints List of blueprints. 735 735 + * @param DrydockLease $lease Requested lease. 736 736 * @return list<DrydockBlueprint> Ranked list of blueprints. 737 737 * @task allocator 738 738 */ ··· 750 750 /** 751 751 * Rank resources by suitability for allocating a particular lease. 752 752 * 753 753 - * @param list<DrydockResource> List of resources. 754 754 - * @param DrydockLease Requested lease. 753 753 + * @param list<DrydockResource> $resources List of resources. 754 754 + * @param DrydockLease $lease Requested lease. 755 755 * @return list<DrydockResource> Ranked list of resources. 756 756 * @task allocator 757 757 */ ··· 769 769 /** 770 770 * Perform an actual resource allocation with a particular blueprint. 771 771 * 772 772 - * @param DrydockBlueprint The blueprint to allocate a resource from. 773 773 - * @param DrydockLease Requested lease. 772 772 + * @param DrydockBlueprint $blueprint The blueprint to allocate a resource 773 773 + * from. 774 774 + * @param DrydockLease $lease Requested lease. 774 775 * @return DrydockResource Allocated resource. 775 776 * @task allocator 776 777 */ ··· 815 816 * Check that the resource a blueprint allocated is roughly the sort of 816 817 * object we expect. 817 818 * 818 818 - * @param DrydockBlueprint Blueprint which built the resource. 819 819 - * @param wild Thing which the blueprint claims is a valid resource. 820 820 - * @param DrydockLease Lease the resource was allocated for. 819 819 + * @param DrydockBlueprint $blueprint Blueprint which built the resource. 820 820 + * @param wild $resource Thing which the blueprint claims is a valid 821 821 + * resource. 822 822 + * @param DrydockLease $lease Lease the resource was allocated for. 821 823 * @return void 822 824 * @task allocator 823 825 */ ··· 899 901 /** 900 902 * Perform an actual lease acquisition on a particular resource. 901 903 * 902 902 - * @param DrydockResource Resource to acquire a lease on. 903 903 - * @param DrydockLease Lease to acquire. 904 904 + * @param DrydockResource $resource Resource to acquire a lease on. 905 905 + * @param DrydockLease $lease Lease to acquire. 904 906 * @return void 905 907 * @task acquire 906 908 */ ··· 931 933 /** 932 934 * Make sure that a lease was really acquired properly. 933 935 * 934 934 - * @param DrydockBlueprint Blueprint which created the resource. 935 935 - * @param DrydockResource Resource which was acquired. 936 936 - * @param DrydockLease The lease which was supposedly acquired. 936 936 + * @param DrydockBlueprint $blueprint Blueprint which created the resource. 937 937 + * @param DrydockResource $resource Resource which was acquired. 938 938 + * @param DrydockLease $lease The lease which was supposedly acquired. 937 939 * @return void 938 940 * @task acquire 939 941 */

+4 -4

src/applications/drydock/worker/DrydockResourceUpdateWorker.php

reviewed

··· 38 38 /** 39 39 * Update a resource, handling exceptions thrown during the update. 40 40 * 41 41 - * @param DrydockReosource Resource to update. 41 41 + * @param DrydockResource $resource Resource to update. 42 42 * @return void 43 43 * @task update 44 44 */ ··· 58 58 /** 59 59 * Update a resource. 60 60 * 61 61 - * @param DrydockResource Resource to update. 61 61 + * @param DrydockResource $resource Resource to update. 62 62 * @return void 63 63 * @task update 64 64 */ ··· 89 89 /** 90 90 * Convert a temporary exception into a yield. 91 91 * 92 92 - * @param DrydockResource Resource to yield. 93 93 - * @param Exception Temporary exception worker encountered. 92 92 + * @param DrydockResource $resource Resource to yield. 93 93 + * @param Exception $ex Temporary exception worker encountered. 94 94 * @task update 95 95 */ 96 96 private function yieldResource(DrydockResource $resource, Exception $ex) {

+1 -1

src/applications/feed/PhabricatorFeedStoryPublisher.php

reviewed

··· 214 214 /** 215 215 * Remove PHIDs who should not receive notifications from a subscriber list. 216 216 * 217 217 - * @param list<phid> List of potential subscribers. 217 217 + * @param list<phid> $phids List of potential subscribers. 218 218 * @return list<phid> List of actual subscribers. 219 219 */ 220 220 private function filterSubscribedPHIDs(array $phids) {

+3 -2

src/applications/feed/story/PhabricatorFeedStory.php

reviewed

··· 32 32 * construct appropriate @{class:PhabricatorFeedStory} wrappers for each 33 33 * data row. 34 34 * 35 35 - * @param list<dict> List of @{class:PhabricatorFeedStoryData} rows from the 36 36 - * database. 35 35 + * @param list<dict> $rows List of @{class:PhabricatorFeedStoryData} rows 36 36 + * from the database. 37 37 + * @param PhabricatorUser $viewer 37 38 * @return list<PhabricatorFeedStory> List of @{class:PhabricatorFeedStory} 38 39 * objects. 39 40 * @task load

+5 -5

src/applications/files/PhabricatorImageTransformer.php

reviewed

··· 20 20 * Phabricator can not encode images in the given format (based on available 21 21 * extensions), but can save images in another format. 22 22 * 23 23 - * @param resource GD image resource. 24 24 - * @param string? Optionally, preferred mime type. 23 23 + * @param resource $data GD image resource. 24 24 + * @param string? $preferred_mime Optionally, preferred mime type. 25 25 * @return string Bytes of an image file. 26 26 * @task save 27 27 */ ··· 62 62 /** 63 63 * Save an image in PNG format, returning the file data as a string. 64 64 * 65 65 - * @param resource GD image resource. 65 65 + * @param resource $image GD image resource. 66 66 * @return string|null PNG file as a string, or null on failure. 67 67 * @task save 68 68 */ ··· 90 90 /** 91 91 * Save an image in GIF format, returning the file data as a string. 92 92 * 93 93 - * @param resource GD image resource. 93 93 + * @param resource $image GD image resource. 94 94 * @return string|null GIF file as a string, or null on failure. 95 95 * @task save 96 96 */ ··· 114 114 /** 115 115 * Save an image in JPG format, returning the file data as a string. 116 116 * 117 117 - * @param resource GD image resource. 117 117 + * @param resource $image GD image resource. 118 118 * @return string|null JPG file as a string, or null on failure. 119 119 * @task save 120 120 */

+2 -2

src/applications/files/engine/PhabricatorChunkedFileStorageEngine.php

reviewed

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

+7 -7

src/applications/files/engine/PhabricatorFileStorageEngine.php

reviewed

··· 160 160 * throw an exception. If there are other satisfactory but less-preferred 161 161 * storage engines available, they will be tried. 162 162 * 163 163 - * @param string The file data to write. 164 164 - * @param array File metadata (name, author), if available. 163 163 + * @param string $data The file data to write. 164 164 + * @param array $params File metadata (name, author), if available. 165 165 * @return string Unique string which identifies the stored file, max length 166 166 * 255. 167 167 * @task file ··· 172 172 /** 173 173 * Read the contents of a file previously written by @{method:writeFile}. 174 174 * 175 175 - * @param string The handle returned from @{method:writeFile} when the 176 176 - * file was written. 175 175 + * @param string $handle The handle returned from @{method:writeFile} 176 176 + * when the file was written. 177 177 * @return string File contents. 178 178 * @task file 179 179 */ ··· 183 183 /** 184 184 * Delete the data for a file previously written by @{method:writeFile}. 185 185 * 186 186 - * @param string The handle returned from @{method:writeFile} when the 187 187 - * file was written. 186 186 + * @param string $handle The handle returned from @{method:writeFile} 187 187 + * when the file was written. 188 188 * @return void 189 189 * @task file 190 190 */ ··· 200 200 * select the MySQL and Local Disk storage engines if they are configured 201 201 * to allow a given file. 202 202 * 203 203 - * @param int File size in bytes. 203 203 + * @param int $length File size in bytes. 204 204 * @task load 205 205 */ 206 206 public static function loadStorageEngines($length) {

+1 -1

src/applications/files/engine/PhabricatorLocalDiskFileStorageEngine.php

reviewed

··· 116 116 /** 117 117 * Convert a handle into an absolute local disk path. 118 118 * 119 119 - * @param string File data handle. 119 119 + * @param string $handle File data handle. 120 120 * @return string Absolute path to the corresponding file. 121 121 * @task internal 122 122 */

+1 -1

src/applications/files/engine/PhabricatorMySQLFileStorageEngine.php

reviewed

··· 80 80 /** 81 81 * Load the Lisk object that stores the file data for a handle. 82 82 * 83 83 - * @param string File data handle. 83 83 + * @param string $handle File data handle. 84 84 * @return PhabricatorFileStorageBlob Data DAO. 85 85 * @task internal 86 86 */

+2 -1

src/applications/files/query/PhabricatorFileQuery.php

reviewed

··· 96 96 * `PHID-FILE-aaaa` and all transformations of the file with PHID 97 97 * `PHID-FILE-bbbb`. 98 98 * 99 99 - * @param list<dict> List of transform specifications, described above. 99 99 + * @param list<dict> $specs List of transform specifications, described 100 100 + * above. 100 101 * @return this 101 102 */ 102 103 public function withTransforms(array $specs) {

+12 -11

src/applications/files/storage/PhabricatorFile.php

reviewed

··· 807 807 /** 808 808 * Return an iterable which emits file content bytes. 809 809 * 810 810 - * @param int Offset for the start of data. 811 811 - * @param int Offset for the end of data. 810 810 + * @param int? $begin Offset for the start of data. 811 811 + * @param int? $end Offset for the end of data. 812 812 * @return Iterable Iterable object which emits requested data. 813 813 */ 814 814 public function getFileDataIterator($begin = null, $end = null) { ··· 1214 1214 * Builtins are located in `resources/builtin/` and identified by their 1215 1215 * name. 1216 1216 * 1217 1217 - * @param PhabricatorUser Viewing user. 1218 1218 - * @param list<PhabricatorFilesBuiltinFile> List of builtin file specs. 1217 1217 + * @param PhabricatorUser $user Viewing user. 1218 1218 + * @param list<PhabricatorFilesBuiltinFile> $builtins List of builtin file 1219 1219 + * specs. 1219 1220 * @return dict<string, PhabricatorFile> Dictionary of named builtins. 1220 1221 */ 1221 1222 public static function loadBuiltins(PhabricatorUser $user, array $builtins) { ··· 1281 1282 /** 1282 1283 * Convenience wrapper for @{method:loadBuiltins}. 1283 1284 * 1284 1284 - * @param PhabricatorUser Viewing user. 1285 1285 - * @param string Single builtin name to load. 1285 1285 + * @param PhabricatorUser $user Viewing user. 1286 1286 + * @param string $name Single builtin name to load. 1286 1287 * @return PhabricatorFile Corresponding builtin file. 1287 1288 */ 1288 1289 public static function loadBuiltin(PhabricatorUser $user, $name) { ··· 1473 1474 * Write the policy edge between this file and some object. 1474 1475 * This method is successful even if the file is already attached. 1475 1476 * 1476 1476 - * @param phid Object PHID to attach to. 1477 1477 + * @param phid $phid Object PHID to attach to. 1477 1478 * @return this 1478 1479 */ 1479 1480 public function attachToObject($phid) { ··· 1487 1488 * NOTE: Please avoid to use this static method directly. 1488 1489 * Instead, use PhabricatorFile#attachToObject(phid). 1489 1490 * 1490 1490 - * @param phid File PHID to attach from. 1491 1491 - * @param phid Object PHID to attach to. 1491 1491 + * @param phid $file_phid File PHID to attach from. 1492 1492 + * @param phid $object_phid Object PHID to attach to. 1492 1493 * @return void 1493 1494 */ 1494 1495 public static function attachFileToObject($file_phid, $object_phid) { ··· 1526 1527 * This method is called both when creating a file from fresh data, and 1527 1528 * when creating a new file which reuses existing storage. 1528 1529 * 1529 1529 - * @param map<string, wild> Bag of parameters, see @{class:PhabricatorFile} 1530 1530 - * for documentation. 1530 1530 + * @param map<string, wild> $params Bag of parameters, see 1531 1531 + * @{class:PhabricatorFile} for documentation. 1531 1532 * @return this 1532 1533 */ 1533 1534 private function readPropertiesFromParameters(array $params) {

+4 -4

src/applications/files/transform/PhabricatorFileImageTransform.php

reviewed

··· 11 11 /** 12 12 * Get an estimate of the transformed dimensions of a file. 13 13 * 14 14 - * @param PhabricatorFile File to transform. 14 14 + * @param PhabricatorFile $file File to transform. 15 15 * @return list<int, int>|null Width and height, if available. 16 16 */ 17 17 public function getTransformedDimensions(PhabricatorFile $file) { ··· 132 132 /** 133 133 * Create a new @{class:PhabricatorFile} from raw data. 134 134 * 135 135 - * @param string Raw file data. 135 135 + * @param string $data Raw file data. 136 136 */ 137 137 protected function newFileFromData($data) { 138 138 if ($this->file) { ··· 159 159 /** 160 160 * Create a new image filled with transparent pixels. 161 161 * 162 162 - * @param int Desired image width. 163 163 - * @param int Desired image height. 162 162 + * @param int $w Desired image width. 163 163 + * @param int $h Desired image height. 164 164 * @return resource New image resource. 165 165 */ 166 166 protected function newEmptyImage($w, $h) {

+1 -1

src/applications/harbormaster/constants/HarbormasterBuildStatus.php

reviewed

··· 96 96 /** 97 97 * Get a human readable name for a build status constant. 98 98 * 99 99 - * @param const Build status constant. 99 99 + * @param const $status Build status constant. 100 100 * @return string Human-readable name. 101 101 */ 102 102 public static function getBuildStatusName($status) {

+5 -4

src/applications/harbormaster/engine/HarbormasterBuildEngine.php

reviewed

··· 322 322 * particularly relevant when a build uses multiple hosts since it returns 323 323 * hosts to the pool more quickly. 324 324 * 325 325 - * @param list<HarbormasterBuildTarget> Targets in the build. 326 326 - * @param list<HarbormasterBuildStep> List of running and waiting steps. 325 325 + * @param list<HarbormasterBuildTarget> $targets Targets in the build. 326 326 + * @param list<HarbormasterBuildStep> $steps List of running and waiting 327 327 + * steps. 327 328 * @return void 328 329 */ 329 330 private function releaseUnusedArtifacts(array $targets, array $steps) { ··· 372 373 * Process messages which were sent to these targets, kicking applicable 373 374 * targets out of "Waiting" and into either "Passed" or "Failed". 374 375 * 375 375 - * @param list<HarbormasterBuildTarget> List of targets to process. 376 376 + * @param list<HarbormasterBuildTarget> $targets List of targets to process. 376 377 * @return void 377 378 */ 378 379 private function updateWaitingTargets(array $targets) { ··· 436 437 * the overall state of the associated buildable. Compute the new aggregate 437 438 * state and save it on the buildable. 438 439 * 439 439 - * @param HarbormasterBuild The buildable to update. 440 440 + * @param HarbormasterBuild $buildable The buildable to update. 440 441 * @return void 441 442 */ 442 443 public function updateBuildable(HarbormasterBuildable $buildable) {

+4 -4

src/applications/harbormaster/engine/HarbormasterTargetEngine.php

reviewed

··· 56 56 * 57 57 * This method creates the steps if they do not yet exist. 58 58 * 59 59 - * @param list<string> Autotarget keys, like `"core.arc.lint"`. 59 59 + * @param list<string> $autotargets Autotarget keys, like `"core.arc.lint"`. 60 60 * @return map<string, object> Map of keys to step objects. 61 61 */ 62 62 private function generateBuildStepMap(array $autotargets) { ··· 127 127 * Get all of the @{class:HarbormasterBuildStepImplementation} objects for 128 128 * a list of autotarget keys. 129 129 * 130 130 - * @param list<string> Autotarget keys, like `"core.arc.lint"`. 130 130 + * @param list<string> $autotargets Autotarget keys, like `"core.arc.lint"`. 131 131 * @return map<string, object> Map of keys to implementations. 132 132 */ 133 133 private function getAutosteps(array $autotargets) { ··· 154 154 * 155 155 * If some targets or builds do not exist, they are created. 156 156 * 157 157 - * @param HarbormasterBuildable A buildable. 158 158 - * @param map<string, object> Map of keys to steps. 157 157 + * @param HarbormasterBuildable $buildable A buildable. 158 158 + * @param map<string, object> $step_map Map of keys to steps. 159 159 * @return map<string, object> Map of keys to targets. 160 160 */ 161 161 private function generateBuildTargetMap(

+5 -3

src/applications/harbormaster/step/HarbormasterBuildStepImplementation.php

reviewed

··· 187 187 * 188 188 * ls 'dir with spaces' 189 189 * 190 190 - * @param string Name of a `vxsprintf` function, like @{function:vcsprintf}. 191 191 - * @param string User-provided pattern string containing `${variables}`. 192 192 - * @param dict List of available replacement variables. 190 190 + * @param string $function Name of a `vxsprintf` function, like 191 191 + * @{function:vcsprintf}. 192 192 + * @param string $pattern User-provided pattern string containing 193 193 + * `${variables}`. 194 194 + * @param dict $variables List of available replacement variables. 193 195 * @return string String with variables replaced safely into it. 194 196 */ 195 197 protected function mergeVariables($function, $pattern, array $variables) {

+3 -3

src/applications/harbormaster/storage/HarbormasterBuildable.php

reviewed

··· 60 60 /** 61 61 * Start builds for a given buildable. 62 62 * 63 63 - * @param phid PHID of the object to build. 64 64 - * @param phid Container PHID for the buildable. 65 65 - * @param list<HarbormasterBuildRequest> List of builds to perform. 63 63 + * @param phid $phid PHID of the object to build. 64 64 + * @param phid $container_phid Container PHID for the buildable. 65 65 + * @param list<HarbormasterBuildRequest> $requests List of builds to perform. 66 66 * @return void 67 67 */ 68 68 public static function applyBuildPlans(

+2 -1

src/applications/herald/adapter/HeraldAdapter.php

reviewed

··· 171 171 * These transactions are set by @{class:PhabricatorApplicationEditor} 172 172 * automatically, before it invokes Herald. 173 173 * 174 174 - * @param list<PhabricatorApplicationTransaction> List of transactions. 174 174 + * @param list<PhabricatorApplicationTransaction> $xactions List of 175 175 + * transactions. 175 176 * @return this 176 177 */ 177 178 final public function setAppliedTransactions(array $xactions) {

+2 -2

src/applications/maniphest/constants/ManiphestTaskPriority.php

reviewed

··· 137 137 /** 138 138 * Retrieve the full name of the priority level provided. 139 139 * 140 140 - * @param int A priority level. 140 140 + * @param int $priority A priority level. 141 141 * @return string The priority name if the level is a valid one. 142 142 */ 143 143 public static function getTaskPriorityName($priority) { ··· 147 147 /** 148 148 * Retrieve the color of the priority level given 149 149 * 150 150 - * @param int A priority level. 150 150 + * @param int $priority A priority level. 151 151 * @return string The color of the priority if the level is valid, 152 152 * or black if it is not. 153 153 */

+1 -1

src/applications/meta/panel/PhabricatorApplicationConfigurationPanel.php

reviewed

··· 27 27 /** 28 28 * Get the URI for this application configuration panel. 29 29 * 30 30 - * @param string? Optional path to append. 30 30 + * @param string? $path Optional path to append. 31 31 * @return string Relative URI for the panel. 32 32 */ 33 33 public function getPanelURI($path = '') {

+1 -1

src/applications/metamta/parser/PhabricatorMetaMTAEmailBodyParser.php

reviewed

··· 26 26 * ), 27 27 * ) 28 28 * 29 29 - * @param string Raw mail text body. 29 29 + * @param string $body Raw mail text body. 30 30 * @return dict Parsed body. 31 31 */ 32 32 public function parseBody($body) {

+3 -3

src/applications/metamta/receiver/PhabricatorObjectMailReceiver.php

reviewed

··· 19 19 * Load the object receiving mail, based on an identifying pattern. Normally 20 20 * this pattern is some sort of object ID. 21 21 * 22 22 - * @param string A string matched by @{method:getObjectPattern} 23 23 - * fragment. 24 24 - * @param PhabricatorUser The viewing user. 22 22 + * @param string $pattern A string matched by 23 23 + * @{method:getObjectPattern} fragment. 24 24 + * @param PhabricatorUser $viewer The viewing user. 25 25 * @return object|null The object to receive mail, or null if no such 26 26 * object exists. 27 27 */

+8 -8

src/applications/metamta/replyhandler/PhabricatorMailReplyHandler.php

reviewed

··· 199 199 * Each target should be sent a separate email, and contains the information 200 200 * required to generate it with appropriate permissions and configuration. 201 201 * 202 202 - * @param list<phid> List of "To" PHIDs. 203 203 - * @param list<phid> List of "CC" PHIDs. 202 202 + * @param list<phid> $raw_to List of "To" PHIDs. 203 203 + * @param list<phid> $raw_cc List of "CC" PHIDs. 204 204 * @return list<PhabricatorMailTarget> List of targets. 205 205 */ 206 206 final public function getMailTargets(array $raw_to, array $raw_cc) { ··· 274 274 * This takes any compound recipients (like projects) and looks up all their 275 275 * members. 276 276 * 277 277 - * @param list<phid> List of To PHIDs. 278 278 - * @param list<phid> List of CC PHIDs. 277 277 + * @param list<phid> $to List of To PHIDs. 278 278 + * @param list<phid> $cc List of CC PHIDs. 279 279 * @return pair<list<phid>, list<phid>> Expanded PHID lists. 280 280 */ 281 281 private function expandRecipientPHIDs(array $to, array $cc) { ··· 332 332 * 333 333 * Invalid recipients are dropped from the results. 334 334 * 335 335 - * @param list<phid> List of To PHIDs. 336 336 - * @param list<phid> List of CC PHIDs. 335 335 + * @param list<phid> $to List of To PHIDs. 336 336 + * @param list<phid> $cc List of CC PHIDs. 337 337 * @return pair<wild, wild> Maps from PHIDs to users. 338 338 */ 339 339 private function loadRecipientUsers(array $to, array $cc) { ··· 370 370 /** 371 371 * Remove recipients who do not have permission to view the mail receiver. 372 372 * 373 373 - * @param map<string, PhabricatorUser> Map of "To" users. 374 374 - * @param map<string, PhabricatorUser> Map of "CC" users. 373 373 + * @param map<string, PhabricatorUser> $to Map of "To" users. 374 374 + * @param map<string, PhabricatorUser> $cc Map of "CC" users. 375 375 * @return pair<wild, wild> Filtered user maps. 376 376 */ 377 377 private function filterRecipientUsers(array $to, array $cc) {

+10 -9

src/applications/metamta/storage/PhabricatorMetaMTAMail.php

reviewed

··· 88 88 * These tags are used to allow users to opt out of receiving certain types 89 89 * of mail, like updates when a task's projects change. 90 90 * 91 91 - * @param list<const> 91 91 + * @param list<const> $tags 92 92 * @return this 93 93 */ 94 94 public function setMailTags(array $tags) { ··· 109 109 * needs to be set whenever an action is triggered by an email message. See 110 110 * T251 for more details. 111 111 * 112 112 - * @param string The "Message-ID" of the email which precedes this one. 112 112 + * @param string $id The "Message-ID" of the email which precedes this one. 113 113 * @return this 114 114 */ 115 115 public function setParentMessageID($id) { ··· 419 419 * This is primarily intended to let users who don't want any email still 420 420 * receive things like password resets. 421 421 * 422 422 - * @param bool True to force delivery despite user preferences. 422 422 + * @param bool $force True to force delivery despite user preferences. 423 423 * @return this 424 424 */ 425 425 public function setForceDelivery($force) { ··· 437 437 * "Precedence: bulk" or similar, but is implementation and configuration 438 438 * dependent. 439 439 * 440 440 - * @param bool True if the mail is automated bulk mail. 440 440 + * @param bool $is_bulk True if the mail is automated bulk mail. 441 441 * @return this 442 442 */ 443 443 public function setIsBulk($is_bulk) { ··· 454 454 * set appropriate headers (Message-ID, In-Reply-To, References and 455 455 * Thread-Index) based on the capabilities of the underlying mailer. 456 456 * 457 457 - * @param string Unique identifier, appropriate for use in a Message-ID, 458 458 - * In-Reply-To or References headers. 459 459 - * @param bool If true, indicates this is the first message in the thread. 457 457 + * @param string $thread_id Unique identifier, appropriate for use in a 458 458 + * Message-ID, In-Reply-To or References headers. 459 459 + * @param bool? $is_first_message If true, indicates this is the first 460 460 + * message in the thread. 460 461 * @return this 461 462 */ 462 463 public function setThreadID($thread_id, $is_first_message = false) { ··· 858 859 * For example, this will expand project PHIDs into a list of the project's 859 860 * members. 860 861 * 861 861 - * @param list<phid> List of recipient PHIDs, possibly including aggregate 862 862 - * recipients. 862 862 + * @param list<phid> $phids List of recipient PHIDs, possibly including 863 863 + * aggregate recipients. 863 864 * @return list<phid> Deaggregated list of mailable recipients. 864 865 */ 865 866 public function expandRecipients(array $phids) {

+3 -3

src/applications/metamta/util/PhabricatorMailUtil.php

reviewed

··· 10 10 * which can make forwarding rules easier to write. This method strips the 11 11 * prefix if it is present, and normalizes casing and whitespace. 12 12 * 13 13 - * @param PhutilEmailAddress Email address. 13 13 + * @param PhutilEmailAddress $address Email address. 14 14 * @return PhutilEmailAddress Normalized address. 15 15 */ 16 16 public static function normalizeAddress(PhutilEmailAddress $address) { ··· 47 47 * <ALincoln@example.com> 48 48 * "Abraham" <phabricator+ALINCOLN@EXAMPLE.COM> # With configured prefix. 49 49 * 50 50 - * @param PhutilEmailAddress Email address. 51 51 - * @param PhutilEmailAddress Another email address. 50 50 + * @param PhutilEmailAddress $u Email address. 51 51 + * @param PhutilEmailAddress $v Another email address. 52 52 * @return bool True if addresses are effectively the same address. 53 53 */ 54 54 public static function matchAddresses(

+5 -5

src/applications/metamta/view/PhabricatorMetaMTAMailBody.php

reviewed

··· 40 40 /** 41 41 * Add a raw block of text to the email. This will be rendered as-is. 42 42 * 43 43 - * @param string Block of text. 43 43 + * @param string $text Block of text. 44 44 * @return this 45 45 * @task compose 46 46 */ ··· 100 100 * HEADER 101 101 * Text is indented. 102 102 * 103 103 - * @param string Header text. 104 104 - * @param string Section text. 103 103 + * @param string $header Header text. 104 104 + * @param string $section Section text. 105 105 * @return this 106 106 * @task compose 107 107 */ ··· 155 155 /** 156 156 * Add an attachment. 157 157 * 158 158 - * @param PhabricatorMailAttachment Attachment. 158 158 + * @param PhabricatorMailAttachment $attachment Attachment. 159 159 * @return this 160 160 * @task compose 161 161 */ ··· 198 198 /** 199 199 * Indent a block of text for rendering under a section heading. 200 200 * 201 201 - * @param string Text to indent. 201 201 + * @param string $text Text to indent. 202 202 * @return string Indented text. 203 203 * @task render 204 204 */

+2 -2

src/applications/notification/query/PhabricatorNotificationQuery.php

reviewed

··· 31 31 * only unread notifications, while `false` means to return only //read// 32 32 * notifications. The default is `null`, which returns both. 33 33 * 34 34 - * @param mixed True or false to filter results by read status. Null to remove 35 35 - * the filter. 34 34 + * @param mixed $unread True or false to filter results by read status. Null 35 35 + * to remove the filter. 36 36 * @return this 37 37 * @task config 38 38 */

+3 -3

src/applications/passphrase/view/PassphraseCredentialControl.php

reviewed

··· 157 157 * - If you do change the credential, the new credential must be one you 158 158 * can use. 159 159 * 160 160 - * @param PhabricatorUser The acting user. 161 161 - * @param list<PhabricatorApplicationTransaction> List of credential altering 162 162 - * transactions. 160 160 + * @param PhabricatorUser $actor The acting user. 161 161 + * @param list<PhabricatorApplicationTransaction> $xactions List of 162 162 + * credential altering transactions. 163 163 * @return bool True if the transactions are valid. 164 164 */ 165 165 public static function validateTransactions(

+8 -8

src/applications/people/storage/PhabricatorUser.php

reviewed

··· 429 429 /** 430 430 * Test if a given setting is set to a particular value. 431 431 * 432 432 - * @param const Setting key. 433 433 - * @param wild Value to compare. 432 432 + * @param const $key Setting key. 433 433 + * @param wild $value Value to compare. 434 434 * @return bool True if the setting has the specified value. 435 435 * @task settings 436 436 */ ··· 477 477 * 478 478 * This is primarily useful for unit tests. 479 479 * 480 480 - * @param string New timezone identifier. 480 480 + * @param string $identifier New timezone identifier. 481 481 * @return this 482 482 * @task settings 483 483 */ ··· 770 770 /** 771 771 * Write to the availability cache. 772 772 * 773 773 - * @param wild Availability cache data. 774 774 - * @param int|null Cache TTL. 773 773 + * @param wild $availability Availability cache data. 774 774 + * @param int|null $ttl Cache TTL. 775 775 * @return this 776 776 * @task availability 777 777 */ ··· 916 916 * Get a @{class:PhabricatorHandleList} which benefits from this viewer's 917 917 * internal handle pool. 918 918 * 919 919 - * @param list<phid> List of PHIDs to load. 919 919 + * @param list<phid> $phids List of PHIDs to load. 920 920 * @return PhabricatorHandleList Handle list object. 921 921 * @task handle 922 922 */ ··· 935 935 * 936 936 * This benefits from the viewer's internal handle pool. 937 937 * 938 938 - * @param phid PHID to render a handle for. 938 938 + * @param phid $phid PHID to render a handle for. 939 939 * @return PHUIHandleView View of the handle. 940 940 * @task handle 941 941 */ ··· 949 949 * 950 950 * This benefits from the viewer's internal handle pool. 951 951 * 952 952 - * @param list<phid> List of PHIDs to render. 952 952 + * @param list<phid> $phids List of PHIDs to render. 953 953 * @return PHUIHandleListView View of the handles. 954 954 * @task handle 955 955 */

+4 -4

src/applications/people/storage/PhabricatorUserEmail.php

reviewed

··· 180 180 /** 181 181 * Send a verification email from $user to this address. 182 182 * 183 183 - * @param PhabricatorUser The user sending the verification. 183 183 + * @param PhabricatorUser $user The user sending the verification. 184 184 * @return this 185 185 * @task email 186 186 */ ··· 229 229 * Send a notification email from $user to this address, informing the 230 230 * recipient that this is no longer their account's primary address. 231 231 * 232 232 - * @param PhabricatorUser The user sending the notification. 233 233 - * @param PhabricatorUserEmail New primary email address. 232 232 + * @param PhabricatorUser $user The user sending the notification. 233 233 + * @param PhabricatorUserEmail $new New primary email address. 234 234 * @task email 235 235 */ 236 236 public function sendOldPrimaryEmail( ··· 269 269 * Send a notification email from $user to this address, informing the 270 270 * recipient that this is now their account's new primary email address. 271 271 * 272 272 - * @param PhabricatorUser The user sending the verification. 272 272 + * @param PhabricatorUser $user The user sending the verification. 273 273 * @return this 274 274 * @task email 275 275 */

+1 -1

src/applications/phid/PhabricatorObjectHandle.php

reviewed

··· 275 275 * Set whether or not the underlying object is complete. See 276 276 * @{method:isComplete} for an explanation of what it means to be complete. 277 277 * 278 278 - * @param bool True if the handle represents a complete object. 278 278 + * @param bool $complete True if the handle represents a complete object. 279 279 * @return this 280 280 */ 281 281 public function setComplete($complete) {

+2 -2

src/applications/phid/query/PhabricatorObjectQuery.php

reviewed

··· 196 196 * viewer. This method is generally used to validate that PHIDs affected by 197 197 * a transaction are valid. 198 198 * 199 199 - * @param PhabricatorUser Viewer. 200 200 - * @param list<phid> List of ostensibly valid PHIDs. 199 199 + * @param PhabricatorUser $viewer Viewer. 200 200 + * @param list<phid> $phids List of ostensibly valid PHIDs. 201 201 * @return list<phid> List of invalid or restricted PHIDs. 202 202 */ 203 203 public static function loadInvalidPHIDsForViewer(

+11 -10

src/applications/phid/type/PhabricatorPHIDType.php

reviewed

··· 52 52 * can provide a dummy implementation for this method and overload 53 53 * @{method:loadObjects} instead. 54 54 * 55 55 - * @param PhabricatorObjectQuery Query being executed. 56 56 - * @param list<phid> PHIDs to load. 55 55 + * @param PhabricatorObjectQuery $query Query being executed. 56 56 + * @param list<phid> $phids PHIDs to load. 57 57 * @return PhabricatorPolicyAwareQuery Query object which loads the 58 58 * specified PHIDs when executed. 59 59 */ ··· 67 67 * necessary to implement @{method:buildQueryForObjects} to get object 68 68 * loading to work. 69 69 * 70 70 - * @param PhabricatorObjectQuery Query being executed. 71 71 - * @param list<phid> PHIDs to load. 70 70 + * @param PhabricatorObjectQuery $query Query being executed. 71 71 + * @param list<phid> $phids PHIDs to load. 72 72 * @return list<wild> Corresponding objects. 73 73 */ 74 74 public function loadObjects( ··· 113 113 * each handle at a minimum. See @{class:PhabricatorObjectHandle} for other 114 114 * handle properties. 115 115 * 116 116 - * @param PhabricatorHandleQuery Issuing query object. 117 117 - * @param list<PhabricatorObjectHandle> Handles to populate with data. 118 118 - * @param list<Object> Objects for these PHIDs loaded by 119 119 - * @{method:buildQueryForObjects()}. 116 116 + * @param PhabricatorHandleQuery $query Issuing query object. 117 117 + * @param list<PhabricatorObjectHandle> $handles Handles to populate with 118 118 + * data. 119 119 + * @param list<Object> $objects Objects for these PHIDs 120 120 + * loaded by @{method:buildQueryForObjects()}. 120 121 * @return void 121 122 */ 122 123 abstract public function loadHandles( ··· 165 166 /** 166 167 * Get all PHID types of applications installed for a given viewer. 167 168 * 168 168 - * @param PhabricatorUser Viewing user. 169 169 + * @param PhabricatorUser $viewer Viewing user. 169 170 * @return dict<string, PhabricatorPHIDType> Map of constants to installed 170 171 * types. 171 172 */ ··· 209 210 /** 210 211 * Get all PHID types of an application. 211 212 * 212 212 - * @param string Class name of an application 213 213 + * @param string $application Class name of an application 213 214 * @return dict<string, PhabricatorPHIDType> Map of constants of application 214 215 */ 215 216 public static function getAllTypesForApplication(

+2 -2

src/applications/phid/utils.php

reviewed

··· 4 4 * Look up the type of a PHID. Returns 5 5 * PhabricatorPHIDConstants::PHID_TYPE_UNKNOWN if it fails to look up the type 6 6 * 7 7 - * @param phid Anything. 7 7 + * @param phid $phid Anything. 8 8 * @return string A value from PhabricatorPHIDConstants (ideally) 9 9 */ 10 10 function phid_get_type($phid) { ··· 18 18 /** 19 19 * Group a list of phids by type. 20 20 * 21 21 - * @param phids array of phids 21 21 + * @param $phids Array of phids 22 22 * @return map of phid type => list of phids 23 23 */ 24 24 function phid_group_by_type($phids) {

+2 -1

src/applications/phrequent/storage/PhrequentTimeBlock.php

reviewed

··· 254 254 * This is used to avoid double-counting time on objects which had timers 255 255 * started multiple times. 256 256 * 257 257 - * @param list<pair<int, int>> List of possibly overlapping time ranges. 257 257 + * @param list<pair<int, int>> $ranges List of possibly overlapping time 258 258 + * ranges. 258 259 * @return list<pair<int, int>> Nonoverlapping time ranges. 259 260 */ 260 261 public static function mergeTimeRanges(array $ranges) {

+7 -5

src/applications/policy/filter/PhabricatorPolicyFilter.php

reviewed

··· 52 52 * ...will throw a @{class:PhabricatorPolicyException} if the new policy would 53 53 * remove the user's ability to edit the object. 54 54 * 55 55 - * @param PhabricatorUser The viewer to perform a policy check for. 56 56 - * @param PhabricatorPolicyInterface The object to perform a policy check on. 57 57 - * @param string Capability to test. 58 58 - * @param string Perform the test as though the object has this 59 59 - * policy instead of the policy it actually has. 55 55 + * @param PhabricatorUser $viewer The viewer to perform a policy check for. 56 56 + * @param PhabricatorPolicyInterface $object The object to perform a policy 57 57 + * check on. 58 58 + * @param string $capability Capability to test. 59 59 + * @param string $forced_policy Perform the test as though the 60 60 + * object has this policy instead of the policy it 61 61 + * actually has. 60 62 * @return void 61 63 */ 62 64 public static function requireCapabilityWithForcedPolicy(

+2 -2

src/applications/policy/interface/PhabricatorExtendedPolicyInterface.php

reviewed

··· 62 62 * // ... 63 63 * ); 64 64 * 65 65 - * @param const Capability being tested. 66 66 - * @param PhabricatorUser Viewer whose capabilities are being tested. 65 65 + * @param const $capability Capability being tested. 66 66 + * @param PhabricatorUser $viewer Viewer whose capabilities are being tested. 67 67 * @return list<pair<wild, wild>> List of extended policies. 68 68 */ 69 69 public function getExtendedPolicy($capability, PhabricatorUser $viewer);

+3 -3

src/applications/policy/rule/PhabricatorPolicyRule.php

reviewed

··· 120 120 * rendering a verdict about whether the user will be able to see the object 121 121 * or not after applying the policy change. 122 122 * 123 123 - * @param PhabricatorPolicyInterface Object to pass a hint about. 124 124 - * @param PhabricatorPolicyRule Rule to pass hint to. 125 125 - * @param wild Hint. 123 123 + * @param PhabricatorPolicyInterface $object Object to pass a hint about. 124 124 + * @param PhabricatorPolicyRule $rule Rule to pass hint to. 125 125 + * @param wild $hint Hint. 126 126 * @return void 127 127 */ 128 128 public static function passTransactionHintToRule(

+2 -2

src/applications/policy/storage/PhabricatorPolicy.php

reviewed

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

+2 -2

src/applications/repository/daemon/PhabricatorRepositoryPullLocalDaemon.php

reviewed

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

+1 -1

src/applications/repository/engine/PhabricatorRepositoryDiscoveryEngine.php

reviewed

··· 538 538 * 539 539 * @task internal 540 540 * 541 541 - * @param list<DiffusionRepositoryRef> List of refs. 541 541 + * @param list<DiffusionRepositoryRef> $refs List of refs. 542 542 * @return list<DiffusionRepositoryRef> Sorted list of refs. 543 543 */ 544 544 private function sortRefs(array $refs) {

+1 -1

src/applications/repository/engine/PhabricatorRepositoryPullEngine.php

reviewed

··· 740 740 * error message. To prevent this, censor response bodies out of error 741 741 * messages. 742 742 * 743 743 - * @param string Uncensored Mercurial command output. 743 743 + * @param string $message Uncensored Mercurial command output. 744 744 * @return string Censored Mercurial command output. 745 745 */ 746 746 private function censorMercurialErrorMessage($message) {

+1 -1

src/applications/repository/engine/PhabricatorRepositoryRefEngine.php

reviewed

··· 233 233 * point at commits which no longer exist. This can make commands issued later 234 234 * fail. See T5839 for discussion. 235 235 * 236 236 - * @param list<string> List of commit identifiers. 236 236 + * @param list<string> $identifiers List of commit identifiers. 237 237 * @return list<string> List with nonexistent identifiers removed. 238 238 */ 239 239 private function removeMissingCommits(array $identifiers) {

+13 -12

src/applications/repository/graphcache/PhabricatorRepositoryGraphCache.php

reviewed

··· 64 64 /** 65 65 * Search the graph cache for the most modification to a path. 66 66 * 67 67 - * @param int The commit ID to search ancestors of. 68 68 - * @param int The path ID to search for changes to. 69 69 - * @param float Maximum number of seconds to spend trying to satisfy this 70 70 - * query using the graph cache. By default, `0.5` (500ms). 67 67 + * @param int $commit_id The commit ID to search ancestors of. 68 68 + * @param int $path_id The path ID to search for changes to. 69 69 + * @param float $time Maximum number of seconds to spend trying to satisfy 70 70 + * this query using the graph cache. By default `0.5` (500ms). 71 71 * @return mixed Commit ID, or `null` if no ancestors exist, or `false` if 72 72 * the graph cache was unable to determine the answer. 73 73 * @task query ··· 189 189 /** 190 190 * Get the bucket key for a given commit ID. 191 191 * 192 192 - * @param int Commit ID. 192 192 + * @param int $commit_id Commit ID. 193 193 * @return int Bucket key. 194 194 * @task cache 195 195 */ ··· 201 201 /** 202 202 * Get the cache key for a given bucket key (from @{method:getBucketKey}). 203 203 * 204 204 - * @param int Bucket key. 204 204 + * @param int $bucket_key Bucket key. 205 205 * @return string Cache key. 206 206 * @task cache 207 207 */ ··· 235 235 * Normally, this operates as a readthrough cache call. It can also be used 236 236 * to force a cache update by passing the existing data to `$rebuild_data`. 237 237 * 238 238 - * @param int Bucket key, from @{method:getBucketKey}. 239 239 - * @param mixed Current data, to force a cache rebuild of this bucket. 240 240 - * @return array Data from the cache. 238 238 + * @param int $bucket_key Bucket key, from @{method:getBucketKey}. 239 239 + * @param mixed? $rebuild_data Current data, to force a cache rebuild of 240 240 + * this bucket. 241 241 + * @return array Data from the cache. 241 242 * @task cache 242 243 */ 243 244 private function getBucketData($bucket_key, $rebuild_data = null) { ··· 287 288 /** 288 289 * Rebuild a cache bucket, amending existing data if available. 289 290 * 290 290 - * @param int Bucket key, from @{method:getBucketKey}. 291 291 - * @param array Existing bucket data. 292 292 - * @return array Rebuilt bucket data. 291 291 + * @param int $bucket_key Bucket key, from @{method:getBucketKey}. 292 292 + * @param array $current_data Existing bucket data. 293 293 + * @return array Rebuilt bucket data. 293 294 * @task cache 294 295 */ 295 296 private function rebuildBucket($bucket_key, array $current_data) {

+6 -6

src/applications/repository/storage/PhabricatorRepository.php

reviewed

··· 1288 1288 /** 1289 1289 * Determine if a protocol is SSH or SSH-like. 1290 1290 * 1291 1291 - * @param string A protocol string, like "http" or "ssh". 1291 1291 + * @param string $protocol A protocol string, like "http" or "ssh". 1292 1292 * @return bool True if the protocol is SSH-like. 1293 1293 * @task uri 1294 1294 */ ··· 1701 1701 * 2037). We adjust the pull frequency based on when the most recent commit 1702 1702 * occurred. 1703 1703 * 1704 1704 - * @param int The minimum update interval to use, in seconds. 1704 1704 + * @param int? $minimum The minimum update interval to use, in seconds. 1705 1705 * @return int Repository update interval, in seconds. 1706 1706 */ 1707 1707 public function loadUpdateInterval($minimum = 15) { ··· 1836 1836 * with repository services. This method provides lower-level resolution of 1837 1837 * services, returning raw URIs. 1838 1838 * 1839 1839 - * @param PhabricatorUser Viewing user. 1840 1840 - * @param map<string, wild> Constraints on selectable services. 1839 1839 + * @param PhabricatorUser $viewer Viewing user. 1840 1840 + * @param map<string, wild> $options Constraints on selectable services. 1841 1841 * @return string|null URI, or `null` for local repositories. 1842 1842 */ 1843 1843 public function getAlmanacServiceURI( ··· 2168 2168 * 2169 2169 * For lower-level service resolution, see @{method:getAlmanacServiceURI}. 2170 2170 * 2171 2171 - * @param PhabricatorUser Viewing user. 2172 2172 - * @param bool `true` to throw if a client would be returned. 2171 2171 + * @param PhabricatorUser $viewer Viewing user. 2172 2172 + * @param bool? $never_proxy `true` to throw if a client would be returned. 2173 2173 * @return ConduitClient|null Client, or `null` for local repositories. 2174 2174 */ 2175 2175 public function newConduitClient(

+17 -16

src/applications/search/engine/PhabricatorApplicationSearchEngine.php

reviewed

··· 126 126 /** 127 127 * Create a saved query object from the request. 128 128 * 129 129 - * @param AphrontRequest The search request. 129 129 + * @param AphrontRequest $request The search request. 130 130 * @return PhabricatorSavedQuery 131 131 */ 132 132 public function buildSavedQueryFromRequest(AphrontRequest $request) { ··· 147 147 /** 148 148 * Executes the saved query. 149 149 * 150 150 - * @param PhabricatorSavedQuery The saved query to operate on. 150 150 + * @param PhabricatorSavedQuery $original The saved query to operate on. 151 151 * @return PhabricatorQuery The result of the query. 152 152 */ 153 153 public function buildQueryFromSavedQuery(PhabricatorSavedQuery $original) { ··· 201 201 * hook to keep old queries working the way users expect, by reading, 202 202 * adjusting, and overwriting parameters. 203 203 * 204 204 - * @param PhabricatorSavedQuery Saved query which will be executed. 204 204 + * @param PhabricatorSavedQuery $saved Saved query which will be executed. 205 205 * @return void 206 206 */ 207 207 protected function willUseSavedQuery(PhabricatorSavedQuery $saved) { ··· 215 215 /** 216 216 * Builds the search form using the request. 217 217 * 218 218 - * @param AphrontFormView Form to populate. 219 219 - * @param PhabricatorSavedQuery The query from which to build the form. 218 218 + * @param AphrontFormView $form Form to populate. 219 219 + * @param PhabricatorSavedQuery $saved Query from which to build the form. 220 220 * @return void 221 221 */ 222 222 public function buildSearchForm( ··· 400 400 * Return an application URI corresponding to the results page of a query. 401 401 * Normally, this is something like `/application/query/QUERYKEY/`. 402 402 * 403 403 - * @param string The query key to build a URI for. 403 403 + * @param string $query_key The query key to build a URI for. 404 404 * @return string URI where the query can be executed. 405 405 * @task uri 406 406 */ ··· 730 730 * links to pages (like "alincoln's open revisions") without needing to make 731 731 * API calls. 732 732 * 733 733 - * @param AphrontRequest Request to read user PHIDs from. 734 734 - * @param string Key to read in the request. 735 735 - * @param list<const> Other permitted PHID types. 733 733 + * @param AphrontRequest $request Request to read user PHIDs from. 734 734 + * @param string $key Key to read in the request. 735 735 + * @param list<const>? $allow_types Other permitted PHID types. 736 736 * @return list<phid> List of user PHIDs and selector functions. 737 737 * @task read 738 738 */ ··· 782 782 /** 783 783 * Read a list of subscribers from a request in a flexible way. 784 784 * 785 785 - * @param AphrontRequest Request to read PHIDs from. 786 786 - * @param string Key to read in the request. 785 785 + * @param AphrontRequest $request Request to read PHIDs from. 786 786 + * @param string $key Key to read in the request. 787 787 * @return list<phid> List of object PHIDs. 788 788 * @task read 789 789 */ ··· 805 805 * comma-delimited forms. Objects can be specified either by PHID or by 806 806 * object name. 807 807 * 808 808 - * @param AphrontRequest Request to read PHIDs from. 809 809 - * @param string Key to read in the request. 810 810 - * @param list<const> Optional, list of permitted PHID types. 808 808 + * @param AphrontRequest $request Request to read PHIDs from. 809 809 + * @param string $key Key to read in the request. 810 810 + * @param list<const>? $allow_types Optional, list of permitted PHID 811 811 + * types. 811 812 * @return list<phid> List of object PHIDs. 812 813 * 813 814 * @task read ··· 853 854 * This provides flexibility when constructing URIs, especially from external 854 855 * sources. 855 856 * 856 856 - * @param AphrontRequest Request to read strings from. 857 857 - * @param string Key to read in the request. 857 857 + * @param AphrontRequest $request Request to read strings from. 858 858 + * @param string $key Key to read in the request. 858 859 * @return list<string> List of values. 859 860 */ 860 861 protected function readListFromRequest(

+9 -9

src/applications/search/field/PhabricatorSearchField.php

reviewed

··· 33 33 * The key should be a short, unique (within a search engine) string which 34 34 * does not contain any special characters. 35 35 * 36 36 - * @param string Unique key which identifies the field. 36 36 + * @param string $key Unique key which identifies the field. 37 37 * @return this 38 38 * @task config 39 39 */ ··· 59 59 * 60 60 * This should be a short text string, like "Reviewers" or "Colors". 61 61 * 62 62 - * @param string Short, human-readable field label. 62 62 + * @param string $label Short, human-readable field label. 63 63 * @return this 64 64 * task config 65 65 */ ··· 86 86 * Engines do not need to do this explicitly; it will be done on their 87 87 * behalf by the caller. 88 88 * 89 89 - * @param PhabricatorUser Viewer. 89 89 + * @param PhabricatorUser $viewer Viewer. 90 90 * @return this 91 91 * @task config 92 92 */ ··· 115 115 * an alias like `authors` to let users write `&authors=alincoln` instead of 116 116 * `&authorPHIDs=alincoln`. This is a little easier to use. 117 117 * 118 118 - * @param list<string> List of aliases for this field. 118 118 + * @param list<string> $aliases List of aliases for this field. 119 119 * @return this 120 120 * @task config 121 121 */ ··· 142 142 * This can allow you to choose a more usable key for API endpoints. 143 143 * If no key is provided, the main key is used. 144 144 * 145 145 - * @param string Alternate key for Conduit. 145 145 + * @param string $conduit_key Alternate key for Conduit. 146 146 * @return this 147 147 * @task config 148 148 */ ··· 170 170 /** 171 171 * Set a human-readable description for this field. 172 172 * 173 173 - * @param string Human-readable description. 173 173 + * @param string $description Human-readable description. 174 174 * @return this 175 175 * @task config 176 176 */ ··· 194 194 /** 195 195 * Hide this field from the web UI. 196 196 * 197 197 - * @param bool True to hide the field from the web UI. 197 197 + * @param bool $is_hidden True to hide the field from the web UI. 198 198 * @return this 199 199 * @task config 200 200 */ ··· 400 400 * This provides flexibility when constructing URIs, especially from external 401 401 * sources. 402 402 * 403 403 - * @param AphrontRequest Request to read strings from. 404 404 - * @param string Key to read in the request. 403 403 + * @param AphrontRequest $request Request to read strings from. 404 404 + * @param string $key Key to read in the request. 405 405 * @return list<string> List of values. 406 406 * @task utility 407 407 */

+2 -2

src/applications/search/fulltextstorage/PhabricatorFulltextStorageEngine.php

reviewed

··· 47 47 /** 48 48 * Update the index for an abstract document. 49 49 * 50 50 - * @param PhabricatorSearchAbstractDocument Document to update. 50 50 + * @param PhabricatorSearchAbstractDocument $document Document to update. 51 51 * @return void 52 52 */ 53 53 abstract public function reindexAbstractDocument( ··· 56 56 /** 57 57 * Execute a search query. 58 58 * 59 59 - * @param PhabricatorSavedQuery A query to execute. 59 59 + * @param PhabricatorSavedQuery $query A query to execute. 60 60 * @return list A list of matching PHIDs. 61 61 */ 62 62 abstract public function executeSearch(PhabricatorSavedQuery $query);

+2 -2

src/applications/settings/panel/PhabricatorSettingsPanel.php

reviewed

··· 222 222 * Generally, render your settings panel by returning a form, then return 223 223 * a redirect when the user saves settings. 224 224 * 225 225 - * @param AphrontRequest Incoming request. 225 225 + * @param AphrontRequest $request Incoming request. 226 226 * @return wild Response to request, either as an 227 227 * @{class:AphrontResponse} or something which can 228 228 * be composed into a @{class:AphrontView}. ··· 234 234 /** 235 235 * Get the URI for this panel. 236 236 * 237 237 - * @param string? Optional path to append. 237 237 + * @param string? $path Optional path to append. 238 238 * @return string Relative URI for the panel. 239 239 * @task panel 240 240 */

+2 -1

src/applications/settings/query/PhabricatorUserPreferencesQuery.php

reviewed

··· 49 49 * If no settings exist for a user, a new empty settings object with 50 50 * appropriate defaults is returned. 51 51 * 52 52 - * @param bool True to generate synthetic preferences for missing users. 52 52 + * @param bool $synthetic True to generate synthetic preferences for missing 53 53 + * users. 53 54 */ 54 55 public function needSyntheticPreferences($synthetic) { 55 56 $this->synthetic = $synthetic;

+2 -2

src/applications/settings/storage/PhabricatorUserPreferences.php

reviewed

··· 119 119 /** 120 120 * Load or create a preferences object for the given user. 121 121 * 122 122 - * @param PhabricatorUser User to load or create preferences for. 122 122 + * @param PhabricatorUser $user User to load or create preferences for. 123 123 */ 124 124 public static function loadUserPreferences(PhabricatorUser $user) { 125 125 return id(new PhabricatorUserPreferencesQuery()) ··· 134 134 * 135 135 * If no global preferences exist, an empty preferences object is returned. 136 136 * 137 137 - * @param PhabricatorUser Viewing user. 137 137 + * @param PhabricatorUser $viewer Viewing user. 138 138 */ 139 139 public static function loadGlobalPreferences(PhabricatorUser $viewer) { 140 140 $global = id(new PhabricatorUserPreferencesQuery())

+1 -1

src/applications/spaces/query/PhabricatorSpacesNamespaceQuery.php

reviewed

··· 212 212 * This is intended to simplify performing a bunch of redundant checks; you 213 213 * can intentionally pass any value in (including `null`). 214 214 * 215 215 - * @param wild 215 215 + * @param wild $object 216 216 * @return phid|null 217 217 */ 218 218 public static function getObjectSpacePHID($object) {

+3 -3

src/applications/subscriptions/editor/PhabricatorSubscriptionsEditor.php

reviewed

··· 18 18 * (or been subscribed) to the object, and will be added even if they 19 19 * had previously unsubscribed. 20 20 * 21 21 - * @param list<phid> List of PHIDs to explicitly subscribe. 21 21 + * @param list<phid> $phids List of PHIDs to explicitly subscribe. 22 22 * @return this 23 23 */ 24 24 public function subscribeExplicit(array $phids) { ··· 32 32 * implicitly subscribes them (e.g., adding a comment) but it will be 33 33 * suppressed if they've previously unsubscribed from the object. 34 34 * 35 35 - * @param list<phid> List of PHIDs to implicitly subscribe. 35 35 + * @param list<phid> $phids List of PHIDs to implicitly subscribe. 36 36 * @return this 37 37 */ 38 38 public function subscribeImplicit(array $phids) { ··· 45 45 * Unsubscribe PHIDs and mark them as unsubscribed, so implicit subscriptions 46 46 * will not resubscribe them. 47 47 * 48 48 - * @param list<phid> List of PHIDs to unsubscribe. 48 48 + * @param list<phid> $phids List of PHIDs to unsubscribe. 49 49 * @return this 50 50 */ 51 51 public function unsubscribe(array $phids) {

+2 -1

src/applications/subscriptions/interface/PhabricatorSubscribableInterface.php

reviewed

··· 8 8 * irrevocably a subscriber). This will, e.g., cause the UI to render 9 9 * "Automatically Subscribed" instead of "Subscribe". 10 10 * 11 11 - * @param PHID PHID (presumably a user) to test for automatic subscription. 11 11 + * @param PHID $phid PHID (presumably a user) to test for automatic 12 12 + * subscription. 12 13 * @return bool True if the object/user is automatically subscribed. 13 14 */ 14 15 public function isAutomaticallySubscribed($phid);

+4 -4

src/applications/system/engine/PhabricatorSystemActionEngine.php

reviewed

··· 33 33 * If any actor is exceeding their rate limit, this method throws a 34 34 * @{class:PhabricatorSystemActionRateLimitException}. 35 35 * 36 36 - * @param list<string> List of actors. 37 37 - * @param PhabricatorSystemAction Action being taken. 38 38 - * @param float Score or credit, see above. 36 36 + * @param list<string> $actors List of actors. 37 37 + * @param PhabricatorSystemAction $action Action being taken. 38 38 + * @param float $score Score or credit, see above. 39 39 * @return void 40 40 */ 41 41 public static function willTakeAction( ··· 174 174 * Reset all action counts for actions taken by some set of actors in the 175 175 * previous action window. 176 176 * 177 177 - * @param list<string> Actors to reset counts for. 177 177 + * @param list<string> $actors Actors to reset counts for. 178 178 * @return int Number of actions cleared. 179 179 */ 180 180 public static function resetActions(array $actors) {

+21 -21

src/applications/transactions/editengine/PhabricatorEditEngine.php

reviewed

··· 343 343 * Set default placeholder plain text in the comment textarea of the engine. 344 344 * To be overwritten by conditions defined in the child EditEngine class. 345 345 * 346 346 - * @param object Object in which the comment textarea is displayed. 346 346 + * @param object $object Object in which the comment textarea is displayed. 347 347 * @return string Placeholder text to display in the comment textarea. 348 348 * @task text 349 349 */ ··· 678 678 * Initialize a new object for object creation via Conduit. 679 679 * 680 680 * @return object Newly initialized object. 681 681 - * @param list<wild> Raw transactions. 681 681 + * @param list<wild> $raw_xactions Raw transactions. 682 682 * @task load 683 683 */ 684 684 protected function newEditableObjectFromConduit(array $raw_xactions) { ··· 698 698 /** 699 699 * Flag this workflow as a create or edit. 700 700 * 701 701 - * @param bool True if this is a create workflow. 701 701 + * @param bool $is_create True if this is a create workflow. 702 702 * @return this 703 703 * @task load 704 704 */ ··· 712 712 * Try to load an object by ID, PHID, or monogram. This is done primarily 713 713 * to make Conduit a little easier to use. 714 714 * 715 715 - * @param wild ID, PHID, or monogram. 716 716 - * @param list<const> List of required capability constants, or omit for 717 717 - * defaults. 715 715 + * @param wild $identifier ID, PHID, or monogram. 716 716 + * @param list<const>? $capabilities List of required capability constants, 717 717 + * or omit for defaults. 718 718 * @return object Corresponding editable object. 719 719 * @task load 720 720 */ ··· 792 792 /** 793 793 * Load an object by ID. 794 794 * 795 795 - * @param int Object ID. 796 796 - * @param list<const> List of required capability constants, or omit for 797 797 - * defaults. 795 795 + * @param int $id Object ID. 796 796 + * @param list<const>? $capabilities List of required capability constants, 797 797 + * or omit for defaults. 798 798 * @return object|null Object, or null if no such object exists. 799 799 * @task load 800 800 */ ··· 809 809 /** 810 810 * Load an object by PHID. 811 811 * 812 812 - * @param phid Object PHID. 813 813 - * @param list<const> List of required capability constants, or omit for 814 814 - * defaults. 812 812 + * @param phid $phid Object PHID. 813 813 + * @param list<const>? $capabilities List of required capability constants, 814 814 + * or omit for defaults. 815 815 * @return object|null Object, or null if no such object exists. 816 816 * @task load 817 817 */ ··· 826 826 /** 827 827 * Load an object given a configured query. 828 828 * 829 829 - * @param PhabricatorPolicyAwareQuery Configured query. 830 830 - * @param list<const> List of required capability constants, or omit for 831 831 - * defaults. 829 829 + * @param PhabricatorPolicyAwareQuery $query Configured query. 830 830 + * @param list<const>? $capabilities List of required capability constants, 831 831 + * or omit for defaults. 832 832 * @return object|null Object, or null if no such object exists. 833 833 * @task load 834 834 */ ··· 860 860 /** 861 861 * Verify that an object is appropriate for editing. 862 862 * 863 863 - * @param wild Loaded value. 863 863 + * @param wild $object Loaded value. 864 864 * @return void 865 865 * @task load 866 866 */ ··· 1767 1767 /** 1768 1768 * Respond to a request for documentation on HTTP parameters. 1769 1769 * 1770 1770 - * @param object Editable object. 1770 1770 + * @param object $object Editable object. 1771 1771 * @return AphrontResponse Response object. 1772 1772 * @task http 1773 1773 */ ··· 2244 2244 * Generate transactions which can be applied from edit actions in a Conduit 2245 2245 * request. 2246 2246 * 2247 2247 - * @param ConduitAPIRequest The request. 2248 2248 - * @param list<wild> Raw conduit transactions. 2249 2249 - * @param list<PhabricatorEditType> Supported edit types. 2250 2250 - * @param PhabricatorApplicationTransaction Template transaction. 2247 2247 + * @param ConduitAPIRequest $request The request. 2248 2248 + * @param list<wild> $xactions Raw conduit transactions. 2249 2249 + * @param list<PhabricatorEditType> $types Supported edit types. 2250 2250 + * @param PhabricatorApplicationTransaction $template Template transaction. 2251 2251 * @return list<PhabricatorApplicationTransaction> Generated transactions. 2252 2252 * @task conduit 2253 2253 */

+2 -2

src/applications/transactions/editfield/PhabricatorEditField.php

reviewed

··· 573 573 * Most fields do not need to store these values or deal with initial value 574 574 * handling. 575 575 * 576 576 - * @param AphrontRequest Request to read from. 577 577 - * @param string Key to read. 576 576 + * @param AphrontRequest $request Request to read from. 577 577 + * @param string $key Key to read. 578 578 * @return wild Value read from request. 579 579 */ 580 580 protected function getInitialValueFromSubmit(AphrontRequest $request, $key) {

+20 -18

src/applications/transactions/editor/PhabricatorApplicationTransactionEditor.php

reviewed

··· 140 140 * nothing (e.g., empty comment with a status change that has already been 141 141 * performed by another user). 142 142 * 143 143 - * @param bool True to drop transactions without effect and continue. 143 143 + * @param bool $continue True to drop transactions without effect and 144 144 + * continue. 144 145 * @return this 145 146 */ 146 147 public function setContinueOnNoEffect($continue) { ··· 168 169 * (like the priority, batch, and merge editors in Maniphest), these 169 170 * operations can continue to function even if an object is outdated. 170 171 * 171 171 - * @param bool True to continue when transactions don't completely satisfy 172 172 - * all required fields. 172 172 + * @param bool $continue_on_missing_fields True to continue when transactions 173 173 + * don't completely satisfy all required fields. 173 174 * @return this 174 175 */ 175 176 public function setContinueOnMissingFields($continue_on_missing_fields) { ··· 2853 2854 * missing, by detecting that the object has no field value and there is no 2854 2855 * transaction which sets one. 2855 2856 * 2856 2856 - * @param PhabricatorLiskDAO Object being edited. 2857 2857 - * @param string Transaction type to validate. 2858 2858 - * @param list<PhabricatorApplicationTransaction> Transactions of given type, 2859 2859 - * which may be empty if the edit does not apply any transactions of the 2860 2860 - * given type. 2857 2857 + * @param PhabricatorLiskDAO $object Object being edited. 2858 2858 + * @param string $type Transaction type to validate. 2859 2859 + * @param list<PhabricatorApplicationTransaction> $xactions Transactions of 2860 2860 + * given type, which may be empty if the edit does not apply any 2861 2861 + * transactions of the given type. 2861 2862 * @return list<PhabricatorApplicationTransactionValidationError> List of 2862 2863 * validation errors. 2863 2864 */ ··· 3277 3278 * This will return `true` if the net effect of the object and transactions 3278 3279 * is an empty field. 3279 3280 * 3280 3280 - * @param wild Current field value. 3281 3281 - * @param list<PhabricatorApplicationTransaction> Transactions editing the 3282 3282 - * field. 3281 3281 + * @param wild $field_value Current field value. 3282 3282 + * @param list<PhabricatorApplicationTransaction> $xactions Transactions 3283 3283 + * editing the field. 3283 3284 * @return bool True if the field will be an empty text field after edits. 3284 3285 */ 3285 3286 protected function validateIsEmptyTextField($field_value, array $xactions) { ··· 4600 4601 * 4601 4602 * This method is used to load state when running worker operations. 4602 4603 * 4603 4603 - * @param dict<string, wild> Editor state, from @{method:getWorkerState}. 4604 4604 + * @param dict<string, wild> $state Editor state, from 4605 4605 + @{method:getWorkerState}. 4604 4606 * @return this 4605 4607 * @task workers 4606 4608 */ ··· 4626 4628 * Hook; set custom properties on the editor from data emitted by 4627 4629 * @{method:getCustomWorkerState}. 4628 4630 * 4629 4629 - * @param dict<string, wild> Custom state, 4631 4631 + * @param dict<string, wild> $state Custom state, 4630 4632 * from @{method:getCustomWorkerState}. 4631 4633 * @return this 4632 4634 * @task workers ··· 4674 4676 * 4675 4677 * See @{method:getCustomWorkerStateEncoding}. 4676 4678 * 4677 4677 - * @param map<string, wild> Map of values to encode. 4678 4678 - * @param map<string, string> Map of encodings to apply. 4679 4679 + * @param map<string, wild> $state Map of values to encode. 4680 4680 + * @param map<string, string> $encodings Map of encodings to apply. 4679 4681 * @return map<string, wild> Map of encoded values. 4680 4682 * @task workers 4681 4683 */ ··· 4720 4722 * 4721 4723 * See @{method:getCustomWorkerStateEncoding}. 4722 4724 * 4723 4723 - * @param map<string, wild> Map of encoded values. 4724 4724 - * @param map<string, string> Map of encodings. 4725 4725 + * @param map<string, wild> $state Map of encoded values. 4726 4726 + * @param map<string, string> $encodings Map of encodings. 4725 4727 * @return map<string, wild> Map of decoded values. 4726 4728 * @task workers 4727 4729 */ ··· 4759 4761 * If the list of PHIDs include mutually exclusive projects, remove the 4760 4762 * conflicting projects. 4761 4763 * 4762 4762 - * @param list<phid> List of project PHIDs. 4764 4764 + * @param list<phid> $phids List of project PHIDs. 4763 4765 * @return list<phid> List with conflicts removed. 4764 4766 */ 4765 4767 private function applyProjectConflictRules(array $phids) {

+1 -1

src/applications/transactions/storage/PhabricatorApplicationTransaction.php

reviewed

··· 1696 1696 * Should this transaction be visually grouped with an existing transaction 1697 1697 * group? 1698 1698 * 1699 1699 - * @param list<PhabricatorApplicationTransaction> List of transactions. 1699 1699 + * @param list<PhabricatorApplicationTransaction> $group List of transactions. 1700 1700 * @return bool True to display in a group with the other transactions. 1701 1701 */ 1702 1702 public function shouldDisplayGroupWith(array $group) {

+3 -2

src/applications/transactions/storage/PhabricatorModularTransactionType.php

reviewed

··· 428 428 * additional capability or policy requirement above and beyond CAN_EDIT, it 429 429 * is usually better implemented as a validation check. 430 430 * 431 431 - * @param object Object being edited. 432 432 - * @param PhabricatorApplicationTransaction Transaction being applied. 431 431 + * @param object $object Object being edited. 432 432 + * @param PhabricatorApplicationTransaction $xaction Transaction being 433 433 + * applied. 433 434 * @return null|const|list<const> A capability constant (or list of 434 435 * capability constants) which the actor must have on the object. You can 435 436 * return `null` as a shorthand for "no capabilities are required".

+1 -1

src/applications/typeahead/datasource/PhabricatorTypeaheadDatasource.php

reviewed

··· 212 212 * For datasources backed by database objects, this is often much less 213 213 * efficient than filtering at the query level. 214 214 * 215 215 - * @param list<PhabricatorTypeaheadResult> List of typeahead results. 215 215 + * @param list<PhabricatorTypeaheadResult> $results List of typeahead results. 216 216 * @return list<PhabricatorTypeaheadResult> Filtered results. 217 217 */ 218 218 protected function filterResultsAgainstTokens(array $results) {

+1 -1

src/infrastructure/cache/PhutilInRequestKeyValueCache.php

reviewed

··· 26 26 * When too many keys are inserted, the oldest keys are removed from the 27 27 * cache. Setting a limit of `0` disables the cache. 28 28 * 29 29 - * @param int Maximum number of items to store in the cache. 29 29 + * @param int $limit Maximum number of items to store in the cache. 30 30 * @return this 31 31 */ 32 32 public function setLimit($limit) {

+11 -11

src/infrastructure/cache/PhutilKeyValueCache.php

reviewed

··· 30 30 * Get a single key from cache. See @{method:getKeys} to get multiple keys at 31 31 * once. 32 32 * 33 33 - * @param string Key to retrieve. 34 34 - * @param wild Optional value to return if the key is not found. By 35 35 - * default, returns null. 33 33 + * @param string $key Key to retrieve. 34 34 + * @param wild? $default Optional value to return if the key is not 35 35 + * found. By default, returns null. 36 36 * @return wild Cache value (on cache hit) or default value (on cache 37 37 * miss). 38 38 * @task kvimpl ··· 49 49 * 50 50 * See @{method:setKeys} for a description of TTLs. 51 51 * 52 52 - * @param string Key to set. 53 53 - * @param wild Value to set. 54 54 - * @param int|null Optional TTL. 52 52 + * @param string $key Key to set. 53 53 + * @param wild $value Value to set. 54 54 + * @param int|null? $ttl Optional TTL. 55 55 * @return this 56 56 * @task kvimpl 57 57 */ ··· 64 64 * Delete a key from the cache. See @{method:deleteKeys} to delete multiple 65 65 * keys at once. 66 66 * 67 67 - * @param string Key to delete. 67 67 + * @param string $key Key to delete. 68 68 * @return this 69 69 * @task kvimpl 70 70 */ ··· 76 76 /** 77 77 * Get data from the cache. 78 78 * 79 79 - * @param list<string> List of cache keys to retrieve. 79 79 + * @param list<string> $keys List of cache keys to retrieve. 80 80 * @return dict<string, wild> Dictionary of keys that were found in the 81 81 * cache. Keys not present in the cache are 82 82 * omitted, so you can detect a cache miss. ··· 92 92 * after a specified number of seconds. By default, there is no expiration 93 93 * policy and data will persist in cache indefinitely. 94 94 * 95 95 - * @param dict<string, wild> Map of cache keys to values. 96 96 - * @param int|null TTL for cache keys, in seconds. 95 95 + * @param dict<string, wild> $keys Map of cache keys to values. 96 96 + * @param int|null? $ttl TTL for cache keys, in seconds. 97 97 * @return this 98 98 * @task kvimpl 99 99 */ ··· 103 103 /** 104 104 * Delete a list of keys from the cache. 105 105 * 106 106 - * @param list<string> List of keys to delete. 106 106 + * @param list<string> $keys List of keys to delete. 107 107 * @return this 108 108 * @task kvimpl 109 109 */

+1 -1

src/infrastructure/cache/PhutilKeyValueCacheProfiler.php

reviewed

··· 17 17 /** 18 18 * Set a profiler for cache operations. 19 19 * 20 20 - * @param PhutilServiceProfiler Service profiler. 20 20 + * @param PhutilServiceProfiler $profiler Service profiler. 21 21 * @return this 22 22 * @task kvimpl 23 23 */

+3 -2

src/infrastructure/cache/PhutilKeyValueCacheStack.php

reviewed

··· 38 38 /** 39 39 * Set the caches which comprise this stack. 40 40 * 41 41 - * @param list<PhutilKeyValueCache> Ordered list of key-value caches. 41 41 + * @param list<PhutilKeyValueCache> $caches Ordered list of key-value 42 42 + * caches. 42 43 * @return this 43 44 * @task config 44 45 */ ··· 62 63 * // TTL does not persist; this will use no TTL. 63 64 * $stack->getKey('hedgehog'); 64 65 * 65 65 - * @param int TTL in seconds. 66 66 + * @param int $ttl TTL in seconds. 66 67 * @return this 67 68 * 68 69 * @task config

+1 -1

src/infrastructure/cache/PhutilMemcacheKeyValueCache.php

reviewed

··· 100 100 * ), 101 101 * )); 102 102 * 103 103 - * @param list<dict> List of server specifications. 103 103 + * @param list<dict> $servers List of server specifications. 104 104 * @return this 105 105 * @task memcache 106 106 */

+4 -4

src/infrastructure/contentsource/PhabricatorContentSource.php

reviewed

··· 22 22 /** 23 23 * Construct a new content source object. 24 24 * 25 25 - * @param const The source type constant to build a source for. 26 26 - * @param array Source parameters. 27 27 - * @param bool True to suppress errors and force construction of a source 28 28 - * even if the source type is not valid. 25 25 + * @param const $source The source type constant to build a source for. 26 26 + * @param array? $params Source parameters. 27 27 + * @param bool? $force True to suppress errors and force construction of a 28 28 + * source even if the source type is not valid. 29 29 * @return PhabricatorContentSource New source object. 30 30 */ 31 31 final public static function newForSource(

+25 -20

src/infrastructure/customfield/field/PhabricatorCustomField.php

reviewed

··· 243 243 * For general implementations, the general field implementation can return 244 244 * multiple field instances here. 245 245 * 246 246 - * @param object The object to create fields for. 246 246 + * @param object $object The object to create fields for. 247 247 * @return list<PhabricatorCustomField> List of fields. 248 248 * @task core 249 249 */ ··· 382 382 * Set the proxy implementation for this field. See @{method:canSetProxy} for 383 383 * discussion of field proxies. 384 384 * 385 385 - * @param PhabricatorCustomField Field implementation. 385 385 + * @param PhabricatorCustomField $proxy Field implementation. 386 386 * @return this 387 387 * @task proxy 388 388 */ ··· 421 421 /** 422 422 * Sets the object this field belongs to. 423 423 * 424 424 - * @param PhabricatorCustomFieldInterface The object this field belongs to. 424 424 + * @param PhabricatorCustomFieldInterface $object The object this field 425 425 + * belongs to. 425 426 * @return this 426 427 * @task context 427 428 */ ··· 440 441 /** 441 442 * Read object data into local field storage, if applicable. 442 443 * 443 443 - * @param PhabricatorCustomFieldInterface The object this field belongs to. 444 444 + * @param PhabricatorCustomFieldInterface $object The object this field 445 445 + * belongs to. 444 446 * @return this 445 447 * @task context 446 448 */ ··· 607 609 * need to undo whatever serialization you applied in 608 610 * @{method:getValueForStorage}. 609 611 * 610 610 - * @param string|null Serialized field representation (from 612 612 + * @param string|null $value Serialized field representation (from 611 613 * @{method:getValueForStorage}) or null if no value has 612 614 * ever been stored. 613 615 * @return this ··· 729 731 /** 730 732 * Build and populate storage for a string index. 731 733 * 732 732 - * @param string String to index. 734 734 + * @param string $value String to index. 733 735 * @return PhabricatorCustomFieldStringIndexStorage Populated storage. 734 736 * @task appsearch 735 737 */ ··· 748 750 /** 749 751 * Build and populate storage for a numeric index. 750 752 * 751 751 - * @param string Numeric value to index. 753 753 + * @param string $value Numeric value to index. 752 754 * @return PhabricatorCustomFieldNumericIndexStorage Populated storage. 753 755 * @task appsearch 754 756 */ ··· 767 769 * Read a query value from a request, for storage in a saved query. Normally, 768 770 * this method should, e.g., read a string out of the request. 769 771 * 770 770 - * @param PhabricatorApplicationSearchEngine Engine building the query. 771 771 - * @param AphrontRequest Request to read from. 772 772 + * @param PhabricatorApplicationSearchEngine $engine Engine building the 773 773 + * query. 774 774 + * @param AphrontRequest $request Request to read from. 772 775 * @return wild 773 776 * @task appsearch 774 777 */ ··· 789 792 * use `with...()` methods to apply filters or other constraints to the 790 793 * query. 791 794 * 792 792 - * @param PhabricatorApplicationSearchEngine Engine executing the query. 793 793 - * @param PhabricatorCursorPagedPolicyAwareQuery Query to constrain. 794 794 - * @param wild Constraint provided by the user. 795 795 + * @param PhabricatorApplicationSearchEngine $engine Engine executing the 796 796 + * query. 797 797 + * @param PhabricatorCursorPagedPolicyAwareQuery $query Query to constrain. 798 798 + * @param wild $value Constraint provided by the user. 795 799 * @return void 796 800 * @task appsearch 797 801 */ ··· 812 816 /** 813 817 * Append search controls to the interface. 814 818 * 815 815 - * @param PhabricatorApplicationSearchEngine Engine constructing the form. 816 816 - * @param AphrontFormView The form to update. 817 817 - * @param wild Value from the saved query. 819 819 + * @param PhabricatorApplicationSearchEngine $engine Engine constructing the 820 820 + * form. 821 821 + * @param AphrontFormView $form The form to update. 822 822 + * @param wild $value Value from the saved query. 818 823 * @return void 819 824 * @task appsearch 820 825 */ ··· 1000 1005 * when a transaction would set a field to an invalid value, or when a field 1001 1006 * is required but no transactions provide value. 1002 1007 * 1003 1003 - * @param PhabricatorLiskDAO Editor applying the transactions. 1004 1004 - * @param string Transaction type. This type is always 1008 1008 + * @param PhabricatorLiskDAO $editor Editor applying the transactions. 1009 1009 + * @param string $type Transaction type. This type is always 1005 1010 * `PhabricatorTransactions::TYPE_CUSTOMFIELD`, it is provided for 1006 1011 * convenience when constructing exceptions. 1007 1007 - * @param list<PhabricatorApplicationTransaction> Transactions being applied, 1008 1008 - * which may be empty if this field is not being edited. 1012 1012 + * @param list<PhabricatorApplicationTransaction> $xactions Transactions 1013 1013 + * being applied, which may be empty if this field is not being edited. 1009 1014 * @return list<PhabricatorApplicationTransactionValidationError> Validation 1010 1015 * errors. 1011 1016 * ··· 1566 1571 /** 1567 1572 * Get the Herald value type for the given condition. 1568 1573 * 1569 1569 - * @param const Herald condition constant. 1574 1574 + * @param const $condition Herald condition constant. 1570 1575 * @return const|null Herald value type, or null to use the default. 1571 1576 * @task herald 1572 1577 */

+2 -1

src/infrastructure/customfield/field/PhabricatorCustomFieldList.php

reviewed

··· 46 46 /** 47 47 * Read stored values for all fields which support storage. 48 48 * 49 49 - * @param PhabricatorCustomFieldInterface Object to read field values for. 49 49 + * @param PhabricatorCustomFieldInterface $object Object to read field values 50 50 + * for. 50 51 * @return void 51 52 */ 52 53 public function readFieldsFromStorage(

+1 -1

src/infrastructure/customfield/storage/PhabricatorCustomFieldStorage.php

reviewed

··· 44 44 * The keys in the result should correspond to the keys in the input. The 45 45 * fields in the list may belong to different objects. 46 46 * 47 47 - * @param map<string, PhabricatorCustomField> Map of fields. 47 47 + * @param map<string, PhabricatorCustomField> $fields Map of fields. 48 48 * @return map<String, PhabricatorCustomField> Map of available field data. 49 49 */ 50 50 final public function loadStorageSourceData(array $fields) {

+1 -1

src/infrastructure/daemon/PhabricatorDaemon.php

reviewed

··· 24 24 * Format a command so it executes as the daemon user, if a daemon user is 25 25 * defined. This wraps the provided command in `sudo -u ...`, roughly. 26 26 * 27 27 - * @param PhutilCommandString Command to execute. 27 27 + * @param PhutilCommandString $command Command to execute. 28 28 * @return PhutilCommandString `sudo` version of the command. 29 29 */ 30 30 public static function sudoCommandAsDaemonUser($command) {

+2 -2

src/infrastructure/daemon/PhutilDaemonHandle.php

reviewed

··· 328 328 /** 329 329 * Dispatch an event to event listeners. 330 330 * 331 331 - * @param string Event type. 332 332 - * @param dict Event parameters. 331 331 + * @param string $type Event type. 332 332 + * @param dict? $params Event parameters. 333 333 * @return void 334 334 */ 335 335 private function dispatchEvent($type, array $params = array()) {

+2 -2

src/infrastructure/daemon/PhutilDaemonOverseerModule.php

reviewed

··· 47 47 * return; 48 48 * } 49 49 * 50 50 - * @param string Throttle key. 51 51 - * @param float Duration in seconds. 50 50 + * @param string $name Throttle key. 51 51 + * @param float $duration Duration in seconds. 52 52 * @return bool True to throttle the check. 53 53 */ 54 54 protected function shouldThrottle($name, $duration) {

+2 -2

src/infrastructure/daemon/workers/PhabricatorTriggerDaemon.php

reviewed

··· 122 122 * Process all of the triggers which have been updated since the last time 123 123 * the daemon ran, scheduling them into the event table. 124 124 * 125 125 - * @param int Cursor for the next version update to process. 125 125 + * @param int $cursor Cursor for the next version update to process. 126 126 * @return void 127 127 */ 128 128 private function scheduleTriggers($cursor) { ··· 326 326 /** 327 327 * Run the garbage collector for up to a specified number of seconds. 328 328 * 329 329 - * @param int Number of seconds the GC may run for. 329 329 + * @param int $duration Number of seconds the GC may run for. 330 330 * @return int Number of seconds remaining in the time budget. 331 331 * @task garbage 332 332 */

+11 -11

src/infrastructure/daemon/workers/PhabricatorWorker.php

reviewed

··· 68 68 * retrying. For most tasks you can leave this at `null`, which will give you 69 69 * a short default retry period (currently 60 seconds). 70 70 * 71 71 - * @param PhabricatorWorkerTask The task itself. This object is probably 72 72 - * useful mostly to examine the failure count 73 73 - * if you want to implement staggered retries, 74 74 - * or to examine the execution exception if 75 75 - * you want to react to different failures in 76 76 - * different ways. 71 71 + * @param PhabricatorWorkerTask $task The task itself. This object is 72 72 + * probably useful mostly to examine the 73 73 + * failure count if you want to implement 74 74 + * staggered retries, or to examine the 75 75 + * execution exception if you want to react to 76 76 + * different failures in different ways. 77 77 * @return int|null Number of seconds to wait between retries, 78 78 * or null for a default retry period 79 79 * (currently 60 seconds). ··· 230 230 * 231 231 * The followup task will be queued only if this task completes cleanly. 232 232 * 233 233 - * @param string Task class to queue. 234 234 - * @param array Data for the followup task. 235 235 - * @param array Options for the followup task. 233 233 + * @param string $class Task class to queue. 234 234 + * @param array $data Data for the followup task. 235 235 + * @param array? $options Options for the followup task. 236 236 * @return this 237 237 */ 238 238 final protected function queueTask( ··· 261 261 * this method to force the queue to flush before failing (for example, if 262 262 * you are using queues to improve locking behavior). 263 263 * 264 264 - * @param map<string, wild> Optional default options. 264 264 + * @param map<string, wild>? $defaults Optional default options. 265 265 */ 266 266 final public function flushTaskQueue($defaults = array()) { 267 267 foreach ($this->getQueuedTasks() as $task) { ··· 286 286 * This method does not provide any assurances about when these tasks will 287 287 * execute, or even guarantee that it will have any effect at all. 288 288 * 289 289 - * @param list<id> List of task IDs to try to awaken. 289 289 + * @param list<id> $ids List of task IDs to try to awaken. 290 290 * @return void 291 291 */ 292 292 final public static function awakenTaskIDs(array $ids) {

+5 -5

src/infrastructure/daemon/workers/action/PhabricatorTriggerAction.php

reviewed

··· 28 28 /** 29 29 * Validate action configuration. 30 30 * 31 31 - * @param map<string, wild> Map of action properties. 31 31 + * @param map<string, wild> $properties Map of action properties. 32 32 * @return void 33 33 */ 34 34 abstract public function validateProperties(array $properties); ··· 62 62 * may be simplest to pass the trigger time to the task and then make the 63 63 * decision to discard the action there. 64 64 * 65 65 - * @param int|null Last time the event occurred, or null if it has never 66 66 - * triggered before. 67 67 - * @param int The scheduled time for the current action. This may be 68 68 - * significantly different from the current time. 65 65 + * @param int|null $last_epoch Last time the event occurred, or null if it 66 66 + * has never triggered before. 67 67 + * @param int $this_epoch The scheduled time for the current action. This 68 68 + * may be significantly different from the current time. 69 69 * @return void 70 70 */ 71 71 abstract public function execute($last_epoch, $this_epoch);

+5 -4

src/infrastructure/daemon/workers/clock/PhabricatorTriggerClock.php

reviewed

··· 32 32 /** 33 33 * Validate clock configuration. 34 34 * 35 35 - * @param map<string, wild> Map of clock properties. 35 35 + * @param map<string, wild> $properties Map of clock properties. 36 36 * @return void 37 37 */ 38 38 abstract public function validateProperties(array $properties); ··· 64 64 * week to 3 minutes from now, the clock may reschedule the notification to 65 65 * occur 12 minutes ago. This will cause it to execute immediately. 66 66 * 67 67 - * @param int|null Last time the event occurred, or null if it has never 68 68 - * triggered before. 69 69 - * @param bool True if this is a reschedule after a successful trigger. 67 67 + * @param int|null $last_epoch Last time the event occurred, or null if it 68 68 + * has never triggered before. 69 69 + * @param bool $is_reschedule True if this is a reschedule after a successful 70 70 + * trigger. 70 71 * @return int|null Next event, or null to decline to reschedule. 71 72 */ 72 73 abstract public function getNextEventEpoch($last_epoch, $is_reschedule);

+3 -3

src/infrastructure/daemon/workers/query/PhabricatorWorkerLeaseQuery.php

reviewed

··· 30 30 * This can be used to show which tasks are coming up next without altering 31 31 * the queue's behavior. 32 32 * 33 33 - * @param bool True to skip the lease acquisition step. 33 33 + * @param bool $skip True to skip the lease acquisition step. 34 34 */ 35 35 public function setSkipLease($skip) { 36 36 $this->skipLease = $skip; ··· 58 58 * leasing using @{method:setSkipLease}. These options are intended for use 59 59 * when displaying task status information. 60 60 * 61 61 - * @param mixed `true` to select only leased tasks, `false` to select only 62 62 - * unleased tasks (default), or `null` to select both. 61 61 + * @param mixed $leased `true` to select only leased tasks, `false` to select 62 62 + * only unleased tasks (default), or `null` to select both. 63 63 * @return this 64 64 */ 65 65 public function withLeasedTasks($leased) {

+1 -1

src/infrastructure/daemon/workers/query/PhabricatorWorkerTriggerQuery.php

reviewed

··· 59 59 * triggers which have been scheduled to execute. You should not use this 60 60 * ordering when querying for specific triggers, e.g. by ID or PHID. 61 61 * 62 62 - * @param const Result order. 62 62 + * @param const $order Result order. 63 63 * @return this 64 64 */ 65 65 public function setOrder($order) {

+8 -7

src/infrastructure/daemon/workers/storage/PhabricatorWorkerTrigger.php

reviewed

··· 67 67 * is changed (usually because of an application edit). The `$is_reschedule` 68 68 * parameter distinguishes between these cases. 69 69 * 70 70 - * @param int|null Epoch of the most recent successful event execution. 71 71 - * @param bool `true` if we're trying to reschedule the event after 72 72 - * execution; `false` if this is in response to a trigger update. 70 70 + * @param int|null $last_epoch Epoch of the most recent successful event 71 71 + * execution. 72 72 + * @param bool $is_reschedule `true` if we're trying to reschedule the event 73 73 + * after execution; `false` if this is in response to a trigger update. 73 74 * @return int|null Return an epoch to schedule the next event execution, 74 75 * or `null` to stop the event from executing again. 75 76 */ ··· 81 82 /** 82 83 * Execute the event. 83 84 * 84 84 - * @param int|null Epoch of previous execution, or null if this is the first 85 85 - * execution. 86 86 - * @param int Scheduled epoch of this execution. This may not be the same 87 87 - * as the current time. 85 85 + * @param int|null $last_event Epoch of previous execution, or null if this 86 86 + * is the first execution. 87 87 + * @param int $this_event Scheduled epoch of this execution. This may not be 88 88 + * the same as the current time. 88 89 * @return void 89 90 */ 90 91 public function executeTrigger($last_event, $this_event) {

+6 -6

src/infrastructure/diff/PhabricatorDifferenceEngine.php

reviewed

··· 21 21 /** 22 22 * Set the name to identify the old file with. Primarily cosmetic. 23 23 * 24 24 - * @param string Old file name. 24 24 + * @param string $old_name Old file name. 25 25 * @return this 26 26 * @task config 27 27 */ ··· 34 34 /** 35 35 * Set the name to identify the new file with. Primarily cosmetic. 36 36 * 37 37 - * @param string New file name. 37 37 + * @param string $new_name New file name. 38 38 * @return this 39 39 * @task config 40 40 */ ··· 62 62 * @{method:generateChangesetFromFileContent}, but may be useful if you need 63 63 * to use a custom parser configuration, as with Diffusion. 64 64 * 65 65 - * @param string Entire previous file content. 66 66 - * @param string Entire current file content. 65 65 + * @param string $old Entire previous file content. 66 66 + * @param string $new Entire current file content. 67 67 * @return string Raw diff between the two files. 68 68 * @task diff 69 69 */ ··· 132 132 * principally useful because you can feed the output to 133 133 * @{class:DifferentialChangesetParser} in order to render it. 134 134 * 135 135 - * @param string Entire previous file content. 136 136 - * @param string Entire current file content. 135 135 + * @param string $old Entire previous file content. 136 136 + * @param string $new Entire current file content. 137 137 * @return @{class:DifferentialChangeset} Synthetic changeset. 138 138 * @task diff 139 139 */

+7 -7

src/infrastructure/edges/editor/PhabricatorEdgeEditor.php

reviewed

··· 45 45 * - `inverse_data` Optional, data to write on the inverse edge. If not 46 46 * provided, `data` will be written. 47 47 * 48 48 - * @param phid Source object PHID. 49 49 - * @param const Edge type constant. 50 50 - * @param phid Destination object PHID. 51 51 - * @param map Options map (see documentation). 48 48 + * @param phid $src Source object PHID. 49 49 + * @param const $type Edge type constant. 50 50 + * @param phid $dst Destination object PHID. 51 51 + * @param map? $options Options map (see documentation). 52 52 * @return this 53 53 * 54 54 * @task edit ··· 67 67 * will be ignored. Edges are added after edges are removed, so the effect of 68 68 * a remove plus an add is to overwrite. 69 69 * 70 70 - * @param phid Source object PHID. 71 71 - * @param const Edge type constant. 72 72 - * @param phid Destination object PHID. 70 70 + * @param phid $src Source object PHID. 71 71 + * @param const $type Edge type constant. 72 72 + * @param phid $dst Destination object PHID. 73 73 * @return this 74 74 * 75 75 * @task edit

+12 -12

src/infrastructure/edges/query/PhabricatorEdgeQuery.php

reviewed

··· 40 40 * Find edges originating at one or more source PHIDs. You MUST provide this 41 41 * to execute an edge query. 42 42 * 43 43 - * @param list List of source PHIDs. 43 43 + * @param list $source_phids List of source PHIDs. 44 44 * @return this 45 45 * 46 46 * @task config ··· 61 61 /** 62 62 * Find edges terminating at one or more destination PHIDs. 63 63 * 64 64 - * @param list List of destination PHIDs. 64 64 + * @param list $dest_phids List of destination PHIDs. 65 65 * @return this 66 66 * 67 67 */ ··· 74 74 /** 75 75 * Find edges of specific types. 76 76 * 77 77 - * @param list List of PhabricatorEdgeConfig type constants. 77 77 + * @param list $types List of PhabricatorEdgeConfig type constants. 78 78 * @return this 79 79 * 80 80 * @task config ··· 88 88 /** 89 89 * Configure the order edge results are returned in. 90 90 * 91 91 - * @param const Order constant. 91 91 + * @param const $order Order constant. 92 92 * @return this 93 93 * 94 94 * @task config ··· 102 102 /** 103 103 * When loading edges, also load edge data. 104 104 * 105 105 - * @param bool True to load edge data. 105 105 + * @param bool $need True to load edge data. 106 106 * @return this 107 107 * 108 108 * @task config ··· 121 121 * edge type. Equivalent to building a full query, but simplifies a common 122 122 * use case. 123 123 * 124 124 - * @param phid Source PHID. 125 125 - * @param const Edge type. 124 124 + * @param phid $src_phid Source PHID. 125 125 + * @param const $edge_type Edge type. 126 126 * @return list<phid> List of destination PHIDs. 127 127 */ 128 128 public static function loadDestinationPHIDs($src_phid, $edge_type) { ··· 139 139 * if the edge does not exist or does not have metadata. Builds 140 140 * and immediately executes a full query. 141 141 * 142 142 - * @param phid Source PHID. 143 143 - * @param const Edge type. 144 144 - * @param phid Destination PHID. 142 142 + * @param phid $src_phid Source PHID. 143 143 + * @param const $edge_type Edge type. 144 144 + * @param phid $dest_phid Destination PHID. 145 145 * @return wild Edge annotation (or null). 146 146 */ 147 147 public static function loadSingleEdgeData($src_phid, $edge_type, $dest_phid) { ··· 256 256 * $object->attachHandles(array_select_keys($handles, $dst_phids)); 257 257 * } 258 258 * 259 259 - * @param list? List of PHIDs to select, or empty to select all. 260 260 - * @param list? List of edge types to select, or empty to select all. 259 259 + * @param list? $src_phids List of PHIDs to select, or empty to select all. 260 260 + * @param list? $types List of edge types to select, or empty to select all. 261 261 * @return list<phid> List of matching destination PHIDs. 262 262 */ 263 263 public function getDestinationPHIDs(

+9 -9

src/infrastructure/env/PhabricatorEnv.php

reviewed

··· 638 638 * NOTE: This method is generally intended to reject URIs which it may be 639 639 * unsafe to put in an "href" link attribute. 640 640 * 641 641 - * @param string URI to test. 641 641 + * @param string $uri URI to test. 642 642 * @return bool True if the URI identifies a web resource. 643 643 * @task uri 644 644 */ ··· 654 654 * NOTE: This method is generally intended to reject URIs which it may be 655 655 * unsafe to issue a "Location:" redirect to. 656 656 * 657 657 - * @param string URI to test. 657 657 + * @param string $uri URI to test. 658 658 * @return bool True if the URI identifies a local page. 659 659 * @task uri 660 660 */ ··· 696 696 /** 697 697 * Detect if a URI identifies some valid linkable remote resource. 698 698 * 699 699 - * @param string URI to test. 699 699 + * @param string $uri URI to test. 700 700 * @return bool True if a URI identifies a remote resource with an allowed 701 701 * protocol. 702 702 * @task uri ··· 718 718 * A valid linkable remote resource can be safely linked or redirected to. 719 719 * This is primarily a protocol whitelist check. 720 720 * 721 721 - * @param string URI to test. 721 721 + * @param string $raw_uri URI to test. 722 722 * @return void 723 723 * @task uri 724 724 */ ··· 758 758 /** 759 759 * Detect if a URI identifies a valid fetchable remote resource. 760 760 * 761 761 - * @param string URI to test. 762 762 - * @param list<string> Allowed protocols. 761 761 + * @param string $uri URI to test. 762 762 + * @param list<string> $protocols Allowed protocols. 763 763 * @return bool True if the URI is a valid fetchable remote resource. 764 764 * @task uri 765 765 */ ··· 781 781 * originating on this server. This is a primarily an address check against 782 782 * the outbound address blacklist. 783 783 * 784 784 - * @param string URI to test. 785 785 - * @param list<string> Allowed protocols. 784 784 + * @param string $raw_uri URI to test. 785 785 + * @param list<string> $protocols Allowed protocols. 786 786 * @return pair<string, string> Pre-resolved URI and domain. 787 787 * @task uri 788 788 */ ··· 853 853 /** 854 854 * Determine if an IP address is in the outbound address blacklist. 855 855 * 856 856 - * @param string IP address. 856 856 + * @param string $address IP address. 857 857 * @return bool True if the address is blacklisted. 858 858 */ 859 859 public static function isBlacklistedOutboundAddress($address) {

+2 -2

src/infrastructure/env/PhabricatorScopedEnv.php

reviewed

··· 17 17 /** 18 18 * Override a configuration key in this scope, setting it to a new value. 19 19 * 20 20 - * @param string Key to override. 21 21 - * @param wild New value. 20 20 + * @param string $key Key to override. 21 21 + * @param wild $value New value. 22 22 * @return this 23 23 * 24 24 * @task override

+17 -15

src/infrastructure/markup/PhabricatorMarkupEngine.php

reviewed

··· 56 56 * Convenience method for pushing a single object through the markup 57 57 * pipeline. 58 58 * 59 59 - * @param PhabricatorMarkupInterface The object to render. 60 60 - * @param string The field to render. 61 61 - * @param PhabricatorUser User viewing the markup. 62 62 - * @param object A context object for policy checks 59 59 + * @param PhabricatorMarkupInterface $object The object to render. 60 60 + * @param string $field The field to render. 61 61 + * @param PhabricatorUser $viewer User viewing the markup. 62 62 + * @param object? $context_object A context object for 63 63 + * policy checks. 63 64 * @return string Marked up output. 64 65 * @task markup 65 66 */ ··· 81 82 * Queue an object for markup generation when @{method:process} is 82 83 * called. You can retrieve the output later with @{method:getOutput}. 83 84 * 84 84 - * @param PhabricatorMarkupInterface The object to render. 85 85 - * @param string The field to render. 85 85 + * @param PhabricatorMarkupInterface $object The object to render. 86 86 + * @param string $field The field to render. 86 87 * @return this 87 88 * @task markup 88 89 */ ··· 175 176 * @{method:addObject}. Before you can call this method, you must call 176 177 * @{method:process}. 177 178 * 178 178 - * @param PhabricatorMarkupInterface The object to retrieve. 179 179 - * @param string The field to retrieve. 179 179 + * @param PhabricatorMarkupInterface $object The object to retrieve. 180 180 + * @param string $field The field to retrieve. 180 181 * @return string Processed output. 181 182 * @task markup 182 183 */ ··· 191 192 /** 192 193 * Retrieve engine metadata for a given field. 193 194 * 194 194 - * @param PhabricatorMarkupInterface The object to retrieve. 195 195 - * @param string The field to retrieve. 196 196 - * @param string The engine metadata field to retrieve. 197 197 - * @param wild Optional default value. 195 195 + * @param PhabricatorMarkupInterface $object The object to retrieve. 196 196 + * @param string $field The field to retrieve. 197 197 + * @param string $metadata_key The engine metadata field 198 198 + * to retrieve. 199 199 + * @param wild? $default Optional default value. 198 200 * @task markup 199 201 */ 200 202 public function getEngineMetadata( ··· 316 318 /** 317 319 * Set the viewing user. Used to implement object permissions. 318 320 * 319 319 - * @param PhabricatorUser The viewing user. 321 321 + * @param PhabricatorUser $viewer The viewing user. 320 322 * @return this 321 323 * @task markup 322 324 */ ··· 328 330 /** 329 331 * Set the context object. Used to implement object permissions. 330 332 * 331 331 - * @param The object in which context this remarkup is used. 333 333 + * @param $object The object in which context this remarkup is used. 332 334 * @return this 333 335 * @task markup 334 336 */ ··· 670 672 * 671 673 * TODO: We could do a better job of this. 672 674 * 673 673 - * @param string Remarkup corpus to summarize. 675 675 + * @param string $corpus Remarkup corpus to summarize. 674 676 * @return string Summarized corpus. 675 677 */ 676 678 public static function summarize($corpus) {

+6 -6

src/infrastructure/markup/PhabricatorMarkupInterface.php

reviewed

··· 28 28 * 29 29 * "{$phid}:{$field}" 30 30 * 31 31 - * @param string Field name. 31 31 + * @param string $field Field name. 32 32 * @return string Cache key up to 125 characters. 33 33 * 34 34 * @task markup ··· 39 39 /** 40 40 * Build the engine the field should use. 41 41 * 42 42 - * @param string Field name. 42 42 + * @param string $field Field name. 43 43 * @return PhutilRemarkupEngine Markup engine to use. 44 44 * @task markup 45 45 */ ··· 49 49 /** 50 50 * Return the contents of the specified field. 51 51 * 52 52 - * @param string Field name. 52 52 + * @param string $field Field name. 53 53 * @return string The raw markup contained in the field. 54 54 * @task markup 55 55 */ ··· 60 60 * Callback for final postprocessing of output. Normally, you can return 61 61 * the output unmodified. 62 62 * 63 63 - * @param string Field name. 64 64 - * @param string The finalized output of the engine. 65 65 - * @param string The engine which generated the output. 63 63 + * @param string $field Field name. 64 64 + * @param string $output The finalized output of the engine. 65 65 + * @param string $engine The engine which generated the output. 66 66 * @return string Final output. 67 67 * @task markup 68 68 */

+5 -4

src/infrastructure/markup/PhutilMarkupEngine.php

reviewed

··· 8 8 * documentation for specific rules and blocks for what options are available 9 9 * for configuration. 10 10 * 11 11 - * @param string Key to set in the configuration dictionary. 12 12 - * @param string Value to set. 11 11 + * @param string $key Key to set in the configuration dictionary. 12 12 + * @param string $value Value to set. 13 13 * @return this 14 14 */ 15 15 abstract public function setConfig($key, $value); ··· 21 21 * text; consult the documentation for specific rules and blocks to see what 22 22 * metadata may be available in your configuration. 23 23 * 24 24 - * @param string Key to retrieve from metadata. 25 25 - * @param mixed Default value to return if the key is not available. 24 24 + * @param string $key Key to retrieve from metadata. 25 25 + * @param mixed? $default Default value to return if the key is not 26 26 + * available. 26 27 * @return mixed Metadata property, or default value. 27 28 */ 28 29 abstract public function getTextMetadata($key, $default = null);

+1 -1

src/infrastructure/markup/blockrule/PhutilRemarkupCodeBlockRule.php

reviewed

··· 350 350 351 351 /** 352 352 * Get the extension from a filename. 353 353 - * @param string "/path/to/something.name" 353 353 + * @param string $name "/path/to/something.name" 354 354 * @return null|string ".name" 355 355 */ 356 356 private function guessFilenameExtension($name) {

+8 -7

src/infrastructure/markup/markuprule/PhutilRemarkupRule.php

reviewed

··· 20 20 21 21 /** 22 22 * Check input whether to apply RemarkupRule. If true, apply formatting. 23 23 - * @param string|PhutilSafeHTML String to check and potentially format. 23 23 + * @param string|PhutilSafeHTML $text String to check and potentially 24 24 + * format. 24 25 * @return string|PhutilSafeHTML Unchanged input if no match, or input after 25 25 - * matching the formatting rule and applying the formatting. 26 26 + * matching the formatting rule and applying the formatting. 26 27 */ 27 28 abstract public function apply($text); 28 29 ··· 59 60 * This method acts as @{function:phutil_tag}, but checks attributes before 60 61 * using them. 61 62 * 62 62 - * @param string Tag name. 63 63 - * @param dict<string, wild> Tag attributes. 64 64 - * @param wild Tag content. 63 63 + * @param string $name Tag name. 64 64 + * @param dict<string, wild> $attrs Tag attributes. 65 65 + * @param wild? $content Tag content. 65 66 * @return PhutilSafeHTML Tag object. 66 67 */ 67 68 protected function newTag($name, array $attrs, $content = null) { ··· 85 86 * Normally, you can call @{method:newTag} rather than calling this method 86 87 * directly. @{method:newTag} will check attributes for you. 87 88 * 88 88 - * @param wild Ostensibly flat text. 89 89 + * @param wild $text Ostensibly flat text. 89 90 * @return string Flat text. 90 91 */ 91 92 protected function assertFlatText($text) { ··· 104 105 /** 105 106 * Check whether text is flat (contains no replacement tokens) or not. 106 107 * 107 107 - * @param wild Ostensibly flat text. 108 108 + * @param wild $text Ostensibly flat text. 108 109 * @return bool True if the text is flat. 109 110 */ 110 111 protected function isFlatText($text) {

+3 -3

src/infrastructure/markup/render.php

reviewed

··· 16 16 * trusted blindly, and not escaped. You should not pass user data in these 17 17 * parameters. 18 18 * 19 19 - * @param string The name of the tag, like `a` or `div`. 20 20 - * @param map<string, string> A map of tag attributes. 21 21 - * @param wild Content to put in the tag. 19 19 + * @param string $tag The name of the tag, like `a` or `div`. 20 20 + * @param map<string, string>? $attributes A map of tag attributes. 21 21 + * @param wild? $content Content to put in the tag. 22 22 * @return PhutilSafeHTML Tag object. 23 23 */ 24 24 function phutil_tag($tag, array $attributes = array(), $content = null) {

+1 -1

src/infrastructure/markup/rule/PhabricatorObjectRemarkupRule.php

reviewed

··· 258 258 * This is intended to make it easy to write unit tests for object remarkup 259 259 * rules. Production code is not normally expected to call this method. 260 260 * 261 261 - * @param string Text to match rules against. 261 261 + * @param string $text Text to match rules against. 262 262 * @return wild Matches, suitable for writing unit tests against. 263 263 */ 264 264 public function extractReferences($text) {

+1 -1

src/infrastructure/parser/PhutilURIHelper.php

reviewed

··· 19 19 private $phutilUri; 20 20 21 21 /** 22 22 - * @param string|PhutilURI 22 22 + * @param string|PhutilURI $uri 23 23 */ 24 24 public function __construct($uri) { 25 25

+24 -20

src/infrastructure/query/policy/PhabricatorCursorPagedPolicyAwareQuery.php

reviewed

··· 718 718 * 719 719 * This method will then return a composable clause for inclusion in WHERE. 720 720 * 721 721 - * @param AphrontDatabaseConnection Connection query will execute on. 722 722 - * @param list<map> Column description dictionaries. 723 723 - * @param map Additional construction options. 721 721 + * @param AphrontDatabaseConnection $conn Connection query will execute on. 722 722 + * @param list<map> $columns Column description dictionaries. 723 723 + * @param map $options Additional construction options. 724 724 * @return string Query clause. 725 725 * @task paging 726 726 */ ··· 884 884 * across individual orderable columns. This offers greater control but is 885 885 * also more involved. 886 886 * 887 887 - * @param string Key of a builtin order supported by this query. 887 887 + * @param string $order Key of a builtin order supported by this query. 888 888 * @return this 889 889 * @task order 890 890 */ ··· 917 917 * This is a high-level method which works alongside @{method:setOrder}. For 918 918 * lower-level control over order vectors, use @{method:setOrderVector}. 919 919 * 920 920 - * @param PhabricatorQueryOrderVector|list<string> List of order keys. 920 920 + * @param PhabricatorQueryOrderVector|list<string> $vector List of order 921 921 + * keys. 921 922 * @return this 922 923 * @task order 923 924 */ ··· 1041 1042 * To set an order vector, specify a list of order keys as provided by 1042 1043 * @{method:getOrderableColumns}. 1043 1044 * 1044 1044 - * @param PhabricatorQueryOrderVector|list<string> List of order keys. 1045 1045 + * @param PhabricatorQueryOrderVector|list<string> $vector List of order 1046 1046 + * keys. 1045 1047 * @return this 1046 1048 * @task order 1047 1049 */ ··· 1353 1355 * - Find users with shirt sizes "X" or "XL". 1354 1356 * - Find shoes with size "13". 1355 1357 * 1356 1356 - * @param PhabricatorCustomFieldIndexStorage Table where the index is stored. 1357 1357 - * @param string|list<string> One or more values to filter by. 1358 1358 + * @param PhabricatorCustomFieldIndexStorage $index Table where the index is 1359 1359 + * stored. 1360 1360 + * @param string|list<string> $value One or more values to filter by. 1358 1361 * @return this 1359 1362 * @task appsearch 1360 1363 */ ··· 1403 1406 * `5` will match fields with values `3`, `4`, or `5`. Providing `null` for 1404 1407 * either end of the range will leave that end of the constraint open. 1405 1408 * 1406 1406 - * @param PhabricatorCustomFieldIndexStorage Table where the index is stored. 1407 1407 - * @param int|null Minimum permissible value, inclusive. 1408 1408 - * @param int|null Maximum permissible value, inclusive. 1409 1409 + * @param PhabricatorCustomFieldIndexStorage $index Table where the index is 1410 1410 + * stored. 1411 1411 + * @param int|null $min Minimum permissible value, inclusive. 1412 1412 + * @param int|null $max Maximum permissible value, inclusive. 1409 1413 * @return this 1410 1414 * @task appsearch 1411 1415 */ ··· 1449 1453 * See @{method:getPrimaryTableAlias} if the column needs to be qualified with 1450 1454 * a table alias. 1451 1455 * 1452 1452 - * @param AphrontDatabaseConnection Connection executing queries. 1456 1456 + * @param AphrontDatabaseConnection $conn Connection executing queries. 1453 1457 * @return PhutilQueryString Column name. 1454 1458 * @task appsearch 1455 1459 */ ··· 1509 1513 /** 1510 1514 * Construct a GROUP BY clause appropriate for ApplicationSearch constraints. 1511 1515 * 1512 1512 - * @param AphrontDatabaseConnection Connection executing the query. 1516 1516 + * @param AphrontDatabaseConnection $conn Connection executing the query. 1513 1517 * @return string Group clause. 1514 1518 * @task appsearch 1515 1519 */ ··· 1531 1535 * Construct a JOIN clause appropriate for applying ApplicationSearch 1532 1536 * constraints. 1533 1537 * 1534 1534 - * @param AphrontDatabaseConnection Connection executing the query. 1538 1538 + * @param AphrontDatabaseConnection $conn Connection executing the query. 1535 1539 * @return string Join clause. 1536 1540 * @task appsearch 1537 1541 */ ··· 1653 1657 * Construct a WHERE clause appropriate for applying ApplicationSearch 1654 1658 * constraints. 1655 1659 * 1656 1656 - * @param AphrontDatabaseConnection Connection executing the query. 1660 1660 + * @param AphrontDatabaseConnection $conn Connection executing the query. 1657 1661 * @return list<string> Where clause parts. 1658 1662 * @task appsearch 1659 1663 */ ··· 2583 2587 * Convenience method for specifying edge logic constraints with a list of 2584 2588 * PHIDs. 2585 2589 * 2586 2586 - * @param const Edge constant. 2587 2587 - * @param const Constraint operator. 2588 2588 - * @param list<phid> List of PHIDs. 2590 2590 + * @param const $edge_type Edge constant. 2591 2591 + * @param const $operator Constraint operator. 2592 2592 + * @param list<phid> $phids List of PHIDs. 2589 2593 * @return this 2590 2594 * @task edgelogic 2591 2595 */ ··· 3091 3095 * Queries are always constrained to include only results from spaces the 3092 3096 * viewer has access to. 3093 3097 * 3094 3094 - * @param list<phid|null> 3098 3098 + * @param list<phid|null> $space_phids 3095 3099 * @task spaces 3096 3100 */ 3097 3101 public function withSpacePHIDs(array $space_phids) { ··· 3135 3139 * viewer has access to see with any explicit constraint on spaces added by 3136 3140 * @{method:withSpacePHIDs}. 3137 3141 * 3138 3138 - * @param AphrontDatabaseConnection Database connection. 3142 3142 + * @param AphrontDatabaseConnection $conn Database connection. 3139 3143 * @return string Part of a WHERE clause. 3140 3144 * @task spaces 3141 3145 */

+11 -11

src/infrastructure/query/policy/PhabricatorPolicyAwareQuery.php

reviewed

··· 57 57 * according to the viewer's capabilities. You must set a viewer to execute 58 58 * a policy query. 59 59 * 60 60 - * @param PhabricatorUser The viewing user. 60 60 + * @param PhabricatorUser $viewer The viewing user. 61 61 * @return this 62 62 * @task config 63 63 */ ··· 473 473 * automatically populated as a side effect of objects surviving policy 474 474 * filtering. 475 475 * 476 476 - * @param map<phid, PhabricatorPolicyInterface> Objects to add to the query 477 477 - * workspace. 476 476 + * @param map<phid, PhabricatorPolicyInterface> $objects Objects to add to 477 477 + * the query workspace. 478 478 * @return this 479 479 * @task workspace 480 480 */ ··· 506 506 * searches both the current query's workspace and the workspaces of parent 507 507 * queries. 508 508 * 509 509 - * @param list<phid> List of PHIDs to retrieve. 509 509 + * @param list<phid> $phids List of PHIDs to retrieve. 510 510 * @return this 511 511 * @task workspace 512 512 */ ··· 536 536 * PHIDs which are "in flight" are actively being queried for. Using this 537 537 * list can prevent infinite query loops by aborting queries which cycle. 538 538 * 539 539 - * @param list<phid> List of PHIDs which are now in flight. 539 539 + * @param list<phid> $phids List of PHIDs which are now in flight. 540 540 * @return this 541 541 */ 542 542 public function putPHIDsInFlight(array $phids) { ··· 606 606 * return new results. Generally, you should adjust a cursor position based 607 607 * on the provided result page. 608 608 * 609 609 - * @param list<PhabricatorPolicyInterface> The current page of results. 609 609 + * @param list<PhabricatorPolicyInterface> $page The current page of results. 610 610 * @return void 611 611 * @task policyimpl 612 612 */ ··· 627 627 * This method will only be called if data is available. Implementations 628 628 * do not need to handle the case of no results specially. 629 629 * 630 630 - * @param list<wild> Results from `loadPage()`. 630 630 + * @param list<wild> $page Results from `loadPage()`. 631 631 * @return list<PhabricatorPolicyInterface> Objects for policy filtering. 632 632 * @task policyimpl 633 633 */ ··· 650 650 * This method will only be called if data is available. Implementations do 651 651 * not need to handle the case of no results specially. 652 652 * 653 653 - * @param list<wild> Results from @{method:willFilterPage()}. 653 653 + * @param list<wild> $page Results from @{method:willFilterPage()}. 654 654 * @return list<PhabricatorPolicyInterface> Objects after additional 655 655 * non-policy processing. 656 656 */ ··· 665 665 * filtered for policy reasons. The query should remove them from any cached 666 666 * or partial result sets. 667 667 * 668 668 - * @param list<wild> List of objects that should not be returned by alternate 669 669 - * result mechanisms. 668 668 + * @param list<wild> $results List of objects that should not be returned by 669 669 + * alternate result mechanisms. 670 670 * @return void 671 671 * @task policyimpl 672 672 */ ··· 680 680 * used by @{class:PhabricatorCursorPagedPolicyAwareQuery} to reverse results 681 681 * that are queried during reverse paging. 682 682 * 683 683 - * @param list<PhabricatorPolicyInterface> Query results. 683 683 + * @param list<PhabricatorPolicyInterface> $results Query results. 684 684 * @return list<PhabricatorPolicyInterface> Final results. 685 685 * @task policyimpl 686 686 */

+43 -33

src/infrastructure/storage/lisk/LiskDAO.php

reviewed

··· 221 221 * return a new connection. Lisk handles connection caching and management; 222 222 * do not perform caching deeper in the stack. 223 223 * 224 224 - * @param string Mode, either 'r' (reading) or 'w' (reading and writing). 224 224 + * @param string $mode Mode, either 'r' (reading) or 'w' (reading and 225 225 + * writing). 225 226 * @return AphrontDatabaseConnection New database connection. 226 227 * @task conn 227 228 */ ··· 245 246 /** 246 247 * Get an existing, cached connection for this object. 247 248 * 248 248 - * @param mode Connection mode. 249 249 + * @param mode $mode Connection mode. 249 250 * @return AphrontDatabaseConnection|null Connection, if it exists in cache. 250 251 * @task conn 251 252 */ ··· 261 262 /** 262 263 * Store a connection in the connection cache. 263 264 * 264 264 - * @param mode Connection mode. 265 265 - * @param AphrontDatabaseConnection Connection to cache. 265 265 + * @param mode $mode Connection mode. 266 266 + * @param AphrontDatabaseConnection $connection Connection to cache. 267 267 + * @param bool? $force_unique 266 268 * @return this 267 269 * @task conn 268 270 */ ··· 291 293 * This overrides all connection management and forces the object to use 292 294 * a specific connection when interacting with the database. 293 295 * 294 294 - * @param AphrontDatabaseConnection Connection to force this object to use. 296 296 + * @param AphrontDatabaseConnection $connection Connection to force this 297 297 + * object to use. 295 298 * @task conn 296 299 */ 297 300 public function setForcedConnection(AphrontDatabaseConnection $connection) { ··· 397 400 398 401 399 402 /** 400 400 - * Determine the setting of a configuration option for this class of objects. 403 403 + * Determine the setting of a configuration option for this class of objects. 401 404 * 402 402 - * @param const Option name, one of the CONFIG_* constants. 403 403 - * @return mixed Option value, if configured (null if unavailable). 405 405 + * @param const $option_name Option name, one of the CONFIG_* constants. 406 406 + * @return mixed Option value, if configured (null if unavailable). 404 407 * 405 405 - * @task config 408 408 + * @task config 406 409 */ 407 410 public function getConfigOption($option_name) { 408 411 $options = $this->getLiskMetadata('config'); ··· 426 429 * 427 430 * $dog = id(new Dog())->load($dog_id); 428 431 * 429 429 - * @param int Numeric ID identifying the object to load. 432 432 + * @param int $id Numeric ID identifying the object to load. 430 433 * @return obj|null Identified object, or null if it does not exist. 431 434 * 432 435 * @task load ··· 468 471 * 469 472 * The pattern and arguments are as per queryfx(). 470 473 * 471 471 - * @param string queryfx()-style SQL WHERE clause. 474 474 + * @param string $pattern queryfx()-style SQL WHERE clause. 472 475 * @param ... Zero or more conversions. 473 476 * @return dict Dictionary of matching objects, keyed on ID. 474 477 * ··· 489 492 * query. See loadAllWhere(). This method is similar, but returns a single 490 493 * result instead of a list. 491 494 * 492 492 - * @param string queryfx()-style SQL WHERE clause. 495 495 + * @param string $pattern queryfx()-style SQL WHERE clause. 493 496 * @param ... Zero or more conversions. 494 497 * @return obj|null Matching object, or null if no object matches. 495 498 * ··· 574 577 * convenient to pull data from elsewhere directly (e.g., a complicated 575 578 * join via @{method:queryData}) and then load from an array representation. 576 579 * 577 577 - * @param dict Dictionary of properties, which should be equivalent to 578 578 - * selecting a row from the table or calling 580 580 + * @param dict $row Dictionary of properties, which should be equivalent 581 581 + * to selecting a row from the table or calling 579 582 * @{method:getProperties}. 580 583 * @return this 581 584 * ··· 649 652 * 650 653 * This is a lot messier than @{method:loadAllWhere}, but more flexible. 651 654 * 652 652 - * @param list List of property dictionaries. 655 655 + * @param list $rows List of property dictionaries. 653 656 * @return dict List of constructed objects, keyed on ID. 654 657 * 655 658 * @task load ··· 690 693 * Set unique ID identifying this object. You normally don't need to call this 691 694 * method unless with `IDS_MANUAL`. 692 695 * 693 693 - * @param mixed Unique ID. 696 696 + * @param mixed $id Unique ID. 694 697 * @return this 695 698 * @task save 696 699 */ ··· 723 726 /** 724 727 * Test if a property exists. 725 728 * 726 726 - * @param string Property name. 729 729 + * @param string $property Property name. 727 730 * @return bool True if the property exists. 728 731 * @task info 729 732 */ ··· 798 801 /** 799 802 * Get or build the database connection for this object. 800 803 * 801 801 - * @param string 'r' for read, 'w' for read/write. 802 802 - * @param bool True to force a new connection. The connection will not 803 803 - * be retrieved from or saved into the connection cache. 804 804 + * @param string $mode 'r' for read, 'w' for read/write. 805 805 + * @param bool? $force_new True to force a new connection. The connection 806 806 + * will not be retrieved from or saved into the connection cache. 804 807 * @return AphrontDatabaseConnection Lisk connection object. 805 808 * 806 809 * @task info ··· 1038 1041 /** 1039 1042 * Internal implementation of INSERT and REPLACE. 1040 1043 * 1041 1041 - * @param const Either "INSERT" or "REPLACE", to force the desired mode. 1044 1044 + * @param const $mode Either "INSERT" or "REPLACE", to force the desired 1045 1045 + * mode. 1042 1046 * @return this 1043 1047 * 1044 1048 * @task save ··· 1272 1276 * Reads the value from a field. Override this method for custom behavior 1273 1277 * of @{method:getField} instead of overriding getField directly. 1274 1278 * 1275 1275 - * @param string Canonical field name 1279 1279 + * @param string $field Canonical field name 1276 1280 * @return mixed Value of the field 1277 1281 * 1278 1282 * @task hook ··· 1288 1292 * Writes a value to a field. Override this method for custom behavior of 1289 1293 * setField($value) instead of overriding setField directly. 1290 1294 * 1291 1291 - * @param string Canonical field name 1292 1292 - * @param mixed Value to write 1295 1295 + * @param string $field Canonical field name 1296 1296 + * @param mixed $value Value to write 1293 1297 * 1294 1298 * @task hook 1295 1299 */ ··· 1476 1480 * Long-running processes can use this method to clean up connections which 1477 1481 * have not been used recently. 1478 1482 * 1479 1479 - * @param int Close connections with no activity for this many seconds. 1483 1483 + * @param int $idle_window Close connections with no activity for this many 1484 1484 + * seconds. 1480 1485 * @return void 1481 1486 */ 1482 1487 public static function closeInactiveConnections($idle_window) { ··· 1576 1581 /** 1577 1582 * Black magic. Builds implied get*() and set*() for all properties. 1578 1583 * 1579 1579 - * @param string Method name. 1580 1580 - * @param list Argument vector. 1584 1584 + * @param string $method Method name. 1585 1585 + * @param list $args Argument vector. 1581 1586 * @return mixed get*() methods return the property value. set*() methods 1582 1587 * return $this. 1583 1588 * @task util ··· 1652 1657 /** 1653 1658 * Increments a named counter and returns the next value. 1654 1659 * 1655 1655 - * @param AphrontDatabaseConnection Database where the counter resides. 1656 1656 - * @param string Counter name to create or increment. 1660 1660 + * @param AphrontDatabaseConnection $conn_w Database where the counter 1661 1661 + * resides. 1662 1662 + * @param string $counter_name Counter name to create 1663 1663 + * or increment. 1657 1664 * @return int Next counter value. 1658 1665 * 1659 1666 * @task util ··· 1686 1693 /** 1687 1694 * Returns the current value of a named counter. 1688 1695 * 1689 1689 - * @param AphrontDatabaseConnection Database where the counter resides. 1690 1690 - * @param string Counter name to read. 1696 1696 + * @param AphrontDatabaseConnection $conn_r Database where the counter 1697 1697 + * resides. 1698 1698 + * @param string $counter_name Counter name to read. 1691 1699 * @return int|null Current value, or `null` if the counter does not exist. 1692 1700 * 1693 1701 * @task util ··· 1714 1722 * 1715 1723 * If the counter does not exist, it is created. 1716 1724 * 1717 1717 - * @param AphrontDatabaseConnection Database where the counter resides. 1718 1718 - * @param string Counter name to create or overwrite. 1725 1725 + * @param AphrontDatabaseConnection $conn_w Database where the counter 1726 1726 + * resides. 1727 1727 + * @param string $counter_name Counter name to create or overwrite. 1728 1728 + * @param int $counter_value 1719 1729 * @return void 1720 1730 * 1721 1731 * @task util

+1 -1

src/infrastructure/util/PhabricatorGlobalLock.php

reviewed

··· 88 88 * (somewhat arbitrarily). In most cases this is fine, but this method can 89 89 * be used to lock on a specific connection. 90 90 * 91 91 - * @param AphrontDatabaseConnection 91 91 + * @param AphrontDatabaseConnection $conn 92 92 * @return this 93 93 */ 94 94 public function setExternalConnection(AphrontDatabaseConnection $conn) {

+6 -5

src/infrastructure/util/PhabricatorHash.php

reviewed

··· 11 11 * Because a SHA1 collision is now known, this method should be considered 12 12 * weak. Callers should prefer @{method:digestWithNamedKey}. 13 13 * 14 14 - * @param string Input string. 14 14 + * @param string $string Input string. 15 15 + * @param string? $key 15 16 * @return string 32-byte hexadecimal SHA1+HMAC hash. 16 17 */ 17 18 public static function weakDigest($string, $key = null) { ··· 38 39 * This method emphasizes compactness, and should not be used for security 39 40 * related hashing (for general purpose hashing, see @{method:digest}). 40 41 * 41 41 - * @param string Input string. 42 42 + * @param string $string Input string. 42 43 * @return string 12-byte, case-sensitive, mostly-alphanumeric hash of 43 44 * the string. 44 45 */ ··· 72 73 * much stuff we're breaking by switching to it. For additional discussion, 73 74 * see T13045. 74 75 * 75 75 - * @param string Input string. 76 76 + * @param string $string Input string. 76 77 * @return string 12-byte, case-sensitive, purely-alphanumeric hash of 77 78 * the string. 78 79 */ ··· 149 150 * maintaining a high degree of collision resistance and a moderate degree 150 151 * of human readability. 151 152 * 152 152 - * @param string The string to shorten. 153 153 - * @param int Maximum length of the result. 153 153 + * @param string $string The string to shorten. 154 154 + * @param int $length Maximum length of the result. 154 155 * @return string String shortened in a collision-resistant way. 155 156 */ 156 157 public static function digestToLength($string, $length) {

+9 -9

src/infrastructure/util/password/PhabricatorPasswordHasher.php

reviewed

··· 101 101 /** 102 102 * Produce a password hash. 103 103 * 104 104 - * @param PhutilOpaqueEnvelope Text to be hashed. 104 104 + * @param PhutilOpaqueEnvelope $envelope Text to be hashed. 105 105 * @return PhutilOpaqueEnvelope Hashed text. 106 106 * @task hasher 107 107 */ ··· 114 114 * The default implementation checks for equality; if a hasher embeds salt in 115 115 * hashes it should override this method and perform a salt-aware comparison. 116 116 * 117 117 - * @param PhutilOpaqueEnvelope Password to compare. 118 118 - * @param PhutilOpaqueEnvelope Bare password hash. 117 117 + * @param PhutilOpaqueEnvelope $password Password to compare. 118 118 + * @param PhutilOpaqueEnvelope $hash Bare password hash. 119 119 * @return bool True if the passwords match. 120 120 * @task hasher 121 121 */ ··· 137 137 * have (for example) an internal cost function may be able to upgrade an 138 138 * existing hash to a stronger one with a higher cost. 139 139 * 140 140 - * @param PhutilOpaqueEnvelope Bare hash. 140 140 + * @param PhutilOpaqueEnvelope $hash Bare hash. 141 141 * @return bool True if the hash can be upgraded without 142 142 * changing the algorithm (for example, to a 143 143 * higher cost). ··· 154 154 /** 155 155 * Get the hash of a password for storage. 156 156 * 157 157 - * @param PhutilOpaqueEnvelope Password text. 157 157 + * @param PhutilOpaqueEnvelope $envelope Password text. 158 158 * @return PhutilOpaqueEnvelope Hashed text. 159 159 * @task hashing 160 160 */ ··· 349 349 /** 350 350 * Generate a new hash for a password, using the best available hasher. 351 351 * 352 352 - * @param PhutilOpaqueEnvelope Password to hash. 352 352 + * @param PhutilOpaqueEnvelope $password Password to hash. 353 353 * @return PhutilOpaqueEnvelope Hashed password, using best available 354 354 * hasher. 355 355 * @task hashing ··· 364 364 /** 365 365 * Compare a password to a stored hash. 366 366 * 367 367 - * @param PhutilOpaqueEnvelope Password to compare. 368 368 - * @param PhutilOpaqueEnvelope Stored password hash. 367 367 + * @param PhutilOpaqueEnvelope $password Password to compare. 368 368 + * @param PhutilOpaqueEnvelope $hash Stored password hash. 369 369 * @return bool True if the passwords match. 370 370 * @task hashing 371 371 */ ··· 383 383 /** 384 384 * Get the human-readable algorithm name for a given hash. 385 385 * 386 386 - * @param PhutilOpaqueEnvelope Storage hash. 386 386 + * @param PhutilOpaqueEnvelope $hash Storage hash. 387 387 * @return string Human-readable algorithm name. 388 388 */ 389 389 public static function getCurrentAlgorithmName(PhutilOpaqueEnvelope $hash) {

+3 -3

src/view/AphrontView.php

reviewed

··· 16 16 /** 17 17 * Set the user viewing this element. 18 18 * 19 19 - * @param PhabricatorUser Viewing user. 19 19 + * @param PhabricatorUser $viewer Viewing user. 20 20 * @return this 21 21 */ 22 22 public function setViewer(PhabricatorUser $viewer) { ··· 100 100 * This method will only work if the view supports children, which is 101 101 * determined by @{method:canAppendChild}. 102 102 * 103 103 - * @param wild Something renderable. 103 103 + * @param wild $child Something renderable. 104 104 * @return this 105 105 */ 106 106 final public function appendChild($child) { ··· 152 152 * NOTE: Because View children are not rendered, a View which renders down 153 153 * to nothing will not be reduced by this method. 154 154 * 155 155 - * @param list<wild> Renderable children. 155 155 + * @param list<wild> $children Renderable children. 156 156 * @return list<wild> Reduced list of children. 157 157 * @task children 158 158 */

+1 -1

src/view/control/AphrontTableView.php

reviewed

··· 105 105 * 106 106 * list($sort, $reverse) = AphrontTableView::parseSortParam($sort_param); 107 107 * 108 108 - * @param string Sort request parameter. 108 108 + * @param string $sort Sort request parameter. 109 109 * @return pair Sort value, sort direction. 110 110 */ 111 111 public static function parseSort($sort) {

+1 -1

src/view/form/AphrontFormView.php

reviewed

··· 120 120 * controls. It will propagate some information from the form to the 121 121 * control to simplify rendering. 122 122 * 123 123 - * @param AphrontFormControl Control to append. 123 123 + * @param AphrontFormControl $control Control to append. 124 124 * @return this 125 125 */ 126 126 public function appendControl(AphrontFormControl $control) {

+1 -1

src/view/form/control/AphrontFormControl.php

reviewed

··· 59 59 /** 60 60 * Set the Caption 61 61 * The Caption shows a tip usually nearby the related input field. 62 62 - * @param string|PhutilSafeHTML|null 62 62 + * @param string|PhutilSafeHTML|null $caption 63 63 * @return self 64 64 */ 65 65 public function setCaption($caption) {

+1 -1

src/view/page/PhabricatorStandardPageView.php

reviewed

··· 379 379 /** 380 380 * Insert a HTML element into <head> of the page to render. 381 381 * 382 382 - * @param PhutilSafeHTML HTML header to add 382 382 + * @param PhutilSafeHTML $html HTML header to add 383 383 */ 384 384 public function addHeadItem($html) { 385 385 if ($html instanceof PhutilSafeHTML) {

+2 -1

src/view/phui/PHUIBoxView.php

reviewed

··· 35 35 * Render PHUIBoxView as a <details> instead of a <div> HTML tag. 36 36 * To be used for collapse/expand in combination with PHUIHeaderView. 37 37 * 38 38 - * @param bool True to wrap in <summary> instead of <div> HTML tag. 38 38 + * @param bool $collapsible True to wrap in <summary> instead of <div> HTML 39 39 + * tag. 39 40 */ 40 41 public function setCollapsible($collapsible) { 41 42 $this->collapsible = $collapsible;

+1 -1

src/view/phui/PHUICrumbView.php

reviewed

··· 23 23 * Make this crumb always visible, even on devices where it would normally 24 24 * be hidden. 25 25 * 26 26 - * @param bool True to make the crumb always visible. 26 26 + * @param bool $always_visible True to make the crumb always visible. 27 27 * @return this 28 28 */ 29 29 public function setAlwaysVisible($always_visible) {

+2 -2

src/view/phui/PHUICrumbsView.php

reviewed

··· 15 15 * Convenience method for adding a simple crumb with just text, or text and 16 16 * a link. 17 17 * 18 18 - * @param string Text of the crumb. 19 19 - * @param string? Optional href for the crumb. 18 18 + * @param string $text Text of the crumb. 19 19 + * @param string? $href Optional href for the crumb. 20 20 * @return this 21 21 */ 22 22 public function addTextCrumb($text, $href = null) {

+2 -1

src/view/phui/PHUIHeaderView.php

reviewed

··· 95 95 * Render PHUIHeaderView as a <summary> instead of a <div> HTML tag. 96 96 * To be used for collapse/expand in combination with PHUIBoxView. 97 97 * 98 98 - * @param bool True to wrap in <summary> instead of <div> HTML tag. 98 98 + * @param bool $collapsible True to wrap in <summary> instead of <div> HTML 99 99 + * tag. 99 100 */ 100 101 public function setCollapsible($collapsible) { 101 102 $this->collapsible = $collapsible;

+1 -1

src/view/phui/PHUIPagerView.php

reviewed

··· 95 95 * $pager->getPageSize() + 1); 96 96 * $results = $pager->sliceResults($results); 97 97 * 98 98 - * @param list Result array. 98 98 + * @param list $results Result array. 99 99 * @return list One page of results. 100 100 */ 101 101 public function sliceResults(array $results) {

+3 -3

src/view/viewutils.php

reviewed

··· 104 104 * @{function:phabricator_date}, @{function:phabricator_time}, or 105 105 * @{function:phabricator_datetime}. 106 106 * 107 107 - * @param int Unix epoch timestamp. 108 108 - * @param PhabricatorUser User viewing the timestamp. 109 109 - * @param string Date format, as per DateTime class. 107 107 + * @param int $epoch Unix epoch timestamp. 108 108 + * @param PhabricatorUser $user User viewing the timestamp. 109 109 + * @param string $format Date format, as per DateTime class. 110 110 * @return string Formatted, local date/time. 111 111 */ 112 112 function phabricator_format_local_time($epoch, $user, $format) {

+3 -4

support/startup/PhabricatorClientLimit.php

reviewed

··· 170 170 /** 171 171 * Get the APC key for a given bucket. 172 172 * 173 173 - * @param int Bucket to get the key for. 173 173 + * @param int $bucket_id Bucket to get the key for. 174 174 * @return string APC key for the bucket. 175 175 */ 176 176 private function getBucketCacheKey($bucket_id) { ··· 182 182 /** 183 183 * Add points to the rate limit score for some client. 184 184 * 185 185 - * @param string Some key which identifies the client making the request. 186 186 - * @param float The cost for this request; more points pushes them toward 187 187 - * the limit faster. 185 185 + * @param float $score The cost for this request; more points pushes them 186 186 + * toward the limit faster. 188 187 * @return this 189 188 */ 190 189 private function addScore($score) {

+19 -17

support/startup/PhabricatorStartup.php

reviewed

··· 112 112 113 113 114 114 /** 115 115 - * @param float Request start time, from `microtime(true)`. 115 115 + * @param float $start_time Request start time, from `microtime(true)`. 116 116 * @task hook 117 117 */ 118 118 public static function didStartup($start_time) { ··· 255 255 * The limit is implemented with a tick function, so enabling it implies 256 256 * some accounting overhead. 257 257 * 258 258 - * @param int Time limit in seconds. 258 258 + * @param int $limit Time limit in seconds. 259 259 * @return void 260 260 */ 261 261 public static function setDebugTimeLimit($limit) { ··· 312 312 * Fatal the request completely in response to an exception, sending a plain 313 313 * text message to the client. Calls @{method:didFatal} internally. 314 314 * 315 315 - * @param string Brief description of the exception context, like 315 315 + * @param string $note Brief description of the exception context, like 316 316 * `"Rendering Exception"`. 317 317 - * @param Throwable The exception itself. 318 318 - * @param bool True if it's okay to show the exception's stack trace 319 319 - * to the user. The trace will always be logged. 317 317 + * @param Throwable $ex The exception itself. 318 318 + * @param bool $show_trace True if it's okay to show the exception's 319 319 + * stack trace to the user. The trace will always be 320 320 + * logged. 320 321 * 321 322 * @task apocalypse 322 323 */ ··· 342 343 /** 343 344 * Fatal the request completely, sending a plain text message to the client. 344 345 * 345 345 - * @param string Plain text message to send to the client. 346 346 - * @param string Plain text message to send to the error log. If not 347 347 - * provided, the client message is used. You can pass a more 348 348 - * detailed message here (e.g., with stack traces) to avoid 349 349 - * showing it to users. 346 346 + * @param string $message Plain text message to send to the client. 347 347 + * @param string? $log_message Plain text message to send to the error log. 348 348 + * If not provided, the client message is used. You can pass 349 349 + * a more detailed message here (e.g., with stack traces) to 350 350 + * avoid showing it to users. 350 351 * @return exit This method **does not return**. 351 352 * 352 353 * @task apocalypse ··· 513 514 * Adjustments here primarily impact the environment as seen by subprocesses. 514 515 * The environment is forwarded explicitly by @{class:ExecFuture}. 515 516 * 516 516 - * @param map<string, wild> Input `$_ENV`. 517 517 + * @param map<string, wild> $env Input `$_ENV`. 517 518 * @return map<string, string> Suitable `$_ENV`. 518 519 * @task validation 519 520 */ ··· 653 654 /** 654 655 * Add a new client limits. 655 656 * 656 656 - * @param PhabricatorClientLimit New limit. 657 657 + * @param PhabricatorClientLimit $limit New limit. 657 658 * @return PhabricatorClientLimit The limit. 658 659 */ 659 660 public static function addRateLimit(PhabricatorClientLimit $limit) { ··· 698 699 /** 699 700 * Tear down rate limiting and allow limits to score the request. 700 701 * 701 701 - * @param map<string, wild> Additional, freeform request state. 702 702 + * @param map<string, wild> $request_state Additional, freeform request 703 703 + * state. 702 704 * @return void 703 705 * @task ratelimit 704 706 */ ··· 745 747 * time and record it with @{method:recordStartupPhase} after the class is 746 748 * available. 747 749 * 748 748 - * @param string Phase name. 750 750 + * @param string $phase Phase name. 749 751 * @task phases 750 752 */ 751 753 public static function beginStartupPhase($phase) { ··· 761 763 * record a time before the class loads, then hand it over once the class 762 764 * becomes available. 763 765 * 764 764 - * @param string Phase name. 765 765 - * @param float Phase start time, from `microtime(true)`. 766 766 + * @param string $phase Phase name. 767 767 + * @param float $time Phase start time, from `microtime(true)`. 766 768 * @task phases 767 769 */ 768 770 public static function recordStartupPhase($phase, $time) {

+1 -1

support/startup/preamble-utils.php

reviewed

··· 4 4 * Parse the "X_FORWARDED_FOR" HTTP header to determine the original client 5 5 * address. 6 6 * 7 7 - * @param int Number of devices to trust. 7 7 + * @param int? $layers Number of devices to trust. 8 8 * @return void 9 9 */ 10 10 function preamble_trust_x_forwarded_for_header($layers = 1) {