Merge pull request #78 from 05nelsonm/mn/update/dokka

Fix Dokka Docs

Author: 05nelsonm

.versions

@@ -3,7 +3,7 @@
 ## Version 1.0.0-alpha02 (2020-08-03)
  - API breaking changes were made to `TorServiceController.Builder`. See the following to update:
      - [TorServiceController.Builder](./topl-service/io.matthewnelson.topl_service/-tor-service-controller/-builder/index.md)
-     - [TorServiceEventBroadcaster](./topl-service/io.matthewnelson.topl_service.service.components.onionproxy/-tor-service-event-broadcaster/index.md)
+     - [TorServiceEventBroadcaster](./topl-service/io.matthewnelson.topl_service.service.components.onionproxy.model/-tor-service-event-broadcaster/index.md)
  - Added ability to hide the notification
      - NOTE: Will be shown when user swipes the application out of recent's tray (required).
  - Service now starts via `Context.startService` + `Context.bindService` instead of starting

docs/changelog.md

@@ -31,7 +31,7 @@ Get Started
         no unnecessary classes or resources; just the binaries. Android API 29+ no longer supports 
         execution of executable files from your application's `/data/data/` directory, and must now be
         installed in the `context.applicationInfo.nativeLibraryDir` directory (aka, `/data/app/...`) 
-        to execute.
+        to execute.  
             - Nothing more is needed in terms of configuring initialization via the 
             `TorServiceController.Builder`, as files will be installed in the correct directory, and 
             named to match what `topl-service` looks for.

docs/get_started.md

@@ -7,7 +7,7 @@
  :material-checkbox-marked: Alpha release  
  :material-checkbox-blank-outline: Pass-through commands to the TorControlConnection  
  :material-checkbox-blank-outline: Settings/Debug Activity (so devs don't have to create one if they don't wish to)  
- :material-checkbox-blank-outline: Builder Option to disable stop service on task termination  
+ :material-checkbox-marked: Builder Option to disable stop service on task termination  
  :material-checkbox-blank-outline: Transport Plugin support  
  :material-checkbox-blank-outline: v3 Hidden Service Authentication support  
  :material-checkbox-blank-outline: v3 Hidden Service Creation  

docs/roadmap.md

@@ -139,6 +139,7 @@ class CodeSamples {
             geoipAssetPath = "common/geoip",
             geoip6AssetPath = "common/geoip6"
         )
+            .addTimeToDisableNetworkDelay(milliseconds = 1_000L)
             .addTimeToRestartTorDelay(milliseconds = 100L)
             .addTimeToStopServiceDelay(milliseconds = 100L)
             .disableStopServiceOnTaskRemoved(disable = false)

sampleapp/src/main/java/io/matthewnelson/sampleapp/topl_android/CodeSamples.kt

@@ -72,8 +72,35 @@ DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null && pwd )"
 # Find all file paths within projectDir/docs/ that contains http:FIX_DOKKA_LINKDS/
 mapfile -t INPUT_FILES < <(grep -rnwl "$DIR/../docs/" -e "(http://FIX_DOKKA_LINKS/.*)")
 
-# Replace the urls with appropriate file path for Mkdocs to generate proper urls
+# Replace the static string we're looking for with appropriate file path for Mkdocs to
+# generate proper links to files located in different modules.
 for INPUT_FILE in ${INPUT_FILES[*]}; do
-  echo "Fixing line in $INPUT_FILE"
-  sed -i 's+http://FIX_DOKKA_LINKS+../../..+gI' $INPUT_FILE
-done
+  echo "Fixing line in: $INPUT_FILE"
+
+  # Det depth of the file location to determine number of directories needed to
+  # traverse back to get to "../docs/<this directory>/"
+  START_COUNTING=false
+  FILE_DEPTH=-1
+  IFS='/' read -ra DIRECTORY_ARRAY <<< "$INPUT_FILE"
+  for DIRECTORY_NAME in "${DIRECTORY_ARRAY[@]}"; do
+    if $START_COUNTING; then
+      (( FILE_DEPTH++ ))
+    fi
+
+    if [ "$DIRECTORY_NAME" == "docs" ]; then
+      START_COUNTING=true
+    fi
+
+  done
+
+  # Build string with number of directories needed to get back to the desired dir
+  FILE_DEPTH_STRING=
+  for (( i = 0; i < "$FILE_DEPTH"; i++ )); do
+      FILE_DEPTH_STRING+="../"
+  done
+
+  # Replace our static string with the proper directory location of the Dokka doc
+  sed -i "s+http://FIX_DOKKA_LINKS+$FILE_DEPTH_STRING+gI" "$INPUT_FILE"
+done
+
+exit 0