add Dokka docs

Author: 05nelsonm

build.gradle

@@ -7,6 +7,7 @@ buildscript {
     }
     dependencies {
         classpath deps.androidGradlePlugin
+        classpath deps.dokka
         classpath deps.kotlin.gradlePlugin
     }
 }

gradle/dependencies.gradle

@@ -29,6 +29,7 @@ ext.deps = [
             liveDataCore: "androidx.arch.core:core-testing:2.1.0",
         ],
     ],
+    dokka: "org.jetbrains.dokka:dokka-gradle-plugin:0.10.1",
     gradleVersions: "com.github.ben-manes:gradle-versions-plugin:0.20.0",
     jtorctl: "info.guardianproject:jtorctl:0.4",
     junit: "junit:junit:4.12",

topl-core-base/build.gradle

@@ -1,6 +1,7 @@
 apply plugin: 'com.android.library'
 apply plugin: 'kotlin-android'
 apply plugin: 'kotlin-android-extensions'
+apply plugin: 'org.jetbrains.dokka'
 
 android {
     compileSdkVersion versions.compileSdk
@@ -34,6 +35,17 @@ android {
     }
 }
 
+dokka {
+    configuration {
+        reportUndocumented = false
+        includeNonPublic = false
+        skipEmptyPackages = true
+        samples = [
+                "$rootDir/sampleapp/samplecode/SampleCode.kt".toString()
+        ]
+    }
+}
+
 dependencies {
     implementation fileTree(dir: "libs", include: ["*.jar"])
     implementation deps.kotlin.stdlib

topl-core-base/src/main/java/io/matthewnelson/topl_core_base/TorConfigFiles.kt

@@ -181,6 +181,7 @@ class TorConfigFiles private constructor(
      *
      * @param [installDir] directory where the tor binaries are installed.
      * @param [configDir] directory where the filesystem will be setup for tor.
+     * @sample [io.matthewnelson.sampleapp.samplecode.SampleCode.customTorConfigFilesSetup]
      */
     class Builder(private val installDir: File, private val configDir: File) {
 

topl-core-base/src/main/java/io/matthewnelson/topl_core_base/TorSettings.kt

@@ -57,8 +57,6 @@ package io.matthewnelson.topl_core_base
  *
  * Would **highly recommend** reading up on what's what:
  *  - See <a href="https://2019.www.torproject.org/docs/tor-manual.html.en" target="_blank">docs</a>
- *
- * @sample [io.matthewnelson.sampleapp.MyTorSettings]
  * */
 abstract class TorSettings: BaseConsts() {
 

topl-core/build.gradle

@@ -1,6 +1,7 @@
 apply plugin: 'com.android.library'
 apply plugin: 'kotlin-android'
 apply plugin: 'kotlin-android-extensions'
+apply plugin: 'org.jetbrains.dokka'
 
 android {
     compileSdkVersion versions.compileSdk
@@ -34,6 +35,18 @@ android {
     }
 }
 
+dokka {
+    configuration {
+        reportUndocumented = false
+        includeNonPublic = false
+        skipEmptyPackages = true
+        samples = [
+                "$rootDir/topl-service/service/TorService.kt".toString(),
+                "$rootDir/topl-service/service/onionproxy/ServiceTorInstaller.kt".toString()
+        ]
+    }
+}
+
 dependencies {
     implementation fileTree(dir: "libs", include: ["*.jar"])
     implementation project(':topl-core-base')

topl-service/build.gradle

@@ -1,6 +1,7 @@
 apply plugin: 'com.android.library'
 apply plugin: 'kotlin-android'
 apply plugin: 'kotlin-android-extensions'
+apply plugin: 'org.jetbrains.dokka'
 
 android {
     compileSdkVersion versions.compileSdk
@@ -34,6 +35,17 @@ android {
     }
 }
 
+dokka {
+    configuration {
+        reportUndocumented = false
+        includeNonPublic = false
+        skipEmptyPackages = true
+        samples = [
+                "$rootDir/sampleapp/samplecode/SampleCode.kt".toString()
+        ]
+    }
+}
+
 dependencies {
     implementation fileTree(dir: "libs", include: ["*.jar"])
     implementation project(':topl-core')