Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename dokkaModuleDirectory, and mark as internal #3880

Merged
merged 7 commits into from
Oct 24, 2024
Merged

Rename dokkaModuleDirectory, and mark as internal #3880

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
f6c4351
Rename `dokkaPublicationDirectory` to `basePublicationsDirectory`
adam-enko Oct 21, 2024
9a87f19
Update output dir docs
adam-enko Oct 21, 2024
8968b4f
update api dump
adam-enko Oct 21, 2024
af9850b
deprecate level ERROR
adam-enko Oct 21, 2024
d618681
update outputDirectory v1 config
adam-enko Oct 21, 2024
ae396c3
Rename `dokkaModuleDirectory`, and mark as internal
adam-enko Oct 21, 2024
aea8a66
Merge branch 'master' into adam/feat/KT-70336/hide-dokka-module-direc…
adam-enko Oct 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion dokka-runners/dokka-gradle-plugin/api/dokka-gradle-plugin.api
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,6 @@ public abstract class org/jetbrains/dokka/gradle/DokkaExtension : java/io/Serial
public abstract fun getDokkaCacheDirectory ()Lorg/gradle/api/file/DirectoryProperty;
public abstract fun getDokkaEngineVersion ()Lorg/gradle/api/provider/Property;
public abstract fun getDokkaGeneratorIsolation ()Lorg/gradle/api/provider/Property;
public abstract fun getDokkaModuleDirectory ()Lorg/gradle/api/file/DirectoryProperty;
public final fun getDokkaPublicationDirectory ()Lorg/gradle/api/file/DirectoryProperty;
public final fun getDokkaPublications ()Lorg/gradle/api/NamedDomainObjectContainer;
public final fun getDokkaSourceSets ()Lorg/gradle/api/NamedDomainObjectContainer;
Expand Down
4 changes: 2 additions & 2 deletions dokka-runners/dokka-gradle-plugin/src/main/kotlin/DokkaBasePlugin.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ constructor(

sourceSetScopeDefault.convention(project.path)
basePublicationsDirectory.convention(layout.buildDirectory.dir("dokka"))
dokkaModuleDirectory.convention(layout.buildDirectory.dir("dokka-module"))
baseModulesDirectory.convention(layout.buildDirectory.dir("dokka-module"))
// @Suppress("DEPRECATION")
// dokkaConfigurationsDirectory.convention(layout.buildDirectory.dir("dokka-config"))

Expand Down Expand Up @@ -158,7 +158,7 @@ constructor(
moduleVersion.convention(dokkaExtension.moduleVersion)
offlineMode.convention(false)
outputDirectory.convention(dokkaExtension.basePublicationsDirectory.dir(formatName))
moduleOutputDirectory.convention(dokkaExtension.dokkaModuleDirectory.dir(formatName))
moduleOutputDirectory.convention(dokkaExtension.baseModulesDirectory.dir(formatName))
suppressInheritedMembers.convention(
@Suppress("DEPRECATION")
dokkaExtension.suppressInheritedMembers
Expand Down
2 changes: 1 addition & 1 deletion dokka-runners/dokka-gradle-plugin/src/main/kotlin/DokkaExtension.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ constructor(
* Note that Dokka Modules are intermediate products and must be combined into a completed
* Dokka Publication. They are not intended to be comprehensible in isolation.
*/
abstract val dokkaModuleDirectory: DirectoryProperty
internal abstract val baseModulesDirectory: DirectoryProperty

/** Default Dokka Gradle Plugin cache directory */
abstract val dokkaCacheDirectory: DirectoryProperty
Expand Down
Loading