[tor-commits] [orbot/master] improved javadoc of start process

[n8fr8 at torproject.org]

commit 1e93ef46062d393b1ccccfcd482d7451f688cba1
Author: Hans-Christoph Steiner <hans at eds.org>
Date:   Fri Jun 3 11:30:08 2016 +0200

    improved javadoc of start process
---
 src/org/torproject/android/service/TorService.java          | 4 +++-
 src/org/torproject/android/service/TorServiceConstants.java | 4 +++-
 2 files changed, 6 insertions(+), 2 deletions(-)

diff --git a/src/org/torproject/android/service/TorService.java b/src/org/torproject/android/service/TorService.java
index b90442b..147ca78 100644
--- a/src/org/torproject/android/service/TorService.java
+++ b/src/org/torproject/android/service/TorService.java
@@ -698,7 +698,9 @@ public class TorService extends VpnService implements TorServiceConstants, Orbot
     /**
      * Send Orbot's status in reply to an
      * {@link TorServiceConstants#ACTION_START} {@link Intent}, targeted only to
-     * the app that sent the initial request.
+     * the app that sent the initial request. If the user has disabled auto-
+     * starts, the reply {@code ACTION_START Intent} will include the extra
+     * {@link TorServiceConstants#STATUS_STARTS_DISABLED}
      */
     private void replyWithStatus(Intent startRequest) {
         String packageName = startRequest.getStringExtra(EXTRA_PACKAGE_NAME);
diff --git a/src/org/torproject/android/service/TorServiceConstants.java b/src/org/torproject/android/service/TorServiceConstants.java
index e2f0964..86c6a64 100644
--- a/src/org/torproject/android/service/TorServiceConstants.java
+++ b/src/org/torproject/android/service/TorServiceConstants.java
@@ -117,9 +117,11 @@ public interface TorServiceConstants {
     public final static String STATUS_ON = "ON";
     public final static String STATUS_STARTING = "STARTING";
     public final static String STATUS_STOPPING = "STOPPING";
+
     /**
      * The user has disabled the ability for background starts triggered by
-     * apps. Fallback to the old Intent that brings up Orbot.
+     * apps. Fallback to the old {@link Intent} action that brings up Orbot:
+     * {@link org.torproject.android.OrbotMainActivity#INTENT_ACTION_REQUEST_START_TOR}
      */
     public final static String STATUS_STARTS_DISABLED = "STARTS_DISABLED";