Rename dokkaModuleDirectory, and mark as internal
#3880
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Follow up for #3876 When Dokka produces 'partial' Modules it stores them in a project-local directory. How Dokka processes Modules is an implementation detail, so exposing the directory is not useful for users, and could be confusing. It is useful to have a single property for DGP to use though, so it should be kept. As such, mark it as `internal` to hide it from the DSL.
adam-enko
added
the
runner: Gradle plugin
Base automatically changed from
adam/feat/KT-70336/rename-dokka-publication-dir
to
master
October 22, 2024 13:45
whyoleg
approved these changes
Oct 22, 2024
Tapchicoma
approved these changes
Oct 24, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Follow up for #3876
When Dokka produces 'partial' Modules it stores them in a project-local directory.
How Dokka processes Modules is an implementation detail, so exposing the directory is not useful for users, and could be confusing. It is useful to have a single property for DGP to use though, so it should be kept.
As such, mark
baseModulesDirectoryasinternalto hide it from the DSL.I propose skipping the Deprecation phase since I think it's very unlikely anyone ever configured this property, even for Dokkatoo users.