From 960d12bd2332b73d49adbd6fdcbb767abf3f461c Mon Sep 17 00:00:00 2001 From: Sumir Kataria Date: Thu, 31 May 2018 14:31:43 -0700 Subject: Fix/improve some docs. Test: Ran genDocs. Change-Id: I5987f71327dd73ebe83b2218ca4e612e93221e82 --- .../src/main/java/androidx/work/test/TestScheduler.java | 8 +++----- .../main/java/androidx/work/test/WorkManagerTestInitHelper.java | 4 ++-- .../src/main/java/androidx/work/PeriodicWorkRequest.java | 6 ++---- work/workmanager/src/main/java/androidx/work/WorkRequest.java | 6 +++--- 4 files changed, 10 insertions(+), 14 deletions(-) diff --git a/work/workmanager-test/src/main/java/androidx/work/test/TestScheduler.java b/work/workmanager-test/src/main/java/androidx/work/test/TestScheduler.java index 6b9b1f88f6a..bfec17187ce 100644 --- a/work/workmanager-test/src/main/java/androidx/work/test/TestScheduler.java +++ b/work/workmanager-test/src/main/java/androidx/work/test/TestScheduler.java @@ -76,12 +76,10 @@ class TestScheduler implements Scheduler, ExecutionListener { } /** - * Tells the {@link TestScheduler} to pretend that all constraints on the - * {@link Worker} with the given {@code workSpecId} are met. + * Tells the {@link TestScheduler} to pretend that all constraints on the {@link Worker} with + * the given {@code workSpecId} are met. * - * The {@link Worker} is scheduled for execution. - * - * @param workSpecId is the {@link Worker}s id. + * @param workSpecId The {@link Worker}'s id. */ void setAllConstraintsMet(@NonNull UUID workSpecId) { synchronized (sLock) { diff --git a/work/workmanager-test/src/main/java/androidx/work/test/WorkManagerTestInitHelper.java b/work/workmanager-test/src/main/java/androidx/work/test/WorkManagerTestInitHelper.java index a349865f442..d3e691a642c 100644 --- a/work/workmanager-test/src/main/java/androidx/work/test/WorkManagerTestInitHelper.java +++ b/work/workmanager-test/src/main/java/androidx/work/test/WorkManagerTestInitHelper.java @@ -76,8 +76,8 @@ public final class WorkManagerTestInitHelper { } /** - * @return An instance of {@link TestDriver}. This exposes additional functionality - * that are useful in the context of testing when using WorkManager. + * @return An instance of {@link TestDriver}. This exposes additional functionality that is + * useful in the context of testing when using WorkManager. */ public static TestDriver getTestDriver() { WorkManagerImpl workManager = WorkManagerImpl.getInstance(); diff --git a/work/workmanager/src/main/java/androidx/work/PeriodicWorkRequest.java b/work/workmanager/src/main/java/androidx/work/PeriodicWorkRequest.java index 0ebe01d520c..fe1a3870241 100644 --- a/work/workmanager/src/main/java/androidx/work/PeriodicWorkRequest.java +++ b/work/workmanager/src/main/java/androidx/work/PeriodicWorkRequest.java @@ -29,13 +29,11 @@ import java.util.concurrent.TimeUnit; public final class PeriodicWorkRequest extends WorkRequest { /** - * The minimum interval duration for {@link PeriodicWorkRequest}, in milliseconds. - * Based on {@see https://android.googlesource.com/platform/frameworks/base/+/master/core/java/android/app/job/JobInfo.java#110}. + * The minimum interval duration for {@link PeriodicWorkRequest} (in milliseconds). */ public static final long MIN_PERIODIC_INTERVAL_MILLIS = 15 * 60 * 1000L; // 15 minutes. /** - * The minimum flex duration for {@link PeriodicWorkRequest}, in milliseconds. - * Based on {@see https://android.googlesource.com/platform/frameworks/base/+/master/core/java/android/app/job/JobInfo.java#113}. + * The minimum flex duration for {@link PeriodicWorkRequest} (in milliseconds). */ public static final long MIN_PERIODIC_FLEX_MILLIS = 5 * 60 * 1000L; // 5 minutes. diff --git a/work/workmanager/src/main/java/androidx/work/WorkRequest.java b/work/workmanager/src/main/java/androidx/work/WorkRequest.java index 5636bf59d86..223244448f1 100644 --- a/work/workmanager/src/main/java/androidx/work/WorkRequest.java +++ b/work/workmanager/src/main/java/androidx/work/WorkRequest.java @@ -35,17 +35,17 @@ import java.util.concurrent.TimeUnit; public abstract class WorkRequest { /** - * {@see https://android.googlesource.com/platform/frameworks/base/+/oreo-release/core/java/android/app/job/JobInfo.java#77} + * The default initial backoff time (in milliseconds) for work that has to be retried. */ public static final long DEFAULT_BACKOFF_DELAY_MILLIS = 30000L; /** - * {@see https://android.googlesource.com/platform/frameworks/base/+/oreo-release/core/java/android/app/job/JobInfo.java#82} + * The maximum backoff time (in milliseconds) for work that has to be retried. */ public static final long MAX_BACKOFF_MILLIS = 5 * 60 * 60 * 1000; // 5 hours. /** - * {@see https://android.googlesource.com/platform/frameworks/base/+/oreo-release/core/java/android/app/job/JobInfo.java#119} + * The minimum backoff time for work (in milliseconds) that has to be retried. */ public static final long MIN_BACKOFF_MILLIS = 10 * 1000; // 10 seconds. -- cgit v1.2.3