Skip to content
This repository was archived by the owner on Oct 23, 2021. It is now read-only.

Commit f6bfb32

Browse files
author
Bill Phillips
committed
Add missing param description.
1 parent 7519d47 commit f6bfb32

File tree

2 files changed

+1
-14
lines changed

2 files changed

+1
-14
lines changed

recyclerview-multiselect/src/main/java/com/bignerdranch/android/multiselector/MultiSelector.java

+1-5
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@
99
/**
1010
* <p>A class that handles selection logic and dispatches updates to
1111
* connected instances of {@link com.bignerdranch.android.multiselector.SelectableHolder}.</p>
12-
* <p/>
1312
* <p>The out-of-the-box use of MultiSelector is to team it up with {@link com.bignerdranch.android.multiselector.SwappingHolder}
1413
* for easy selection functionality in {@link android.support.v7.widget.RecyclerView}s. Like this:</p>
1514
* <pre>
@@ -77,7 +76,6 @@ public void setSelected(SelectableHolder holder, boolean isSelected) {
7776
/**
7877
* <p>Sets whether a particular item is selected. In this implementation, id is
7978
* ignored, but subclasses may use id instead.</p>
80-
* <p/>
8179
* <p>If a holder is bound for this position, this will call through to
8280
* {@link com.bignerdranch.android.multiselector.SelectableHolder#setActivated(boolean)}
8381
* for that holder.</p>
@@ -130,7 +128,6 @@ public List<Integer> getSelectedPositions() {
130128

131129
/**
132130
* <p>Bind a holder to a specific position/id. This implementation ignores the id.</p>
133-
* <p/>
134131
* <p>Bound holders will receive calls to {@link com.bignerdranch.android.multiselector.SelectableHolder#setSelectable(boolean)}
135132
* and {@link com.bignerdranch.android.multiselector.SelectableHolder#setActivated(boolean)} when
136133
* {@link #setSelectable(boolean)} is called, or when {@link #setSelected(int, long, boolean)} is called for the
@@ -160,7 +157,6 @@ public boolean tapSelection(SelectableHolder holder) {
160157
* If {@link #isSelectable()} is true, this method toggles selection
161158
* for the specified item and returns true. Otherwise, it returns false
162159
* and does nothing.</p>
163-
* <p/>
164160
* <p>Equivalent to:</p>
165161
* <pre>
166162
* {@code
@@ -221,7 +217,7 @@ public Bundle saveSelectionStates() {
221217
/**
222218
* restore the selection states of the multiselector and the ViewHolder Trackers
223219
*
224-
* @param savedStates
220+
* @param savedStates Saved state bundle, probably from a fragment or activity.
225221
*/
226222

227223
public void restoreSelectionStates(Bundle savedStates) {

recyclerview-multiselect/src/main/java/com/bignerdranch/android/multiselector/SwappingHolder.java

-9
Original file line numberDiff line numberDiff line change
@@ -16,21 +16,17 @@
1616
* <p>
1717
* A holder extended to support having a selectable mode with a different
1818
* background and state list animator.</p>
19-
* <p/>
2019
* <p>When {@link #setSelectable(boolean)} is set to true, itemView's
2120
* background is set to the value of selectionModeBackgroundDrawable,
2221
* and its StateListAnimator is set to selectionModeStateListAnimator.
2322
* When it is set to false, the defaultModeBackgroundDrawable and
2423
* defaultModeStateListAnimator are used.</p>
25-
* <p/>
2624
* <p>defaultModeBackgroundDrawable and defaultModeStateListAnimator
2725
* default to the values on itemView at the time the holder was constructed.</p>
28-
* <p/>
2926
* <p>selectionModeBackgroundDrawable defaults to a StateListDrawable that displays
3027
* your colorAccent theme color when state_activated=true, and nothing otherwise.
3128
* selectionModeStateListAnimator defaults to a raise animation that animates selection
3229
* items to a 12dp translationZ.</p>
33-
* <p/>
3430
* <p>(Thanks to <a href="https://github.com/kurtisnelson/">Kurt Nelson</a> for examples and discussion on approaches here.)</p>
3531
*/
3632
public class SwappingHolder extends MultiSelectorBindingHolder implements SelectableHolder {
@@ -43,10 +39,8 @@ public class SwappingHolder extends MultiSelectorBindingHolder implements Selec
4339

4440
/**
4541
* <p>Construct a new SelectableHolder hooked up to be controlled by a MultiSelector.</p>
46-
* <p/>
4742
* <p>If the MultiSelector is not null, the SelectableHolder can be selected by
4843
* calling {@link com.bignerdranch.android.multiselector.MultiSelector#setSelected(com.bignerdranch.android.multiselector.SelectableHolder, boolean)}.</p>
49-
* <p/>
5044
* <p>If the MultiSelector is null, the SelectableHolder acts as a standalone
5145
* ViewHolder that you can control manually by setting {@link #setSelectable(boolean)}
5246
* and {@link #setActivated(boolean)}</p>
@@ -72,7 +66,6 @@ public SwappingHolder(View itemView, MultiSelector multiSelector) {
7266

7367
/**
7468
* <p>Construct a new standalone SelectableHolder.</p>
75-
* <p/>
7669
* <p>Selectable state can be controlled manually by setting {@link #setSelectable(boolean)}.</p>
7770
*
7871
* @param itemView Item view for this ViewHolder
@@ -222,7 +215,6 @@ public void setDefaultModeStateListAnimator(StateListAnimator defaultModeStateLi
222215

223216
/**
224217
* Whether this holder is currently activated/selected.
225-
* <p/>
226218
* Calls through to {@link View#setActivated(boolean)} on {@link #itemView}.
227219
*
228220
* @return True if the view is activated.
@@ -233,7 +225,6 @@ public boolean isActivated() {
233225

234226
/**
235227
* Activate/select this holder.
236-
* <p/>
237228
* Calls through to {@link android.view.View#isActivated()} on {@link #itemView}.
238229
*
239230
* @param isActivated True to activate the view.

0 commit comments

Comments
 (0)