Skip to content

Commit cfcb72b

Browse files
authored
fix: clean up all javadoc warnings (#365)
1 parent 5b1bd28 commit cfcb72b

File tree

4 files changed

+9
-5
lines changed

4 files changed

+9
-5
lines changed

android-sdk/src/main/java/com/optimizely/ab/android/sdk/OptimizelyClient.java

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -810,6 +810,7 @@ public OptimizelyUserContext createUserContext(@NonNull String userId) {
810810

811811
/**
812812
* Convenience method for adding DecisionNotification Handlers
813+
* @param handler a NotificationHandler to be added
813814
* @return notificationId or -1 if notification is not added
814815
*/
815816
@Nullable
@@ -824,6 +825,7 @@ public int addDecisionNotificationHandler(NotificationHandler<DecisionNotificati
824825

825826
/**
826827
* Convenience method for adding TrackNotification Handlers
828+
* @param handler a NotificationHandler to be added
827829
* @return notificationId or -1 if notification is not added
828830
*/
829831
public int addTrackNotificationHandler(NotificationHandler<TrackNotification> handler) {
@@ -838,6 +840,7 @@ public int addTrackNotificationHandler(NotificationHandler<TrackNotification> ha
838840

839841
/**
840842
* Convenience method for adding UpdateConfigNotification Handlers
843+
* @param handler a NotificationHandler to be added
841844
* @return notificationId or -1 if notification is not added
842845
*/
843846
public int addUpdateConfigNotificationHandler(NotificationHandler<UpdateConfigNotification> handler) {
@@ -852,6 +855,7 @@ public int addUpdateConfigNotificationHandler(NotificationHandler<UpdateConfigNo
852855

853856
/**
854857
* Convenience method for adding LogEvent Notification Handlers
858+
* @param handler a NotificationHandler to be added
855859
* @return notificationId or -1 if notification is not added
856860
*/
857861
public int addLogEventNotificationHandler(NotificationHandler<LogEvent> handler) {

android-sdk/src/main/java/com/optimizely/ab/android/sdk/OptimizelyManager.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -325,8 +325,8 @@ public void run() {
325325

326326
/** This function will first try to get datafile from Cache, if file is not cached yet
327327
* than it will read from Raw file
328-
* @param context
329-
* @param datafileRes
328+
* @param context any {@link Context} instance
329+
* @param datafileRes the R id that the data file is located under.
330330
* @return datafile
331331
*/
332332
public String getDatafile(Context context,@RawRes Integer datafileRes){

shared/src/main/java/com/optimizely/ab/android/shared/DatafileConfig.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/****************************************************************************
2-
* Copyright 2018, Optimizely, Inc. and contributors *
2+
* Copyright 2018,2021, Optimizely, Inc. and contributors *
33
* *
44
* Licensed under the Apache License, Version 2.0 (the "License"); *
55
* you may not use this file except in compliance with the License. *
@@ -120,7 +120,7 @@ public static DatafileConfig fromJSONString(String jsonString) {
120120
/**
121121
* To string either returns the proejct id as string or a concatenated string of project id
122122
* delimiter and environment key.
123-
* @return
123+
* @return the string identification for the DatafileConfig
124124
*/
125125
@Override
126126
public String toString() {

shared/src/main/java/com/optimizely/ab/android/shared/WorkerScheduler.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ public static void unscheduleService(Context context, String workerId) {
4949
* @param workerId worker id
5050
* @param clazz class based on ListenableWorker
5151
* @param data androidx.work.Data
52-
* @param interval
52+
* @param interval the interval for the repeated service
5353
*/
5454
public static void scheduleService(Context context, String workerId, Class clazz, Data data, long interval) {
5555
WorkManager.getInstance(context).cancelAllWorkByTag(workerId);

0 commit comments

Comments
 (0)