Skip to content

Commit

Permalink
Relocate DGPv2 'dokka' package (#3779)
Browse files Browse the repository at this point in the history
* KT-70811 Relocate DGPv2 'dokka' package

Relocate the `org.jetbrains.dokka.gradle.dokka` package to avoid 'dokka' appearing twice in the package name.

- `org.jetbrains.dokka.gradle.engine` contains code for interoping with the Dokka Engine
- `DokkaPublication` was moved to `org.jetbrains.dokka.gradle.formats`, since it controls the publication of a format.
  • Loading branch information
adam-enko authored Sep 10, 2024
1 parent f5bcad8 commit e3dc412
Show file tree
Hide file tree
Showing 41 changed files with 271 additions and 273 deletions.
182 changes: 91 additions & 91 deletions dokka-runners/dokka-gradle-plugin/api/dokka-gradle-plugin.api

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,9 @@ import org.jetbrains.dokka.gradle.dependencies.BaseDependencyManager
import org.jetbrains.dokka.gradle.dependencies.DokkaAttribute.Companion.DokkaClasspathAttribute
import org.jetbrains.dokka.gradle.dependencies.DokkaAttribute.Companion.DokkaFormatAttribute
import org.jetbrains.dokka.gradle.dependencies.DokkaAttribute.Companion.DokkaModuleComponentAttribute
import org.jetbrains.dokka.gradle.dokka.parameters.DokkaSourceSetSpec
import org.jetbrains.dokka.gradle.dokka.parameters.KotlinPlatform
import org.jetbrains.dokka.gradle.dokka.parameters.VisibilityModifier
import org.jetbrains.dokka.gradle.engine.parameters.DokkaSourceSetSpec
import org.jetbrains.dokka.gradle.engine.parameters.KotlinPlatform
import org.jetbrains.dokka.gradle.engine.parameters.VisibilityModifier
import org.jetbrains.dokka.gradle.internal.*
import org.jetbrains.dokka.gradle.tasks.DokkaBaseTask
import org.jetbrains.dokka.gradle.tasks.DokkaGenerateModuleTask
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ import org.gradle.api.tasks.Nested
import org.gradle.kotlin.dsl.newInstance
import org.gradle.workers.WorkerExecutor
import org.jetbrains.dokka.gradle.dependencies.BaseDependencyManager
import org.jetbrains.dokka.gradle.dokka.DokkaPublication
import org.jetbrains.dokka.gradle.dokka.parameters.DokkaSourceSetSpec
import org.jetbrains.dokka.gradle.formats.DokkaPublication
import org.jetbrains.dokka.gradle.engine.parameters.DokkaSourceSetSpec
import org.jetbrains.dokka.gradle.internal.*
import org.jetbrains.dokka.gradle.workers.ClassLoaderIsolation
import org.jetbrains.dokka.gradle.workers.ProcessIsolation
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ import org.gradle.kotlin.dsl.getByType
import org.gradle.kotlin.dsl.withType
import org.jetbrains.dokka.gradle.DokkaBasePlugin
import org.jetbrains.dokka.gradle.DokkaExtension
import org.jetbrains.dokka.gradle.dokka.parameters.KotlinPlatform
import org.jetbrains.dokka.gradle.engine.parameters.KotlinPlatform
import org.jetbrains.dokka.gradle.internal.DokkaInternalApi
import org.jetbrains.dokka.gradle.internal.PluginId
import org.jetbrains.dokka.gradle.internal.artifactType
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ import org.gradle.api.tasks.SourceSetContainer
import org.gradle.kotlin.dsl.getByType
import org.gradle.kotlin.dsl.withType
import org.jetbrains.dokka.gradle.DokkaExtension
import org.jetbrains.dokka.gradle.dokka.parameters.DokkaSourceSetSpec
import org.jetbrains.dokka.gradle.dokka.parameters.KotlinPlatform
import org.jetbrains.dokka.gradle.engine.parameters.DokkaSourceSetSpec
import org.jetbrains.dokka.gradle.engine.parameters.KotlinPlatform
import org.jetbrains.dokka.gradle.internal.DokkaInternalApi
import org.jetbrains.dokka.gradle.internal.PluginId
import org.jetbrains.dokka.gradle.internal.or
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,10 @@ import org.gradle.kotlin.dsl.*
import org.jetbrains.dokka.gradle.DokkaBasePlugin
import org.jetbrains.dokka.gradle.DokkaExtension
import org.jetbrains.dokka.gradle.adapters.KotlinAdapter.Companion.currentKotlinToolingVersion
import org.jetbrains.dokka.gradle.dokka.parameters.SourceSetIdSpec
import org.jetbrains.dokka.gradle.dokka.parameters.SourceSetIdSpec.Companion.dokkaSourceSetIdSpec
import org.jetbrains.dokka.gradle.dokka.parameters.DokkaSourceSetSpec
import org.jetbrains.dokka.gradle.dokka.parameters.KotlinPlatform
import org.jetbrains.dokka.gradle.engine.parameters.SourceSetIdSpec
import org.jetbrains.dokka.gradle.engine.parameters.SourceSetIdSpec.Companion.dokkaSourceSetIdSpec
import org.jetbrains.dokka.gradle.engine.parameters.DokkaSourceSetSpec
import org.jetbrains.dokka.gradle.engine.parameters.KotlinPlatform
import org.jetbrains.dokka.gradle.internal.*
import org.jetbrains.kotlin.commonizer.KonanDistribution
import org.jetbrains.kotlin.commonizer.platformLibsDir
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -200,7 +200,7 @@ class FormatDependenciesManager(
* - module output directory
* - module includes directory
*
* @see org.jetbrains.dokka.gradle.dokka.parameters.DokkaModuleDescriptionKxs
* @see org.jetbrains.dokka.gradle.engine.parameters.DokkaModuleDescriptionKxs
* @see org.jetbrains.dokka.DokkaConfiguration.DokkaModuleDescription.sourceOutputDirectory
*/
val moduleOutputDirectories: ModuleComponentDependencies =
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/*
* Copyright 2014-2024 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
*/
package org.jetbrains.dokka.gradle.dokka.parameters
package org.jetbrains.dokka.gradle.engine.parameters

import org.gradle.api.Named
import org.gradle.api.provider.Property
Expand Down Expand Up @@ -111,9 +111,9 @@ constructor(
*
* Defaults to `true`.
*
* @see org.jetbrains.dokka.gradle.dokka.parameters.DokkaSourceSetSpec.enableKotlinStdLibDocumentationLink
* @see org.jetbrains.dokka.gradle.dokka.parameters.DokkaSourceSetSpec.enableJdkDocumentationLink
* @see org.jetbrains.dokka.gradle.dokka.parameters.DokkaSourceSetSpec.enableAndroidDocumentationLink
* @see org.jetbrains.dokka.gradle.engine.parameters.DokkaSourceSetSpec.enableKotlinStdLibDocumentationLink
* @see org.jetbrains.dokka.gradle.engine.parameters.DokkaSourceSetSpec.enableJdkDocumentationLink
* @see org.jetbrains.dokka.gradle.engine.parameters.DokkaSourceSetSpec.enableAndroidDocumentationLink
*/
@get:Input
abstract val enabled: Property<Boolean>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/*
* Copyright 2014-2024 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
*/
package org.jetbrains.dokka.gradle.dokka.parameters
package org.jetbrains.dokka.gradle.engine.parameters

import org.gradle.api.NamedDomainObjectContainer
import org.gradle.api.file.ConfigurableFileCollection
Expand All @@ -27,7 +27,7 @@ constructor(
objects: ObjectFactory,
/**
* Configurations for Dokka Generator Plugins. Must be provided from
* [org.jetbrains.dokka.gradle.dokka.DokkaPublication.pluginsConfiguration].
* [org.jetbrains.dokka.gradle.formats.DokkaPublication.pluginsConfiguration].
*/
@get:Nested
val pluginsConfiguration: DokkaPluginParametersContainer,
Expand Down Expand Up @@ -69,7 +69,7 @@ constructor(
/**
* Classpath that contains the Dokka Generator Plugins used to modify this publication.
*
* The plugins should be configured in [org.jetbrains.dokka.gradle.dokka.DokkaPublication.pluginsConfiguration].
* The plugins should be configured in [org.jetbrains.dokka.gradle.formats.DokkaPublication.pluginsConfiguration].
*/
@get:InputFiles
@get:Classpath
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/*
* Copyright 2014-2024 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
*/
package org.jetbrains.dokka.gradle.dokka.parameters
package org.jetbrains.dokka.gradle.engine.parameters

import kotlinx.serialization.Serializable
import org.gradle.kotlin.dsl.java
Expand All @@ -20,7 +20,7 @@ import org.jetbrains.dokka.gradle.internal.DokkaInternalApi
*
* All other configuration data classes also implement [java.io.Serializable] via their parent interfaces.
*
* @see org.jetbrains.dokka.gradle.dokka.parameters.DokkaModuleDescriptionKxs
* @see org.jetbrains.dokka.gradle.engine.parameters.DokkaModuleDescriptionKxs
* @see org.jetbrains.dokka.DokkaModuleDescriptionImpl
*/
@Serializable
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
/*
* Copyright 2014-2024 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
*/
package org.jetbrains.dokka.gradle.dokka.parameters
package org.jetbrains.dokka.gradle.engine.parameters

import org.gradle.api.provider.Property
import org.gradle.api.provider.SetProperty
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/*
* Copyright 2014-2024 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
*/
package org.jetbrains.dokka.gradle.dokka.parameters
package org.jetbrains.dokka.gradle.engine.parameters

import org.gradle.api.file.DirectoryProperty
import org.gradle.api.file.ProjectLayout
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/*
* Copyright 2014-2024 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
*/
package org.jetbrains.dokka.gradle.dokka.parameters
package org.jetbrains.dokka.gradle.engine.parameters

import org.gradle.api.Action
import org.gradle.api.DomainObjectSet
Expand All @@ -16,7 +16,7 @@ import org.gradle.api.provider.SetProperty
import org.gradle.api.tasks.*
import org.gradle.kotlin.dsl.java
import org.gradle.kotlin.dsl.newInstance
import org.jetbrains.dokka.gradle.dokka.parameters.SourceSetIdSpec.Companion.dokkaSourceSetIdSpec
import org.jetbrains.dokka.gradle.engine.parameters.SourceSetIdSpec.Companion.dokkaSourceSetIdSpec
import org.jetbrains.dokka.gradle.internal.DokkaInternalApi
import org.jetbrains.dokka.gradle.internal.adding
import org.jetbrains.dokka.gradle.internal.domainObjectContainer
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/*
* Copyright 2014-2024 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
*/
package org.jetbrains.dokka.gradle.dokka.parameters
package org.jetbrains.dokka.gradle.engine.parameters

import org.gradle.api.provider.SetProperty
import org.gradle.api.tasks.Input
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/*
* Copyright 2014-2024 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
*/
package org.jetbrains.dokka.gradle.dokka.parameters
package org.jetbrains.dokka.gradle.engine.parameters

import org.jetbrains.dokka.Platform

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/*
* Copyright 2014-2024 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
*/
package org.jetbrains.dokka.gradle.dokka.parameters
package org.jetbrains.dokka.gradle.engine.parameters

import org.gradle.api.Named
import org.gradle.api.model.ObjectFactory
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/*
* Copyright 2014-2024 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
*/
package org.jetbrains.dokka.gradle.dokka.parameters
package org.jetbrains.dokka.gradle.engine.parameters

import org.jetbrains.dokka.DokkaConfiguration

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/*
* Copyright 2014-2024 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
*/
package org.jetbrains.dokka.gradle.dokka.parameters.builders
package org.jetbrains.dokka.gradle.engine.parameters.builders

import org.gradle.api.Project
import org.gradle.api.file.ArchiveOperations
Expand All @@ -10,9 +10,9 @@ import org.gradle.api.logging.Logger
import org.gradle.api.logging.Logging
import org.jetbrains.dokka.*
import org.jetbrains.dokka.gradle.DokkaBasePlugin
import org.jetbrains.dokka.gradle.dokka.parameters.DokkaGeneratorParametersSpec
import org.jetbrains.dokka.gradle.dokka.parameters.DokkaModuleDescriptionKxs
import org.jetbrains.dokka.gradle.dokka.plugins.DokkaPluginParametersBaseSpec
import org.jetbrains.dokka.gradle.engine.parameters.DokkaGeneratorParametersSpec
import org.jetbrains.dokka.gradle.engine.parameters.DokkaModuleDescriptionKxs
import org.jetbrains.dokka.gradle.engine.plugins.DokkaPluginParametersBaseSpec
import org.jetbrains.dokka.gradle.formats.DokkaHtmlPlugin.Companion.extractDokkaPluginMarkers
import org.jetbrains.dokka.gradle.internal.DokkaInternalApi
import java.io.File
Expand Down
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
/*
* Copyright 2014-2024 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
*/
package org.jetbrains.dokka.gradle.dokka.parameters.builders
package org.jetbrains.dokka.gradle.engine.parameters.builders


import org.gradle.api.logging.Logging
import org.jetbrains.dokka.*
import org.jetbrains.dokka.gradle.dokka.parameters.*
import org.jetbrains.dokka.gradle.dokka.parameters.KotlinPlatform.Companion.dokkaType
import org.jetbrains.dokka.gradle.dokka.parameters.VisibilityModifier.Companion.dokkaType
import org.jetbrains.dokka.gradle.engine.parameters.*
import org.jetbrains.dokka.gradle.engine.parameters.KotlinPlatform.Companion.dokkaType
import org.jetbrains.dokka.gradle.engine.parameters.VisibilityModifier.Companion.dokkaType
import org.jetbrains.dokka.gradle.internal.DokkaInternalApi
import org.jetbrains.dokka.gradle.internal.mapNotNullToSet
import org.jetbrains.dokka.gradle.internal.mapToSet
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/*
* Copyright 2014-2024 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
*/
package org.jetbrains.dokka.gradle.dokka.plugins
package org.jetbrains.dokka.gradle.engine.plugins

import kotlinx.serialization.json.buildJsonObject
import kotlinx.serialization.json.putJsonArray
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/*
* Copyright 2014-2024 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
*/
package org.jetbrains.dokka.gradle.dokka.plugins
package org.jetbrains.dokka.gradle.engine.plugins

import org.gradle.api.Named
import org.gradle.api.tasks.Input
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/*
* Copyright 2014-2024 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
*/
package org.jetbrains.dokka.gradle.dokka.plugins
package org.jetbrains.dokka.gradle.engine.plugins

import kotlinx.serialization.json.JsonArray
import kotlinx.serialization.json.JsonElement
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/*
* Copyright 2014-2024 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
*/
package org.jetbrains.dokka.gradle.dokka.plugins
package org.jetbrains.dokka.gradle.engine.plugins

import kotlinx.serialization.json.buildJsonObject
import kotlinx.serialization.json.putJsonArray
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,14 @@ import org.gradle.api.provider.ProviderFactory
import org.gradle.api.tasks.TaskProvider
import org.gradle.kotlin.dsl.register
import org.jetbrains.dokka.gradle.dependencies.FormatDependenciesManager
import org.jetbrains.dokka.gradle.dokka.DokkaPublication
import org.jetbrains.dokka.gradle.internal.DokkaInternalApi
import org.jetbrains.dokka.gradle.internal.configuring
import org.jetbrains.dokka.gradle.tasks.DokkaGenerateModuleTask
import org.jetbrains.dokka.gradle.tasks.DokkaGeneratePublicationTask
import org.jetbrains.dokka.gradle.tasks.DokkaGenerateTask
import org.jetbrains.dokka.gradle.tasks.TaskNames

/** Tasks for generating a Dokka Publication in a specific format. */
/** Tasks for generating a [DokkaPublication] in a specific format. */
@DokkaInternalApi
class DokkaFormatTasks(
project: Project,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,10 @@ import org.gradle.api.provider.ProviderFactory
import org.gradle.kotlin.dsl.register
import org.gradle.kotlin.dsl.registerBinding
import org.gradle.kotlin.dsl.withType
import org.jetbrains.dokka.gradle.dokka.plugins.DokkaHtmlPluginParameters
import org.jetbrains.dokka.gradle.dokka.plugins.DokkaHtmlPluginParameters.Companion.DOKKA_HTML_PARAMETERS_NAME
import org.jetbrains.dokka.gradle.dokka.plugins.DokkaVersioningPluginParameters
import org.jetbrains.dokka.gradle.dokka.plugins.DokkaVersioningPluginParameters.Companion.DOKKA_VERSIONING_PLUGIN_PARAMETERS_NAME
import org.jetbrains.dokka.gradle.engine.plugins.DokkaHtmlPluginParameters
import org.jetbrains.dokka.gradle.engine.plugins.DokkaHtmlPluginParameters.Companion.DOKKA_HTML_PARAMETERS_NAME
import org.jetbrains.dokka.gradle.engine.plugins.DokkaVersioningPluginParameters
import org.jetbrains.dokka.gradle.engine.plugins.DokkaVersioningPluginParameters.Companion.DOKKA_VERSIONING_PLUGIN_PARAMETERS_NAME
import org.jetbrains.dokka.gradle.internal.DokkaInternalApi
import org.jetbrains.dokka.gradle.internal.rootProjectName
import org.jetbrains.dokka.gradle.internal.uppercaseFirstChar
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/*
* Copyright 2014-2024 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
*/
package org.jetbrains.dokka.gradle.dokka
package org.jetbrains.dokka.gradle.formats

import org.gradle.api.Named
import org.gradle.api.file.ConfigurableFileCollection
Expand All @@ -15,12 +15,11 @@ import java.io.Serializable
import javax.inject.Inject

/**
* A [DokkaPublication] describes a single Dokka output.
* A [DokkaPublication] controls the output running the Dokka Generator.
*
* Each Publication has its own set of Gradle tasks and [org.gradle.api.artifacts.Configuration]s.
* The output format (for example, HTML) is determined by the Dokka Plugins that are present.
*
* The type of site is determined by the Dokka Plugins. By default, an HTML site will be generated.
* By default, Dokka will create publications for HTML, Jekyll, and GitHub Flavoured Markdown.
* Each Dokka Publication has its own set of Gradle tasks and [org.gradle.api.artifacts.Configuration]s.
*/
abstract class DokkaPublication
@DokkaInternalApi
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
package org.jetbrains.dokka.gradle.internal

import org.gradle.api.ExtensiblePolymorphicDomainObjectContainer
import org.jetbrains.dokka.gradle.dokka.plugins.DokkaPluginParametersBaseSpec
import org.jetbrains.dokka.gradle.engine.plugins.DokkaPluginParametersBaseSpec

/** Container for all [Dokka Plugin parameters][DokkaPluginParametersBaseSpec]. */
typealias DokkaPluginParametersContainer =
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ import org.gradle.api.specs.Spec
import org.gradle.api.tasks.TaskProvider
import org.gradle.kotlin.dsl.*
import org.gradle.util.GradleVersion
import org.jetbrains.dokka.gradle.dokka.plugins.DokkaPluginParametersBaseSpec
import org.jetbrains.dokka.gradle.engine.plugins.DokkaPluginParametersBaseSpec
import kotlin.reflect.KClass
import kotlin.reflect.jvm.jvmName

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import org.gradle.api.tasks.Input
import org.gradle.api.tasks.TaskAction
import org.gradle.workers.WorkerExecutor
import org.jetbrains.dokka.gradle.DokkaBasePlugin
import org.jetbrains.dokka.gradle.dokka.parameters.DokkaModuleDescriptionKxs
import org.jetbrains.dokka.gradle.engine.parameters.DokkaModuleDescriptionKxs
import org.jetbrains.dokka.gradle.internal.DokkaPluginParametersContainer
import org.jetbrains.dokka.gradle.internal.DokkaInternalApi
import java.io.File
Expand All @@ -36,7 +36,7 @@ constructor(
private val fs: FileSystemOperations,
/**
* Configurations for Dokka Generator Plugins. Must be provided from
* [org.jetbrains.dokka.gradle.dokka.DokkaPublication.pluginsConfiguration].
* [org.jetbrains.dokka.gradle.formats.DokkaPublication.pluginsConfiguration].
*/
pluginsConfiguration: DokkaPluginParametersContainer,
) : DokkaGenerateTask(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ constructor(
private val fs: FileSystemOperations,
/**
* Configurations for Dokka Generator Plugins. Must be provided from
* [org.jetbrains.dokka.gradle.dokka.DokkaPublication.pluginsConfiguration].
* [org.jetbrains.dokka.gradle.formats.DokkaPublication.pluginsConfiguration].
*/
pluginsConfiguration: DokkaPluginParametersContainer,
) : DokkaGenerateTask(
Expand Down
Loading

0 comments on commit e3dc412

Please sign in to comment.