Details

T15923: Make all PHPDoc @param have variable names

Maniphest Tasks

Commits

rPb44b566b1334: Add missing variable names to PHPDoc @param of methods

Summary

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

Closes T15923

Test Plan

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

Diff Detail

Repository

rP Phorge

Lint

Lint Not Applicable

Unit

Tests Not Applicable

Event Timeline

aklapper created this revision.Aug 20 2024, 16:08

Owners added a reviewer: O1: Blessed Committers.Aug 20 2024, 16:08

Herald added subscribers: Cigaryno, Matthew, valerio.bozzolan, tobiaswiese. · View Herald TranscriptAug 20 2024, 16:08

Harbormaster completed remote builds in B1551: Diff 2402.Aug 20 2024, 16:08

aklapper requested review of this revision.Aug 20 2024, 16:08

Wojak depressed.png (473×635 px, 160 KB)

This revision is now accepted and ready to land.Aug 20 2024, 17:06

mainframe98 awarded a token.Aug 20 2024, 20:43

aklapper mentioned this in T15923: Make all PHPDoc @param have variable names.Aug 21 2024, 13:06

Closed by commit rPb44b566b1334: Add missing variable names to PHPDoc @param of methods. · Explain WhyAug 21 2024, 13:06

This revision was automatically updated to reflect the committed changes.

aklapper added a commit: rPb44b566b1334: Add missing variable names to PHPDoc @param of methods.

Large Diff

This large diff affects 160 files. Files without inline comments have been collapsed. Expand All Files

Revision Contents
Changeset List

Path

Size

Packages

src/

aphront/

AphrontRequest.php

30 lines

AphrontApplicationConfiguration.php

configuration/

27 lines

AphrontHTTPParameterType.php

httpparametertype/

30 lines

response/

AphrontFileResponse.php

2 lines

AphrontRedirectResponse.php

5 lines

sink/

AphrontHTTPSink.php

9 lines

site/

AphrontRoutingMap.php

8 lines

writeguard/

AphrontWriteGuard.php

2 lines

PhabricatorCommonPasswords.php

applications/

auth/

constants/

2 lines

PhabricatorCookies.php

14 lines

PhabricatorAuthController.php

controller/

5 lines

PhabricatorAuthSessionEngine.php

engine/

89 lines

PhabricatorAuthPasswordHashInterface.php

password/

4 lines

PhabricatorAuthProvider.php

provider/

6 lines

PhabricatorApplication.php

base/

14 lines

cache/

PhabricatorCaches.php

4 lines

celerity/

CelerityResourceMap.php

12 lines

CelerityResourceMapGenerator.php

23 lines

CelerityResourceTransformer.php

3 lines

api.php

8 lines

CelerityResourceController.php

controller/

2 lines

CelerityManagementMapWorkflow.php

management/

2 lines

PhabricatorConduitAPIController.php

conduit/

controller/

5 lines

protocol/

exception/

ConduitException.php

2 lines

PhabricatorCustomLogoConfigType.php

config/

custom/

2 lines

PhabricatorSetupIssue.php

issue/

4 lines

PhabricatorConfigJSON.php

json/

3 lines

PhabricatorApplicationConfigOptions.php

option/

4 lines

PhabricatorDashboardPanelRenderingEngine.php

dashboard/

engine/

2 lines

DifferentialReviewerStatus.php

differential/

constants/

2 lines

DifferentialChangesetParser.php

parser/

23 lines

DifferentialLineAdjustmentMap.php

4 lines

DifferentialRevisionQuery.php

query/

30 lines

DifferentialChangesetHTMLRenderer.php

render/

13 lines

DifferentialChangesetRenderer.php

4 lines

DifferentialChangeset.php

storage/

2 lines

DiffusionBrowseResultSet.php

diffusion/

data/

2 lines

DiffusionGitBranch.php

5 lines

DiffusionMercurialCommandEngine.php

protocol/

2 lines

query/

pathid/

DiffusionPathIDQuery.php

6 lines

request/

DiffusionRequest.php

19 lines

view/

DiffusionReadmeView.php

2 lines

diviner/

query/

DivinerAtomQuery.php

18 lines

DoorkeeperFeedStoryPublisher.php

doorkeeper/

engine/

3 lines

DrydockBlueprintImplementation.php

