Closed pklaschka closed 3 years ago
@fussel178 is this actually closed or more "on accident" by referencing it in the PR? As far as I could see it, the PR only handled the "website part" of the docs, didn't it?
@fussel178 is this actually closed or more "on accident" by referencing it in the PR? As far as I could see it, the PR only handled the "website part" of the docs, didn't it?
Nope, the sources will now be published in all packages through:
java {
withJavadocJar()
withSourcesJar()
}
I've used the wrong specifier in the commit message, otherwise the changelog would contain this informatiom. My bad :see_no_evil:
Currently, the source files (or, more specifically, the JavaDoc comments, which, to my knowledge, are in the sources) don't get published in the packages.
This means that the APIs don't include these doc comments, which, of course, is a pity as that's the very reason these comments should be included 😉 .
One example of this can be seen in this screenshot, for the
JsonMessage.on
function:For comparison, this is the comment included in the original sources:
Trying to run the gradle task
'DownloadSources'
results in the following error (in thetelestion-project-daedalus2
repository):Due to my limited knowledge about Java and Gradle, it is, of course, very much possible that I overlooked something and it is an error on my part. In this case, however, it would be great if such information could be included in the README or, potentially, even made accessible with this Gradle task as it is "proposed" by Intellij, which, arguably, would be great to support as much as possible.