Javadoc improvements

This is the client library 0.2 commit
This commit is contained in:
str4d
2014-09-29 23:54:28 +00:00
parent c8e1643326
commit 05c2dbd388

View File

@ -35,7 +35,8 @@ public class I2PAndroidHelper {
} }
/** /**
* Try to bind to I2P Android. Call this in Activity.onStart() * Try to bind to I2P Android. Call this method from
* {@link android.app.Activity#onStart()}.
*/ */
public void bind() { public void bind() {
Intent i2pIntent = new Intent(IRouterState.class.getName()); Intent i2pIntent = new Intent(IRouterState.class.getName());
@ -50,7 +51,8 @@ public class I2PAndroidHelper {
} }
/** /**
* Unbind from I2P Android. Call this in Activity.onStop(); * Unbind from I2P Android. Call this method from
* {@link android.app.Activity#onStop()}.
*/ */
public void unbind() { public void unbind() {
if (mTriedBindState) if (mTriedBindState)
@ -94,8 +96,8 @@ public class I2PAndroidHelper {
} }
/** /**
* Show dialog - install from market or F-Droid. * Show dialog - install I2P Android from market or F-Droid.
* @param activity * @param activity the Activity this method has been called from.
*/ */
public void promptToInstall(final Activity activity) { public void promptToInstall(final Activity activity) {
AlertDialog.Builder builder = new AlertDialog.Builder(activity); AlertDialog.Builder builder = new AlertDialog.Builder(activity);
@ -135,7 +137,7 @@ public class I2PAndroidHelper {
/** /**
* Show dialog - request that I2P Android be started. * Show dialog - request that I2P Android be started.
* @param activity * @param activity the Activity this method has been called from.
*/ */
public void requestI2PAndroidStart(final Activity activity) { public void requestI2PAndroidStart(final Activity activity) {
AlertDialog.Builder builder = new AlertDialog.Builder(activity); AlertDialog.Builder builder = new AlertDialog.Builder(activity);