drydock/

blueprint/

68 lines

storage/

DrydockAuthorization.php

8 lines

DrydockSlotLock.php

14 lines

DrydockLeaseUpdateWorker.php

worker/

50 lines

DrydockResourceUpdateWorker.php

8 lines

PhabricatorFeedStoryPublisher.php

feed/

2 lines

story/

PhabricatorFeedStory.php

5 lines

PhabricatorImageTransformer.php

files/

10 lines

PhabricatorChunkedFileStorageEngine.php

engine/

4 lines

PhabricatorFileStorageEngine.php

14 lines

PhabricatorLocalDiskFileStorageEngine.php

2 lines

PhabricatorMySQLFileStorageEngine.php

2 lines

query/

PhabricatorFileQuery.php

3 lines

storage/

PhabricatorFile.php

23 lines

PhabricatorFileImageTransform.php

transform/

8 lines

HarbormasterBuildStatus.php

harbormaster/

constants/

2 lines

HarbormasterBuildEngine.php

engine/

9 lines

HarbormasterTargetEngine.php

8 lines

HarbormasterBuildStepImplementation.php

step/

8 lines

HarbormasterBuildable.php

storage/

6 lines

herald/

adapter/

HeraldAdapter.php

3 lines

ManiphestTaskPriority.php

maniphest/

constants/

4 lines

PhabricatorApplicationConfigurationPanel.php

meta/

panel/

2 lines

PhabricatorMetaMTAEmailBodyParser.php

metamta/

parser/

2 lines

PhabricatorObjectMailReceiver.php

receiver/

6 lines

PhabricatorMailReplyHandler.php

replyhandler/

16 lines

PhabricatorMetaMTAMail.php

storage/

19 lines

util/

PhabricatorMailUtil.php

6 lines

PhabricatorMetaMTAMailBody.php

view/

10 lines

PhabricatorNotificationQuery.php

notification/

query/

4 lines

PassphraseCredentialControl.php

passphrase/

view/

6 lines

people/

storage/

PhabricatorUser.php

16 lines

PhabricatorUserEmail.php

8 lines

PhabricatorObjectHandle.php

phid/

2 lines

PhabricatorObjectQuery.php

query/

4 lines

type/

PhabricatorPHIDType.php

21 lines

utils.php

4 lines

phrequent/

storage/

PhrequentTimeBlock.php

3 lines

PhabricatorPolicyFilter.php

policy/

filter/

12 lines

PhabricatorExtendedPolicyInterface.php

interface/

4 lines

PhabricatorPolicyRule.php

rule/

6 lines

storage/

PhabricatorPolicy.php

4 lines

PhabricatorRepositoryPullLocalDaemon.php

repository/

daemon/

4 lines

PhabricatorRepositoryDiscoveryEngine.php

engine/

2 lines

PhabricatorRepositoryPullEngine.php

2 lines

PhabricatorRepositoryRefEngine.php

2 lines

PhabricatorRepositoryGraphCache.php

graphcache/

25 lines

PhabricatorRepository.php

storage/

12 lines

PhabricatorApplicationSearchEngine.php

search/

engine/

33 lines

PhabricatorSearchField.php

field/

18 lines

PhabricatorFulltextStorageEngine.php

fulltextstorage/

4 lines

PhabricatorSettingsPanel.php

settings/

panel/

4 lines

PhabricatorUserPreferencesQuery.php

query/

3 lines

PhabricatorUserPreferences.php

storage/

4 lines

PhabricatorSpacesNamespaceQuery.php

spaces/

query/

2 lines

PhabricatorSubscriptionsEditor.php

subscriptions/

editor/

6 lines

PhabricatorSubscribableInterface.php

interface/

3 lines

PhabricatorSystemActionEngine.php

system/

engine/

8 lines

PhabricatorEditEngine.php

transactions/

editengine/

42 lines

editfield/

PhabricatorEditField.php

4 lines

PhabricatorApplicationTransactionEditor.php

editor/

38 lines

PhabricatorApplicationTransaction.php

storage/

2 lines

PhabricatorModularTransactionType.php

5 lines

PhabricatorTypeaheadDatasource.php

typeahead/

datasource/

2 lines

PhutilInRequestKeyValueCache.php

infrastructure/

cache/

2 lines

PhutilKeyValueCache.php

