Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 342c07d6 authored by Fahim M. Choudhury's avatar Fahim M. Choudhury Committed by Vincent Bourgmayer
Browse files

chore: apply suggestion on method doc

parent 25e00e77
Loading
Loading
Loading
Loading
Loading
+9 −9
Original line number Diff line number Diff line
@@ -58,7 +58,7 @@ object WorkRequestFactory {
    private const val PERIODIC_SCAN_FLEX_TIME_IN_MIN = 5L

    /**
     * Build an instance of PeriodicWorkRequest depending of the work type specified
     * Builds an instance of PeriodicWorkRequest depending of the work type specified
     * @param type WorkType. Should be PERIODIC_SCAN or PERIODIC_USER_INFO
     * @return Periodic WorkRequest
     */
@@ -70,7 +70,7 @@ object WorkRequestFactory {
    }

    /**
     * Build an instance of OneTimeWorkRequest depending of the work type specified.
     * Builds an instance of OneTimeWorkRequest depending of the work type specified.
     * @param type Should be ONE_TIME_USER_INFO, or FIRST_START, or CREATE_REMOTE_DIR
     * or it will throw InvalidParameterException
     * @param syncedFolder @Nullable this parameter is required for CREATE_REMOTE_DIR work type. Throw an NPE if null.
@@ -94,7 +94,7 @@ object WorkRequestFactory {
    }

    /**
     * Create a OneTimeWorkRequest instance for
     * Creates a OneTimeWorkRequest instance for
     * a Full scan with constraints on network (CONNECTED) and battery (shouldn't be low)
     * @return instance of OneTimeWorkRequest
     */
@@ -117,7 +117,7 @@ object WorkRequestFactory {
    }

    /**
     * Create a workRequest to generate file which contains list of installed apps
     * Creates a workRequest to generate file which contains list of installed apps
     * @return the workRequest
     */
    private fun createAppListGenerationWorkRequest(): OneTimeWorkRequest {
@@ -129,7 +129,7 @@ object WorkRequestFactory {
    }

    /**
     * Instanciate a OneTimeWorkRequest to retrieve user info
     * Instantiates a OneTimeWorkRequest to retrieve user info
     * @return instance of OneTimeWorkRequest
     */
    private fun createGetUserInfoWorkRequest(): OneTimeWorkRequest {
@@ -147,7 +147,7 @@ object WorkRequestFactory {
    }

    /**
     * Create a OneTime workRequest to create a remote folder
     * Creates a OneTime workRequest to create a remote folder
     * With constraints on network (unmetered) and battery (not low)
     * @param syncedFolder SyncedFolder instance with data about folder to create
     * @return Instance OneTimeWorkRequest
@@ -168,7 +168,7 @@ object WorkRequestFactory {
    }

    /**
     * Parse SyncedFolder instance in Data, used as data for WorkRequest
     * Parses SyncedFolder instance in Data, used as data for WorkRequest
     * @param folder SyncedFolder instance
     * @return Data instance
     */
@@ -189,7 +189,7 @@ object WorkRequestFactory {
    }

    /**
     * Create a OneTime WorkRequest which finish setup process
     * Creates a OneTime WorkRequest which finish setup process
     * @return Instance of OneTimeWorkRequest
     */
    private fun createFinishSetupWorkRequest(): OneTimeWorkRequest {
@@ -215,7 +215,7 @@ object WorkRequestFactory {
    }

    /**
     * Create a PeriodicWorkRequest instance for
     * Creates a PeriodicWorkRequest instance for
     * a Full scan with constraints on network (CONNECTED) and battery (not low)
     * @return instance of PeriodicWorkRequest
     */