- added missing JavaDoc

Author: Piotr Zawadzki

material-stepper/src/main/java/com/stepstone/stepper/util/AnimationUtil.java

@@ -29,6 +29,7 @@ private AnimationUtil() {
      * Animate the View's visibility using a fade animation.
      * @param view The View to be animated
      * @param visibility View visibility constant, can be either View.VISIBLE, View.INVISIBLE or View.GONE
+     * @param animate true if the visibility should be changed with an animation, false if instantaneously
      */
     public static void fadeViewVisibility(@NonNull final View view, @Visibility final int visibility, boolean animate) {
         ViewPropertyAnimator animator = view.animate();

material-stepper/src/main/java/com/stepstone/stepper/viewmodel/StepViewModel.java

@@ -82,6 +82,7 @@ public Builder(@NonNull Context context) {
         /**
          * Set the title using the given resource id.
          *
+         * @param titleId string resource ID for the title
          * @return This Builder object to allow for chaining of calls to set methods
          */
         public Builder setTitle(@StringRes int titleId) {
@@ -92,6 +93,7 @@ public Builder setTitle(@StringRes int titleId) {
         /**
          * Set the title using the given characters.
          *
+         * @param title CharSequence to be used as a title
          * @return This Builder object to allow for chaining of calls to set methods
          */
         public Builder setTitle(@Nullable CharSequence title) {
@@ -102,6 +104,7 @@ public Builder setTitle(@Nullable CharSequence title) {
         /**
          * Set the label of the next button using the given resource id.
          *
+         * @param nextButtonLabelId string resource ID for the Next button
          * @return This Builder object to allow for chaining of calls to set methods
          */
         public Builder setNextButtonLabel(@StringRes int nextButtonLabelId) {
@@ -112,6 +115,7 @@ public Builder setNextButtonLabel(@StringRes int nextButtonLabelId) {
         /**
          * Set the label of the next button.
          *
+         * @param nextButtonLabel CharSequence to be used as a Next button label
          * @return This Builder object to allow for chaining of calls to set methods
          */
         public Builder setNextButtonLabel(@Nullable CharSequence nextButtonLabel) {
@@ -122,6 +126,7 @@ public Builder setNextButtonLabel(@Nullable CharSequence nextButtonLabel) {
         /**
          * Set the label of the back button using the given resource id.
          *
+         * @param backButtonLabelId string resource ID for the Back button
          * @return This Builder object to allow for chaining of calls to set methods
          */
         public Builder setBackButtonLabel(@StringRes int backButtonLabelId) {
@@ -132,6 +137,7 @@ public Builder setBackButtonLabel(@StringRes int backButtonLabelId) {
         /**
          * Set the label of the back button.
          *
+         * @param backButtonLabel CharSequence to be used as a Back button label
          * @return This Builder object to allow for chaining of calls to set methods
          */
         public Builder setBackButtonLabel(@Nullable CharSequence backButtonLabel) {
@@ -142,6 +148,7 @@ public Builder setBackButtonLabel(@Nullable CharSequence backButtonLabel) {
         /**
          * Creates a {@link StepViewModel} with the arguments supplied to this
          * builder.
+         * @return created StepViewModel
          */
         public StepViewModel create() {
             final StepViewModel viewModel = new StepViewModel();