Completed
Pull Request — master (#5231)
by Morris
16:38
created
lib/private/User/Session.php 1 patch
Doc Comments   +5 added lines, -2 removed lines patch added patch discarded remove patch
@@ -329,7 +329,7 @@  discard block
 block discarded – undo
329 329
 	 * @param IUser $user
330 330
 	 * @param array $loginDetails
331 331
 	 * @param bool $regenerateSessionId
332
-	 * @return true returns true if login successful or an exception otherwise
332
+	 * @return boolean returns true if login successful or an exception otherwise
333 333
 	 * @throws LoginException
334 334
 	 */
335 335
 	public function completeLogin(IUser $user, array $loginDetails, $regenerateSessionId = true) {
@@ -377,7 +377,7 @@  discard block
 block discarded – undo
377 377
 	 * @param OC\Security\Bruteforce\Throttler $throttler
378 378
 	 * @throws LoginException
379 379
 	 * @throws PasswordLoginForbiddenException
380
-	 * @return boolean
380
+	 * @return boolean|null
381 381
 	 */
382 382
 	public function logClientIn($user,
383 383
 								$password,
@@ -431,6 +431,9 @@  discard block
 block discarded – undo
431 431
 		return $this->config->getSystemValue('token_auth_enforced', false);
432 432
 	}
433 433
 
434
+	/**
435
+	 * @param string $username
436
+	 */
434 437
 	protected function isTwoFactorEnforced($username) {
435 438
 		Util::emitHook(
436 439
 			'\OCA\Files_Sharing\API\Server2Server',
Please login to merge, or discard this patch.
lib/private/AppFramework/Middleware/Security/SecurityMiddleware.php 1 patch
Doc Comments   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -99,7 +99,7 @@
 block discarded – undo
99 99
 	 * @param bool $isLoggedIn
100 100
 	 * @param bool $isAdminUser
101 101
 	 * @param ContentSecurityPolicyManager $contentSecurityPolicyManager
102
-	 * @param CSRFTokenManager $csrfTokenManager
102
+	 * @param CsrfTokenManager $csrfTokenManager
103 103
 	 * @param ContentSecurityPolicyNonceManager $cspNonceManager
104 104
 	 */
105 105
 	public function __construct(IRequest $request,
Please login to merge, or discard this patch.
apps/sharebymail/lib/ShareByMailProvider.php 1 patch
Doc Comments   +5 added lines, -4 removed lines patch added patch discarded remove patch
@@ -276,10 +276,10 @@  discard block
 block discarded – undo
276 276
 	 * publish activity if a file/folder was shared by mail
277 277
 	 *
278 278
 	 * @param $subject
279
-	 * @param $parameters
280
-	 * @param $affectedUser
279
+	 * @param string[] $parameters
280
+	 * @param string $affectedUser
281 281
 	 * @param $fileId
282
-	 * @param $filePath
282
+	 * @param string $filePath
283 283
 	 */
284 284
 	protected function publishActivity($subject, $parameters, $affectedUser, $fileId, $filePath) {
285 285
 		$event = $this->activityManager->generateEvent();
@@ -557,6 +557,7 @@  discard block
 block discarded – undo
557 557
 	 * @param string $uidOwner
558 558
 	 * @param int $permissions
559 559
 	 * @param string $token
560
+	 * @param string $password
560 561
 	 * @return int
561 562
 	 */
562 563
 	protected function addShareToDB($itemSource, $itemType, $shareWith, $sharedBy, $uidOwner, $permissions, $token, $password) {
@@ -950,7 +951,7 @@  discard block
 block discarded – undo
950 951
 	/**
951 952
 	 * get database row of a give share
952 953
 	 *
953
-	 * @param $id
954
+	 * @param integer $id
954 955
 	 * @return array
955 956
 	 * @throws ShareNotFound
956 957
 	 */
Please login to merge, or discard this patch.
apps/files_sharing/lib/Controller/ShareesAPIController.php 1 patch
Doc Comments   +4 added lines, -1 removed lines patch added patch discarded remove patch
@@ -385,7 +385,7 @@  discard block
 block discarded – undo
385 385
 	 * split user and remote from federated cloud id
386 386
 	 *
387 387
 	 * @param string $address federated share address
388
-	 * @return array [user, remoteURL]
388
+	 * @return string[] [user, remoteURL]
389 389
 	 * @throws \Exception
390 390
 	 */
391 391
 	public function splitUserRemote($address) {
@@ -652,6 +652,9 @@  discard block
 block discarded – undo
652 652
 		return $result;
653 653
 	}
654 654
 
655
+	/**
656
+	 * @param string $search
657
+	 */
655 658
 	protected function getLookup($search) {
656 659
 		$isEnabled = $this->config->getAppValue('files_sharing', 'lookupServerEnabled', 'no');
657 660
 		$lookupServerUrl = $this->config->getSystemValue('lookup_server', 'https://lookup.nextcloud.com');
Please login to merge, or discard this patch.
apps/dav/lib/CardDAV/CardDavBackend.php 1 patch
Doc Comments   +11 added lines, -3 removed lines patch added patch discarded remove patch
@@ -104,7 +104,7 @@  discard block
 block discarded – undo
104 104
 	/**
105 105
 	 * Return the number of address books for a principal
106 106
 	 *
107
-	 * @param $principalUri
107
+	 * @param string $principalUri
108 108
 	 * @return int
109 109
 	 */
110 110
 	public function getAddressBooksForUserCount($principalUri) {
@@ -212,6 +212,9 @@  discard block
 block discarded – undo
212 212
 		return array_values($addressBooks);
213 213
 	}
214 214
 
215
+	/**
216
+	 * @param string $principalUri
217
+	 */
215 218
 	public function getUsersOwnAddressBooks($principalUri) {
216 219
 		$principalUri = $this->convertPrincipal($principalUri, true);
217 220
 		$query = $this->db->getQueryBuilder();
@@ -280,7 +283,8 @@  discard block
 block discarded – undo
280 283
 	}
281 284
 
282 285
 	/**
283
-	 * @param $addressBookUri
286
+	 * @param string $addressBookUri
287
+	 * @param string $principal
284 288
 	 * @return array|null
285 289
 	 */
286 290
 	public function getAddressBooksByUri($principal, $addressBookUri) {
@@ -969,6 +973,7 @@  discard block
 block discarded – undo
969 973
 	 *   * readOnly - boolean
970 974
 	 *   * summary - Optional, a description for the share
971 975
 	 *
976
+	 * @param integer $addressBookId
972 977
 	 * @return array
973 978
 	 */
974 979
 	public function getShares($addressBookId) {
@@ -1068,7 +1073,7 @@  discard block
 block discarded – undo
1068 1073
 
1069 1074
 	/**
1070 1075
 	 * For shared address books the sharee is set in the ACL of the address book
1071
-	 * @param $addressBookId
1076
+	 * @param integer $addressBookId
1072 1077
 	 * @param $acl
1073 1078
 	 * @return array
1074 1079
 	 */
@@ -1076,6 +1081,9 @@  discard block
 block discarded – undo
1076 1081
 		return $this->sharingBackend->applyShareAcl($addressBookId, $acl);
1077 1082
 	}
1078 1083
 
1084
+	/**
1085
+	 * @param boolean $toV2
1086
+	 */
1079 1087
 	private function convertPrincipal($principalUri, $toV2) {
1080 1088
 		if ($this->principalBackend->getPrincipalPrefix() === 'principals') {
1081 1089
 			list(, $name) = URLUtil::splitPath($principalUri);
Please login to merge, or discard this patch.
apps/dav/lib/CalDAV/CalDavBackend.php 1 patch
Doc Comments   +10 added lines, -4 removed lines patch added patch discarded remove patch
@@ -179,7 +179,7 @@  discard block
 block discarded – undo
179 179
 	 *
180 180
 	 * By default this excludes the automatically generated birthday calendar
181 181
 	 *
182
-	 * @param $principalUri
182
+	 * @param string $principalUri
183 183
 	 * @param bool $excludeBirthday
184 184
 	 * @return int
185 185
 	 */
@@ -341,6 +341,9 @@  discard block
 block discarded – undo
341 341
 		return array_values($calendars);
342 342
 	}
343 343
 
344
+	/**
345
+	 * @param string $principalUri
346
+	 */
344 347
 	public function getUsersOwnCalendars($principalUri) {
345 348
 		$principalUri = $this->convertPrincipal($principalUri, true);
346 349
 		$fields = array_values($this->propertyMap);
@@ -920,7 +923,7 @@  discard block
 block discarded – undo
920 923
 	 * calendar-data. If the result of a subsequent GET to this object is not
921 924
 	 * the exact same as this request body, you should omit the ETag.
922 925
 	 *
923
-	 * @param mixed $calendarId
926
+	 * @param integer $calendarId
924 927
 	 * @param string $objectUri
925 928
 	 * @param string $calendarData
926 929
 	 * @return string
@@ -974,7 +977,7 @@  discard block
 block discarded – undo
974 977
 	 * calendar-data. If the result of a subsequent GET to this object is not
975 978
 	 * the exact same as this request body, you should omit the ETag.
976 979
 	 *
977
-	 * @param mixed $calendarId
980
+	 * @param integer $calendarId
978 981
 	 * @param string $objectUri
979 982
 	 * @param string $calendarData
980 983
 	 * @return string
@@ -1551,7 +1554,7 @@  discard block
 block discarded – undo
1551 1554
 	 * @param string $principalUri
1552 1555
 	 * @param string $uri
1553 1556
 	 * @param array $properties
1554
-	 * @return mixed
1557
+	 * @return integer
1555 1558
 	 */
1556 1559
 	function createSubscription($principalUri, $uri, array $properties) {
1557 1560
 
@@ -2087,6 +2090,9 @@  discard block
 block discarded – undo
2087 2090
 		return (int)$objectIds['id'];
2088 2091
 	}
2089 2092
 
2093
+	/**
2094
+	 * @param boolean $toV2
2095
+	 */
2090 2096
 	private function convertPrincipal($principalUri, $toV2) {
2091 2097
 		if ($this->principalBackend->getPrincipalPrefix() === 'principals') {
2092 2098
 			list(, $name) = URLUtil::splitPath($principalUri);
Please login to merge, or discard this patch.
lib/public/Mail/IEMailTemplate.php 1 patch
Doc Comments   +8 added lines, -1 removed lines patch added patch discarded remove patch
@@ -55,6 +55,7 @@  discard block
 block discarded – undo
55 55
 	 * Adds a header to the email
56 56
 	 *
57 57
 	 * @since 12.0.0
58
+	 * @return void
58 59
 	 */
59 60
 	public function addHeader();
60 61
 
@@ -62,10 +63,11 @@  discard block
 block discarded – undo
62 63
 	 * Adds a heading to the email
63 64
 	 *
64 65
 	 * @param string $title
65
-	 * @param string $plainTitle|bool Title that is used in the plain text email
66
+	 * @param string $plainTitle Title that is used in the plain text email
66 67
 	 *   if empty the $title is used, if false none will be used
67 68
 	 *
68 69
 	 * @since 12.0.0
70
+	 * @return void
69 71
 	 */
70 72
 	public function addHeading($title, $plainTitle = '');
71 73
 
@@ -77,6 +79,7 @@  discard block
 block discarded – undo
77 79
 	 *   if empty the $text is used, if false none will be used
78 80
 	 *
79 81
 	 * @since 12.0.0
82
+	 * @return void
80 83
 	 */
81 84
 	public function addBodyText($text, $plainText = '');
82 85
 
@@ -91,6 +94,7 @@  discard block
 block discarded – undo
91 94
 	 * @param string $plainMetaInfo Meta info that is used in the plain text email
92 95
 	 *   if empty the $metaInfo is used, if false none will be used
93 96
 	 * @since 12.0.0
97
+	 * @return void
94 98
 	 */
95 99
 	public function addBodyListItem($text, $metaInfo = '', $icon = '', $plainText = '', $plainMetaInfo = '');
96 100
 
@@ -105,6 +109,7 @@  discard block
 block discarded – undo
105 109
 	 * @param string $plainTextRight Text of right button that is used in the plain text version - if empty the $textRight is used
106 110
 	 *
107 111
 	 * @since 12.0.0
112
+	 * @return void
108 113
 	 */
109 114
 	public function addBodyButtonGroup($textLeft, $urlLeft, $textRight, $urlRight, $plainTextLeft = '', $plainTextRight = '');
110 115
 
@@ -117,6 +122,7 @@  discard block
 block discarded – undo
117 122
 	 * 		if empty the $text is used, if false none will be used
118 123
 	 *
119 124
 	 * @since 12.0.0
125
+	 * @return void
120 126
 	 */
121 127
 	public function addBodyButton($text, $url, $plainText = '');
122 128
 
@@ -126,6 +132,7 @@  discard block
 block discarded – undo
126 132
 	 * @param string $text If the text is empty the default "Name - Slogan<br>This is an automatically sent email" will be used
127 133
 	 *
128 134
 	 * @since 12.0.0
135
+	 * @return void
129 136
 	 */
130 137
 	public function addFooter($text = '');
131 138
 
Please login to merge, or discard this patch.
lib/private/BackgroundJob/JobList.php 1 patch
Doc Comments   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -320,7 +320,7 @@
 block discarded – undo
320 320
 
321 321
 	/**
322 322
 	 * @param IJob $job
323
-	 * @param $timeTaken
323
+	 * @param integer $timeTaken
324 324
 	 */
325 325
 	public function setExecutionTime(IJob $job, $timeTaken) {
326 326
 		$query = $this->connection->getQueryBuilder();
Please login to merge, or discard this patch.
lib/private/Updater.php 1 patch
Doc Comments   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -431,7 +431,7 @@
 block discarded – undo
431 431
 	}
432 432
 
433 433
 	/**
434
-	 * @param array $disabledApps
434
+	 * @param string[] $disabledApps
435 435
 	 * @throws \Exception
436 436
 	 */
437 437
 	private function upgradeAppStoreApps(array $disabledApps) {
Please login to merge, or discard this patch.