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

Jump to bottom

fix for broken link, typo, and sample code #3532

Merged
merged 3 commits into from
Mar 21, 2024
Merged

fix for broken link, typo, and sample code #3532

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
42e6a4a
fix for broken link
LiYing2010 Mar 13, 2024
7ceb9f4
fix for sample code
LiYing2010 Mar 13, 2024
6c9daf1
fix for typo and broken link
LiYing2010 Mar 13, 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
2 changes: 1 addition & 1 deletion docs/topics/dokka-plugins.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -272,7 +272,7 @@ Here are some notable Dokka plugins that you might find useful:
| [Versioning plugin](https://github.com/Kotlin/dokka/tree/%dokkaVersion%/dokka-subprojects/plugin-versioning) | Adds version selector and helps to organize documentation for different versions of your application/library |
| [MermaidJS HTML plugin](https://github.com/glureau/dokka-mermaid) | Renders [MermaidJS](https://mermaid-js.github.io/mermaid/#/) diagrams and visualizations found in KDocs |
| [Mathjax HTML plugin](https://github.com/Kotlin/dokka/tree/%dokkaVersion%/dokka-subprojects/plugin-mathjax) | Pretty prints mathematics found in KDocs |
| [Kotlin as Java plugin](https://github.com/Kotlin/dokka/tree/%dokkaVersion%/dokka-subprojects/plugins-kotlin-as-java) | Renders Kotlin signatures as seen from Java's perspective |
| [Kotlin as Java plugin](https://github.com/Kotlin/dokka/tree/%dokkaVersion%/dokka-subprojects/plugin-kotlin-as-java) | Renders Kotlin signatures as seen from Java's perspective |

If you are a Dokka plugin author and would like to add your plugin to this list, get in touch with maintainers
via [Slack](dokka-introduction.md#community) or [GitHub](https://github.com/Kotlin/dokka/).
4 changes: 2 additions & 2 deletions docs/topics/formats/dokka-markdown.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,13 +54,13 @@ dependency:

After configuring this, running the `dokka:dokka` goal produces documentation in GFM format.

For more information, see the Mavin plugin documentation for [Other output formats](dokka-maven.md#other-output-formats).
For more information, see the Maven plugin documentation for [Other output formats](dokka-maven.md#other-output-formats).

</tab>
<tab title="CLI" group-key="cli">

Since GFM format is implemented as a [Dokka plugin](dokka-plugins.md#apply-dokka-plugins), you need to
[download the JAR file]((https://repo1.maven.org/maven2/org/jetbrains/dokka/gfm-plugin/%dokkaVersion%/gfm-plugin-%dokkaVersion%.jar))
[download the JAR file](https://repo1.maven.org/maven2/org/jetbrains/dokka/gfm-plugin/%dokkaVersion%/gfm-plugin-%dokkaVersion%.jar)
and pass it to `pluginsClasspath`.

Via [command line options](dokka-cli.md#run-with-command-line-options):
Expand Down
4 changes: 2 additions & 2 deletions docs/topics/runners/dokka-maven.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -586,7 +586,7 @@ Below you can see all the possible configuration options applied at the same tim
<suppressInheritedMembers>false</suppressInheritedMembers>
<offlineMode>false</offlineMode>
<sourceDirectories>
<dir>src</dir>
<dir>${project.basedir}/src</dir>
Copy link
Member

Choose a reason for hiding this comment

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

Can you please explain why this particular change is needed?

A recent PR gave me the impression that paths like ${project.basedir}/src are problematic on windows

Copy link
Contributor Author

Choose a reason for hiding this comment

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

here I fixed is sourceDirectories, and the PR you mentioned fixed sourceLinks, they are different

(1) about sourceLinks, according to doc here: https://kotlinlang.org/docs/dokka-maven.html#449338f2

The path must be relative to the root of the current module.

it must be a relative path, so the PR you mentioned is correct

(2) about sourceDirectories, according to doc here: https://kotlinlang.org/docs/dokka-maven.html#1be4d68

The source code roots to be analyzed and documented. Acceptable inputs are directories and individual .kt / .java files.

Default: {project.compileSourceRoots}

it does not mention about relative path or absolute path, but Default value looks like absolute path

and also, in doc here: https://kotlinlang.org/docs/dokka-maven.html#general-configuration
the sample is:

        <sourceDirectories>
            <dir>${project.basedir}/src</dir>
        </sourceDirectories>

it's also absolute path

Copy link
Contributor Author

Choose a reason for hiding this comment

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

BTW, the PR you mentioned fixed sourceLinks, but only in Source link configuration section
in this PR, I fixed the same problem in Complete configuration section

see: https://github.com/Kotlin/dokka/pull/3532/files#diff-f812b435573bdfbf70feb8b89e12da5a618472d79ef4cbb1dbf1a6229bd968a6R620

</sourceDirectories>
<documentedVisibilities>
<visibility>PUBLIC</visibility>
Expand Down Expand Up @@ -617,7 +617,7 @@ Below you can see all the possible configuration options applied at the same tim
</samples>
<sourceLinks>
<link>
<path>${project.basedir}/src</path>
<path>src</path>
<url>https://github.com/kotlin/dokka/tree/master/src</url>
<lineSuffix>#L</lineSuffix>
</link>
Expand Down
Loading