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
Copy file name to clipboardExpand all lines: docs/topics/formats/dokka-markdown.md
+2-1Lines changed: 2 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,7 @@
1
1
[//]: #(title: Markdown)
2
2
3
-
> The Markdown output formats are still in Alpha so you may find bugs and experience migration issues when using them. **You use them at your own risk.**
3
+
> The Markdown output formats are still in Alpha, so you may find bugs and experience migration issues when using them.
Copy file name to clipboardExpand all lines: docs/topics/runners/dokka-cli.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -203,7 +203,7 @@ Short summary:
203
203
|`displayName`| Display name of the source set, used both internally and externally. |
204
204
|`classpath`| Classpath for analysis and interactive samples. Accepts multiple paths separated by semicolons. |
205
205
|`src`| Source code roots to be analyzed and documented. Accepts multiple paths separated by semicolons. |
206
-
|`dependentSourceSets`| Names of the dependent source sets in format `moduleName/sourceSetName`. Accepts multiple paths separated by semicolons.|
206
+
|`dependentSourceSets`| Names of the dependent source sets in format `moduleName/sourceSetName`. Accepts multiple values separated by semicolons. |
207
207
|`samples`| List of directories or files that contain sample functions. Accepts multiple paths separated by semicolons. <anchorname="includes-cli"/> |
208
208
|`includes`| Markdown files that contain [module and package documentation](dokka-module-and-package-docs.md). Accepts multiple paths separated by semicolons. |
209
209
|`documentedVisibilities`| Visibilities to be documented. Accepts multiple values separated by semicolons. Possible values: `PUBLIC`, `PRIVATE`, `PROTECTED`, `INTERNAL`, `PACKAGE`. |
@@ -436,8 +436,8 @@ How to configure Kotlin
436
436
<def title="documentedVisibilities">
437
437
<p>The set of visibility modifiers that should be documented.</p>
438
438
<p>
439
-
This can be used if you want to document protected/internal/private declarations,
440
-
as well as if you want to exclude public declarations and only document internal API.
439
+
This can be used if you want to document <code>protected</code>/<code>internal</code>/<code>private</code> declarations,
440
+
as well as if you want to exclude <code>public</code> declarations and only document internal API.
441
441
</p>
442
442
<p>This can be configured on per-package basis.</p>
443
443
<p>
@@ -674,17 +674,17 @@ You can add package configurations for all source sets together at the same time
674
674
<def title="documentedVisibilities">
675
675
<p>The set of visibility modifiers that should be documented.</p>
676
676
<p>
677
-
This can be used if you want to document protected/internal/private declarations within this package,
678
-
as well as if you want to exclude public declarations and only document internal API.
677
+
This can be used if you want to document <code>protected</code>/<code>internal</code>/<code>private</code> declarations within this package,
678
+
as well as if you want to exclude <code>public</code> declarations and only document internal API.
679
679
</p>
680
680
<p>Can be configured on source set level.</p>
681
681
<p>Default: <code>PUBLIC</code></p>
682
682
</def>
683
683
</deflist>
684
684
685
-
### External documentation configuration
685
+
### External documentation links configuration
686
686
687
-
The `externalDocumentationLink` block allows the creation of links that lead to the externally hosted documentation of
687
+
The `externalDocumentationLinks` block allows the creation of links that lead to the externally hosted documentation of
688
688
your dependencies.
689
689
690
690
For example, if you are using types from `kotlinx.serialization`, by default they are unclickable in your
0 commit comments