aboutsummaryrefslogtreecommitdiff
path: root/plugins/versioning/api/versioning.api
diff options
context:
space:
mode:
authorvmishenev <vad-mishenev@yandex.ru>2021-09-01 00:03:13 +0300
committervmishenev <vad-mishenev@yandex.ru>2021-09-20 19:01:44 +0300
commitfc5496fb8bb888c3a50717260dc05d8fe2d54306 (patch)
tree2b61c01babe696065c4b8bafad61cce7479561ad /plugins/versioning/api/versioning.api
parent8efe04e127e3bf0aef395b31f3f3d9f49a0afe26 (diff)
downloaddokka-fc5496fb8bb888c3a50717260dc05d8fe2d54306.tar.gz
dokka-fc5496fb8bb888c3a50717260dc05d8fe2d54306.tar.bz2
dokka-fc5496fb8bb888c3a50717260dc05d8fe2d54306.zip
Improve versioning plugin (#2104)
- support for single module projects - version navigator is on all pages - dropdown arrow for version navigator
Diffstat (limited to 'plugins/versioning/api/versioning.api')
-rw-r--r--plugins/versioning/api/versioning.api84
1 files changed, 59 insertions, 25 deletions
diff --git a/plugins/versioning/api/versioning.api b/plugins/versioning/api/versioning.api
index 8223579b..15ebe7be 100644
--- a/plugins/versioning/api/versioning.api
+++ b/plugins/versioning/api/versioning.api
@@ -4,28 +4,45 @@ public final class org/jetbrains/dokka/versioning/ByConfigurationVersionOrdering
public fun order (Ljava/util/List;)Ljava/util/List;
}
-public final class org/jetbrains/dokka/versioning/DefaultVersioningHandler : org/jetbrains/dokka/versioning/VersioningHandler {
- public static final field Companion Lorg/jetbrains/dokka/versioning/DefaultVersioningHandler$Companion;
+public final class org/jetbrains/dokka/versioning/CurrentVersion {
+ public fun <init> (Ljava/lang/String;Ljava/io/File;)V
+ public final fun component1 ()Ljava/lang/String;
+ public final fun component2 ()Ljava/io/File;
+ public final fun copy (Ljava/lang/String;Ljava/io/File;)Lorg/jetbrains/dokka/versioning/CurrentVersion;
+ public static synthetic fun copy$default (Lorg/jetbrains/dokka/versioning/CurrentVersion;Ljava/lang/String;Ljava/io/File;ILjava/lang/Object;)Lorg/jetbrains/dokka/versioning/CurrentVersion;
+ public fun equals (Ljava/lang/Object;)Z
+ public final fun getDir ()Ljava/io/File;
+ public final fun getName ()Ljava/lang/String;
+ public fun hashCode ()I
+ public fun toString ()Ljava/lang/String;
+}
+
+public final class org/jetbrains/dokka/versioning/DefaultPreviousDocumentationCopyPostAction : org/jetbrains/dokka/renderers/PostAction {
public fun <init> (Lorg/jetbrains/dokka/plugability/DokkaContext;)V
- public fun currentVersion ()Ljava/io/File;
- public final fun getContext ()Lorg/jetbrains/dokka/plugability/DokkaContext;
- public fun getVersions ()Ljava/util/Map;
public synthetic fun invoke ()Ljava/lang/Object;
public fun invoke ()V
}
-public final class org/jetbrains/dokka/versioning/DefaultVersioningHandler$Companion {
+public final class org/jetbrains/dokka/versioning/DefaultVersioningStorage : org/jetbrains/dokka/versioning/VersioningStorage {
+ public fun <init> (Lorg/jetbrains/dokka/plugability/DokkaContext;)V
+ public fun createVersionFile ()V
+ public final fun getContext ()Lorg/jetbrains/dokka/plugability/DokkaContext;
+ public fun getCurrentVersion ()Lorg/jetbrains/dokka/versioning/CurrentVersion;
+ public fun getPreviousVersions ()Ljava/util/Map;
}
public final class org/jetbrains/dokka/versioning/HtmlVersionsNavigationCreator : org/jetbrains/dokka/versioning/VersionsNavigationCreator {
public fun <init> (Lorg/jetbrains/dokka/plugability/DokkaContext;)V
- public final fun getContext ()Lorg/jetbrains/dokka/plugability/DokkaContext;
- public fun invoke ()Ljava/lang/String;
public fun invoke (Ljava/io/File;)Ljava/lang/String;
}
public final class org/jetbrains/dokka/versioning/MultiModuleStylesInstaller : org/jetbrains/dokka/transformers/pages/PageTransformer {
- public static final field INSTANCE Lorg/jetbrains/dokka/versioning/MultiModuleStylesInstaller;
+ public fun <init> (Lorg/jetbrains/dokka/plugability/DokkaContext;)V
+ public fun invoke (Lorg/jetbrains/dokka/pages/RootPageNode;)Lorg/jetbrains/dokka/pages/RootPageNode;
+}
+
+public final class org/jetbrains/dokka/versioning/NotFoundPageInstaller : org/jetbrains/dokka/transformers/pages/PageTransformer {
+ public fun <init> (Lorg/jetbrains/dokka/plugability/DokkaContext;)V
public fun invoke (Lorg/jetbrains/dokka/pages/RootPageNode;)Lorg/jetbrains/dokka/pages/RootPageNode;
}
@@ -44,34 +61,48 @@ public final class org/jetbrains/dokka/versioning/ReplaceVersionCommandHandler :
public fun handleCommand (Lorg/jsoup/nodes/Element;Lorg/jetbrains/dokka/base/templating/Command;Ljava/io/File;Ljava/io/File;)V
}
-public final class org/jetbrains/dokka/versioning/ReplaceVersionsCommand : org/jetbrains/dokka/base/templating/Command {
- public static final field INSTANCE Lorg/jetbrains/dokka/versioning/ReplaceVersionsCommand;
-}
-
public final class org/jetbrains/dokka/versioning/SemVerVersionOrdering : org/jetbrains/dokka/versioning/VersionsOrdering {
public fun <init> ()V
public fun order (Ljava/util/List;)Ljava/util/List;
}
+public final class org/jetbrains/dokka/versioning/VersionDirs {
+ public fun <init> (Ljava/io/File;Ljava/io/File;)V
+ public final fun component1 ()Ljava/io/File;
+ public final fun component2 ()Ljava/io/File;
+ public final fun copy (Ljava/io/File;Ljava/io/File;)Lorg/jetbrains/dokka/versioning/VersionDirs;
+ public static synthetic fun copy$default (Lorg/jetbrains/dokka/versioning/VersionDirs;Ljava/io/File;Ljava/io/File;ILjava/lang/Object;)Lorg/jetbrains/dokka/versioning/VersionDirs;
+ public fun equals (Ljava/lang/Object;)Z
+ public final fun getDst ()Ljava/io/File;
+ public final fun getSrc ()Ljava/io/File;
+ public fun hashCode ()I
+ public fun toString ()Ljava/lang/String;
+}
+
public final class org/jetbrains/dokka/versioning/VersioningConfiguration : org/jetbrains/dokka/plugability/ConfigurableBlock {
public static final field Companion Lorg/jetbrains/dokka/versioning/VersioningConfiguration$Companion;
+ public static final field OLDER_VERSIONS_DIR Ljava/lang/String;
+ public static final field VERSIONS_FILE Ljava/lang/String;
public fun <init> ()V
- public fun <init> (Ljava/io/File;Ljava/util/List;Ljava/util/List;Ljava/lang/String;)V
- public synthetic fun <init> (Ljava/io/File;Ljava/util/List;Ljava/util/List;Ljava/lang/String;ILkotlin/jvm/internal/DefaultConstructorMarker;)V
+ public fun <init> (Ljava/io/File;Ljava/util/List;Ljava/util/List;Ljava/lang/String;Ljava/lang/Boolean;)V
+ public synthetic fun <init> (Ljava/io/File;Ljava/util/List;Ljava/util/List;Ljava/lang/String;Ljava/lang/Boolean;ILkotlin/jvm/internal/DefaultConstructorMarker;)V
public final fun component1 ()Ljava/io/File;
public final fun component2 ()Ljava/util/List;
public final fun component3 ()Ljava/util/List;
public final fun component4 ()Ljava/lang/String;
- public final fun copy (Ljava/io/File;Ljava/util/List;Ljava/util/List;Ljava/lang/String;)Lorg/jetbrains/dokka/versioning/VersioningConfiguration;
- public static synthetic fun copy$default (Lorg/jetbrains/dokka/versioning/VersioningConfiguration;Ljava/io/File;Ljava/util/List;Ljava/util/List;Ljava/lang/String;ILjava/lang/Object;)Lorg/jetbrains/dokka/versioning/VersioningConfiguration;
+ public final fun component5 ()Ljava/lang/Boolean;
+ public final fun copy (Ljava/io/File;Ljava/util/List;Ljava/util/List;Ljava/lang/String;Ljava/lang/Boolean;)Lorg/jetbrains/dokka/versioning/VersioningConfiguration;
+ public static synthetic fun copy$default (Lorg/jetbrains/dokka/versioning/VersioningConfiguration;Ljava/io/File;Ljava/util/List;Ljava/util/List;Ljava/lang/String;Ljava/lang/Boolean;ILjava/lang/Object;)Lorg/jetbrains/dokka/versioning/VersioningConfiguration;
public fun equals (Ljava/lang/Object;)Z
public final fun getOlderVersions ()Ljava/util/List;
public final fun getOlderVersionsDir ()Ljava/io/File;
+ public final fun getRenderVersionsNavigationOnAllPages ()Ljava/lang/Boolean;
public final fun getVersion ()Ljava/lang/String;
public final fun getVersionsOrdering ()Ljava/util/List;
public fun hashCode ()I
public final fun setOlderVersions (Ljava/util/List;)V
public final fun setOlderVersionsDir (Ljava/io/File;)V
+ public final fun setRenderVersionsNavigationOnAllPages (Ljava/lang/Boolean;)V
public final fun setVersion (Ljava/lang/String;)V
public final fun setVersionsOrdering (Ljava/util/List;)V
public fun toString ()Ljava/lang/String;
@@ -80,30 +111,33 @@ public final class org/jetbrains/dokka/versioning/VersioningConfiguration : org/
public final class org/jetbrains/dokka/versioning/VersioningConfiguration$Companion {
public final fun getDefaultOlderVersions ()Ljava/util/List;
public final fun getDefaultOlderVersionsDir ()Ljava/io/File;
+ public final fun getDefaultRenderVersionsNavigationOnAllPages ()Z
public final fun getDefaultVersion ()Ljava/lang/Void;
public final fun getDefaultVersionsOrdering ()Ljava/util/List;
}
-public abstract interface class org/jetbrains/dokka/versioning/VersioningHandler : kotlin/jvm/functions/Function0 {
- public abstract fun currentVersion ()Ljava/io/File;
- public abstract fun getVersions ()Ljava/util/Map;
-}
-
public final class org/jetbrains/dokka/versioning/VersioningPlugin : org/jetbrains/dokka/plugability/DokkaPlugin {
public fun <init> ()V
public final fun getCssStyleInstaller ()Lorg/jetbrains/dokka/plugability/Extension;
- public final fun getDefaultVersioningHandler ()Lorg/jetbrains/dokka/plugability/Extension;
public final fun getDefaultVersioningNavigationCreator ()Lorg/jetbrains/dokka/plugability/Extension;
+ public final fun getDefaultVersioningStorage ()Lorg/jetbrains/dokka/plugability/Extension;
+ public final fun getNotFoundPageInstaller ()Lorg/jetbrains/dokka/plugability/Extension;
+ public final fun getPreviousDocumentationCopyPostAction ()Lorg/jetbrains/dokka/plugability/Extension;
public final fun getReplaceVersionCommandHandler ()Lorg/jetbrains/dokka/plugability/Extension;
public final fun getResolveLinkConsumer ()Lorg/jetbrains/dokka/plugability/Extension;
- public final fun getVersioningHandler ()Lorg/jetbrains/dokka/plugability/ExtensionPoint;
+ public final fun getVersioningStorage ()Lorg/jetbrains/dokka/plugability/ExtensionPoint;
public final fun getVersionsDefaultOrdering ()Lorg/jetbrains/dokka/plugability/Extension;
public final fun getVersionsNavigationCreator ()Lorg/jetbrains/dokka/plugability/ExtensionPoint;
public final fun getVersionsOrdering ()Lorg/jetbrains/dokka/plugability/ExtensionPoint;
}
+public abstract interface class org/jetbrains/dokka/versioning/VersioningStorage {
+ public abstract fun createVersionFile ()V
+ public abstract fun getCurrentVersion ()Lorg/jetbrains/dokka/versioning/CurrentVersion;
+ public abstract fun getPreviousVersions ()Ljava/util/Map;
+}
+
public abstract interface class org/jetbrains/dokka/versioning/VersionsNavigationCreator {
- public abstract fun invoke ()Ljava/lang/String;
public abstract fun invoke (Ljava/io/File;)Ljava/lang/String;
}