Skip to content

Commit 23c258f

Browse files
author
Tushar Acharya
committed
JavaDoc cleanup
1 parent 716e15f commit 23c258f

File tree

1 file changed

+10
-16
lines changed

1 file changed

+10
-16
lines changed

cardstack/src/main/java/com/mutualmobile/cardstack/CardStackLayout.java

Lines changed: 10 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,11 @@
1515
* <p/>
1616
* See {@link R.styleable#CardStackLayout CardStackLayout Attributes}
1717
*
18-
* @attr ref {@link R.styleable#CardStackLayout_showInitAnimation}
19-
* @attr ref {@link R.styleable#CardStackLayout_card_gap}
20-
* @attr ref {@link R.styleable#CardStackLayout_card_gap_bottom}
21-
* @attr ref {@link R.styleable#CardStackLayout_parallax_enabled}
22-
* @attr ref {@link R.styleable#CardStackLayout_parallax_scale}
18+
* {@link R.styleable#CardStackLayout_showInitAnimation}
19+
* {@link R.styleable#CardStackLayout_card_gap}
20+
* {@link R.styleable#CardStackLayout_card_gap_bottom}
21+
* {@link R.styleable#CardStackLayout_parallax_enabled}
22+
* {@link R.styleable#CardStackLayout_parallax_scale}
2323
*/
2424
public class CardStackLayout extends FrameLayout {
2525
public static final boolean PARALLAX_ENABLED_DEFAULT = false;
@@ -90,8 +90,7 @@ private void handleArgs(Context context, AttributeSet attrs, int defStyleAttr, i
9090
}
9191

9292
/**
93-
* Returns the adapter of type {@link CardStackAdapter} that is set for this view.
94-
* @return
93+
* @return adapter of type {@link CardStackAdapter} that is set for this view.
9594
*/
9695
public CardStackAdapter getAdapter() {
9796
return mAdapter;
@@ -119,8 +118,7 @@ public void run() {
119118
}
120119

121120
/**
122-
* Returns the currently set parallax scale value.
123-
* @return
121+
* @return currently set parallax scale value.
124122
*/
125123
public int getParallaxScale() {
126124
return mParallaxScale;
@@ -129,7 +127,6 @@ public int getParallaxScale() {
129127
/**
130128
* Sets the value of parallax scale. Parallax scale is the factor which decides how much
131129
* distance a card will scroll when the user drags it down.
132-
* @return
133130
*/
134131
public void setParallaxScale(int mParallaxScale) {
135132
this.mParallaxScale = mParallaxScale;
@@ -152,8 +149,7 @@ public void setShowInitAnimation(boolean mShowInitAnimation) {
152149
}
153150

154151
/**
155-
* Returns the gap (in pixels) between two consecutive cards
156-
* @return
152+
* @return the gap (in pixels) between two consecutive cards
157153
*/
158154
public float getCardGap() {
159155
return mCardGap;
@@ -167,8 +163,7 @@ public void setCardGap(float mCardGap) {
167163
}
168164

169165
/**
170-
* Return the gap between the two consecutive cards when collapsed to the bottom of the screen
171-
* @return
166+
* @return gap between the two consecutive cards when collapsed to the bottom of the screen
172167
*/
173168
public float getCardGapBottom() {
174169
return mCardGapBottom;
@@ -179,8 +174,7 @@ public void setCardGapBottom(float mCardGapBottom) {
179174
}
180175

181176
/**
182-
* Returs true if a card is selected, false otherwise
183-
* @return
177+
* @return true if a card is selected, false otherwise
184178
*/
185179
public boolean isCardSelected() {
186180
return mAdapter.isCardSelected();

0 commit comments

Comments
 (0)