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.

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

Relocate DGPv2 'dokka' package #3779

Merged
merged 2 commits into from
Sep 10, 2024

Conversation

adam-enko
Copy link
Member

@adam-enko adam-enko commented Sep 4, 2024

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.

KT-70811

@adam-enko adam-enko added the runner: Gradle plugin An issue/PR related to Dokka's Gradle plugin label Sep 4, 2024
Base automatically changed from adam/feat/OSIP-355/add-migration-helpers to master September 9, 2024 09:13
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.
@adam-enko adam-enko force-pushed the adam/feat/OSIP-355/relocate-dokka-package branch from 670f111 to 94e0686 Compare September 9, 2024 09:49
@adam-enko adam-enko changed the title Relocate dokka package Relocate DGPv2 'dokka' package Sep 9, 2024
@adam-enko adam-enko marked this pull request as ready for review September 9, 2024 14:06
Copy link
Collaborator

@whyoleg whyoleg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@@ -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.engine.DokkaPublication.pluginsConfiguration].
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this KDoc link is unresolved (should be formats instead of engine) - the same in several other places

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! I will fix them.

@adam-enko adam-enko merged commit e3dc412 into master Sep 10, 2024
11 of 14 checks passed
@adam-enko adam-enko deleted the adam/feat/OSIP-355/relocate-dokka-package branch September 10, 2024 15:25
adam-enko added a commit that referenced this pull request Sep 18, 2024
I forgot to move the files in `src/test/` in #3779.
adam-enko added a commit that referenced this pull request Sep 18, 2024
I forgot to move the files in `src/test/` in #3779.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
runner: Gradle plugin An issue/PR related to Dokka's Gradle plugin
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants