fix for broken link, typo, and sample code #3532
Conversation
LiYing2010
changed the title
| <dir>src</dir> | ||
| <dir>${project.basedir}/src</dir> |
There was a problem hiding this comment.
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.
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.
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