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

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

Merged
merged 3 commits into from
Mar 21, 2024

Conversation

LiYing2010
Copy link
Contributor

@LiYing2010 LiYing2010 commented Mar 13, 2024

fix for broken link, typo, and sample code

@LiYing2010 LiYing2010 changed the title fix for broken link fix for broken link, typo, and sample code Mar 13, 2024
Copy link
Member

@IgnatBeresnev IgnatBeresnev left a comment

Choose a reason for hiding this comment

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

Wow, thank you for noticing and fixing it!

<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

@LiYing2010
Copy link
Contributor Author

hi @IgnatBeresnev
thank you very much for approving this PR
could you please merge it?

@IgnatBeresnev
Copy link
Member

Thank you once again!

@IgnatBeresnev IgnatBeresnev merged commit 33c4f56 into Kotlin:master Mar 21, 2024
6 checks passed
@LiYing2010 LiYing2010 deleted the minor_fix_for_doc branch March 26, 2024 08:24
@IgnatBeresnev IgnatBeresnev added this to the Dokka 2.0.0 milestone Apr 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants