aboutsummaryrefslogtreecommitdiff
path: root/core
diff options
context:
space:
mode:
authorIgnat Beresnev <ignat.beresnev@jetbrains.com>2023-11-10 11:46:54 +0100
committerGitHub <noreply@github.com>2023-11-10 11:46:54 +0100
commit8e5c63d035ef44a269b8c43430f43f5c8eebfb63 (patch)
tree1b915207b2b9f61951ddbf0ff2e687efd053d555 /core
parenta44efd4ba0c2e4ab921ff75e0f53fc9335aa79db (diff)
downloaddokka-8e5c63d035ef44a269b8c43430f43f5c8eebfb63.tar.gz
dokka-8e5c63d035ef44a269b8c43430f43f5c8eebfb63.tar.bz2
dokka-8e5c63d035ef44a269b8c43430f43f5c8eebfb63.zip
Restructure the project to utilize included builds (#3174)
* Refactor and simplify artifact publishing * Update Gradle to 8.4 * Refactor and simplify convention plugins and build scripts Fixes #3132 --------- Co-authored-by: Adam <897017+aSemy@users.noreply.github.com> Co-authored-by: Oleg Yukhnevich <whyoleg@gmail.com>
Diffstat (limited to 'core')
-rw-r--r--core/.gitignore1
-rw-r--r--core/api/core.api4745
-rw-r--r--core/build.gradle.kts43
-rw-r--r--core/content-matcher-test-utils/api/content-matcher-test-utils.api81
-rw-r--r--core/content-matcher-test-utils/build.gradle.kts14
-rw-r--r--core/content-matcher-test-utils/src/main/kotlin/matchers/content/ContentMatchersDsl.kt191
-rw-r--r--core/content-matcher-test-utils/src/main/kotlin/matchers/content/contentMatchers.kt191
-rw-r--r--core/src/main/kotlin/ConfigurationJsonUtils.kt54
-rw-r--r--core/src/main/kotlin/CoreExtensions.kt43
-rw-r--r--core/src/main/kotlin/DokkaBootstrap.kt15
-rw-r--r--core/src/main/kotlin/DokkaBootstrapImpl.kt69
-rw-r--r--core/src/main/kotlin/DokkaException.kt7
-rw-r--r--core/src/main/kotlin/DokkaGenerator.kt89
-rw-r--r--core/src/main/kotlin/DokkaVersion.kt15
-rw-r--r--core/src/main/kotlin/InternalDokkaApi.kt28
-rw-r--r--core/src/main/kotlin/configuration.kt280
-rw-r--r--core/src/main/kotlin/defaultConfiguration.kt100
-rw-r--r--core/src/main/kotlin/defaultExternalLinks.kt33
-rw-r--r--core/src/main/kotlin/generation/Generation.kt19
-rw-r--r--core/src/main/kotlin/links/DRI.kt146
-rw-r--r--core/src/main/kotlin/model/CompositeSourceSetID.kt46
-rw-r--r--core/src/main/kotlin/model/DisplaySourceSet.kt61
-rw-r--r--core/src/main/kotlin/model/Documentable.kt540
-rw-r--r--core/src/main/kotlin/model/JvmField.kt14
-rw-r--r--core/src/main/kotlin/model/WithChildren.kt98
-rw-r--r--core/src/main/kotlin/model/additionalExtras.kt142
-rw-r--r--core/src/main/kotlin/model/ancestryNode.kt18
-rw-r--r--core/src/main/kotlin/model/classKinds.kt24
-rw-r--r--core/src/main/kotlin/model/defaultValues.kt34
-rw-r--r--core/src/main/kotlin/model/doc/DocTag.kt372
-rw-r--r--core/src/main/kotlin/model/doc/DocumentationNode.kt9
-rw-r--r--core/src/main/kotlin/model/doc/TagWrapper.kt36
-rw-r--r--core/src/main/kotlin/model/documentableProperties.kt71
-rw-r--r--core/src/main/kotlin/model/documentableUtils.kt27
-rw-r--r--core/src/main/kotlin/model/extraModifiers.kt68
-rw-r--r--core/src/main/kotlin/model/jvmName.kt11
-rw-r--r--core/src/main/kotlin/model/properties/PropertyContainer.kt69
-rw-r--r--core/src/main/kotlin/model/properties/properties.kt36
-rw-r--r--core/src/main/kotlin/pages/ContentNodes.kt436
-rw-r--r--core/src/main/kotlin/pages/PageNodes.kt200
-rw-r--r--core/src/main/kotlin/pages/Pages.kt15
-rw-r--r--core/src/main/kotlin/pages/RendererSpecificPage.kt52
-rw-r--r--core/src/main/kotlin/pages/contentNodeProperties.kt37
-rw-r--r--core/src/main/kotlin/pages/utils.kt63
-rw-r--r--core/src/main/kotlin/plugability/DokkaContext.kt235
-rw-r--r--core/src/main/kotlin/plugability/DokkaJavaPlugin.kt78
-rw-r--r--core/src/main/kotlin/plugability/DokkaPlugin.kt114
-rw-r--r--core/src/main/kotlin/plugability/LazyEvaluated.kt21
-rw-r--r--core/src/main/kotlin/plugability/extensions.kt110
-rw-r--r--core/src/main/kotlin/renderers/PostAction.kt7
-rw-r--r--core/src/main/kotlin/renderers/Renderer.kt11
-rw-r--r--core/src/main/kotlin/transformers/documentation/DefaultDocumentableMerger.kt307
-rw-r--r--core/src/main/kotlin/transformers/documentation/DocumentableMerger.kt12
-rw-r--r--core/src/main/kotlin/transformers/documentation/DocumentableToPageTranslator.kt13
-rw-r--r--core/src/main/kotlin/transformers/documentation/DocumentableTransformer.kt12
-rw-r--r--core/src/main/kotlin/transformers/documentation/PreMergeDocumentableTransformer.kt39
-rw-r--r--core/src/main/kotlin/transformers/pages/PageCreator.kt15
-rw-r--r--core/src/main/kotlin/transformers/pages/PageTransformer.kt11
-rw-r--r--core/src/main/kotlin/transformers/pages/PageTransformerBuilders.kt27
-rw-r--r--core/src/main/kotlin/transformers/sources/AsyncSourceToDocumentableTranslator.kt20
-rw-r--r--core/src/main/kotlin/transformers/sources/SourceToDocumentableTranslator.kt13
-rw-r--r--core/src/main/kotlin/utilities/Collections.kt29
-rw-r--r--core/src/main/kotlin/utilities/DokkaLogging.kt90
-rw-r--r--core/src/main/kotlin/utilities/Html.kt23
-rw-r--r--core/src/main/kotlin/utilities/SelfRepresentingSingletonSet.kt27
-rw-r--r--core/src/main/kotlin/utilities/ServiceLocator.kt99
-rw-r--r--core/src/main/kotlin/utilities/Uri.kt46
-rw-r--r--core/src/main/kotlin/utilities/associateWithNotNull.kt13
-rw-r--r--core/src/main/kotlin/utilities/cast.kt12
-rw-r--r--core/src/main/kotlin/utilities/json.kt65
-rw-r--r--core/src/main/kotlin/utilities/parallelCollectionOperations.kt26
-rw-r--r--core/src/main/kotlin/validity/PreGenerationChecker.kt17
-rw-r--r--core/src/main/resources/META-INF/MANIFEST.MF1
-rw-r--r--core/src/main/resources/META-INF/dokka/dokka-version.properties5
-rw-r--r--core/src/test/kotlin/model/CompositeSourceSetIDTest.kt76
-rw-r--r--core/src/test/kotlin/model/DisplaySourceSetTest.kt63
-rw-r--r--core/src/test/kotlin/model/DocumentableTest.kt115
-rw-r--r--core/src/test/kotlin/utilities/DokkaConfigurationJsonTest.kt72
-rw-r--r--core/src/test/kotlin/utilities/JsonKtTest.kt80
-rw-r--r--core/test-api/api/test-api.api198
-rw-r--r--core/test-api/build.gradle.kts20
-rw-r--r--core/test-api/src/main/kotlin/testApi/context/MockContext.kt53
-rw-r--r--core/test-api/src/main/kotlin/testApi/logger/TestLogger.kt58
-rw-r--r--core/test-api/src/main/kotlin/testApi/testRunner/TestDokkaConfigurationBuilder.kt219
-rw-r--r--core/test-api/src/main/kotlin/testApi/testRunner/TestRunner.kt235
85 files changed, 0 insertions, 11330 deletions
diff --git a/core/.gitignore b/core/.gitignore
deleted file mode 100644
index 1e1b410b..00000000
--- a/core/.gitignore
+++ /dev/null
@@ -1 +0,0 @@
-src/main/resources/dokka/scripts/*.svg \ No newline at end of file
diff --git a/core/api/core.api b/core/api/core.api
deleted file mode 100644
index fffcb877..00000000
--- a/core/api/core.api
+++ /dev/null
@@ -1,4745 +0,0 @@
-public final class org/jetbrains/dokka/ConfigurationJsonUtilsKt {
- public static final fun DokkaConfigurationImpl (Ljava/lang/String;)Lorg/jetbrains/dokka/DokkaConfigurationImpl;
- public static final fun GlobalDokkaConfiguration (Ljava/lang/String;)Lorg/jetbrains/dokka/GlobalDokkaConfiguration;
- public static final fun toCompactJsonString (Lorg/jetbrains/dokka/DokkaConfiguration;)Ljava/lang/String;
- public static final fun toCompactJsonString (Lorg/jetbrains/dokka/plugability/ConfigurableBlock;)Ljava/lang/String;
- public static final fun toJsonString (Lorg/jetbrains/dokka/DokkaConfiguration;)Ljava/lang/String;
- public static final fun toJsonString (Lorg/jetbrains/dokka/plugability/ConfigurableBlock;)Ljava/lang/String;
- public static final fun toPrettyJsonString (Lorg/jetbrains/dokka/DokkaConfiguration;)Ljava/lang/String;
- public static final fun toPrettyJsonString (Lorg/jetbrains/dokka/plugability/ConfigurableBlock;)Ljava/lang/String;
-}
-
-public final class org/jetbrains/dokka/ConfigurationKt {
- public static final fun ExternalDocumentationLink (Ljava/lang/String;Ljava/lang/String;)Lorg/jetbrains/dokka/ExternalDocumentationLinkImpl;
- public static final fun ExternalDocumentationLink (Ljava/net/URL;Ljava/net/URL;)Lorg/jetbrains/dokka/ExternalDocumentationLinkImpl;
- public static synthetic fun ExternalDocumentationLink$default (Ljava/lang/String;Ljava/lang/String;ILjava/lang/Object;)Lorg/jetbrains/dokka/ExternalDocumentationLinkImpl;
- public static synthetic fun ExternalDocumentationLink$default (Ljava/net/URL;Ljava/net/URL;ILjava/lang/Object;)Lorg/jetbrains/dokka/ExternalDocumentationLinkImpl;
- public static final fun apply (Lorg/jetbrains/dokka/DokkaConfiguration;Lorg/jetbrains/dokka/GlobalDokkaConfiguration;)Lorg/jetbrains/dokka/DokkaConfiguration;
- public static final fun build (Ljava/lang/Iterable;)Ljava/util/List;
-}
-
-public final class org/jetbrains/dokka/CoreExtensions {
- public static final field INSTANCE Lorg/jetbrains/dokka/CoreExtensions;
- public final fun getDocumentableMerger ()Lorg/jetbrains/dokka/plugability/ExtensionPoint;
- public final fun getDocumentableToPageTranslator ()Lorg/jetbrains/dokka/plugability/ExtensionPoint;
- public final fun getDocumentableTransformer ()Lorg/jetbrains/dokka/plugability/ExtensionPoint;
- public final fun getGeneration ()Lorg/jetbrains/dokka/plugability/ExtensionPoint;
- public final fun getPageTransformer ()Lorg/jetbrains/dokka/plugability/ExtensionPoint;
- public final fun getPostActions ()Lorg/jetbrains/dokka/plugability/ExtensionPoint;
- public final fun getPreGenerationCheck ()Lorg/jetbrains/dokka/plugability/ExtensionPoint;
- public final fun getRenderer ()Lorg/jetbrains/dokka/plugability/ExtensionPoint;
- public final fun getSourceToDocumentableTranslator ()Lorg/jetbrains/dokka/plugability/ExtensionPoint;
-}
-
-public final class org/jetbrains/dokka/DefaultExternalLinksKt {
- public static final fun androidSdk (Lorg/jetbrains/dokka/DokkaConfiguration$ExternalDocumentationLink$Companion;)Lorg/jetbrains/dokka/ExternalDocumentationLinkImpl;
- public static final fun androidX (Lorg/jetbrains/dokka/DokkaConfiguration$ExternalDocumentationLink$Companion;)Lorg/jetbrains/dokka/ExternalDocumentationLinkImpl;
- public static final fun jdk (Lorg/jetbrains/dokka/DokkaConfiguration$ExternalDocumentationLink$Companion;I)Lorg/jetbrains/dokka/ExternalDocumentationLinkImpl;
- public static final fun kotlinStdlib (Lorg/jetbrains/dokka/DokkaConfiguration$ExternalDocumentationLink$Companion;)Lorg/jetbrains/dokka/ExternalDocumentationLinkImpl;
-}
-
-public abstract interface class org/jetbrains/dokka/DokkaBootstrap {
- public abstract fun configure (Ljava/lang/String;Ljava/util/function/BiConsumer;)V
- public abstract fun generate ()V
-}
-
-public final class org/jetbrains/dokka/DokkaBootstrapImpl : org/jetbrains/dokka/DokkaBootstrap {
- public fun <init> ()V
- public fun configure (Ljava/lang/String;Ljava/util/function/BiConsumer;)V
- public final fun configure (Lorg/jetbrains/dokka/utilities/DokkaLogger;Lorg/jetbrains/dokka/DokkaConfigurationImpl;)V
- public fun generate ()V
-}
-
-public final class org/jetbrains/dokka/DokkaBootstrapImpl$DokkaProxyLogger : org/jetbrains/dokka/utilities/DokkaLogger {
- public fun <init> (Ljava/util/function/BiConsumer;)V
- public fun debug (Ljava/lang/String;)V
- public fun error (Ljava/lang/String;)V
- public final fun getConsumer ()Ljava/util/function/BiConsumer;
- public fun getErrorsCount ()I
- public fun getWarningsCount ()I
- public fun info (Ljava/lang/String;)V
- public fun progress (Ljava/lang/String;)V
- public fun setErrorsCount (I)V
- public fun setWarningsCount (I)V
- public fun warn (Ljava/lang/String;)V
-}
-
-public abstract interface class org/jetbrains/dokka/DokkaConfiguration : java/io/Serializable {
- public abstract fun getCacheRoot ()Ljava/io/File;
- public abstract fun getDelayTemplateSubstitution ()Z
- public abstract fun getFailOnWarning ()Z
- public abstract fun getFinalizeCoroutines ()Z
- public abstract fun getIncludes ()Ljava/util/Set;
- public abstract fun getModuleName ()Ljava/lang/String;
- public abstract fun getModuleVersion ()Ljava/lang/String;
- public abstract fun getModules ()Ljava/util/List;
- public abstract fun getOfflineMode ()Z
- public abstract fun getOutputDir ()Ljava/io/File;
- public abstract fun getPluginsClasspath ()Ljava/util/List;
- public abstract fun getPluginsConfiguration ()Ljava/util/List;
- public abstract fun getSourceSets ()Ljava/util/List;
- public abstract fun getSuppressInheritedMembers ()Z
- public abstract fun getSuppressObviousFunctions ()Z
-}
-
-public abstract interface class org/jetbrains/dokka/DokkaConfiguration$DokkaModuleDescription : java/io/Serializable {
- public abstract fun getIncludes ()Ljava/util/Set;
- public abstract fun getName ()Ljava/lang/String;
- public abstract fun getRelativePathToOutputDirectory ()Ljava/io/File;
- public abstract fun getSourceOutputDirectory ()Ljava/io/File;
-}
-
-public abstract interface class org/jetbrains/dokka/DokkaConfiguration$DokkaSourceSet : java/io/Serializable {
- public abstract fun getAnalysisPlatform ()Lorg/jetbrains/dokka/Platform;
- public abstract fun getApiVersion ()Ljava/lang/String;
- public abstract fun getClasspath ()Ljava/util/List;
- public abstract fun getDependentSourceSets ()Ljava/util/Set;
- public abstract fun getDisplayName ()Ljava/lang/String;
- public abstract fun getDocumentedVisibilities ()Ljava/util/Set;
- public abstract fun getExternalDocumentationLinks ()Ljava/util/Set;
- public abstract fun getIncludeNonPublic ()Z
- public abstract fun getIncludes ()Ljava/util/Set;
- public abstract fun getJdkVersion ()I
- public abstract fun getLanguageVersion ()Ljava/lang/String;
- public abstract fun getNoJdkLink ()Z
- public abstract fun getNoStdlibLink ()Z
- public abstract fun getPerPackageOptions ()Ljava/util/List;
- public abstract fun getReportUndocumented ()Z
- public abstract fun getSamples ()Ljava/util/Set;
- public abstract fun getSkipDeprecated ()Z
- public abstract fun getSkipEmptyPackages ()Z
- public abstract fun getSourceLinks ()Ljava/util/Set;
- public abstract fun getSourceRoots ()Ljava/util/Set;
- public abstract fun getSourceSetID ()Lorg/jetbrains/dokka/DokkaSourceSetID;
- public abstract fun getSuppressedFiles ()Ljava/util/Set;
-}
-
-public abstract interface class org/jetbrains/dokka/DokkaConfiguration$ExternalDocumentationLink : java/io/Serializable {
- public static final field Companion Lorg/jetbrains/dokka/DokkaConfiguration$ExternalDocumentationLink$Companion;
- public abstract fun getPackageListUrl ()Ljava/net/URL;
- public abstract fun getUrl ()Ljava/net/URL;
-}
-
-public final class org/jetbrains/dokka/DokkaConfiguration$ExternalDocumentationLink$Companion {
-}
-
-public abstract interface class org/jetbrains/dokka/DokkaConfiguration$PackageOptions : java/io/Serializable {
- public abstract fun getDocumentedVisibilities ()Ljava/util/Set;
- public abstract fun getIncludeNonPublic ()Z
- public abstract fun getMatchingRegex ()Ljava/lang/String;
- public abstract fun getReportUndocumented ()Ljava/lang/Boolean;
- public abstract fun getSkipDeprecated ()Z
- public abstract fun getSuppress ()Z
-}
-
-public abstract interface class org/jetbrains/dokka/DokkaConfiguration$PluginConfiguration : java/io/Serializable {
- public abstract fun getFqPluginName ()Ljava/lang/String;
- public abstract fun getSerializationFormat ()Lorg/jetbrains/dokka/DokkaConfiguration$SerializationFormat;
- public abstract fun getValues ()Ljava/lang/String;
-}
-
-public final class org/jetbrains/dokka/DokkaConfiguration$SerializationFormat : java/lang/Enum, java/io/Serializable {
- public static final field JSON Lorg/jetbrains/dokka/DokkaConfiguration$SerializationFormat;
- public static final field XML Lorg/jetbrains/dokka/DokkaConfiguration$SerializationFormat;
- public static fun valueOf (Ljava/lang/String;)Lorg/jetbrains/dokka/DokkaConfiguration$SerializationFormat;
- public static fun values ()[Lorg/jetbrains/dokka/DokkaConfiguration$SerializationFormat;
-}
-
-public abstract interface class org/jetbrains/dokka/DokkaConfiguration$SourceLinkDefinition : java/io/Serializable {
- public abstract fun getLocalDirectory ()Ljava/lang/String;
- public abstract fun getRemoteLineSuffix ()Ljava/lang/String;
- public abstract fun getRemoteUrl ()Ljava/net/URL;
-}
-
-public final class org/jetbrains/dokka/DokkaConfiguration$Visibility : java/lang/Enum {
- public static final field Companion Lorg/jetbrains/dokka/DokkaConfiguration$Visibility$Companion;
- public static final field INTERNAL Lorg/jetbrains/dokka/DokkaConfiguration$Visibility;
- public static final field PACKAGE Lorg/jetbrains/dokka/DokkaConfiguration$Visibility;
- public static final field PRIVATE Lorg/jetbrains/dokka/DokkaConfiguration$Visibility;
- public static final field PROTECTED Lorg/jetbrains/dokka/DokkaConfiguration$Visibility;
- public static final field PUBLIC Lorg/jetbrains/dokka/DokkaConfiguration$Visibility;
- public static fun valueOf (Ljava/lang/String;)Lorg/jetbrains/dokka/DokkaConfiguration$Visibility;
- public static fun values ()[Lorg/jetbrains/dokka/DokkaConfiguration$Visibility;
-}
-
-public final class org/jetbrains/dokka/DokkaConfiguration$Visibility$Companion {
- public final fun fromString (Ljava/lang/String;)Lorg/jetbrains/dokka/DokkaConfiguration$Visibility;
-}
-
-public abstract interface class org/jetbrains/dokka/DokkaConfigurationBuilder {
- public abstract fun build ()Ljava/lang/Object;
-}
-
-public final class org/jetbrains/dokka/DokkaConfigurationImpl : org/jetbrains/dokka/DokkaConfiguration {
- public fun <init> ()V
- public fun <init> (Ljava/lang/String;Ljava/lang/String;Ljava/io/File;Ljava/io/File;ZLjava/util/List;Ljava/util/List;Ljava/util/List;Ljava/util/List;ZZZLjava/util/Set;ZZ)V
- public synthetic fun <init> (Ljava/lang/String;Ljava/lang/String;Ljava/io/File;Ljava/io/File;ZLjava/util/List;Ljava/util/List;Ljava/util/List;Ljava/util/List;ZZZLjava/util/Set;ZZILkotlin/jvm/internal/DefaultConstructorMarker;)V
- public final fun component1 ()Ljava/lang/String;
- public final fun component10 ()Z
- public final fun component11 ()Z
- public final fun component12 ()Z
- public final fun component13 ()Ljava/util/Set;
- public final fun component14 ()Z
- public final fun component15 ()Z
- public final fun component2 ()Ljava/lang/String;
- public final fun component3 ()Ljava/io/File;
- public final fun component4 ()Ljava/io/File;
- public final fun component5 ()Z
- public final fun component6 ()Ljava/util/List;
- public final fun component7 ()Ljava/util/List;
- public final fun component8 ()Ljava/util/List;
- public final fun component9 ()Ljava/util/List;
- public final fun copy (Ljava/lang/String;Ljava/lang/String;Ljava/io/File;Ljava/io/File;ZLjava/util/List;Ljava/util/List;Ljava/util/List;Ljava/util/List;ZZZLjava/util/Set;ZZ)Lorg/jetbrains/dokka/DokkaConfigurationImpl;
- public static synthetic fun copy$default (Lorg/jetbrains/dokka/DokkaConfigurationImpl;Ljava/lang/String;Ljava/lang/String;Ljava/io/File;Ljava/io/File;ZLjava/util/List;Ljava/util/List;Ljava/util/List;Ljava/util/List;ZZZLjava/util/Set;ZZILjava/lang/Object;)Lorg/jetbrains/dokka/DokkaConfigurationImpl;
- public fun equals (Ljava/lang/Object;)Z
- public fun getCacheRoot ()Ljava/io/File;
- public fun getDelayTemplateSubstitution ()Z
- public fun getFailOnWarning ()Z
- public fun getFinalizeCoroutines ()Z
- public fun getIncludes ()Ljava/util/Set;
- public fun getModuleName ()Ljava/lang/String;
- public fun getModuleVersion ()Ljava/lang/String;
- public fun getModules ()Ljava/util/List;
- public fun getOfflineMode ()Z
- public fun getOutputDir ()Ljava/io/File;
- public fun getPluginsClasspath ()Ljava/util/List;
- public fun getPluginsConfiguration ()Ljava/util/List;
- public fun getSourceSets ()Ljava/util/List;
- public fun getSuppressInheritedMembers ()Z
- public fun getSuppressObviousFunctions ()Z
- public fun hashCode ()I
- public fun toString ()Ljava/lang/String;
-}
-
-public final class org/jetbrains/dokka/DokkaDefaults {
- public static final field INSTANCE Lorg/jetbrains/dokka/DokkaDefaults;
- public static final field delayTemplateSubstitution Z
- public static final field failOnWarning Z
- public static final field includeNonPublic Z
- public static final field jdkVersion I
- public static final field noAndroidSdkLink Z
- public static final field noJdkLink Z
- public static final field noStdlibLink Z
- public static final field offlineMode Z
- public static final field reportUndocumented Z
- public static final field skipDeprecated Z