22 lines

PhutilKeyValueCacheProfiler.php

2 lines

PhutilKeyValueCacheStack.php

5 lines

PhutilMemcacheKeyValueCache.php

2 lines

PhabricatorContentSource.php

contentsource/

8 lines

PhabricatorCustomField.php

customfield/

field/

45 lines

PhabricatorCustomFieldList.php

3 lines

PhabricatorCustomFieldStorage.php

storage/

2 lines

daemon/

PhabricatorDaemon.php

2 lines

PhutilDaemonHandle.php

4 lines

PhutilDaemonOverseerModule.php

4 lines

PhabricatorTriggerDaemon.php

workers/

4 lines

PhabricatorWorker.php

22 lines

PhabricatorTriggerAction.php

action/

10 lines

PhabricatorTriggerClock.php

clock/

9 lines

PhabricatorWorkerLeaseQuery.php

query/

6 lines

PhabricatorWorkerTriggerQuery.php

2 lines

PhabricatorWorkerTrigger.php

storage/

15 lines

PhabricatorDifferenceEngine.php

diff/

12 lines

PhabricatorEdgeEditor.php

edges/

editor/

14 lines

query/

PhabricatorEdgeQuery.php

24 lines

env/

PhabricatorEnv.php

18 lines

PhabricatorScopedEnv.php

4 lines

PhabricatorMarkupEngine.php

markup/

32 lines

PhabricatorMarkupInterface.php

12 lines

PhutilMarkupEngine.php

9 lines

PhutilRemarkupCodeBlockRule.php

blockrule/

2 lines

markuprule/

PhutilRemarkupRule.php

15 lines

render.php

6 lines

PhabricatorObjectRemarkupRule.php

rule/

2 lines

parser/

PhutilURIHelper.php

2 lines

PhabricatorCursorPagedPolicyAwareQuery.php

query/

policy/

44 lines

PhabricatorPolicyAwareQuery.php

22 lines

storage/

lisk/

LiskDAO.php

76 lines

PhabricatorGlobalLock.php

util/

2 lines

PhabricatorHash.php

11 lines

PhabricatorPasswordHasher.php

password/

18 lines

view/

AphrontView.php

6 lines

control/

AphrontTableView.php

2 lines

form/

AphrontFormView.php

2 lines

control/

AphrontFormControl.php

2 lines

PhabricatorStandardPageView.php

page/

2 lines

phui/

PHUIBoxView.php

3 lines

PHUICrumbView.php

2 lines

PHUICrumbsView.php

4 lines

PHUIHeaderView.php

3 lines

PHUIPagerView.php

2 lines

viewutils.php

6 lines

PhabricatorClientLimit.php

support/

startup/

7 lines

PhabricatorStartup.php

36 lines

preamble-utils.php

2 lines

Diff 2404

src/aphront/AphrontRequest.php

src/aphront/configuration/AphrontApplicationConfiguration.php

src/aphront/httpparametertype/AphrontHTTPParameterType.php

src/aphront/response/AphrontFileResponse.php

src/aphront/response/AphrontRedirectResponse.php

src/aphront/sink/AphrontHTTPSink.php

src/aphront/site/AphrontRoutingMap.php

src/aphront/writeguard/AphrontWriteGuard.php

src/applications/auth/constants/PhabricatorCommonPasswords.php

src/applications/auth/constants/PhabricatorCookies.php

src/applications/auth/controller/PhabricatorAuthController.php

src/applications/auth/engine/PhabricatorAuthSessionEngine.php

src/applications/auth/password/PhabricatorAuthPasswordHashInterface.php

src/applications/auth/provider/PhabricatorAuthProvider.php

src/applications/base/PhabricatorApplication.php

src/applications/cache/PhabricatorCaches.php

src/applications/celerity/CelerityResourceMap.php

src/applications/celerity/CelerityResourceMapGenerator.php

src/applications/celerity/CelerityResourceTransformer.php

src/applications/celerity/api.php

src/applications/celerity/controller/CelerityResourceController.php

src/applications/celerity/management/CelerityManagementMapWorkflow.php

src/applications/conduit/controller/PhabricatorConduitAPIController.php

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

src/applications/config/custom/PhabricatorCustomLogoConfigType.php

src/applications/config/issue/PhabricatorSetupIssue.php

