Skip to content

Commit

Permalink
Fixed documentation to fix issue scottyab#144 (scottyab#146)
Browse files Browse the repository at this point in the history
Co-authored-by: stealthcopter <matthewrollings@pm.me>
  • Loading branch information
stealthcopter and stealthcopter committed Jul 21, 2020
1 parent 08d57fa commit bb43b74
Showing 1 changed file with 3 additions and 4 deletions.
7 changes: 3 additions & 4 deletions rootbeerlib/src/main/java/com/scottyab/rootbeer/RootBeer.java
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,7 @@ public RootBeer(Context context) {
}

/**
* Run all the checks.
* To run the same check but without looking for the busybox binary to avoid a false positive for certain devices please
* see {@link #isRootedWithoutBusyBoxCheck() isRootedWithoutBusyBoxCheck}
* Run all the root detection checks.
*
* @return true, we think there's a good *indication* of root | false good *indication* of no root (could still be cloaked)
*/
Expand All @@ -52,12 +50,13 @@ public boolean isRooted() {
* @deprecated This method is deprecated as checking without the busybox binary is now the
* default. This is because many manufacturers leave this binary on production devices.
*/
@Deprecated
public boolean isRootedWithoutBusyBoxCheck() {
return isRooted();
}

/**
* Run all the checks apart including checking for the busybox binary.
* Run all the checks including checking for the busybox binary.
* Warning: Busybox binary is not always an indication of root, many manufacturers leave this
* binary on production devices
* @return true, we think there's a good *indication* of root | false good *indication* of no root (could still be cloaked)
Expand Down

0 comments on commit bb43b74

Please sign in to comment.