Skip to content

Commit 7b0c238

Browse files
05nelsonm05nelsonm
committed
Fix broken documentation links due
1 parent 12058c3 commit 7b0c238

File tree

19 files changed

+54
-58
lines changed

19 files changed

+54
-58
lines changed

‎library/runtime-core/src/commonMain/kotlin/io/matthewnelson/kmp/tor/runtime/core/Callbacks.kt‎

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,6 @@ import kotlinx.coroutines.Dispatchers
2525
import kotlinx.coroutines.MainCoroutineDispatcher
2626
import kotlin.concurrent.Volatile
2727
import kotlin.coroutines.CoroutineContext
28-
import kotlin.coroutines.EmptyCoroutineContext
2928
import kotlin.jvm.JvmName
3029
import kotlin.jvm.JvmStatic
3130

@@ -37,7 +36,7 @@ import kotlin.jvm.JvmStatic
3736
* within the [OnSuccess] lambda. If [OnSuccess] is
3837
* being utilized with `TorRuntime` APIs, it will be
3938
* treated as an [UncaughtException] and dispatched
40-
* to [io.matthewnelson.kmp.tor.runtime.RuntimeEvent.ERROR]
39+
* to [RuntimeEvent.ERROR](https://kmp-tor.matthewnelson.io/library/runtime/io.matthewnelson.kmp.tor.runtime/-runtime-event/-e-r-r-o-r/index.html)
4140
* observers.
4241
*
4342
* @see [noOp]
@@ -67,7 +66,7 @@ public fun interface OnSuccess<in T: Any?>: ItBlock<T> {
6766
* within the [OnFailure] lambda. If [OnFailure] is
6867
* being utilized with `TorRuntime` APIs, it will be
6968
* treated as an [UncaughtException] and dispatched
70-
* to [io.matthewnelson.kmp.tor.runtime.RuntimeEvent.ERROR]
69+
* to [RuntimeEvent.ERROR](https://kmp-tor.matthewnelson.io/library/runtime/io.matthewnelson.kmp.tor.runtime/-runtime-event/-e-r-r-o-r/index.html)
7170
* observers.
7271
*
7372
* @see [noOp]
@@ -97,7 +96,7 @@ public fun interface OnFailure: ItBlock<Throwable> {
9796
*
9897
* **NOTE:** If [OnEvent] is being utilized with `TorRuntime` APIs,
9998
* exceptions will be treated as an [UncaughtException] and dispatched
100-
* to [io.matthewnelson.kmp.tor.runtime.RuntimeEvent.ERROR].
99+
* to [RuntimeEvent.ERROR](https://kmp-tor.matthewnelson.io/library/runtime/io.matthewnelson.kmp.tor.runtime/-runtime-event/-e-r-r-o-r/index.html).
101100
*
102101
* @see [noOp]
103102
* @see [Executor]
@@ -122,11 +121,11 @@ public fun interface OnEvent<in Data: Any?>: ItBlock<Data> {
122121
* fine-tuning the context in which that dispatching occurs on
123122
* several customizable levels.
124123
*
125-
* Both [io.matthewnelson.kmp.tor.runtime.RuntimeEvent] and [TorEvent]
126-
* observer APIs allow declaration of a specific [Executor] to be used
127-
* for the individual observer. If no [Executor] is specified, then the
128-
* [io.matthewnelson.kmp.tor.runtime.RuntimeEvent.Processor] and
129-
* [TorEvent.Processor] implementations fallback to using whatever
124+
* Both [RuntimeEvent](https://kmp-tor.matthewnelson.io/library/runtime/io.matthewnelson.kmp.tor.runtime/-runtime-event/index.html)
125+
* and [TorEvent] observer APIs allow declaration of a specific [Executor] to
126+
* be used for the individual observer. If no [Executor] is specified, then the
127+
* [RuntimeEvent.Processor](https://kmp-tor.matthewnelson.io/library/runtime/io.matthewnelson.kmp.tor.runtime/-runtime-event/-processor/index.html)
128+
* and [TorEvent.Processor] implementations fallback to using whatever
130129
* [Executor] was declared when they were created. This means that an
131130
* [Executor] can be set for default behavior of how events get dispatched
132131
* based off of the needs of the application, and then be selectively

‎library/runtime-core/src/commonMain/kotlin/io/matthewnelson/kmp/tor/runtime/core/EnqueuedJob.kt‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -353,8 +353,7 @@ public abstract class EnqueuedJob protected constructor(
353353
*
354354
* If `false`, the public [cancel] function will **not** be
355355
* allowed to signal for cancellation. This constrains the
356-
* functionality to users of the [awaitAsync] and
357-
* [io.matthewnelson.kmp.tor.runtime.core.util.awaitSync]
356+
* functionality to users of the [awaitAsync] and `awaitSync`
358357
* APIs (i.e. only the callers of `executeAsync` and
359358
* `executeSync` extension functions may signal for cancellation).
360359
*
@@ -749,11 +748,10 @@ public abstract class EnqueuedJob protected constructor(
749748
* Helper for creating argument based processor agnostic
750749
* extension functions for Async/Sync APIs.
751750
*
752-
* @see [io.matthewnelson.kmp.tor.runtime.Action.Processor]
751+
* See [Action.Processor](https://kmp-tor.matthewnelson.io/library/runtime/io.matthewnelson.kmp.tor.runtime/-action/-processor/index.html)
753752
* @see [io.matthewnelson.kmp.tor.runtime.core.ctrl.TorCmd.Privileged.Processor]
754753
* @see [io.matthewnelson.kmp.tor.runtime.core.ctrl.TorCmd.Unprivileged.Processor]
755754
* @see [io.matthewnelson.kmp.tor.runtime.core.util.awaitAsync]
756-
* @see [io.matthewnelson.kmp.tor.runtime.core.util.awaitSync]
757755
* @suppress
758756
* */
759757
@InternalKmpTorApi

‎library/runtime-core/src/commonMain/kotlin/io/matthewnelson/kmp/tor/runtime/core/Event.kt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,8 +81,8 @@ import kotlin.jvm.JvmField
8181
* ): Observer = Observer(event, tag, executor, onEvent)
8282
* }
8383
*
84+
* See [RuntimeEvent](https://kmp-tor.matthewnelson.io/library/runtime/io.matthewnelson.kmp.tor.runtime/-runtime-event/index.html)
8485
* @see [io.matthewnelson.kmp.tor.runtime.core.TorEvent]
85-
* @see [io.matthewnelson.kmp.tor.runtime.RuntimeEvent]
8686
* */
8787
public abstract class Event<Data: Any?, E: Event<Data, E, O>, O: Event.Observer<Data, E>> protected constructor(
8888
@JvmField

‎library/runtime-core/src/commonMain/kotlin/io/matthewnelson/kmp/tor/runtime/core/TorEvent.kt‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -257,8 +257,8 @@ public sealed class TorEvent private constructor(
257257
* Remove all [Observer] with the given [tag].
258258
*
259259
* If the implementin class extends both [Processor]
260-
* and [io.matthewnelson.kmp.tor.runtime.RuntimeEvent.Processor],
261-
* all [io.matthewnelson.kmp.tor.runtime.RuntimeEvent.Observer]
260+
* and [RuntimeEvent.Processor](https://kmp-tor.matthewnelson.io/library/runtime/io.matthewnelson.kmp.tor.runtime/-runtime-event/-processor/index.html),
261+
* all [RuntimeEvent.Observer](https://kmp-tor.matthewnelson.io/library/runtime/io.matthewnelson.kmp.tor.runtime/-runtime-event/-observer/index.html)
262262
* with the given [tag] will also be removed.
263263
* */
264264
public fun unsubscribeAll(tag: String)
@@ -268,8 +268,8 @@ public sealed class TorEvent private constructor(
268268
* registered.
269269
*
270270
* If the implementin class extends both [Processor]
271-
* and [io.matthewnelson.kmp.tor.runtime.RuntimeEvent.Processor],
272-
* all [io.matthewnelson.kmp.tor.runtime.RuntimeEvent.Observer]
271+
* and [RuntimeEvent.Processor](https://kmp-tor.matthewnelson.io/library/runtime/io.matthewnelson.kmp.tor.runtime/-runtime-event/-processor/index.html),
272+
* all [RuntimeEvent.Observer](https://kmp-tor.matthewnelson.io/library/runtime/io.matthewnelson.kmp.tor.runtime/-runtime-event/-observer/index.html)
273273
* will also be removed.
274274
* */
275275
public fun clearObservers()

‎library/runtime-core/src/commonMain/kotlin/io/matthewnelson/kmp/tor/runtime/core/UncaughtException.kt‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ import kotlin.jvm.JvmSynthetic
3030
/**
3131
* A special exception to indicate something went terribly wrong somewhere.
3232
*
33-
* @see [io.matthewnelson.kmp.tor.runtime.RuntimeEvent.ERROR]
33+
* See [RuntimeEvent.ERROR](https://kmp-tor.matthewnelson.io/library/runtime/io.matthewnelson.kmp.tor.runtime/-runtime-event/-e-r-r-o-r/index.html)
3434
* */
3535
public class UncaughtException private constructor(
3636

@@ -106,8 +106,8 @@ public class UncaughtException private constructor(
106106
*
107107
* **NOTE:** If [Handler] is null, [Handler.THROW] is used.
108108
*
109+
* See [RuntimeEvent.ERROR](https://kmp-tor.matthewnelson.io/library/runtime/io.matthewnelson.kmp.tor.runtime/-runtime-event/-e-r-r-o-r/index.html)
109110
* @see [withSuppression2]
110-
* @see [io.matthewnelson.kmp.tor.runtime.RuntimeEvent.ERROR]
111111
*
112112
* @param [context] Contextual information about where/what [block] is
113113
* to include in the [UncaughtException]

‎library/runtime-core/src/commonMain/kotlin/io/matthewnelson/kmp/tor/runtime/core/ctrl/TorCmd.kt‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -522,7 +522,7 @@ public sealed class TorCmd<Success: Any> private constructor(
522522
public data object Debug: Unprivileged<Reply.Success.OK>("SIGNAL")
523523

524524
/**
525-
* See [io.matthewnelson.kmp.tor.runtime.RuntimeEvent.EXECUTE.CMD.observeSignalNewNym]
525+
* See [RuntimeEvent.EXECUTE.CMD.observeSignalNewNym](https://kmp-tor.matthewnelson.io/library/runtime/io.matthewnelson.kmp.tor.runtime/-runtime-event/-e-x-e-c-u-t-e/-c-m-d/observe-signal-new-nym.html)
526526
* */
527527
public data object NewNym: Unprivileged<Reply.Success.OK>("SIGNAL")
528528

@@ -585,11 +585,11 @@ public sealed class TorCmd<Success: Any> private constructor(
585585
* This can occur when the [Processor] implementation is
586586
* shutdown and the job is awaiting execution.
587587
*
588+
* See [executeSync](https://kmp-tor.matthewnelson.io/library/runtime-core/io.matthewnelson.kmp.tor.runtime.core.util/execute-sync.html)
588589
* @return [EnqueuedJob]
589590
* @see [Reply.Error]
590591
* @see [OnFailure]
591592
* @see [OnSuccess]
592-
* @see [io.matthewnelson.kmp.tor.runtime.core.util.executeSync]
593593
* @see [io.matthewnelson.kmp.tor.runtime.core.util.executeAsync]
594594
* */
595595
public fun <Success: Any> enqueue(
@@ -627,10 +627,10 @@ public sealed class TorCmd<Success: Any> private constructor(
627627
* This can occur when the [Processor] implementation is
628628
* shutdown and the job is awaiting execution.
629629
*
630+
* See [executeSync](https://kmp-tor.matthewnelson.io/library/runtime-core/io.matthewnelson.kmp.tor.runtime.core.util/execute-sync.html)
630631
* @return [EnqueuedJob]
631632
* @see [OnFailure]
632633
* @see [OnSuccess]
633-
* @see [io.matthewnelson.kmp.tor.runtime.core.util.executeSync]
634634
* @see [io.matthewnelson.kmp.tor.runtime.core.util.executeAsync]
635635
* */
636636
public fun <Success: Any> enqueue(

‎library/runtime-core/src/commonMain/kotlin/io/matthewnelson/kmp/tor/runtime/core/net/IPAddress.kt‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -49,10 +49,10 @@ import kotlin.collections.removeFirst as kRemoveFirst
4949
* // 0:0:0:0:0:0:0:0%1
5050
* }
5151
*
52+
* See [toInetAddress](https://kmp-tor.matthewnelson.io/library/runtime-core/io.matthewnelson.kmp.tor.runtime.core.util/to-inet-address.html)
53+
* See [toIPAddress](https://kmp-tor.matthewnelson.io/library/runtime-core/io.matthewnelson.kmp.tor.runtime.core.util/to-i-p-address.html)
5254
* @see [toIPAddress]
5355
* @see [toIPAddressOrNull]
54-
* @see [io.matthewnelson.kmp.tor.runtime.core.util.toInetAddress]
55-
* @see [io.matthewnelson.kmp.tor.runtime.core.util.toIPAddress]
5656
* */
5757
public sealed class IPAddress private constructor(
5858
/** @suppress */
@@ -132,11 +132,11 @@ public sealed class IPAddress private constructor(
132132
/**
133133
* Holder for an IPv4 address
134134
*
135+
* See [toInet4Address](https://kmp-tor.matthewnelson.io/library/runtime-core/io.matthewnelson.kmp.tor.runtime.core.util/to-inet4-address.html)
136+
* See [toIPAddressV4](https://kmp-tor.matthewnelson.io/library/runtime-core/io.matthewnelson.kmp.tor.runtime.core.util/to-i-p-address-v4.html)
135137
* @see [AnyHost]
136138
* @see [toIPAddressV4]
137139
* @see [toIPAddressV4OrNull]
138-
* @see [io.matthewnelson.kmp.tor.runtime.core.util.toInet4Address]
139-
* @see [io.matthewnelson.kmp.tor.runtime.core.util.toIPAddressV4]
140140
* */
141141
public open class V4 private constructor(bytes: ByteArray, value: String): IPAddress(bytes, value) {
142142

@@ -273,13 +273,13 @@ public sealed class IPAddress private constructor(
273273
* **NOTE:** No resolution of device network interfaces
274274
* are performed for a non-null [scope].
275275
*
276+
* See [toInet6Address](https://kmp-tor.matthewnelson.io/library/runtime-core/io.matthewnelson.kmp.tor.runtime.core.util/to-inet6-address.html)
277+
* See [toIPAddressV6](https://kmp-tor.matthewnelson.io/library/runtime-core/io.matthewnelson.kmp.tor.runtime.core.util/to-i-p-address-v6.html)
276278
* @param [scope] The network interface name or index
277279
* number, or null if no scope was expressed.
278280
* @see [AnyHost]
279281
* @see [toIPAddressV6]
280282
* @see [toIPAddressV6OrNull]
281-
* @see [io.matthewnelson.kmp.tor.runtime.core.util.toInet6Address]
282-
* @see [io.matthewnelson.kmp.tor.runtime.core.util.toIPAddressV6]
283283
* */
284284
public open class V6 private constructor(
285285
@JvmField

‎library/runtime-core/src/commonMain/kotlin/io/matthewnelson/kmp/tor/runtime/core/net/Port.kt‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ import io.matthewnelson.kmp.tor.runtime.core.net.Port.Companion.MIN
2222
import io.matthewnelson.kmp.tor.runtime.core.net.Port.Ephemeral.Companion.toPortEphemeralOrNull
2323
import io.matthewnelson.kmp.tor.runtime.core.internal.HostAndPort
2424
import io.matthewnelson.kmp.tor.runtime.core.internal.HostAndPort.Companion.findHostnameAndPortFromURL
25+
import io.matthewnelson.kmp.tor.runtime.core.util.findNextAvailableAsync
2526
import kotlin.jvm.JvmField
2627
import kotlin.jvm.JvmName
2728
import kotlin.jvm.JvmStatic
@@ -37,10 +38,10 @@ import kotlin.jvm.JvmSynthetic
3738
* "http://example.com:8080".toPort()
3839
* "http://[::1]:8181".toPort()
3940
*
41+
* See [isAvailableSync](https://kmp-tor.matthewnelson.io/library/runtime-core/io.matthewnelson.kmp.tor.runtime.core.util/is-available-sync.html)
4042
* @see [toPort]
4143
* @see [toPortOrNull]
4244
* @see [io.matthewnelson.kmp.tor.runtime.core.util.isAvailableAsync]
43-
* @see [io.matthewnelson.kmp.tor.runtime.core.util.isAvailableSync]
4445
* */
4546
public open class Port private constructor(
4647
@JvmField
@@ -194,12 +195,12 @@ public open class Port private constructor(
194195
* "http://example.com:8080".toPortEphemeral()
195196
* "http://[::1]:8181".toPortEphemeral()
196197
*
198+
* See [isAvailableSync](https://kmp-tor.matthewnelson.io/library/runtime-core/io.matthewnelson.kmp.tor.runtime.core.util/is-available-sync.html)
199+
* See [findNextAvailableSync](https://kmp-tor.matthewnelson.io/library/runtime-core/io.matthewnelson.kmp.tor.runtime.core.util/find-next-available-sync.html)
197200
* @see [toPortEphemeral]
198201
* @see [toPortEphemeralOrNull]
199202
* @see [io.matthewnelson.kmp.tor.runtime.core.util.isAvailableAsync]
200-
* @see [io.matthewnelson.kmp.tor.runtime.core.util.isAvailableSync]
201203
* @see [io.matthewnelson.kmp.tor.runtime.core.util.findNextAvailableAsync]
202-
* @see [io.matthewnelson.kmp.tor.runtime.core.util.findAvailableSync]
203204
* */
204205
public class Ephemeral private constructor(value: Int): Port(value) {
205206

‎library/runtime-core/src/commonMain/kotlin/io/matthewnelson/kmp/tor/runtime/core/util/EnqueuedJobUtil.kt‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,7 @@ import io.matthewnelson.kmp.tor.runtime.core.OnSuccess
2626
*
2727
* **NOTE:** This is an internal API not meant for public consumption.
2828
*
29-
* @see [io.matthewnelson.kmp.tor.runtime.core.util.awaitSync]
3029
* @see [io.matthewnelson.kmp.tor.runtime.core.util.executeAsync]
31-
* @see [io.matthewnelson.kmp.tor.runtime.Action.Companion.executeAsync]
3230
* @suppress
3331
* */
3432
@InternalKmpTorApi

‎library/runtime-core/src/commonMain/kotlin/io/matthewnelson/kmp/tor/runtime/core/util/PortUtil.kt‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@ import kotlin.coroutines.cancellation.CancellationException
2323
/**
2424
* Checks if the TCP port is available on [LocalHost] or not.
2525
*
26+
* See [isAvailableSync](https://kmp-tor.matthewnelson.io/library/runtime-core/io.matthewnelson.kmp.tor.runtime.core.util/is-available-sync.html)
2627
* @param [host] either [LocalHost.IPv4] or [LocalHost.IPv6]
27-
* @see [io.matthewnelson.kmp.tor.runtime.core.util.isAvailableSync]
2828
* */
2929
public expect suspend fun Port.isAvailableAsync(
3030
host: LocalHost,
@@ -37,9 +37,9 @@ public expect suspend fun Port.isAvailableAsync(
3737
* If [Port.Ephemeral.MAX] is exceeded while iterating through ports and [limit]
3838
* has not been exhausted, the remaining checks will start from [Port.Ephemeral.MIN].
3939
*
40+
* See [findNextAvailableSync](https://kmp-tor.matthewnelson.io/library/runtime-core/io.matthewnelson.kmp.tor.runtime.core.util/find-next-available-sync.html)
4041
* @param [host] either [LocalHost.IPv4] or [LocalHost.IPv6]
4142
* @param [limit] the number of ports to scan. min: 1, max: 1_000
42-
* @see [io.matthewnelson.kmp.tor.runtime.core.util.findAvailableSync]
4343
* @throws [IllegalArgumentException] if [limit] is not between 1 and 1_000 (inclusive)
4444
* @throws [IOException] if no ports are available
4545
* @throws [CancellationException] if underlying coroutine was cancelled

0 commit comments

Comments
 (0)