src/applications/config/json/PhabricatorConfigJSON.php

src/applications/config/option/PhabricatorApplicationConfigOptions.php

src/applications/dashboard/engine/PhabricatorDashboardPanelRenderingEngine.php

src/applications/differential/constants/DifferentialReviewerStatus.php

src/applications/differential/parser/DifferentialChangesetParser.php

src/applications/differential/parser/DifferentialLineAdjustmentMap.php

src/applications/differential/query/DifferentialRevisionQuery.php

src/applications/differential/render/DifferentialChangesetHTMLRenderer.php

src/applications/differential/render/DifferentialChangesetRenderer.php

src/applications/differential/storage/DifferentialChangeset.php

src/applications/diffusion/data/DiffusionBrowseResultSet.php

src/applications/diffusion/data/DiffusionGitBranch.php

src/applications/diffusion/protocol/DiffusionMercurialCommandEngine.php

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

src/applications/diffusion/request/DiffusionRequest.php

src/applications/diffusion/view/DiffusionReadmeView.php

src/applications/diviner/query/DivinerAtomQuery.php

src/applications/doorkeeper/engine/DoorkeeperFeedStoryPublisher.php

src/applications/drydock/blueprint/DrydockBlueprintImplementation.php

src/applications/drydock/storage/DrydockAuthorization.php

src/applications/drydock/storage/DrydockSlotLock.php

src/applications/drydock/worker/DrydockLeaseUpdateWorker.php

src/applications/drydock/worker/DrydockResourceUpdateWorker.php

src/applications/feed/PhabricatorFeedStoryPublisher.php

src/applications/feed/story/PhabricatorFeedStory.php

src/applications/files/PhabricatorImageTransformer.php

src/applications/files/engine/PhabricatorChunkedFileStorageEngine.php

src/applications/files/engine/PhabricatorFileStorageEngine.php

src/applications/files/engine/PhabricatorLocalDiskFileStorageEngine.php

src/applications/files/engine/PhabricatorMySQLFileStorageEngine.php

src/applications/files/query/PhabricatorFileQuery.php

src/applications/files/storage/PhabricatorFile.php

src/applications/files/transform/PhabricatorFileImageTransform.php

src/applications/harbormaster/constants/HarbormasterBuildStatus.php

src/applications/harbormaster/engine/HarbormasterBuildEngine.php

src/applications/harbormaster/engine/HarbormasterTargetEngine.php

src/applications/harbormaster/step/HarbormasterBuildStepImplementation.php

src/applications/harbormaster/storage/HarbormasterBuildable.php

src/applications/herald/adapter/HeraldAdapter.php

src/applications/maniphest/constants/ManiphestTaskPriority.php

src/applications/meta/panel/PhabricatorApplicationConfigurationPanel.php

src/applications/metamta/parser/PhabricatorMetaMTAEmailBodyParser.php

src/applications/metamta/receiver/PhabricatorObjectMailReceiver.php

src/applications/metamta/replyhandler/PhabricatorMailReplyHandler.php

src/applications/metamta/storage/PhabricatorMetaMTAMail.php

src/applications/metamta/util/PhabricatorMailUtil.php

src/applications/metamta/view/PhabricatorMetaMTAMailBody.php

src/applications/notification/query/PhabricatorNotificationQuery.php

src/applications/passphrase/view/PassphraseCredentialControl.php

src/applications/people/storage/PhabricatorUser.php

src/applications/people/storage/PhabricatorUserEmail.php

src/applications/phid/PhabricatorObjectHandle.php

src/applications/phid/query/PhabricatorObjectQuery.php

src/applications/phid/type/PhabricatorPHIDType.php

src/applications/phid/utils.php

src/applications/phrequent/storage/PhrequentTimeBlock.php

src/applications/policy/filter/PhabricatorPolicyFilter.php

src/applications/policy/interface/PhabricatorExtendedPolicyInterface.php

src/applications/policy/rule/PhabricatorPolicyRule.php

src/applications/policy/storage/PhabricatorPolicy.php

src/applications/repository/daemon/PhabricatorRepositoryPullLocalDaemon.php

src/applications/repository/engine/PhabricatorRepositoryDiscoveryEngine.php

src/applications/repository/engine/PhabricatorRepositoryPullEngine.php

