Skip to content

Commit 6c15c11

Browse files
author
Rachel Prince
committed
Small syntax fixes; Standardize use of period in java docs
1 parent 055df3e commit 6c15c11

10 files changed

+30
-35
lines changed

firebase-appdistribution/src/main/java/com/google/firebase/appdistribution/AppDistributionRelease.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ static Builder builder() {
3030
return new com.google.firebase.appdistribution.AutoValue_AppDistributionRelease.Builder();
3131
}
3232

33-
/** The short bundle version of this build (example 1.0.0). */
33+
/** The short bundle version of this build (example: 1.0.0). */
3434
@NonNull
3535
public abstract String getDisplayVersion();
3636

firebase-appdistribution/src/main/java/com/google/firebase/appdistribution/AppDistributionReleaseInternal.java

Lines changed: 9 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,7 @@
1919
import com.google.auto.value.AutoValue;
2020

2121
/**
22-
* This class represents the AppDistributionRelease object returned by the App Distribution backend
23-
*
24-
* <p>It is an immutable value class implemented by AutoValue.
25-
*
26-
* @see <a
27-
* href="https://github.com/google/auto/tree/master/value">https://github.com/google/auto/tree/master/value</a>
22+
* This class represents the AppDistributionRelease object returned by the App Distribution backend.
2823
*/
2924
@AutoValue
3025
abstract class AppDistributionReleaseInternal {
@@ -34,38 +29,38 @@ static Builder builder() {
3429
return new AutoValue_AppDistributionReleaseInternal.Builder();
3530
}
3631

37-
/** The short bundle version of this build (example 1.0.0) */
32+
/** The short bundle version of this build (example: 1.0.0). */
3833
@NonNull
3934
abstract String getDisplayVersion();
4035

41-
/** The bundle version of this build (example: 123) */
36+
/** The bundle version of this build (example: 123). */
4237
@NonNull
4338
abstract String getBuildVersion();
4439

45-
/** The release notes for this build */
40+
/** The release notes for this build. */
4641
@Nullable
4742
abstract String getReleaseNotes();
4843

49-
/** The binary type for this build */
44+
/** The binary type for this build. */
5045
@NonNull
5146
abstract BinaryType getBinaryType();
5247

53-
/** Hash of binary of an Android app */
48+
/** Hash of binary of an Android app. */
5449
@Nullable
5550
abstract String getCodeHash();
5651

57-
/** Efficient hash of an Android apk. Used to identify a release */
52+
/** Efficient hash of an Android apk. Used to identify a release. */
5853
@Nullable
5954
abstract String getApkHash();
6055

6156
/**
6257
* IAS artifact id. This value is inserted into the manifest of APK's installed via Used to map a
63-
* release to an APK installed via an app bundle
58+
* release to an APK installed via an app bundle.
6459
*/
6560
@Nullable
6661
abstract String getIasArtifactId();
6762

68-
/** Short-lived download URL */
63+
/** Short-lived download URL. */
6964
@Nullable
7065
abstract String getDownloadUrl();
7166

firebase-appdistribution/src/main/java/com/google/firebase/appdistribution/BinaryType.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414

1515
package com.google.firebase.appdistribution;
1616

17-
/** Enum of Android app binary types, used in {@link AppDistributionRelease} */
17+
/** Enum of Android app binary types, used in {@link AppDistributionRelease}. */
1818
public enum BinaryType {
1919
/** Android App Bundle. */
2020
AAB,

firebase-appdistribution/src/main/java/com/google/firebase/appdistribution/FirebaseAppDistribution.java

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ public class FirebaseAppDistribution {
8181
private TaskCompletionSource<Void> showSignInDialogTask = null;
8282
private TaskCompletionSource<Void> showUpdateDialogTask = null;
8383

84-
/** Constructor for FirebaseAppDistribution */
84+
/** Constructor for FirebaseAppDistribution. */
8585
@VisibleForTesting
8686
FirebaseAppDistribution(
8787
@NonNull FirebaseApp firebaseApp,
@@ -103,7 +103,7 @@ public class FirebaseAppDistribution {
103103
lifecycleNotifier.addOnActivityResumedListener(this::onActivityResumed);
104104
}
105105

106-
/** Constructor for FirebaseAppDistribution */
106+
/** Constructor for FirebaseAppDistribution. */
107107
FirebaseAppDistribution(
108108
@NonNull FirebaseApp firebaseApp,
109109
@NonNull Provider<FirebaseInstallationsApi> firebaseInstallationsApiProvider,
@@ -122,7 +122,7 @@ public class FirebaseAppDistribution {
122122
lifecycleNotifier);
123123
}
124124

125-
/** Constructor for FirebaseAppDistribution */
125+
/** Constructor for FirebaseAppDistribution. */
126126
FirebaseAppDistribution(
127127
@NonNull FirebaseApp firebaseApp,
128128
@NonNull Provider<FirebaseInstallationsApi> firebaseInstallationsApiProvider) {
@@ -150,7 +150,7 @@ public static FirebaseAppDistribution getInstance() {
150150
* <li>Checks if a newer release is available. If so, presents the tester with a confirmation
151151
* dialog to begin the download.
152152
* <li>For APKs, downloads the binary and starts an installation intent. For AABs, directs the
153-
* tester to the Play app to complete the download and installation.
153+
* tester to the Google Play app to complete the download and installation.
154154
* </ol>
155155
*/
156156
@NonNull
@@ -246,7 +246,7 @@ private Task<Void> showSignInConfirmationDialog(Activity hostActivity) {
246246
return showSignInDialogTask.getTask();
247247
}
248248

249-
/** Signs in the App Distribution tester. Presents the tester with a Google sign in UI */
249+
/** Signs in the App Distribution tester. Presents the tester with a Google sign in UI. */
250250
@NonNull
251251
public Task<Void> signInTester() {
252252
return this.testerSignInManager.signInTester();
@@ -326,7 +326,7 @@ private UpdateTask updateApp(boolean showDownloadInNotificationManager) {
326326
Constants.ErrorMessages.NOT_FOUND_ERROR, UPDATE_NOT_AVAILABLE));
327327
}
328328
if (cachedNewRelease.getDownloadUrl() == null) {
329-
LogWrapper.getInstance().v("Download failed to execute");
329+
LogWrapper.getInstance().v("Download failed to execute.");
330330
return getErrorUpdateTask(
331331
new FirebaseAppDistributionException(
332332
Constants.ErrorMessages.DOWNLOAD_URL_NOT_FOUND,
@@ -346,7 +346,7 @@ public boolean isTesterSignedIn() {
346346
return this.signInStorage.getSignInStatus();
347347
}
348348

349-
/** Signs out the App Distribution tester */
349+
/** Signs out the App Distribution tester. */
350350
public void signOutTester() {
351351
setCachedNewRelease(null);
352352
this.signInStorage.setSignInStatus(false);

firebase-appdistribution/src/main/java/com/google/firebase/appdistribution/FirebaseAppDistributionException.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ public enum Status {
3232
/** The authentication process was canceled. */
3333
AUTHENTICATION_CANCELED,
3434

35-
/** No network is available to make requests or the request timed out. */
35+
/** No network is available to make requests, or the request timed out. */
3636
NETWORK_FAILURE,
3737

3838
/** The new release failed to download. */

firebase-appdistribution/src/main/java/com/google/firebase/appdistribution/FirebaseAppDistributionLifecycleNotifier.java

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -45,23 +45,23 @@ interface ActivityConsumer<T> {
4545
@GuardedBy("lock")
4646
private Activity currentActivity;
4747

48-
/** A queue of listeners that trigger when the activity is foregrounded */
48+
/** A queue of listeners that trigger when the activity is foregrounded. */
4949
@GuardedBy("lock")
5050
private final Queue<OnActivityCreatedListener> onActivityCreatedListeners = new ArrayDeque<>();
5151

52-
/** A queue of listeners that trigger when the activity is foregrounded */
52+
/** A queue of listeners that trigger when the activity is foregrounded. */
5353
@GuardedBy("lock")
5454
private final Queue<OnActivityStartedListener> onActivityStartedListeners = new ArrayDeque<>();
5555

56-
/** A queue of listeners that trigger when the activity is resumed */
56+
/** A queue of listeners that trigger when the activity is resumed. */
5757
@GuardedBy("lock")
5858
private final Queue<OnActivityResumedListener> onActivityResumedListeners = new ArrayDeque<>();
5959

60-
/** A queue of listeners that trigger when the activity is backgrounded */
60+
/** A queue of listeners that trigger when the activity is backgrounded. */
6161
@GuardedBy("lock")
6262
private final Queue<OnActivityPausedListener> onActivityPausedListeners = new ArrayDeque<>();
6363

64-
/** A queue of listeners that trigger when the activity is destroyed */
64+
/** A queue of listeners that trigger when the activity is destroyed. */
6565
@GuardedBy("lock")
6666
private final Queue<OnActivityDestroyedListener> onDestroyedListeners = new ArrayDeque<>();
6767

firebase-appdistribution/src/main/java/com/google/firebase/appdistribution/FirebaseAppDistributionRegistrar.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030
import java.util.List;
3131

3232
/**
33-
* Registers FirebaseAppDistribution
33+
* Registers FirebaseAppDistribution.
3434
*
3535
* @hide
3636
*/

firebase-appdistribution/src/main/java/com/google/firebase/appdistribution/FirebaseAppDistributionTesterApiClient.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ class FirebaseAppDistributionTesterApiClient {
6969
}
7070

7171
/**
72-
* Fetches and returns the lastest release for the app that the tester has access to, or null if
72+
* Fetches and returns the latest release for the app that the tester has access to, or null if
7373
* the tester doesn't have access to any releases.
7474
*/
7575
@Nullable

firebase-appdistribution/src/main/java/com/google/firebase/appdistribution/ReleaseIdentificationUtils.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,9 @@ final class ReleaseIdentificationUtils {
3737
private static final int NO_FLAGS = 0;
3838

3939
/**
40-
* Get the package info for the currently installed app
40+
* Get the package info for the currently installed app.
4141
*
42-
* @throws FirebaseAppDistributionException if the package name can't be found
42+
* @throws FirebaseAppDistributionException if the package name can't be found.
4343
*/
4444
static PackageInfo getPackageInfo(Context context) throws FirebaseAppDistributionException {
4545
return getPackageInfoWithFlags(context, NO_FLAGS);
@@ -49,7 +49,7 @@ static PackageInfo getPackageInfo(Context context) throws FirebaseAppDistributio
4949
* Get the package info for the currently installed app, with the PackageManager.GET_META_DATA
5050
* flag set.
5151
*
52-
* @throws FirebaseAppDistributionException if the package name can't be found
52+
* @throws FirebaseAppDistributionException if the package name can't be found.
5353
*/
5454
static PackageInfo getPackageInfoWithMetadata(Context context)
5555
throws FirebaseAppDistributionException {

firebase-appdistribution/src/main/java/com/google/firebase/appdistribution/TesterSignInManager.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@
4242
import com.google.firebase.installations.FirebaseInstallationsApi;
4343
import java.util.List;
4444

45-
/** Class that handles signing in the tester */
45+
/** Class that handles signing in the tester. */
4646
class TesterSignInManager {
4747
private static final String TAG = "TesterSignInManager:";
4848
private static final String SIGNIN_REDIRECT_URL =

0 commit comments

Comments
 (0)