Skip to content

Commit f47a586

Browse files
committed
docs: update comments
Signed-off-by: Salvatore Martire <4652631+salmart-dev@users.noreply.github.com>
1 parent ac4e82d commit f47a586

File tree

2 files changed

+14
-2
lines changed

2 files changed

+14
-2
lines changed

lib/private/Files/Config/MountProviderCollection.php

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,9 @@ public function getMountsForUser(IUser $user): array {
8181
}
8282

8383
/**
84+
* Returns the mounts for the user from the specified provider classes.
85+
* Providers not registered in the MountProviderCollection will be skipped.
86+
*
8487
* @return list<IMountPoint>
8588
*/
8689
public function getUserMountsForProviderClasses(IUser $user, array $mountProviderClasses): array {

lib/private/Files/SetupManager.php

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,11 @@ class SetupManager {
6060
private array $setupUsers = [];
6161
// List of users for which all mounts are setup
6262
private array $setupUsersComplete = [];
63-
/** @var array<string, string[]> */
63+
/**
64+
* An array of provider classes that have been set up, indexed by UserUID.
65+
*
66+
* @var array<string, class-string<IMountProvider>[]>
67+
*/
6468
private array $setupUserMountProviders = [];
6569
private ICache $cache;
6670
private bool $listeningForProviders;
@@ -213,7 +217,7 @@ public function setupForUser(IUser $user): void {
213217
}
214218

215219
/**
216-
* part of the user setup that is run only once per user
220+
* Part of the user setup that is run only once per user.
217221
*/
218222
private function oneTimeUserSetup(IUser $user) {
219223
if ($this->isSetupStarted($user)) {
@@ -303,11 +307,16 @@ private function afterUserFullySetup(IUser $user, array $previouslySetupProvider
303307
}
304308

305309
/**
310+
* Executes the one-time user setup and, if the user can access the
311+
* filesystem, executes $mountCallback.
312+
*
306313
* @param IUser $user
307314
* @param IMountPoint $mounts
308315
* @return void
309316
* @throws \OCP\HintException
310317
* @throws \OC\ServerNotAvailableException
318+
* @see self::oneTimeUserSetup()
319+
*
311320
*/
312321
private function setupForUserWith(IUser $user, callable $mountCallback): void {
313322
$this->oneTimeUserSetup($user);

0 commit comments

Comments
 (0)