diff options
| author | Ignat Beresnev <ignat.beresnev@jetbrains.com> | 2023-11-10 11:46:54 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-11-10 11:46:54 +0100 |
| commit | 8e5c63d035ef44a269b8c43430f43f5c8eebfb63 (patch) | |
| tree | 1b915207b2b9f61951ddbf0ff2e687efd053d555 /plugins/javadoc | |
| parent | a44efd4ba0c2e4ab921ff75e0f53fc9335aa79db (diff) | |
| download | dokka-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 'plugins/javadoc')
74 files changed, 0 insertions, 39738 deletions
diff --git a/plugins/javadoc/README.md b/plugins/javadoc/README.md deleted file mode 100644 index aaa1f272..00000000 --- a/plugins/javadoc/README.md +++ /dev/null @@ -1,19 +0,0 @@ -# Javadoc plugin - -The Javadoc plugin adds a Javadoc output format that looks like Java's Javadoc HTML, but it's for the most part -a lookalike, so you may experience problems if you try to use it with a tool that expects native -Javadoc documentation generated by Java. - -The Javadoc plugin is shipped with the Dokka Gradle Plugin, so you can start using it right away with one of the following -tasks: - -* `dokkaJavadoc` - builds Javadoc documentation for single-project builds or for a specific module. -* `dokkaJavadocCollector` - collects generated Javadoc documentation from submodules and assembles it together. - -The Javadoc plugin has its own signature provider that essentially translates Kotlin signatures to Java ones. - -To use it with Maven or the CLI runner, you have to add it as a dependency. You can find it on -[Maven Central](https://mvnrepository.com/artifact/org.jetbrains.dokka/javadoc-plugin). - -**This plugin is at its early stages**, so you may experience issues and encounter bugs. Feel free to -[report](https://github.com/Kotlin/dokka/issues/new/choose) any errors you see. diff --git a/plugins/javadoc/api/javadoc.api b/plugins/javadoc/api/javadoc.api deleted file mode 100644 index a6b686d7..00000000 --- a/plugins/javadoc/api/javadoc.api +++ /dev/null @@ -1,694 +0,0 @@ -public final class org/jetbrains/dokka/javadoc/JavadocDocumentableToPageTranslator : org/jetbrains/dokka/transformers/documentation/DocumentableToPageTranslator { - public fun <init> (Lorg/jetbrains/dokka/plugability/DokkaContext;)V - public fun invoke (Lorg/jetbrains/dokka/model/DModule;)Lorg/jetbrains/dokka/pages/RootPageNode; -} - -public class org/jetbrains/dokka/javadoc/JavadocPageCreator { - public fun <init> (Lorg/jetbrains/dokka/plugability/DokkaContext;)V - public final fun nodeForJvm (Ljava/util/List;Lorg/jetbrains/dokka/DokkaConfiguration$DokkaSourceSet;)Lorg/jetbrains/dokka/pages/ContentNode; - public final fun pageForClasslike (Lorg/jetbrains/dokka/model/DClasslike;)Lorg/jetbrains/dokka/javadoc/pages/JavadocClasslikePageNode; - public final fun pageForModule (Lorg/jetbrains/dokka/model/DModule;)Lorg/jetbrains/dokka/javadoc/pages/JavadocModulePageNode; - public final fun pageForPackage (Lorg/jetbrains/dokka/model/DPackage;)Lorg/jetbrains/dokka/javadoc/pages/JavadocPackagePageNode; -} - -public final class org/jetbrains/dokka/javadoc/JavadocPlugin : org/jetbrains/dokka/plugability/DokkaPlugin { - public fun <init> ()V - public final fun getAllClassessPageInstaller ()Lorg/jetbrains/dokka/plugability/Extension; - public final fun getDeprecatedPageCreator ()Lorg/jetbrains/dokka/plugability/Extension; - public final fun getDocumentableSourceSetFilter ()Lorg/jetbrains/dokka/plugability/Extension; - public final fun getDokkaJavadocPlugin ()Lorg/jetbrains/dokka/plugability/Extension; - public final fun getIndexGenerator ()Lorg/jetbrains/dokka/plugability/Extension; - public final fun getJavadocLocationProviderFactory ()Lorg/jetbrains/dokka/plugability/Extension; - public final fun getJavadocMultiplatformCheck ()Lorg/jetbrains/dokka/plugability/Extension; - public final fun getJavadocPreprocessors ()Lorg/jetbrains/dokka/plugability/ExtensionPoint; - public final fun getJavadocSignatureProvider ()Lorg/jetbrains/dokka/plugability/Extension; - public final fun getLocationProviderFactory ()Lorg/jetbrains/dokka/plugability/ExtensionPoint; - public final fun getPackageListCreator ()Lorg/jetbrains/dokka/plugability/Extension; - public final fun getPageTranslator ()Lorg/jetbrains/dokka/plugability/Extension; - public final fun getResourcesInstaller ()Lorg/jetbrains/dokka/plugability/Extension; - public final fun getRootCreator ()Lorg/jetbrains/dokka/plugability/Extension; - public final fun getTreeViewInstaller ()Lorg/jetbrains/dokka/plugability/Extension; -} - -public final class org/jetbrains/dokka/javadoc/location/JavadocLocationProvider : org/jetbrains/dokka/base/resolvers/local/DefaultLocationProvider { - public fun <init> (Lorg/jetbrains/dokka/pages/RootPageNode;Lorg/jetbrains/dokka/plugability/DokkaContext;)V - public fun ancestors (Lorg/jetbrains/dokka/pages/PageNode;)Ljava/util/List; - public fun expectedLocationForDri (Lorg/jetbrains/dokka/links/DRI;)Ljava/lang/String; - public fun pathToRoot (Lorg/jetbrains/dokka/pages/PageNode;)Ljava/lang/String; - public final fun resolve (Lorg/jetbrains/dokka/javadoc/pages/LinkJavadocListEntry;Lorg/jetbrains/dokka/pages/PageNode;Z)Ljava/lang/String; - public fun resolve (Lorg/jetbrains/dokka/links/DRI;Ljava/util/Set;Lorg/jetbrains/dokka/pages/PageNode;)Ljava/lang/String; - public fun resolve (Lorg/jetbrains/dokka/pages/PageNode;Lorg/jetbrains/dokka/pages/PageNode;Z)Ljava/lang/String; - public static synthetic fun resolve$default (Lorg/jetbrains/dokka/javadoc/location/JavadocLocationProvider;Lorg/jetbrains/dokka/javadoc/pages/LinkJavadocListEntry;Lorg/jetbrains/dokka/pages/PageNode;ZILjava/lang/Object;)Ljava/lang/String; -} - -public final class org/jetbrains/dokka/javadoc/location/JavadocLocationProviderFactory : org/jetbrains/dokka/base/resolvers/local/LocationProviderFactory { - public fun <init> (Lorg/jetbrains/dokka/plugability/DokkaContext;)V - public fun getLocationProvider (Lorg/jetbrains/dokka/pages/RootPageNode;)Lorg/jetbrains/dokka/base/resolvers/local/LocationProvider; -} - -public final class org/jetbrains/dokka/javadoc/pages/AllClassesPage : org/jetbrains/dokka/javadoc/pages/JavadocPageNode { - public fun <init> (Ljava/util/List;)V - public fun getChildren ()Ljava/util/List; - public final fun getClassEntries ()Ljava/util/List; - public final fun getClasses ()Ljava/util/List; - public fun getContent ()Lorg/jetbrains/dokka/pages/ContentNode; - public fun getDocumentable ()Lorg/jetbrains/dokka/model/Documentable; - public fun getDocumentables ()Ljava/util/List; - public fun getDri ()Ljava/util/Set; - public fun getEmbeddedResources ()Ljava/util/List; - public fun getName ()Ljava/lang/String; - public fun modified (Ljava/lang/String;Ljava/util/List;)Lorg/jetbrains/dokka/pages/PageNode; - public fun modified (Ljava/lang/String;Lorg/jetbrains/dokka/pages/ContentNode;Ljava/util/Set;Ljava/util/List;Ljava/util/List;)Lorg/jetbrains/dokka/pages/ContentPage; -} - -public final class org/jetbrains/dokka/javadoc/pages/AllClassesPageInstaller : org/jetbrains/dokka/transformers/pages/PageTransformer { - public static final field INSTANCE Lorg/jetbrains/dokka/javadoc/pages/AllClassesPageInstaller; - public fun invoke (Lorg/jetbrains/dokka/pages/RootPageNode;)Lorg/jetbrains/dokka/pages/RootPageNode; -} - -public abstract class org/jetbrains/dokka/javadoc/pages/AnchorableJavadocNode : org/jetbrains/dokka/javadoc/pages/NavigableJavadocNode { - public synthetic fun <init> (Ljava/lang/String;Lorg/jetbrains/dokka/links/DRI;Lkotlin/jvm/internal/DefaultConstructorMarker;)V - public fun getDRI ()Lorg/jetbrains/dokka/links/DRI; - public fun getDri ()Lorg/jetbrains/dokka/links/DRI; - public fun getId ()Ljava/lang/String; - public fun getName ()Ljava/lang/String; -} - -public final class org/jetbrains/dokka/javadoc/pages/DeprecatedNode { - public fun <init> (Ljava/lang/String;Lorg/jetbrains/dokka/links/DRI;Ljava/util/List;)V - public fun equals (Ljava/lang/Object;)Z - public final fun getAddress ()Lorg/jetbrains/dokka/links/DRI; - public final fun getDescription ()Ljava/util/List; - public final fun getName ()Ljava/lang/String; - public fun hashCode ()I -} - -public final class org/jetbrains/dokka/javadoc/pages/DeprecatedPage : org/jetbrains/dokka/javadoc/pages/JavadocPageNode { - public fun <init> (Ljava/util/Map;Ljava/util/Set;)V - public fun getChildren ()Ljava/util/List; - public fun getContent ()Lorg/jetbrains/dokka/pages/ContentNode; - public fun getDocumentable ()Lorg/jetbrains/dokka/model/Documentable; - public fun getDocumentables ()Ljava/util/List; - public fun getDri ()Ljava/util/Set; - public final fun getElements ()Ljava/util/Map; - public fun getEmbeddedResources ()Ljava/util/List; - public fun getName ()Ljava/lang/String; - public fun modified (Ljava/lang/String;Ljava/util/List;)Lorg/jetbrains/dokka/pages/PageNode; - public fun modified (Ljava/lang/String;Lorg/jetbrains/dokka/pages/ContentNode;Ljava/util/Set;Ljava/util/List;Ljava/util/List;)Lorg/jetbrains/dokka/pages/ContentPage; -} - -public final class org/jetbrains/dokka/javadoc/pages/DeprecatedPageCreator : org/jetbrains/dokka/transformers/pages/PageTransformer { - public static final field INSTANCE Lorg/jetbrains/dokka/javadoc/pages/DeprecatedPageCreator; - public fun invoke (Lorg/jetbrains/dokka/pages/RootPageNode;)Lorg/jetbrains/dokka/pages/RootPageNode; -} - -public final class org/jetbrains/dokka/javadoc/pages/DeprecatedPageSection : java/lang/Enum { - public static final field DeprecatedClasses Lorg/jetbrains/dokka/javadoc/pages/DeprecatedPageSection; - public static final field DeprecatedConstructors Lorg/jetbrains/dokka/javadoc/pages/DeprecatedPageSection; - public static final field DeprecatedEnumConstants Lorg/jetbrains/dokka/javadoc/pages/DeprecatedPageSection; - public static final field DeprecatedEnums Lorg/jetbrains/dokka/javadoc/pages/DeprecatedPageSection; - public static final field DeprecatedExceptions Lorg/jetbrains/dokka/javadoc/pages/DeprecatedPageSection; - public static final field DeprecatedFields Lorg/jetbrains/dokka/javadoc/pages/DeprecatedPageSection; - public static final field DeprecatedForRemoval Lorg/jetbrains/dokka/javadoc/pages/DeprecatedPageSection; - public static final field DeprecatedInterfaces Lorg/jetbrains/dokka/javadoc/pages/DeprecatedPageSection; - public static final field DeprecatedMethods Lorg/jetbrains/dokka/javadoc/pages/DeprecatedPageSection; - public static final field DeprecatedModules Lorg/jetbrains/dokka/javadoc/pages/DeprecatedPageSection; - public final fun getCaption ()Ljava/lang/String; - public final fun getHeader ()Ljava/lang/String; - public final fun getId ()Ljava/lang/String; - public static fun valueOf (Ljava/lang/String;)Lorg/jetbrains/dokka/javadoc/pages/DeprecatedPageSection; - public static fun values ()[Lorg/jetbrains/dokka/javadoc/pages/DeprecatedPageSection; -} - -public final class org/jetbrains/dokka/javadoc/pages/EmptyNode : org/jetbrains/dokka/pages/ContentNode { - public fun <init> (Lorg/jetbrains/dokka/links/DRI;Lorg/jetbrains/dokka/pages/Kind;Ljava/util/Set;Lorg/jetbrains/dokka/model/properties/PropertyContainer;)V - public synthetic fun <init> (Lorg/jetbrains/dokka/links/DRI;Lorg/jetbrains/dokka/pages/Kind;Ljava/util/Set;Lorg/jetbrains/dokka/model/properties/PropertyContainer;ILkotlin/jvm/internal/DefaultConstructorMarker;)V - public final fun component1 ()Lorg/jetbrains/dokka/links/DRI; - public final fun component2 ()Lorg/jetbrains/dokka/pages/Kind; - public final fun component3 ()Ljava/util/Set; - public final fun component4 ()Lorg/jetbrains/dokka/model/properties/PropertyContainer; - public final fun copy (Lorg/jetbrains/dokka/links/DRI;Lorg/jetbrains/dokka/pages/Kind;Ljava/util/Set;Lorg/jetbrains/dokka/model/properties/PropertyContainer;)Lorg/jetbrains/dokka/javadoc/pages/EmptyNode; - public static synthetic fun copy$default (Lorg/jetbrains/dokka/javadoc/pages/EmptyNode;Lorg/jetbrains/dokka/links/DRI;Lorg/jetbrains/dokka/pages/Kind;Ljava/util/Set;Lorg/jetbrains/dokka/model/properties/PropertyContainer;ILjava/lang/Object;)Lorg/jetbrains/dokka/javadoc/pages/EmptyNode; - public fun equals (Ljava/lang/Object;)Z - public fun getChildren ()Ljava/util/List; - public fun getDci ()Lorg/jetbrains/dokka/pages/DCI; - public final fun getDri ()Lorg/jetbrains/dokka/links/DRI; - public fun getExtra ()Lorg/jetbrains/dokka/model/properties/PropertyContainer; - public final fun getKind ()Lorg/jetbrains/dokka/pages/Kind; - public fun getSourceSets ()Ljava/util/Set; - public fun getStyle ()Ljava/util/Set; - public fun hasAnyContent ()Z - public fun hashCode ()I - public fun toString ()Ljava/lang/String; - public synthetic fun withNewExtras (Lorg/jetbrains/dokka/model/properties/PropertyContainer;)Ljava/lang/Object; - public fun withNewExtras (Lorg/jetbrains/dokka/model/properties/PropertyContainer;)Lorg/jetbrains/dokka/javadoc/pages/EmptyNode; - public fun withSourceSets (Ljava/util/Set;)Lorg/jetbrains/dokka/javadoc/pages/EmptyNode; - public synthetic fun withSourceSets (Ljava/util/Set;)Lorg/jetbrains/dokka/pages/ContentNode; -} - -public final class org/jetbrains/dokka/javadoc/pages/IndexGenerator : org/jetbrains/dokka/transformers/pages/PageTransformer { - public static final field INSTANCE Lorg/jetbrains/dokka/javadoc/pages/IndexGenerator; - public fun invoke (Lorg/jetbrains/dokka/pages/RootPageNode;)Lorg/jetbrains/dokka/pages/RootPageNode; -} - -public final class org/jetbrains/dokka/javadoc/pages/IndexPage : org/jetbrains/dokka/javadoc/pages/JavadocPageNode { - public fun <init> (ILjava/util/List;Ljava/util/List;Ljava/util/Set;)V - public fun getChildren ()Ljava/util/List; - public fun getContent ()Lorg/jetbrains/dokka/pages/ContentNode; - public fun getDocumentable ()Lorg/jetbrains/dokka/model/Documentable; - public fun getDocumentables ()Ljava/util/List; - public fun getDri ()Ljava/util/Set; - public final fun getElements ()Ljava/util/List; - public fun getEmbeddedResources ()Ljava/util/List; - public final fun getId ()I - public final fun getKeys ()Ljava/util/List; - public fun getName ()Ljava/lang/String; - public final fun getTitle ()Ljava/lang/String; - public fun modified (Ljava/lang/String;Ljava/util/List;)Lorg/jetbrains/dokka/pages/PageNode; - public fun modified (Ljava/lang/String;Lorg/jetbrains/dokka/pages/ContentNode;Ljava/util/Set;Ljava/util/List;Ljava/util/List;)Lorg/jetbrains/dokka/pages/ContentPage; -} - -public final class org/jetbrains/dokka/javadoc/pages/JavaContentGroupBuilder { - public fun <init> (Ljava/util/Set;)V - public final fun getList ()Ljava/util/List; - public final fun getSourceSets ()Ljava/util/Set; -} - -public final class org/jetbrains/dokka/javadoc/pages/JavadocClasslikePageNode : org/jetbrains/dokka/javadoc/pages/JavadocPageNode, org/jetbrains/dokka/javadoc/pages/NavigableJavadocNode, org/jetbrains/dokka/javadoc/pages/WithBrief, org/jetbrains/dokka/javadoc/pages/WithJavadocExtra, org/jetbrains/dokka/javadoc/pages/WithNavigable, org/jetbrains/dokka/pages/ClasslikePage { - public fun <init> (Ljava/lang/String;Lorg/jetbrains/dokka/javadoc/pages/JavadocContentNode;Ljava/util/Set;Lorg/jetbrains/dokka/javadoc/pages/JavadocSignatureContentNode;Ljava/util/List;Ljava/util/List;Ljava/util/List;Ljava/util/List;Ljava/util/List;Ljava/util/List;Ljava/util/List;Ljava/util/List;Ljava/util/List;Ljava/util/List;Ljava/util/List;Ljava/util/List;Lorg/jetbrains/dokka/model/properties/PropertyContainer;)V - public synthetic fun <init> (Ljava/lang/String;Lorg/jetbrains/dokka/javadoc/pages/JavadocContentNode;Ljava/util/Set;Lorg/jetbrains/dokka/javadoc/pages/JavadocSignatureContentNode;Ljava/util/List;Ljava/util/List;Ljava/util/List;Ljava/util/List;Ljava/util/List;Ljava/util/List;Ljava/util/List;Ljava/util/List;Ljava/util/List;Ljava/util/List;Ljava/util/List;Ljava/util/List;Lorg/jetbrains/dokka/model/properties/PropertyContainer;ILkotlin/jvm/internal/DefaultConstructorMarker;)V - public fun getAllNavigables ()Ljava/util/List; - public final fun getAnchorables ()Ljava/util/List; - public final fun getAuthorTagContent ()Ljava/util/List; - public fun getBrief ()Ljava/util/List; - public fun getChildren ()Ljava/util/List; - public final fun getClasslikes ()Ljava/util/List; - public final fun getConstructors ()Ljava/util/List; - public fun getContent ()Lorg/jetbrains/dokka/javadoc/pages/JavadocContentNode; - public synthetic fun getContent ()Lorg/jetbrains/dokka/pages/ContentNode; - public fun getDRI ()Lorg/jetbrains/dokka/links/DRI; - public final fun getDescription ()Ljava/util/List; - public fun getDocumentable ()Lorg/jetbrains/d |
