diff options
| author | Marcin Aman <maman@virtuslab.com> | 2020-09-03 13:39:58 +0200 |
|---|---|---|
| committer | Paweł Marks <Kordyjan@users.noreply.github.com> | 2020-09-04 08:55:02 +0200 |
| commit | cc3d4872f70cfebaf5d85c72af0030f526671915 (patch) | |
| tree | b8f75efddd4cb631b930b0d24efdbdcc4159ee73 /plugins/javadoc/src/main/kotlin/org | |
| parent | 4d8e84396824b8a3d5d6e3e26ea4911fa944e3aa (diff) | |
| download | dokka-cc3d4872f70cfebaf5d85c72af0030f526671915.tar.gz dokka-cc3d4872f70cfebaf5d85c72af0030f526671915.tar.bz2 dokka-cc3d4872f70cfebaf5d85c72af0030f526671915.zip | |
Javadoc version number is always 0.0.1 #1406
Diffstat (limited to 'plugins/javadoc/src/main/kotlin/org')
6 files changed, 14 insertions, 28 deletions
diff --git a/plugins/javadoc/src/main/kotlin/org/jetbrains/dokka/javadoc/JavadocDocumentableToPageTranslator.kt b/plugins/javadoc/src/main/kotlin/org/jetbrains/dokka/javadoc/JavadocDocumentableToPageTranslator.kt index f8723f33..8cfd4911 100644 --- a/plugins/javadoc/src/main/kotlin/org/jetbrains/dokka/javadoc/JavadocDocumentableToPageTranslator.kt +++ b/plugins/javadoc/src/main/kotlin/org/jetbrains/dokka/javadoc/JavadocDocumentableToPageTranslator.kt @@ -5,14 +5,15 @@ import org.jetbrains.dokka.base.transformers.pages.comments.CommentsToContentCon import org.jetbrains.dokka.model.DModule import org.jetbrains.dokka.pages.ModulePageNode import org.jetbrains.dokka.pages.RootPageNode +import org.jetbrains.dokka.plugability.DokkaContext import org.jetbrains.dokka.transformers.documentation.DocumentableToPageTranslator import org.jetbrains.dokka.utilities.DokkaLogger class JavadocDocumentableToPageTranslator( - private val commentsToContentConverter: CommentsToContentConverter, + private val context: DokkaContext, private val signatureProvider: SignatureProvider, private val logger: DokkaLogger ) : DocumentableToPageTranslator { override fun invoke(module: DModule): RootPageNode = - JavadocPageCreator(commentsToContentConverter, signatureProvider, logger).pageForModule(module) + JavadocPageCreator(context, signatureProvider, logger).pageForModule(module) }
\ No newline at end of file diff --git a/plugins/javadoc/src/main/kotlin/org/jetbrains/dokka/javadoc/JavadocPageCreator.kt b/plugins/javadoc/src/main/kotlin/org/jetbrains/dokka/javadoc/JavadocPageCreator.kt index 0379a752..45d8c61f 100644 --- a/plugins/javadoc/src/main/kotlin/org/jetbrains/dokka/javadoc/JavadocPageCreator.kt +++ b/plugins/javadoc/src/main/kotlin/org/jetbrains/dokka/javadoc/JavadocPageCreator.kt @@ -15,14 +15,16 @@ import org.jetbrains.dokka.model.doc.TagWrapper import org.jetbrains.dokka.model.properties.PropertyContainer import org.jetbrains.dokka.model.properties.WithExtraProperties import org.jetbrains.dokka.pages.* +import org.jetbrains.dokka.plugability.DokkaContext import org.jetbrains.dokka.utilities.DokkaLogger import kotlin.reflect.KClass open class JavadocPageCreator( - commentsToContentConverter: CommentsToContentConverter, + context: DokkaContext, private val signatureProvider: SignatureProvider, val logger: DokkaLogger ) { + private val documentationVersion = context.configuration.moduleVersion fun pageForModule(m: DModule): JavadocModulePageNode = JavadocModulePageNode( @@ -80,7 +82,7 @@ open class JavadocPageCreator( JavadocContentKind.OverviewSummary, m.jvmSourceSets.toDisplaySourceSets() ) { - title(m.name, m.brief(), "0.0.1", dri = setOf(m.dri), kind = ContentKind.Main) + title(m.name, m.brief(), documentationVersion, dri = setOf(m.dri), kind = ContentKind.Main) leafList(setOf(m.dri), ContentKind.Packages, JavadocList( "Packages", "Package", @@ -99,7 +101,7 @@ open class JavadocPageCreator( JavadocContentKind.PackageSummary, p.jvmSourceSets.toDisplaySourceSets() ) { - title(p.name, p.brief(), "0.0.1", dri = setOf(p.dri), kind = ContentKind.Packages) + title("Package ${p.name}", p.brief(), dri = setOf(p.dri), kind = ContentKind.Packages) val rootList = p.classlikes.groupBy { it::class }.map { (key, value) -> JavadocList(key.tabTitle, key.colTitle, value.map { c -> RowJavadocListEntry( @@ -133,7 +135,7 @@ open class JavadocPageCreator( title( c.name.orEmpty(), c.brief(), - "0.0.1", + documentationVersion, parent = c.dri.packageName, dri = setOf(c.dri), kind = JavadocContentKind.Class diff --git a/plugins/javadoc/src/main/kotlin/org/jetbrains/dokka/javadoc/JavadocPlugin.kt b/plugins/javadoc/src/main/kotlin/org/jetbrains/dokka/javadoc/JavadocPlugin.kt index e86816a3..50eb319d 100644 --- a/plugins/javadoc/src/main/kotlin/org/jetbrains/dokka/javadoc/JavadocPlugin.kt +++ b/plugins/javadoc/src/main/kotlin/org/jetbrains/dokka/javadoc/JavadocPlugin.kt @@ -30,7 +30,7 @@ class JavadocPlugin : DokkaPlugin() { val pageTranslator by extending { CoreExtensions.documentableToPageTranslator providing { context -> JavadocDocumentableToPageTranslator( - dokkaBasePlugin.querySingle { commentsToContentConverter }, + context, dokkaBasePlugin.querySingle { signatureProvider }, context.logger ) diff --git a/plugins/javadoc/src/main/kotlin/org/jetbrains/dokka/javadoc/pages/JavadocContentNodes.kt b/plugins/javadoc/src/main/kotlin/org/jetbrains/dokka/javadoc/pages/JavadocContentNodes.kt index 2b6ebb1c..6115cbff 100644 --- a/plugins/javadoc/src/main/kotlin/org/jetbrains/dokka/javadoc/pages/JavadocContentNodes.kt +++ b/plugins/javadoc/src/main/kotlin/org/jetbrains/dokka/javadoc/pages/JavadocContentNodes.kt @@ -79,13 +79,13 @@ class JavaContentGroupBuilder(val sourceSets: Set<DisplaySourceSet>) { data class TitleNode( val title: String, val subtitle: List<ContentNode>, - val version: String, + val version: String?, val parent: String?, val dri: Set<DRI>, val kind: Kind, override val sourceSets: Set<DisplaySourceSet> ) : JavadocContentNode(dri, kind, sourceSets) { - override fun hasAnyContent(): Boolean = !title.isBlank() || !version.isBlank() || subtitle.isNotEmpty() + override fun hasAnyContent(): Boolean = !title.isBlank() || !version.isNullOrBlank() || subtitle.isNotEmpty() override fun withNewExtras(newExtras: PropertyContainer<ContentNode>): TitleNode = this @@ -96,7 +96,7 @@ data class TitleNode( fun JavaContentGroupBuilder.title( title: String, subtitle: List<ContentNode>, - version: String, + version: String? = null, parent: String? = null, dri: Set<DRI>, kind: Kind diff --git a/plugins/javadoc/src/main/kotlin/org/jetbrains/dokka/javadoc/pages/pages.kt b/plugins/javadoc/src/main/kotlin/org/jetbrains/dokka/javadoc/pages/pages.kt deleted file mode 100644 index 14aa1903..00000000 --- a/plugins/javadoc/src/main/kotlin/org/jetbrains/dokka/javadoc/pages/pages.kt +++ /dev/null @@ -1,17 +0,0 @@ -package org.jetbrains.dokka.javadoc.pages - -internal const val jQueryVersion = "3.3.1" -internal const val jQueryMigrateVersion = "3.0.1" - -//class PackageSummary(val page: PageNode) : RendererSpecificPage { -// override val name = "package-summary" -// override val children = emptyList<PageNode>() -// override fun modified(name: String, children: List<PageNode>) = this -// -// override val strategy = RenderingStrategy.Write(content()) -// -// private fun content(): String = pageStart(page.name, "0.0.1", page.name, "../") + // TODO -// topNavbar(page, "???") -// -//} - diff --git a/plugins/javadoc/src/main/kotlin/org/jetbrains/dokka/javadoc/renderer/JavadocContentToTemplateMapTranslator.kt b/plugins/javadoc/src/main/kotlin/org/jetbrains/dokka/javadoc/renderer/JavadocContentToTemplateMapTranslator.kt index 46cad6f5..f7305152 100644 --- a/plugins/javadoc/src/main/kotlin/org/jetbrains/dokka/javadoc/renderer/JavadocContentToTemplateMapTranslator.kt +++ b/plugins/javadoc/src/main/kotlin/org/jetbrains/dokka/javadoc/renderer/JavadocContentToTemplateMapTranslator.kt @@ -22,7 +22,7 @@ internal class JavadocContentToTemplateMapTranslator( ) { fun templateMapForPageNode(node: JavadocPageNode): TemplateMap = - mapOf<String, Any?>( + mapOf( "docName" to "docName", // todo docname "pathToRoot" to pathToRoot(node), "contextRoot" to node, |