src/applications/repository/engine/PhabricatorRepositoryRefEngine.php

src/applications/repository/graphcache/PhabricatorRepositoryGraphCache.php

src/applications/repository/storage/PhabricatorRepository.php

src/applications/search/engine/PhabricatorApplicationSearchEngine.php

src/applications/search/field/PhabricatorSearchField.php

src/applications/search/fulltextstorage/PhabricatorFulltextStorageEngine.php

src/applications/settings/panel/PhabricatorSettingsPanel.php

src/applications/settings/query/PhabricatorUserPreferencesQuery.php

src/applications/settings/storage/PhabricatorUserPreferences.php

src/applications/spaces/query/PhabricatorSpacesNamespaceQuery.php

src/applications/subscriptions/editor/PhabricatorSubscriptionsEditor.php

src/applications/subscriptions/interface/PhabricatorSubscribableInterface.php

src/applications/system/engine/PhabricatorSystemActionEngine.php

src/applications/transactions/editengine/PhabricatorEditEngine.php

src/applications/transactions/editfield/PhabricatorEditField.php

src/applications/transactions/editor/PhabricatorApplicationTransactionEditor.php

src/applications/transactions/storage/PhabricatorApplicationTransaction.php

src/applications/transactions/storage/PhabricatorModularTransactionType.php

src/applications/typeahead/datasource/PhabricatorTypeaheadDatasource.php

src/infrastructure/cache/PhutilInRequestKeyValueCache.php

src/infrastructure/cache/PhutilKeyValueCache.php

src/infrastructure/cache/PhutilKeyValueCacheProfiler.php

src/infrastructure/cache/PhutilKeyValueCacheStack.php

src/infrastructure/cache/PhutilMemcacheKeyValueCache.php

src/infrastructure/contentsource/PhabricatorContentSource.php

src/infrastructure/customfield/field/PhabricatorCustomField.php

src/infrastructure/customfield/field/PhabricatorCustomFieldList.php

src/infrastructure/customfield/storage/PhabricatorCustomFieldStorage.php

src/infrastructure/daemon/PhabricatorDaemon.php

src/infrastructure/daemon/PhutilDaemonHandle.php

src/infrastructure/daemon/PhutilDaemonOverseerModule.php

src/infrastructure/daemon/workers/PhabricatorTriggerDaemon.php

src/infrastructure/daemon/workers/PhabricatorWorker.php

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

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

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

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

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

src/infrastructure/diff/PhabricatorDifferenceEngine.php

src/infrastructure/edges/editor/PhabricatorEdgeEditor.php

src/infrastructure/edges/query/PhabricatorEdgeQuery.php

src/infrastructure/env/PhabricatorEnv.php

src/infrastructure/env/PhabricatorScopedEnv.php

src/infrastructure/markup/PhabricatorMarkupEngine.php

src/infrastructure/markup/PhabricatorMarkupInterface.php

src/infrastructure/markup/PhutilMarkupEngine.php

src/infrastructure/markup/blockrule/PhutilRemarkupCodeBlockRule.php

src/infrastructure/markup/markuprule/PhutilRemarkupRule.php

src/infrastructure/markup/render.php

src/infrastructure/markup/rule/PhabricatorObjectRemarkupRule.php

src/infrastructure/parser/PhutilURIHelper.php

src/infrastructure/query/policy/PhabricatorCursorPagedPolicyAwareQuery.php

src/infrastructure/query/policy/PhabricatorPolicyAwareQuery.php

src/infrastructure/storage/lisk/LiskDAO.php

src/infrastructure/util/PhabricatorGlobalLock.php

src/infrastructure/util/PhabricatorHash.php

src/infrastructure/util/password/PhabricatorPasswordHasher.php

src/view/AphrontView.php

src/view/control/AphrontTableView.php

src/view/form/AphrontFormView.php

src/view/form/control/AphrontFormControl.php

src/view/page/PhabricatorStandardPageView.php

src/view/phui/PHUIBoxView.php

src/view/phui/PHUICrumbView.php

src/view/phui/PHUICrumbsView.php

src/view/phui/PHUIHeaderView.php

src/view/phui/PHUIPagerView.php

src/view/viewutils.php

support/startup/PhabricatorClientLimit.php

support/startup/PhabricatorStartup.php

support/startup/preamble-utils.php