Package org.jetbrains.dokka.javadoc.pages

Types

AllClassesPage

class AllClassesPage(classes: List<JavadocClasslikePageNode>) : JavadocPageNode

AllClassesPageInstaller

object AllClassesPageInstaller : PageTransformer

AnchorableJavadocNode

sealed class AnchorableJavadocNode : NavigableJavadocNode

DeprecatedNode

class DeprecatedNode(name: String, address: DRI, description: List<ContentNode>)

DeprecatedPage

class DeprecatedPage(elements: Map<DeprecatedPageSection, Set<DeprecatedNode>>, sourceSet: Set<DisplaySourceSet>) : JavadocPageNode

DeprecatedPageCreator

object DeprecatedPageCreator : PageTransformer

DeprecatedPageSection

enum DeprecatedPageSection : Enum<DeprecatedPageSection>

EmptyNode

data class EmptyNode(dri: DRI, kind: Kind, sourceSets: Set<DisplaySourceSet>, extra: PropertyContainer<ContentNode>) : ContentNode

IndexGenerator

object IndexGenerator : PageTransformer

IndexPage

class IndexPage(id: Int, elements: List<NavigableJavadocNode>, keys: List<Char>, sourceSet: Set<DisplaySourceSet>) : JavadocPageNode

JavaContentGroupBuilder

class JavaContentGroupBuilder(sourceSets: Set<DisplaySourceSet>)

JavadocClasslikePageNode

class JavadocClasslikePageNode(name: String, content: JavadocContentNode, dri: Set<DRI>, signature: JavadocSignatureContentNode, description: List<ContentNode>, constructors: List<JavadocFunctionNode>, methods: List<JavadocFunctionNode>, entries: List<JavadocEntryNode>, classlikes: List<JavadocClasslikePageNode>, properties: List<JavadocPropertyNode>, brief: List<ContentNode>, documentable: Documentable?, children: List<PageNode>, embeddedResources: List<String>, extra: PropertyContainer<DClasslike>) : JavadocPageNode, WithJavadocExtra<DClasslike> , NavigableJavadocNode, WithNavigable, WithBrief, ClasslikePage

JavadocContentGroup

data class JavadocContentGroup(dri: Set<DRI>, kind: Kind, sourceSets: Set<DisplaySourceSet>, children: List<JavadocContentNode>) : JavadocContentNode

JavadocContentKind

enum JavadocContentKind : Enum<JavadocContentKind> , Kind

JavadocContentNode

abstract class JavadocContentNode(dri: Set<DRI>, kind: Kind, sourceSets: Set<DisplaySourceSet>) : ContentNode

JavadocEntryNode

data class JavadocEntryNode(dri: DRI, name: String, signature: JavadocSignatureContentNode, brief: List<ContentNode>, extra: PropertyContainer<DEnumEntry>) : AnchorableJavadocNode, WithJavadocExtra<DEnumEntry> , WithBrief

JavadocFunctionNode

data class JavadocFunctionNode(signature: JavadocSignatureContentNode, brief: List<ContentNode>, description: List<ContentNode>, parameters: List<JavadocParameterNode>, name: String, dri: DRI, extra: PropertyContainer<DFunction>) : AnchorableJavadocNode, WithJavadocExtra<DFunction> , WithBrief

JavadocIndexExtra

data class JavadocIndexExtra(index: List<ContentNode>) : ExtraProperty<Documentable>

JavadocList

interface JavadocList

JavadocListEntry

interface JavadocListEntry

JavadocModulePageNode

class JavadocModulePageNode(name: String, content: JavadocContentNode, children: List<PageNode>, dri: Set<DRI>, extra: PropertyContainer<DModule>) : RootPageNode, WithJavadocExtra<DModule> , NavigableJavadocNode, JavadocPageNode, ModulePage

JavadocPackagePageNode

class JavadocPackagePageNode(name: String, content: JavadocContentNode, dri: Set<DRI>, documentable: Documentable?, children: List<PageNode>, embeddedResources: List<String>) : JavadocPageNode, WithNavigable, NavigableJavadocNode, PackagePage

JavadocPageNode

interface JavadocPageNode : ContentPage

JavadocParameterNode

data class JavadocParameterNode(dri: DRI, name: String, type: ContentNode, description: List<ContentNode>, typeBound: Bound, extra: PropertyContainer<DParameter>) : AnchorableJavadocNode, WithJavadocExtra<DParameter>

JavadocPropertyNode

data class JavadocPropertyNode(dri: DRI, name: String, signature: JavadocSignatureContentNode, brief: List<ContentNode>, extra: PropertyContainer<DProperty>) : AnchorableJavadocNode, WithJavadocExtra<DProperty> , WithBrief

JavadocSignatureContentNode

data class JavadocSignatureContentNode(dri: DRI, kind: Kind, annotations: ContentNode?, modifiers: ContentNode?, signatureWithoutModifiers: ContentNode, supertypes: ContentNode?) : JavadocContentNode

LeafListNode

data class LeafListNode(tabTitle: String, colTitle: String, entries: List<JavadocListEntry>, dri: Set<DRI>, kind: Kind, sourceSets: Set<DisplaySourceSet>) : JavadocContentNode

LinkJavadocListEntry

class LinkJavadocListEntry(name: String, dri: Set<DRI>, kind: Kind, sourceSets: Set<DisplaySourceSet>) : JavadocListEntry

NavigableJavadocNode

interface NavigableJavadocNode

ResourcesInstaller

object ResourcesInstaller : PageTransformer

RootListNode

data class RootListNode(entries: List<LeafListNode>, dri: Set<DRI>, kind: Kind, sourceSets: Set<DisplaySourceSet>) : JavadocContentNode

RowJavadocListEntry

data class RowJavadocListEntry(link: LinkJavadocListEntry, doc: List<ContentNode>) : JavadocListEntry

TitleNode

data class TitleNode(title: String, subtitle: List<ContentNode>, version: String?, parent: String?, dri: Set<DRI>, kind: Kind, sourceSets: Set<DisplaySourceSet>) : JavadocContentNode

TreeViewInstaller

object TreeViewInstaller : PageTransformer

TreeViewPage

class TreeViewPage(name: String, packages: List<JavadocPackagePageNode>?, classes: List<JavadocClasslikePageNode>?, dri: Set<DRI>, documentable: Documentable?, root: PageNode) : JavadocPageNode

WithBrief

interface WithBrief

WithJavadocExtra

interface WithJavadocExtra<T : Documentable> : WithExtraProperties<T>

WithNavigable

interface WithNavigable

Functions

JavadocList

fun JavadocList(tabTitle: String, colTitle: String, children: List<JavadocListEntry>): JavadocList

leafList

fun JavaContentGroupBuilder.leafList(dri: Set<DRI>, kind: Kind, leafList: JavadocList)

rootList

fun JavaContentGroupBuilder.rootList(dri: Set<DRI>, kind: Kind, rootList: List<JavadocList>)

title

fun JavaContentGroupBuilder.title(title: String, subtitle: List<ContentNode>, version: String? = null, parent: String? = null, dri: Set<DRI>, kind: Kind)