-
Notifications
You must be signed in to change notification settings - Fork 410
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
Conversation
There was a problem hiding this 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> |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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
hi @IgnatBeresnev |
Thank you once again! |
fix for broken link, typo, and sample code