You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Dokka allows you to extend its functionality by [configuring custom plugins](https://github.com/Kotlin/dokka/blob/ae3840edb4e4afd7b3e3768a5fddfe8ec0e08f31/examples/gradle-v2/custom-dokka-plugin-example/demo-library/build.gradle.kts),
222
222
which enable additional processing or modifications to the documentation generation process.
Copy file name to clipboardExpand all lines: docs/topics/dokka-migration.md
+9-8Lines changed: 9 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,10 +1,5 @@
1
1
[//]: #(title: Migrate to Dokka Gradle plugin v2)
2
2
3
-
> The Dokka Gradle plugin v2 is an [Experimental](https://kotlinlang.org/docs/components-stability.html#stability-levels-explained) feature.
4
-
> It may be changed at any time. We appreciate your feedback on [GitHub](https://github.com/Kotlin/dokka/issues).
5
-
>
6
-
{style="warning"}
7
-
8
3
The Dokka Gradle plugin (DGP) is a tool for generating comprehensive API documentation for Kotlin projects built with Gradle.
9
4
10
5
DGP seamlessly processes both Kotlin's KDoc comments and Java's Javadoc comments to extract information and create
@@ -38,6 +33,12 @@ Ensure that your project meets the minimum version requirements:
38
33
39
34
### Enable DGP v2
40
35
36
+
> Starting from Dokka 2.1.0, DGP v2 is enabled by default.
37
+
> If you are using or updating to Dokka 2.1.0 or later,
38
+
> you can skip this step and go directly to [Migrate your project](#migrate-your-project).
39
+
>
40
+
{style="note"}
41
+
41
42
Update the Dokka version to 2.0.0 in the `plugins {}` block of your project’s `build.gradle.kts` file:
42
43
43
44
```kotlin
@@ -233,7 +234,7 @@ documentedVisibilities.set(
233
234
documentedVisibilities(VisibilityModifier.Public)
234
235
```
235
236
236
-
Additionally, use DGP v2's [utility function](https://github.com/Kotlin/dokka/blob/v2.0.0/dokka-runners/dokka-gradle-plugin/src/main/kotlin/engine/parameters/HasConfigurableVisibilityModifiers.kt#L14-L16) to add documented visibilities:
237
+
Additionally, use DGP v2's [utility function](https://github.com/Kotlin/dokka/blob/v2.1.0/dokka-runners/dokka-gradle-plugin/src/main/kotlin/engine/parameters/HasConfigurableVisibilityModifiers.kt#L14-L16) to add documented visibilities:
Dokka 2.0.0 allows you to extend its functionality by [configuring custom plugins](https://github.com/Kotlin/dokka/blob/ae3840edb4e4afd7b3e3768a5fddfe8ec0e08f31/examples/gradle-v2/custom-dokka-plugin-example/demo-library/build.gradle.kts).
526
+
DGP v2 allows you to extend its functionality by [configuring custom plugins](https://github.com/Kotlin/dokka/blob/ae3840edb4e4afd7b3e3768a5fddfe8ec0e08f31/examples/gradle-v2/custom-dokka-plugin-example/demo-library/build.gradle.kts).
526
527
Custom plugins enable additional processing or modifications to the documentation generation process.
527
528
528
529
### Share Dokka configuration across modules
@@ -759,7 +760,7 @@ Here is a list of the plugin `id` and Gradle task that correspond to each format
759
760
760
761
### Address deprecations and removals
761
762
762
-
***Output format support:**Dokka2.0.0 only supports HTMLandJavadoc output. Experimental formats like MarkdownandJekyll are no longer supported.
763
+
***Output format support:**DGP v2 only supports HTMLandJavadoc output. Experimental formats like MarkdownandJekyll are no longer supported.
763
764
***Collector task:** `DokkaCollectorTask` has been removed. Now, you need to generate the documentation separately for
764
765
each subproject and then [aggregate the documentation](#update-documentation-aggregation-in-multi-module-projects) if necessary.
Copy file name to clipboardExpand all lines: dokka-subprojects/analysis-kotlin-symbols/README.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,7 +24,7 @@ To build it with an override version of Analysis API, the property
24
24
25
25
### Entry point
26
26
27
-
The main entry point is `DefaultSymbolToDocumentableTranslator` (this is an extension for [the extension point](https://kotlin.github.io/dokka/2.0.0/developer_guide/architecture/extension_points/core_extensions/#sourcetodocumentabletranslator) ), that is used by the Dokka core to build Documentable model by a source set.
27
+
The main entry point is `DefaultSymbolToDocumentableTranslator` (this is an extension for [the extension point](https://kotlin.github.io/dokka/2.1.0/developer_guide/architecture/extension_points/core_extensions/#sourcetodocumentabletranslator) ), that is used by the Dokka core to build Documentable model by a source set.
28
28
29
29
Across running Dokka we keep `StandaloneAnalysisAPISession` and `KtSourceModule` instances from Analysis API into `KotlinAnalysis`.
30
30
`KotlinAnalysis` is used in `DefaultSymbolToDocumentableTranslator` and other services that need an additional analysis.
@@ -51,4 +51,4 @@ By default, we run unit tests on TeamCity against the latest Analysis API by a s
51
51
- You can use the `gradle :publishToMavenLocal` task to publish Dokka locally.
52
52
- To build Dokka without running testing, using the `gradle assemble` task is recommended since the tests are time-consuming.
53
53
54
-
See the detailed guide [here](https://kotlin.github.io/dokka/2.0.0/developer_guide/workflow/).
54
+
See the detailed guide [here](https://kotlin.github.io/dokka/2.1.0/developer_guide/workflow/).
0 commit comments