core/org.jetbrains.dokka.utilities

Package-level declarations

Types

DokkaConsoleLogger

class DokkaConsoleLogger(minLevel: LoggingLevel = LoggingLevel.PROGRESS, emitter: MessageEmitter = MessageEmitter.consoleEmitter) : DokkaLogger

interface DokkaLogger

enum LoggingLevel : Enum<LoggingLevel>

fun interface MessageEmitter : Function1<String, Unit>

Used to decouple the transport layer from logger and make it convenient for testing

SelfRepresentingSingletonSet

interface ~~SelfRepresentingSingletonSet~~<T : SelfRepresentingSingletonSet<T>> : Set<T>

ServiceDescriptor

data class ServiceDescriptor(val name: String, val category: String, val description: String?, val className: String)

object ServiceLocator

ServiceLookupException

class ServiceLookupException(message: String) : Exception

Functions

associateWithNotNull

inline fun <K, V : Any> Iterable<K>.associateWithNotNull(valueSelector: (K) -> V?): Map<K, V>

inline fun <T> Any.cast(): T

firstIsInstanceOrNull

inline fun <T : Any> Iterable<*>.firstIsInstanceOrNull(): T?

inline fun <T : Any> Sequence<*>.firstIsInstanceOrNull(): T?

This utility method was previously imported from org.jetbrains.kotlin.utils.addToStdlib, and there were a lot of usages. Since no replacement exists in stdlib, it was implemented locally for convenience.

formatToEndWithHtml

fun String.formatToEndWithHtml(): String

fun String.htmlEscape(): String

Replaces symbols reserved in HTML with their respective entities. Replaces & with &, < with < and with >

parallelForEach

inline suspend fun <A> Iterable<A>.parallelForEach(crossinline f: suspend (A) -> Unit)

inline suspend fun <A, B> Iterable<A>.parallelMap(crossinline f: suspend (A) -> B): List<B>

parallelMapNotNull

inline suspend fun <A, B> Iterable<A>.parallelMapNotNull(crossinline f: suspend (A) -> B?): List<B>

fun URI.~~relativeTo~~(uri: URI): URI

fun DokkaLogger.report()

fun String.urlEncoded(): String