Skip to content

Commit 770f779

Browse files
committed
Adds some API doc
1 parent 3a9c664 commit 770f779

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

sample/src/main/java/com/github/amlcurran/showcaseview/sample/ViewTargets.java

+9
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,17 @@
77

88
import java.lang.reflect.Field;
99

10+
/**
11+
* A collection of not-officially supported ViewTargets. Use them at your own risk!
12+
*/
1013
public class ViewTargets {
1114

15+
/**
16+
* Highlight the navigation button (the Up or Navigation drawer button) in a Toolbar
17+
* @param toolbar The toolbar to search for the view in
18+
* @return the {@link ViewTarget} to supply to a {@link com.github.amlcurran.showcaseview.ShowcaseView}
19+
* @throws MissingViewException when the view couldn't be found. Raise an issue on Github if you get this!
20+
*/
1221
public static ViewTarget navigationButtonViewTarget(Toolbar toolbar) throws MissingViewException {
1322
try {
1423
Field field = Toolbar.class.getDeclaredField("mNavButtonView");

0 commit comments

Comments
 (0)