From 20709d00c388910c597558d7a6b0758031f88847 Mon Sep 17 00:00:00 2001
From: Torsten Grote <t@grobox.de>
Date: Tue, 2 May 2023 15:03:11 -0300
Subject: [PATCH] Document that calling start does not connect to Tor, yet
---
.../main/java/org/briarproject/onionwrapper/TorWrapper.java | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)
diff --git a/onionwrapper-core/src/main/java/org/briarproject/onionwrapper/TorWrapper.java b/onionwrapper-core/src/main/java/org/briarproject/onionwrapper/TorWrapper.java
index d3c2efd..a72ac10 100644
--- a/onionwrapper-core/src/main/java/org/briarproject/onionwrapper/TorWrapper.java
+++ b/onionwrapper-core/src/main/java/org/briarproject/onionwrapper/TorWrapper.java
@@ -16,7 +16,8 @@ public interface TorWrapper {
Logger LOG = getLogger(TorWrapper.class.getName());
/**
- * Starts the Tor process.
+ * Starts the Tor process, but does not yet connect to the Tor Network.
+ * Call {@link #enableNetwork(boolean)} for this.
* <p>
* This method must only be called once. To restart the Tor process, stop
* this wrapper instance and then create a new instance.
--
GitLab