From ec2a547b1f12558015b94b00586653f3d480184b Mon Sep 17 00:00:00 2001 From: Marc Sciglimpaglia Date: Fri, 2 Feb 2018 14:45:50 -0800 Subject: [PATCH] Javadoc cleanup (#346) * [javadoc-cleans] javadoc cleanup * [javadoc-cleans] restricted annotations * [javadoc-cleans] more feedback --- .../java/com/urbanairship/ChannelCapture.java | 2 +- .../urbanairship/UrbanAirshipResolver.java | 6 +++++- .../analytics/data/EventApiClient.java | 4 ++++ .../analytics/data/EventResolver.java | 2 ++ .../automation/ActionScheduleEdits.java | 4 ++-- .../automation/ActionScheduleInfo.java | 10 +++++----- .../automation/AutomationDataManager.java | 2 ++ .../automation/AutomationDriver.java | 2 +- .../automation/ScheduleDelay.java | 2 +- .../automation/ScheduleEdits.java | 16 +++++++-------- .../urbanairship/automation/ScheduleInfo.java | 20 +++++++++---------- .../com/urbanairship/automation/Trigger.java | 2 +- .../automation/TriggerObservables.java | 2 ++ .../java/com/urbanairship/iam/Audience.java | 2 +- .../java/com/urbanairship/iam/ButtonInfo.java | 2 +- .../com/urbanairship/iam/DisplayContent.java | 2 +- .../com/urbanairship/iam/DisplayEvent.java | 2 +- .../urbanairship/iam/InAppActionUtils.java | 2 +- .../com/urbanairship/iam/InAppMessage.java | 1 - .../urbanairship/iam/InAppMessageAdapter.java | 4 ++-- .../iam/InAppMessageListener.java | 1 + .../iam/InAppMessageScheduleEdits.java | 14 ++++++------- .../iam/InAppMessageScheduleInfo.java | 8 ++++---- .../iam/InAppRemoteDataObserver.java | 2 ++ .../urbanairship/iam/MediaDisplayAdapter.java | 2 +- .../java/com/urbanairship/iam/MediaInfo.java | 10 +++++----- .../iam/banner/BannerDismissLayout.java | 8 ++++---- .../iam/banner/BannerDisplayContent.java | 2 +- .../urbanairship/iam/banner/package-info.java | 6 ++++++ .../urbanairship/iam/custom/package-info.java | 7 +++++++ .../iam/fullscreen/package-info.java | 7 +++++++ .../urbanairship/iam/html/package-info.java | 6 ++++++ .../urbanairship/iam/modal/package-info.java | 7 +++++++ .../com/urbanairship/iam/package-info.java | 7 +++++++ .../urbanairship/iam/view/BorderRadius.java | 4 ++++ .../iam/view/BoundedLinearLayout.java | 2 ++ .../iam/view/InAppButtonLayout.java | 2 ++ .../urbanairship/iam/view/InAppViewUtils.java | 2 ++ .../com/urbanairship/iam/view/MediaView.java | 2 ++ .../urbanairship/iam/view/package-info.java | 6 ++++++ .../DefaultMultiChoiceModeListener.java | 2 ++ .../notifications/NotificationFactory.java | 2 +- .../remotedata/RemoteDataPayloadEntry.java | 4 ++++ 43 files changed, 141 insertions(+), 61 deletions(-) create mode 100644 urbanairship-sdk/src/main/java/com/urbanairship/iam/banner/package-info.java create mode 100644 urbanairship-sdk/src/main/java/com/urbanairship/iam/custom/package-info.java create mode 100644 urbanairship-sdk/src/main/java/com/urbanairship/iam/fullscreen/package-info.java create mode 100644 urbanairship-sdk/src/main/java/com/urbanairship/iam/html/package-info.java create mode 100644 urbanairship-sdk/src/main/java/com/urbanairship/iam/modal/package-info.java create mode 100644 urbanairship-sdk/src/main/java/com/urbanairship/iam/package-info.java create mode 100644 urbanairship-sdk/src/main/java/com/urbanairship/iam/view/package-info.java diff --git a/urbanairship-sdk/src/main/java/com/urbanairship/ChannelCapture.java b/urbanairship-sdk/src/main/java/com/urbanairship/ChannelCapture.java index be2ee8704..eeb471976 100644 --- a/urbanairship-sdk/src/main/java/com/urbanairship/ChannelCapture.java +++ b/urbanairship-sdk/src/main/java/com/urbanairship/ChannelCapture.java @@ -21,7 +21,7 @@ /** * ChannelCapture checks the device clipboard for a String that is prefixed by - * {@link #generateToken()} on app foreground and posts a notification + * an expected token on app foreground and posts a notification * that allows the user to copy the Channel or optionally open a url with the channel as * an argument. */ diff --git a/urbanairship-sdk/src/main/java/com/urbanairship/UrbanAirshipResolver.java b/urbanairship-sdk/src/main/java/com/urbanairship/UrbanAirshipResolver.java index f3a35270a..fab859ea3 100644 --- a/urbanairship-sdk/src/main/java/com/urbanairship/UrbanAirshipResolver.java +++ b/urbanairship-sdk/src/main/java/com/urbanairship/UrbanAirshipResolver.java @@ -8,11 +8,15 @@ import android.database.ContentObserver; import android.database.Cursor; import android.net.Uri; +import android.support.annotation.RestrictTo; /** - * An ContentResolver wrapper used to access data from the + * A ContentResolver wrapper used to access data from the * {@link com.urbanairship.UrbanAirshipProvider}. + * + * @hide */ +@RestrictTo(RestrictTo.Scope.LIBRARY_GROUP) public class UrbanAirshipResolver { private final Context context; diff --git a/urbanairship-sdk/src/main/java/com/urbanairship/analytics/data/EventApiClient.java b/urbanairship-sdk/src/main/java/com/urbanairship/analytics/data/EventApiClient.java index b7f7b3efa..bee5d06d4 100644 --- a/urbanairship-sdk/src/main/java/com/urbanairship/analytics/data/EventApiClient.java +++ b/urbanairship-sdk/src/main/java/com/urbanairship/analytics/data/EventApiClient.java @@ -9,6 +9,7 @@ import android.os.Build; import android.provider.Settings; import android.support.annotation.NonNull; +import android.support.annotation.RestrictTo; import android.support.annotation.VisibleForTesting; import com.urbanairship.Logger; @@ -32,7 +33,10 @@ /** * A client that handles uploading analytic events + * + * @hide */ +@RestrictTo(RestrictTo.Scope.LIBRARY_GROUP) public class EventApiClient { static final String SYSTEM_LOCATION_DISABLED = "SYSTEM_LOCATION_DISABLED"; diff --git a/urbanairship-sdk/src/main/java/com/urbanairship/analytics/data/EventResolver.java b/urbanairship-sdk/src/main/java/com/urbanairship/analytics/data/EventResolver.java index 627c7b155..093f5dc89 100644 --- a/urbanairship-sdk/src/main/java/com/urbanairship/analytics/data/EventResolver.java +++ b/urbanairship-sdk/src/main/java/com/urbanairship/analytics/data/EventResolver.java @@ -21,6 +21,8 @@ /** * Performs event database operations. + * + * @hide */ @RestrictTo(RestrictTo.Scope.LIBRARY_GROUP) public class EventResolver extends UrbanAirshipResolver { diff --git a/urbanairship-sdk/src/main/java/com/urbanairship/automation/ActionScheduleEdits.java b/urbanairship-sdk/src/main/java/com/urbanairship/automation/ActionScheduleEdits.java index c3ffaf755..ceeb875de 100644 --- a/urbanairship-sdk/src/main/java/com/urbanairship/automation/ActionScheduleEdits.java +++ b/urbanairship-sdk/src/main/java/com/urbanairship/automation/ActionScheduleEdits.java @@ -17,7 +17,7 @@ import java.util.concurrent.TimeUnit; /** - * Edits for an action schedules. + * Edits for an action schedule. */ public class ActionScheduleEdits implements ScheduleEdits { @@ -111,7 +111,7 @@ public Map getActions() { /** - * Create a new builder. + * Creates a new builder. * * @return A new builder instance. */ diff --git a/urbanairship-sdk/src/main/java/com/urbanairship/automation/ActionScheduleInfo.java b/urbanairship-sdk/src/main/java/com/urbanairship/automation/ActionScheduleInfo.java index 5cb444153..dd0e1bb23 100644 --- a/urbanairship-sdk/src/main/java/com/urbanairship/automation/ActionScheduleInfo.java +++ b/urbanairship-sdk/src/main/java/com/urbanairship/automation/ActionScheduleInfo.java @@ -213,7 +213,7 @@ public long getInterval() { * - "group": Optional. Group identifier. Useful to cancel schedules for a specific campaign. * - "start": Optional. Start time as an ISO 8601 timestamp. Time before the schedule starts listening for events. * - "end": Optional. End time as an ISO 8601 timestamp. After the schedule is past the end time it will automatically be canceled. - * - "triggers": Required. An array of triggers. Trigger payload as defined by {@link Trigger#predicate}. + * - "triggers": Required. An array of triggers. * - "limit": Optional, defaults to 1. Number of times to trigger the actions payload before cancelling the schedule. * - "priority": Optional, defaults to 0. In case of conflict, schedules will be executed by priority in ascending order. * - "actions": Required. Actions payload to run when one or more of the triggers meets its goal. @@ -357,9 +357,9 @@ public Builder setGroup(String group) { } /** - * Sets the start time in MS. + * Sets the start time in ms. * - * @param start The start time in MS. + * @param start The start time in ms. * @return The Builder instance. */ public Builder setStart(long start) { @@ -368,9 +368,9 @@ public Builder setStart(long start) { } /** - * Sets the end time in MS. + * Sets the end time in ms. * - * @param end The end time in MS. + * @param end The end time in ms. * @return The Builder instance. */ public Builder setEnd(long end) { diff --git a/urbanairship-sdk/src/main/java/com/urbanairship/automation/AutomationDataManager.java b/urbanairship-sdk/src/main/java/com/urbanairship/automation/AutomationDataManager.java index a8a380df4..9298651ca 100644 --- a/urbanairship-sdk/src/main/java/com/urbanairship/automation/AutomationDataManager.java +++ b/urbanairship-sdk/src/main/java/com/urbanairship/automation/AutomationDataManager.java @@ -25,6 +25,8 @@ /** * {@link DataManager} class for automation schedules. + * + * @hide */ @RestrictTo(RestrictTo.Scope.LIBRARY_GROUP) public class AutomationDataManager extends DataManager { diff --git a/urbanairship-sdk/src/main/java/com/urbanairship/automation/AutomationDriver.java b/urbanairship-sdk/src/main/java/com/urbanairship/automation/AutomationDriver.java index f4fd77eeb..6d3e3a328 100644 --- a/urbanairship-sdk/src/main/java/com/urbanairship/automation/AutomationDriver.java +++ b/urbanairship-sdk/src/main/java/com/urbanairship/automation/AutomationDriver.java @@ -6,7 +6,7 @@ import android.support.annotation.NonNull; /** - * Driver for AutomationEngine. Handles executing, and converting generic ScheduleInfo into the proper + * Driver for AutomationEngine. Handles executing and converting generic ScheduleInfo into the proper * Schedule class. * * @param The schedule type. diff --git a/urbanairship-sdk/src/main/java/com/urbanairship/automation/ScheduleDelay.java b/urbanairship-sdk/src/main/java/com/urbanairship/automation/ScheduleDelay.java index 4f779d7a1..79aafa883 100644 --- a/urbanairship-sdk/src/main/java/com/urbanairship/automation/ScheduleDelay.java +++ b/urbanairship-sdk/src/main/java/com/urbanairship/automation/ScheduleDelay.java @@ -17,7 +17,7 @@ import java.util.List; /** - * Defines a conditions that might delay the execution of a schedule. + * Defines conditions that might delay the execution of a schedule. */ public class ScheduleDelay implements Parcelable { diff --git a/urbanairship-sdk/src/main/java/com/urbanairship/automation/ScheduleEdits.java b/urbanairship-sdk/src/main/java/com/urbanairship/automation/ScheduleEdits.java index 1a527af2c..754319d81 100644 --- a/urbanairship-sdk/src/main/java/com/urbanairship/automation/ScheduleEdits.java +++ b/urbanairship-sdk/src/main/java/com/urbanairship/automation/ScheduleEdits.java @@ -39,33 +39,33 @@ public interface ScheduleEdits { Integer getPriority(); /** - * Gets the schedule start time in MS. + * Gets the schedule start time in ms. * - * @return The schedule start time in MS. + * @return The schedule start time in ms. */ @Nullable Long getStart(); /** - * Gets the schedule end time in MS. + * Gets the schedule end time in ms. * - * @return The schedule end time in MS. + * @return The schedule end time in ms. */ @Nullable Long getEnd(); /** - * Gets the schedule interval in MS. + * Gets the schedule interval in ms. * - * @return The schedule interval in MS. + * @return The schedule interval in ms. */ @Nullable Long getInterval(); /** - * Gets the schedule edit grace period in MS. + * Gets the schedule edit grace period in ms. * - * @return The schedule edit grace period in MS. + * @return The schedule edit grace period in ms. */ @Nullable Long getEditGracePeriod(); diff --git a/urbanairship-sdk/src/main/java/com/urbanairship/automation/ScheduleInfo.java b/urbanairship-sdk/src/main/java/com/urbanairship/automation/ScheduleInfo.java index 6d7279d93..f8cbcec57 100644 --- a/urbanairship-sdk/src/main/java/com/urbanairship/automation/ScheduleInfo.java +++ b/urbanairship-sdk/src/main/java/com/urbanairship/automation/ScheduleInfo.java @@ -32,9 +32,9 @@ public interface ScheduleInfo { List getTriggers(); /** - * Gets the schedules data. + * Gets the schedule data. * - * @return Schedules data. + * @return Schedule data. */ @RestrictTo(RestrictTo.Scope.LIBRARY_GROUP) JsonSerializable getData(); @@ -61,16 +61,16 @@ public interface ScheduleInfo { String getGroup(); /** - * Gets the schedule start time in MS. + * Gets the schedule start time in ms. * - * @return The schedule start time in MS. + * @return The schedule start time in ms. */ long getStart(); /** - * Gets the schedule end time in MS. + * Gets the schedule end time in ms. * - * @return The schedule end time in MS. + * @return The schedule end time in ms. */ long getEnd(); @@ -82,16 +82,16 @@ public interface ScheduleInfo { ScheduleDelay getDelay(); /** - * Gets the edit grace period in MS. + * Gets the edit grace period in ms. * - * @return The edit grace period in MS. + * @return The edit grace period in ms. */ long getEditGracePeriod(); /** - * Gets the schedule execution interval in MS. + * Gets the schedule execution interval in ms. * - * @return The interval in MS. + * @return The interval in ms. */ long getInterval(); } diff --git a/urbanairship-sdk/src/main/java/com/urbanairship/automation/Trigger.java b/urbanairship-sdk/src/main/java/com/urbanairship/automation/Trigger.java index 1228f34de..11c417f3d 100644 --- a/urbanairship-sdk/src/main/java/com/urbanairship/automation/Trigger.java +++ b/urbanairship-sdk/src/main/java/com/urbanairship/automation/Trigger.java @@ -99,7 +99,7 @@ public class Trigger implements Parcelable { /** * Trigger type for version. Version triggers can be create with - * {@link Triggers#newVersionTriggerBuilder(JsonPredicate)} + * {@link Triggers#newVersionTriggerBuilder(com.urbanairship.json.ValueMatcher)} */ public static final int VERSION = 10; diff --git a/urbanairship-sdk/src/main/java/com/urbanairship/automation/TriggerObservables.java b/urbanairship-sdk/src/main/java/com/urbanairship/automation/TriggerObservables.java index 873349477..057d90ecc 100644 --- a/urbanairship-sdk/src/main/java/com/urbanairship/automation/TriggerObservables.java +++ b/urbanairship-sdk/src/main/java/com/urbanairship/automation/TriggerObservables.java @@ -15,6 +15,8 @@ /** * Factory methods for creating compound trigger observables + * + * @hide */ class TriggerObservables { diff --git a/urbanairship-sdk/src/main/java/com/urbanairship/iam/Audience.java b/urbanairship-sdk/src/main/java/com/urbanairship/iam/Audience.java index af48f3b3e..9706f1b2a 100644 --- a/urbanairship-sdk/src/main/java/com/urbanairship/iam/Audience.java +++ b/urbanairship-sdk/src/main/java/com/urbanairship/iam/Audience.java @@ -19,7 +19,7 @@ /** * Audience conditions for an in-app message. Audiences are normally only validated at display time, - * and if the audience is not met, the in-app message will be canceled. + * and if the audience is not met, the in-app message will not be displayed. */ public class Audience implements JsonSerializable { diff --git a/urbanairship-sdk/src/main/java/com/urbanairship/iam/ButtonInfo.java b/urbanairship-sdk/src/main/java/com/urbanairship/iam/ButtonInfo.java index e90ef57c3..06a4f6559 100644 --- a/urbanairship-sdk/src/main/java/com/urbanairship/iam/ButtonInfo.java +++ b/urbanairship-sdk/src/main/java/com/urbanairship/iam/ButtonInfo.java @@ -174,7 +174,7 @@ public static ButtonInfo parseJson(JsonValue jsonValue) throws JsonException { * * @param jsonList The json list.. * @return The list of parsed button info. - * @throws JsonException If list was unable to be parsed. + * @throws JsonException If the list was unable to be parsed. */ public static List parseJson(JsonList jsonList) throws JsonException { if (jsonList == null || jsonList.isEmpty()) { diff --git a/urbanairship-sdk/src/main/java/com/urbanairship/iam/DisplayContent.java b/urbanairship-sdk/src/main/java/com/urbanairship/iam/DisplayContent.java index 814f05581..dc16f2b35 100644 --- a/urbanairship-sdk/src/main/java/com/urbanairship/iam/DisplayContent.java +++ b/urbanairship-sdk/src/main/java/com/urbanairship/iam/DisplayContent.java @@ -19,7 +19,7 @@ public interface DisplayContent extends JsonSerializable { @interface ButtonLayout {} /** - * Buttons are displays with a space between them. + * Buttons are displayed with a space between them. */ String BUTTON_LAYOUT_SEPARATE = "separate"; diff --git a/urbanairship-sdk/src/main/java/com/urbanairship/iam/DisplayEvent.java b/urbanairship-sdk/src/main/java/com/urbanairship/iam/DisplayEvent.java index 7a61967c9..9883697a7 100644 --- a/urbanairship-sdk/src/main/java/com/urbanairship/iam/DisplayEvent.java +++ b/urbanairship-sdk/src/main/java/com/urbanairship/iam/DisplayEvent.java @@ -6,7 +6,7 @@ import android.support.annotation.RestrictTo; /** - * Display in-app message event. + * In-app message display event. * * @hide */ diff --git a/urbanairship-sdk/src/main/java/com/urbanairship/iam/InAppActionUtils.java b/urbanairship-sdk/src/main/java/com/urbanairship/iam/InAppActionUtils.java index 167c21730..ee32fd7d3 100644 --- a/urbanairship-sdk/src/main/java/com/urbanairship/iam/InAppActionUtils.java +++ b/urbanairship-sdk/src/main/java/com/urbanairship/iam/InAppActionUtils.java @@ -11,7 +11,7 @@ import java.util.Map; /** - * Actions utils for in-app messaging. + * Action utils for in-app messaging. */ public abstract class InAppActionUtils { diff --git a/urbanairship-sdk/src/main/java/com/urbanairship/iam/InAppMessage.java b/urbanairship-sdk/src/main/java/com/urbanairship/iam/InAppMessage.java index e86948ef1..822bfe86c 100644 --- a/urbanairship-sdk/src/main/java/com/urbanairship/iam/InAppMessage.java +++ b/urbanairship-sdk/src/main/java/com/urbanairship/iam/InAppMessage.java @@ -143,7 +143,6 @@ public String getType() { * {@link #TYPE_CUSTOM}: a {@link com.urbanairship.iam.custom.CustomDisplayContent}, * {@link #TYPE_FULLSCREEN}: a {@link com.urbanairship.iam.fullscreen.FullScreenDisplayContent} * - * @param The expected content type. * @return The display content. */ public T getDisplayContent() { diff --git a/urbanairship-sdk/src/main/java/com/urbanairship/iam/InAppMessageAdapter.java b/urbanairship-sdk/src/main/java/com/urbanairship/iam/InAppMessageAdapter.java index 75f558714..b9540b3f6 100644 --- a/urbanairship-sdk/src/main/java/com/urbanairship/iam/InAppMessageAdapter.java +++ b/urbanairship-sdk/src/main/java/com/urbanairship/iam/InAppMessageAdapter.java @@ -42,12 +42,12 @@ interface Factory { int OK = 0; /*** - * Indicates a failure result that needs to be retried. + * Indicates that the the prepare step should be retried. */ int RETRY = 1; /*** - * Indicates a failure result and the schedule should be cancelled. + * Indicates that the prepare step failed and the schedule should be canceled. */ int CANCEL = 2; diff --git a/urbanairship-sdk/src/main/java/com/urbanairship/iam/InAppMessageListener.java b/urbanairship-sdk/src/main/java/com/urbanairship/iam/InAppMessageListener.java index cf28f5c35..f53164668 100644 --- a/urbanairship-sdk/src/main/java/com/urbanairship/iam/InAppMessageListener.java +++ b/urbanairship-sdk/src/main/java/com/urbanairship/iam/InAppMessageListener.java @@ -19,6 +19,7 @@ public interface InAppMessageListener { /** * Called when an in-app message finished displaying. + * * @param scheduleId The schedule ID. * @param message The in-app message. * @param resolutionInfo The resolution info. diff --git a/urbanairship-sdk/src/main/java/com/urbanairship/iam/InAppMessageScheduleEdits.java b/urbanairship-sdk/src/main/java/com/urbanairship/iam/InAppMessageScheduleEdits.java index 6c4f59295..25d8d0bdd 100644 --- a/urbanairship-sdk/src/main/java/com/urbanairship/iam/InAppMessageScheduleEdits.java +++ b/urbanairship-sdk/src/main/java/com/urbanairship/iam/InAppMessageScheduleEdits.java @@ -114,7 +114,7 @@ public InAppMessage getMessage() { /** - * Parses a json value for an in-app message edits. + * Parses a json value for in-app message edits. * * @param value The json value. * @return The edit info. @@ -230,9 +230,9 @@ public Builder setMessage(InAppMessage message) { } /** - * Sets the start time in MS. + * Sets the start time in ms. * - * @param start The start time in MS. + * @param start The start time in ms. * @return The Builder instance. */ public Builder setStart(long start) { @@ -241,9 +241,9 @@ public Builder setStart(long start) { } /** - * Sets the end time in MS. + * Sets the end time in ms. * - * @param end The end time in MS. + * @param end The end time in ms. * @return The Builder instance. */ public Builder setEnd(long end) { @@ -287,9 +287,9 @@ public Builder setInterval(@IntRange(from = 0) long duration, @NonNull TimeUnit } /** - * Builds the in-app message schedule edit. + * Builds the in-app message schedule edits. * - * @return The schedule edit. + * @return The schedule edits. */ public InAppMessageScheduleEdits build() { return new InAppMessageScheduleEdits(this); diff --git a/urbanairship-sdk/src/main/java/com/urbanairship/iam/InAppMessageScheduleInfo.java b/urbanairship-sdk/src/main/java/com/urbanairship/iam/InAppMessageScheduleInfo.java index 3671a8f90..911994ac5 100644 --- a/urbanairship-sdk/src/main/java/com/urbanairship/iam/InAppMessageScheduleInfo.java +++ b/urbanairship-sdk/src/main/java/com/urbanairship/iam/InAppMessageScheduleInfo.java @@ -279,9 +279,9 @@ public Builder setMessage(InAppMessage message) { } /** - * Sets the start time in MS. + * Sets the start time in ms. * - * @param start The start time in MS. + * @param start The start time in ms. * @return The Builder instance. */ public Builder setStart(long start) { @@ -290,9 +290,9 @@ public Builder setStart(long start) { } /** - * Sets the end time in MS. + * Sets the end time in ms. * - * @param end The end time in MS. + * @param end The end time in ms. * @return The Builder instance. */ public Builder setEnd(long end) { diff --git a/urbanairship-sdk/src/main/java/com/urbanairship/iam/InAppRemoteDataObserver.java b/urbanairship-sdk/src/main/java/com/urbanairship/iam/InAppRemoteDataObserver.java index adedb5b3e..e5f48a9be 100644 --- a/urbanairship-sdk/src/main/java/com/urbanairship/iam/InAppRemoteDataObserver.java +++ b/urbanairship-sdk/src/main/java/com/urbanairship/iam/InAppRemoteDataObserver.java @@ -32,6 +32,8 @@ /** * Subscriber for {@link com.urbanairship.remotedata.RemoteData}. + * + * @hide */ class InAppRemoteDataObserver { diff --git a/urbanairship-sdk/src/main/java/com/urbanairship/iam/MediaDisplayAdapter.java b/urbanairship-sdk/src/main/java/com/urbanairship/iam/MediaDisplayAdapter.java index d9f890823..456bd5fad 100644 --- a/urbanairship-sdk/src/main/java/com/urbanairship/iam/MediaDisplayAdapter.java +++ b/urbanairship-sdk/src/main/java/com/urbanairship/iam/MediaDisplayAdapter.java @@ -22,7 +22,7 @@ import java.net.URL; /** - * Display adapter that handles caching in-app message. + * Display adapter that handles caching an in-app message. */ public abstract class MediaDisplayAdapter implements InAppMessageAdapter { diff --git a/urbanairship-sdk/src/main/java/com/urbanairship/iam/MediaInfo.java b/urbanairship-sdk/src/main/java/com/urbanairship/iam/MediaInfo.java index 67fc87cb6..b28fd90bc 100644 --- a/urbanairship-sdk/src/main/java/com/urbanairship/iam/MediaInfo.java +++ b/urbanairship-sdk/src/main/java/com/urbanairship/iam/MediaInfo.java @@ -16,7 +16,7 @@ import java.lang.annotation.RetentionPolicy; /** - * Image display info. + * Media display info. */ public class MediaInfo implements JsonSerializable { @@ -51,7 +51,7 @@ public class MediaInfo implements JsonSerializable { /** * Default constructor. * - * @param builder The image info builder. + * @param builder The media info builder. */ private MediaInfo(Builder builder) { this.url = builder.url; @@ -70,11 +70,11 @@ public JsonValue toJsonValue() { } /** - * Parses an {@link MediaInfo} from a {@link JsonValue}. + * Parses a {@link MediaInfo} from a {@link JsonValue}. * * @param jsonValue The json value. * @return The parsed media info. - * @throws JsonException If the image info was unable to be parsed. + * @throws JsonException If the media info was unable to be parsed. */ public static MediaInfo parseJson(JsonValue jsonValue) throws JsonException { try { @@ -162,7 +162,7 @@ public static Builder newBuilder() { } /** - * Image info builder. + * Media info builder. */ public static class Builder { private String url; diff --git a/urbanairship-sdk/src/main/java/com/urbanairship/iam/banner/BannerDismissLayout.java b/urbanairship-sdk/src/main/java/com/urbanairship/iam/banner/BannerDismissLayout.java index 178df8331..c42f39a53 100644 --- a/urbanairship-sdk/src/main/java/com/urbanairship/iam/banner/BannerDismissLayout.java +++ b/urbanairship-sdk/src/main/java/com/urbanairship/iam/banner/BannerDismissLayout.java @@ -25,13 +25,13 @@ public class BannerDismissLayout extends FrameLayout { /** - * The percent of a view's width it must be dragged before its considered dismissible when the velocity + * The percent of a view's width it must be dragged before it is considered dismissible when the velocity * is less then the {@link #getMinFlingVelocity()}. */ private static final float IDLE_MIN_DRAG_PERCENT = .4f; /** - * The percent of a view's width it must be dragged before its considered dismissible when the velocity + * The percent of a view's width it must be dragged before it is considered dismissible when the velocity * is greater then the {@link #getMinFlingVelocity()}. */ private static final float FLING_MIN_DRAG_PERCENT = .1f; @@ -83,7 +83,7 @@ public BannerDismissLayout(@NonNull Context context, @Nullable AttributeSet attr * BannerDismissLayout Constructor * * @param context A Context object used to access application assets. - * @param attrs An AttributeSet passed to our parent. + * @param attrs An AttributeSet passed to the parent. * @param defStyle The default style resource ID. */ public BannerDismissLayout(@NonNull Context context, @Nullable AttributeSet attrs, int defStyle) { @@ -95,7 +95,7 @@ public BannerDismissLayout(@NonNull Context context, @Nullable AttributeSet attr * BannerDismissLayout Constructor * * @param context A Context object used to access application assets. - * @param attrs An AttributeSet passed to our parent. + * @param attrs An AttributeSet passed to the parent. * @param defStyle The default style resource ID. * @param defResStyle A resource identifier of a style resource that supplies default values for * the view, used only if defStyle is 0 or cannot be found in the theme. Can be 0 to not diff --git a/urbanairship-sdk/src/main/java/com/urbanairship/iam/banner/BannerDisplayContent.java b/urbanairship-sdk/src/main/java/com/urbanairship/iam/banner/BannerDisplayContent.java index 22c0d7c39..f84863d2b 100644 --- a/urbanairship-sdk/src/main/java/com/urbanairship/iam/banner/BannerDisplayContent.java +++ b/urbanairship-sdk/src/main/java/com/urbanairship/iam/banner/BannerDisplayContent.java @@ -70,7 +70,7 @@ public class BannerDisplayContent implements DisplayContent { public static final long DEFAULT_DURATION_MS = 15000; /** - * Maximum number of button supported by a banner. + * Maximum number of buttons supported by a banner. */ public static final int MAX_BUTTONS = 2; diff --git a/urbanairship-sdk/src/main/java/com/urbanairship/iam/banner/package-info.java b/urbanairship-sdk/src/main/java/com/urbanairship/iam/banner/package-info.java new file mode 100644 index 000000000..725c7af0f --- /dev/null +++ b/urbanairship-sdk/src/main/java/com/urbanairship/iam/banner/package-info.java @@ -0,0 +1,6 @@ +/* Copyright 2018 Urban Airship and Contributors */ + +/** + * Contains classes related to banner in-app messages. + */ +package com.urbanairship.iam.banner; diff --git a/urbanairship-sdk/src/main/java/com/urbanairship/iam/custom/package-info.java b/urbanairship-sdk/src/main/java/com/urbanairship/iam/custom/package-info.java new file mode 100644 index 000000000..bec63f357 --- /dev/null +++ b/urbanairship-sdk/src/main/java/com/urbanairship/iam/custom/package-info.java @@ -0,0 +1,7 @@ +/* Copyright 2018 Urban Airship and Contributors */ + +/** + * Contains classes related to custom in-app messages. + */ +package com.urbanairship.iam.custom; + diff --git a/urbanairship-sdk/src/main/java/com/urbanairship/iam/fullscreen/package-info.java b/urbanairship-sdk/src/main/java/com/urbanairship/iam/fullscreen/package-info.java new file mode 100644 index 000000000..dff92b2cc --- /dev/null +++ b/urbanairship-sdk/src/main/java/com/urbanairship/iam/fullscreen/package-info.java @@ -0,0 +1,7 @@ +/* Copyright 2018 Urban Airship and Contributors */ + +/** + * Contains classes related to fullscreen in-app messages. + */ +package com.urbanairship.iam.fullscreen; + diff --git a/urbanairship-sdk/src/main/java/com/urbanairship/iam/html/package-info.java b/urbanairship-sdk/src/main/java/com/urbanairship/iam/html/package-info.java new file mode 100644 index 000000000..7b06939da --- /dev/null +++ b/urbanairship-sdk/src/main/java/com/urbanairship/iam/html/package-info.java @@ -0,0 +1,6 @@ +/* Copyright 2018 Urban Airship and Contributors */ + +/** + * Contains classes related to html in-app messages. + */ +package com.urbanairship.iam.html; diff --git a/urbanairship-sdk/src/main/java/com/urbanairship/iam/modal/package-info.java b/urbanairship-sdk/src/main/java/com/urbanairship/iam/modal/package-info.java new file mode 100644 index 000000000..d73c04b99 --- /dev/null +++ b/urbanairship-sdk/src/main/java/com/urbanairship/iam/modal/package-info.java @@ -0,0 +1,7 @@ +/* Copyright 2018 Urban Airship and Contributors */ + +/** + * Contains classes related to modal in-app messages. + */ +package com.urbanairship.iam.modal; + diff --git a/urbanairship-sdk/src/main/java/com/urbanairship/iam/package-info.java b/urbanairship-sdk/src/main/java/com/urbanairship/iam/package-info.java new file mode 100644 index 000000000..6c0ac3e90 --- /dev/null +++ b/urbanairship-sdk/src/main/java/com/urbanairship/iam/package-info.java @@ -0,0 +1,7 @@ +/* Copyright 2018 Urban Airship and Contributors */ + +/** + * Contains classes for creating and scheduling in-app messages. + */ +package com.urbanairship.iam; + diff --git a/urbanairship-sdk/src/main/java/com/urbanairship/iam/view/BorderRadius.java b/urbanairship-sdk/src/main/java/com/urbanairship/iam/view/BorderRadius.java index 56695baad..5c72ff1e2 100644 --- a/urbanairship-sdk/src/main/java/com/urbanairship/iam/view/BorderRadius.java +++ b/urbanairship-sdk/src/main/java/com/urbanairship/iam/view/BorderRadius.java @@ -3,6 +3,7 @@ package com.urbanairship.iam.view; import android.support.annotation.IntDef; +import android.support.annotation.RestrictTo; import android.util.TypedValue; import android.view.View; import android.view.ViewTreeObserver; @@ -13,7 +14,10 @@ /** * Utils class to generate a border radius array. + * + * @hide */ +@RestrictTo(RestrictTo.Scope.LIBRARY_GROUP) public abstract class BorderRadius { @IntDef(flag = true, diff --git a/urbanairship-sdk/src/main/java/com/urbanairship/iam/view/BoundedLinearLayout.java b/urbanairship-sdk/src/main/java/com/urbanairship/iam/view/BoundedLinearLayout.java index 3a6d71de0..9ca04646e 100644 --- a/urbanairship-sdk/src/main/java/com/urbanairship/iam/view/BoundedLinearLayout.java +++ b/urbanairship-sdk/src/main/java/com/urbanairship/iam/view/BoundedLinearLayout.java @@ -21,6 +21,8 @@ /** * LinearLayout that supports max width. + * + * @hide */ public class BoundedLinearLayout extends LinearLayout { diff --git a/urbanairship-sdk/src/main/java/com/urbanairship/iam/view/InAppButtonLayout.java b/urbanairship-sdk/src/main/java/com/urbanairship/iam/view/InAppButtonLayout.java index 4521568a3..bc8134f85 100644 --- a/urbanairship-sdk/src/main/java/com/urbanairship/iam/view/InAppButtonLayout.java +++ b/urbanairship-sdk/src/main/java/com/urbanairship/iam/view/InAppButtonLayout.java @@ -21,6 +21,8 @@ /** * In-app button layout. Supports stacked, separated, and joined button layouts. + * + * @hide */ public class InAppButtonLayout extends BoundedLinearLayout { diff --git a/urbanairship-sdk/src/main/java/com/urbanairship/iam/view/InAppViewUtils.java b/urbanairship-sdk/src/main/java/com/urbanairship/iam/view/InAppViewUtils.java index 1f7f5d76a..33dc5841e 100644 --- a/urbanairship-sdk/src/main/java/com/urbanairship/iam/view/InAppViewUtils.java +++ b/urbanairship-sdk/src/main/java/com/urbanairship/iam/view/InAppViewUtils.java @@ -42,6 +42,8 @@ /** * In-app view utils. + * + * @hide */ public class InAppViewUtils { diff --git a/urbanairship-sdk/src/main/java/com/urbanairship/iam/view/MediaView.java b/urbanairship-sdk/src/main/java/com/urbanairship/iam/view/MediaView.java index af9834450..bb75d6edf 100644 --- a/urbanairship-sdk/src/main/java/com/urbanairship/iam/view/MediaView.java +++ b/urbanairship-sdk/src/main/java/com/urbanairship/iam/view/MediaView.java @@ -31,6 +31,8 @@ /** * Media view. + * + * @hide */ public class MediaView extends FrameLayout { private WebView webView; diff --git a/urbanairship-sdk/src/main/java/com/urbanairship/iam/view/package-info.java b/urbanairship-sdk/src/main/java/com/urbanairship/iam/view/package-info.java new file mode 100644 index 000000000..8668e9e44 --- /dev/null +++ b/urbanairship-sdk/src/main/java/com/urbanairship/iam/view/package-info.java @@ -0,0 +1,6 @@ +/* Copyright 2018 Urban Airship and Contributors */ + +/** + * Contains classes and utilities for in-app message views. + */ +package com.urbanairship.iam.view; diff --git a/urbanairship-sdk/src/main/java/com/urbanairship/messagecenter/DefaultMultiChoiceModeListener.java b/urbanairship-sdk/src/main/java/com/urbanairship/messagecenter/DefaultMultiChoiceModeListener.java index 9713a1d02..f942ebf9e 100644 --- a/urbanairship-sdk/src/main/java/com/urbanairship/messagecenter/DefaultMultiChoiceModeListener.java +++ b/urbanairship-sdk/src/main/java/com/urbanairship/messagecenter/DefaultMultiChoiceModeListener.java @@ -18,6 +18,8 @@ /** * The default {@link android.widget.AbsListView.MultiChoiceModeListener} for the {@link MessageListFragment} * to handle multiple selection. + * + * @hide */ public class DefaultMultiChoiceModeListener implements AbsListView.MultiChoiceModeListener { diff --git a/urbanairship-sdk/src/main/java/com/urbanairship/push/notifications/NotificationFactory.java b/urbanairship-sdk/src/main/java/com/urbanairship/push/notifications/NotificationFactory.java index eef269219..21cdff788 100644 --- a/urbanairship-sdk/src/main/java/com/urbanairship/push/notifications/NotificationFactory.java +++ b/urbanairship-sdk/src/main/java/com/urbanairship/push/notifications/NotificationFactory.java @@ -357,7 +357,7 @@ protected NotificationCompat.Builder createNotificationBuilder(@NonNull PushMess *

* The default behavior returns {@link #TAG_NOTIFICATION_ID} if the push message contains a tag * (see {@link PushMessage#getNotificationTag()}). Otherwise it will either return {@link #getConstantNotificationId()} - * if the constant notification id > 0, or it will return a random ID generated from {@link NotificationIdGenerator#nextID()}. + * if the constant notification id > 0, or it will return a randomly generated ID}. * * @param pushMessage The push message. * @return An integer ID for the next notification. diff --git a/urbanairship-sdk/src/main/java/com/urbanairship/remotedata/RemoteDataPayloadEntry.java b/urbanairship-sdk/src/main/java/com/urbanairship/remotedata/RemoteDataPayloadEntry.java index 5592a7f42..9808f944e 100644 --- a/urbanairship-sdk/src/main/java/com/urbanairship/remotedata/RemoteDataPayloadEntry.java +++ b/urbanairship-sdk/src/main/java/com/urbanairship/remotedata/RemoteDataPayloadEntry.java @@ -5,13 +5,17 @@ import android.content.ContentValues; import android.database.Cursor; import android.database.sqlite.SQLiteDatabase; +import android.support.annotation.RestrictTo; import android.support.annotation.WorkerThread; import com.urbanairship.json.JsonMap; /** * Helper class for reading and writing RemoteDataPayloads to the data store. + * + * @hide */ +@RestrictTo(RestrictTo.Scope.LIBRARY_GROUP) public class RemoteDataPayloadEntry { static final String TABLE_NAME = "payloads";