Skip to content
This repository was archived by the owner on Nov 10, 2024. It is now read-only.

Commit f8794c4

Browse files
committed
Added some jsdoc comments as context.
1 parent 9c98609 commit f8794c4

File tree

1 file changed

+11
-0
lines changed
  • showcaseviewlib/src/main/java/smartdevelop/ir/eram/showcaseviewlib

1 file changed

+11
-0
lines changed

showcaseviewlib/src/main/java/smartdevelop/ir/eram/showcaseviewlib/Targetable.java

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,17 @@
44
import android.graphics.RectF;
55

66
public interface Targetable {
7+
/**
8+
* This path will be used when drawing the guide.
9+
* @return The path that will be drawn.
10+
*/
711
Path guidePath();
12+
13+
/**
14+
* This rect is used when displaying the guide message.
15+
* If the guidePath is a circle then the bounding box should
16+
* be a square that contains the circle inside of it.
17+
* @return The rect that will used for positioning guide message.
18+
*/
819
RectF boundingRect();
920
}

0 commit comments

Comments
 (0)