tunnel: document more public API from backend package

Signed-off-by: Harsh Shandilya <me@msfjarvis.dev>

1 files changed, 9 insertions, 0 deletions

diff --git a/tunnel/src/main/java/com/wireguard/android/backend/Tunnel.java b/tunnel/src/main/java/com/wireguard/android/backend/Tunnel.java
index a9761929..2f12f6c3 100644
--- a/tunnel/src/main/java/com/wireguard/android/backend/Tunnel.java
+++ b/tunnel/src/main/java/com/wireguard/android/backend/Tunnel.java
@@ -36,11 +36,20 @@ public interface Tunnel {
      */
     void onStateChange(State newState);
 
+    /**
+     * Enum class to represent all possible states of a {@link Tunnel}.
+     */
     enum State {
         DOWN,
         TOGGLE,
         UP;
 
+        /**
+         * Get the state of a {@link Tunnel}
+         *
+         * @param running boolean indicating if the tunnel is running.
+         * @return State of the tunnel based on whether or not it is running.
+         */
         public static State of(final boolean running) {
             return running ? UP : DOWN;
         }